Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Apply suggestions from code review 

Co-Authored-By: Derek Pierre <derek.pierre@gmail.com>
Co-Authored-By: Tux <tuxxy@users.noreply.github.com>
pull/1352/head
David Núñez 2019-09-23 15:41:56 +02:00 committed by GitHub
parent d9403e361c
commit ee210d956f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/architecture/contracts.md
View File

@ -14,7 +14,7 @@
## Deployment Procedure
This section describes how NuCypher contracts are deployed, step-by-step.
This section provides a step-by-step guide of how NuCypher contracts are deployed.
For a guide of how to deploy these contracts automatically, see the [Deployment guide](/guides/deployment_guide).
1. Deploy `NuCypherToken` with all future supply tokens
@ -87,7 +87,7 @@ When calculating locked tokens using the `StakingEscrow.getLockedTokens(address,
### The Staker Bonds to a Worker ("Ursula")
The staker must specify a worker who will confirm the activity and sign on behalf of this staker by calling the `StakingEscrow.setWorker(address)` method.
Changing a worker is allowed no more than 1 time in `StakingEscrow.minWorkerPeriods()`.
Changing a worker is allowed no more than once within `StakingEscrow.minWorkerPeriods()`.
Only the worker can confirm activity.
@ -119,6 +119,6 @@ The staker can set a minimum reward rate for a policy. For that, the staker shou
Some users will have locked but not staked tokens.
In that case, an instance of the `UserEscrow` contract will hold their tokens (method `UserEscrow.initialDeposit(uint256, uint256)`).
All tokens will be unlocked after a specified time and the user can retrieve them using the `UserEscrow.withdraw(uint256)` method.
When the user wants to become a staker - she uses the `UserEscrow` contract as a proxy for the `StakingEscrow` and `PolicyManager` contracts.
When the user wants to become a staker - they use the `UserEscrow` contract as a proxy for the `StakingEscrow` and `PolicyManager` contracts.

2
docs/source/guides/contribution_guide.rst
View File

@ -29,7 +29,7 @@ contributing proposed changes:
$ git clone https://github.com/<YOUR-GITHUB-USERNAME>/nucypher.git
3. Change directories into ``nucypher``
3. Change directory to ``nucypher``
.. code-block:: bash