Skip to content

Commit 73b4667

Browse files
authored
Merge pull request #176 from keep-network/implementation-details-rewards
Rewards Documentation This PR adds documentation for the rewards mechanism of the sortition pool!
2 parents f937be7 + 7079290 commit 73b4667

2 files changed

Lines changed: 435 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ To familiarize yourself with the sortition pool and it's design, we provide
1414

1515
+ [Building Intuition](docs/building-intuition.md)
1616
+ [Implementation Details](docs/implementation-details.md)
17+
+ [Rewards](docs/rewards.md)
1718

1819
[Building Intuition](docs/building-intuition.md) starts the reader from the
1920
problem description and an easy-to-understand naive solution, and then works
@@ -26,6 +27,10 @@ the finer points about the data structure, data (de)serialization, how
2627
operators join/leave the pool, and how it all comes together to select a full
2728
group.
2829

30+
[Rewards](docs/rewards.md) is a deep-dive into how the sortition pool keeps
31+
track of rewards. It features code explanations and walk-throughs of state
32+
transitions for common situations.
33+
2934
## Important Facts
3035

3136
+ The max number of operators is `2,097,152`
@@ -34,6 +39,7 @@ group.
3439
+ The sortition pool can be [optimistic](#optimisic-group-selection)! The
3540
on-chain code then is only run in the case that the selection submission is
3641
challenged.
42+
+ The sortition pool tracks rewards!
3743

3844
## Safe Use
3945

0 commit comments

Comments
 (0)