Skip to content

IIP-59: clarify voter reward distribution event #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
envestcc wants to merge 1 commit into
base: master
Choose a base branch
from
Open

IIP-59: clarify voter reward distribution event #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 11 additions & 6 deletions iip-59.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,12 +368,12 @@ freeze height.
Each chunk emits one EVM-compatible event per contributing delegate:

```solidity
event DelegateDistributed(
event DelegateVoterRewardsDistributed(
uint64 indexed epoch,
address indexed delegate,
address rewardAddr,
uint256 totalCommission,
uint256 totalVoterPool,
uint256 eraCommission,
uint256 chunkVoterReward,
bytes32 snapshotHash,
address[] voters,
address[] recipients,
Expand All @@ -384,14 +384,19 @@ event DelegateDistributed(
```

`epoch` is the chunk epoch; `delegate` is candidate identity; `rewardAddr` is
the owner frozen in the plan; `totalCommission` is the boundary epoch
commission; and `totalVoterPool` is the sum of this event's `amounts`. The five
the owner frozen in the plan; `eraCommission` is the era-wide commission
repeated in each chunk; and `chunkVoterReward` is the sum of this event's
`amounts` and MUST be summed across chunks. The five
arrays are parallel and describe each beneficiary, actual recipient,
delegate-level contribution, compound bucket, and route. Consumers MUST use
`compounded`, because bucket ID zero is valid. `snapshotHash` joins a
delegate's partial events across chunks. `amounts[i]` is this delegate's
contribution, not the voter's combined payment. For compound routes,
`recipients[i] = voters[i]` and `compoundBucketIds[i]` identifies the bucket.
Events are grouped by delegate even though settlement traverses voters. A voter
who voted for multiple delegates therefore appears once in each contributing
delegate's event, while the protocol may combine those contributions into one
payment to the voter.

Every chunk first emits `CURSOR_PROGRESS`, encoding
`targetEra:shardsDone:hex(resumeVoter):shardsRemaining` in its address field and
Expand Down Expand Up @@ -501,7 +506,7 @@ distributing post-fork rewards for automatically migrated delegates.

`ForwardRegistration` entries are not imported. A voter requiring a non-default
destination must configure it once. Historical post-activation distributions
are reconstructed from receipts and `DelegateDistributed`, not persistent
are reconstructed from receipts and `DelegateVoterRewardsDistributed`, not persistent
per-voter history.

## Security Considerations
Expand Down