Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Documentation for Staking Module #1951

Closed
kianenigma wants to merge 23 commits into from
Closed

Documentation for Staking Module #1951

Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
aa83f22
initial doc for the staking module
kianenigma Mar 9, 2019
b9d09bb
Remove md style links.
kianenigma Mar 9, 2019
7df2b19
Remove todos.
kianenigma Mar 9, 2019
28b959b
Add rust code types
kianenigma Mar 9, 2019
91be68b
Rename and fix review notes.
kianenigma Mar 11, 2019
5912ff5
Add new md file
kianenigma Mar 11, 2019
64ca546
Final touches.
kianenigma Mar 11, 2019
a8ba78e
Migrate compleatly to rustdoc
kianenigma Mar 11, 2019
982d7e8
Update link
kianenigma Mar 11, 2019
4a572a2
Fix heading
kianenigma Mar 11, 2019
ea5ae00
Merge branch 'master' into kiz-document-staking
kianenigma Mar 12, 2019
89682a6
Final touches wrt the new template.
kianenigma Mar 12, 2019
956ec96
Remove empty prereq.
kianenigma Mar 12, 2019
2879e1d
Fix more reviews
kianenigma Mar 12, 2019
105723b
Some final nits.
kianenigma Mar 12, 2019
531ae73
Merge branch 'master' of github.com:paritytech/substrate into kiz-doc…
kianenigma Mar 14, 2019
5567859
Fix some side issues.
kianenigma Mar 14, 2019
e739361
Fix another set of reviews
kianenigma Mar 15, 2019
aa4994e
Clean up a lot of the misleading language.
gavofyork Mar 15, 2019
1fee935
Update srml/staking/src/lib.rs
shawntabrizi Mar 15, 2019
1848306
Update srml/staking/src/lib.rs
shawntabrizi Mar 15, 2019
117eb93
Update srml/staking/src/lib.rs
shawntabrizi Mar 15, 2019
f9144b2
Final fixes
kianenigma Mar 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove todos.
  • Loading branch information
@kianenigma
kianenigma committed Mar 9, 2019
commit 7df2b19ff20e97f22213f69e32b6922b42fd3dcc
4 changes: 1 addition & 3 deletions srml/staking/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The staking module is the means by which a set of network maintainers (known as
### Terminology

- **Staking**: The process of locking up funds for some time, placing them at risk of slashing (loss) in order to become a rewarded maintainer of the network.
- **Validating**: The process of running a node to actively maintain the network, either by producing blocks or guaranteeing finality of the chain. (see [here]() for the details of how block production and finalization are separated)
- **Validating**: The process of running a node to actively maintain the network, either by producing blocks or guaranteeing finality of the chain.
- **Nominating**: The process of placing staked funds behind one or more validators in order to share in any reward and punishment, they take.
- **Stash account**: The account holding an owner's funds used for staking.
- **Controller account**: The account which controls an owner's funds for staking.
Expand Down Expand Up @@ -69,7 +69,6 @@ Finally, account 4 can withdraw from any of the above roles via
Staking::chill(Origin::signed(4));
```

TODO: What else could be a usage example here interesting for the user? Do we have any?

## Implementation Details

Expand Down Expand Up @@ -104,7 +103,6 @@ Current election algorithm is implemented based on Phragmen. The reference imple

// Details that the user can modify or customize to make their own


## Dependencies

### GenesisConfig
Expand Down