certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updating transactions

This commit is contained in:
rigelrozanski 2018-08-09 00:34:19 -04:00
parent 5285489977
commit e7ebe35b0a
1 changed files with 61 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
docs/spec/distribution/transactions.md
View File

@ -1,16 +1,3 @@
Each delegation holds multiple accumulation factors to specify its entitlement to
the rewards from a validator. `Accum` is used to passively calculate
each bonds entitled rewards from the `RewardPool`. `AccumProposer` is used to
passively calculate each bonds entitled rewards from
`ValidatorDistribution.ProposerRewardPool`
# Transactions # Transactions
## TxWithdrawDelegation ## TxWithdrawDelegation
@ -42,14 +29,14 @@ func GetDelegatorEntitlement(delegatorAddr sdk.AccAddress) DecCoins
delegations = GetDelegations(delegatorAddr) delegations = GetDelegations(delegatorAddr)
DelDistr = GetDelegationDistribution(delegation.DelegatorAddr, DelDistr = GetDelegationDistribution(delegation.DelegatorAddr,
delegation.ValidatorAddr) delegation.ValidatorAddr)
pcs = GetPowerChanges(DelDistr.WithdrawalHeight) vus = GetValidatorUpdates(DelDistr.WithdrawalHeight)
// update all adjustment factors for each delegation since last withdrawal // update all adjustment factors for each delegation since last withdrawal
for pc = range pcs for vu = range vus
for delegation = range delegations for delegation = range delegations
DelDistr = GetDelegationDistribution(delegation.DelegatorAddr, DelDistr = GetDelegationDistribution(delegation.DelegatorAddr,
delegation.ValidatorAddr) delegation.ValidatorAddr)
pc.ProcessPowerChangeDelegation(delegation, DelDistr) vu.ProcessPowerChangeDelegation(delegation, DelDistr)
// collect all entitled fees // collect all entitled fees
entitlement = 0 entitlement = 0
@ -70,16 +57,16 @@ func GetDelegatorEntitlement(delegatorAddr sdk.AccAddress) DecCoins
return entitlement return entitlement
func (pc ValidatorUpdate) ProcessPowerChangeDelegation(delegation sdk.Delegation, func (vu ValidatorUpdate) ProcessPowerChangeDelegation(delegation sdk.Delegation,
DelDistr DelegationDistribution) DelDistr DelegationDistribution)
// get the historical scenarios // get the historical scenarios
scenario1 = pc.DelegationFromGlobalPool(delegation, DelDistr) scenario1 = vu.DelegationFromGlobalPool(delegation, DelDistr)
scenario2 = pc.DelegationFromProvisionPool(delegation, DelDistr) scenario2 = vu.DelegationFromProvisionPool(delegation, DelDistr)
// process the adjustment factors // process the adjustment factors
scenario1.UpdateAdjustmentForPowerChange(pc.Height) scenario1.UpdateAdjustmentForPowerChange(vu.Height)
scenario2.UpdateAdjustmentForPowerChange(pc.Height) scenario2.UpdateAdjustmentForPowerChange(vu.Height)
``` ```
## TxWithdrawValidator ## TxWithdrawValidator
@ -91,7 +78,7 @@ redelegation, or delegation of additional tokens to a specific validator. This
transaction withdraws the validators commission rewards, as well as any rewards transaction withdraws the validators commission rewards, as well as any rewards
earning on their self-delegation. earning on their self-delegation.
```golang ```
type TxWithdrawValidator struct { type TxWithdrawValidator struct {
ownerAddr sdk.AccAddress // validator address to withdraw from ownerAddr sdk.AccAddress // validator address to withdraw from
withdrawAddr sdk.AccAddress // address to make the withdrawal to withdrawAddr sdk.AccAddress // address to make the withdrawal to
@ -104,9 +91,9 @@ func WithdrawalValidator(ownerAddr, withdrawAddr sdk.AccAddress)
// update the validator adjustment factors for commission // update the validator adjustment factors for commission
ValDistr = GetValidatorDistribution(ownerAddr.ValidatorAddr) ValDistr = GetValidatorDistribution(ownerAddr.ValidatorAddr)
pcs = GetPowerChanges(ValDistr.CommissionWithdrawalHeight) vus = GetValidatorUpdates(ValDistr.CommissionWithdrawalHeight)
for pc = range pcs for vu = range vus
pc.ProcessPowerChangeCommission() vu.ProcessPowerChangeCommission()
// withdrawal validator commission rewards // withdrawal validator commission rewards
global = GetGlobal() global = GetGlobal()
@ -122,38 +109,78 @@ func WithdrawalValidator(ownerAddr, withdrawAddr sdk.AccAddress)
AddCoins(withdrawAddr, totalEntitlment.TruncateDecimal()) AddCoins(withdrawAddr, totalEntitlment.TruncateDecimal())
func (pc ValidatorUpdate) ProcessPowerChangeCommission() func (vu ValidatorUpdate) ProcessPowerChangeCommission()
// get the historical scenarios // get the historical scenarios
scenario1 = pc.CommissionFromGlobalPool() scenario1 = vu.CommissionFromGlobalPool()
scenario2 = pc.CommissionFromProposerPool() scenario2 = vu.CommissionFromProposerPool()
// process the adjustment factors // process the adjustment factors
scenario1.UpdateAdjustmentForPowerChange(pc.Height) scenario1.UpdateAdjustmentForPowerChange(vu.Height)
scenario2.UpdateAdjustmentForPowerChange(pc.Height) scenario2.UpdateAdjustmentForPowerChange(vu.Height)
``` ```
## Common Calculations ## Common Calculations
### Distribution scenarios ### Update total validator accum
Note that the distribution scenario structures are found in `state.md`. The total amount of validator accum must be calculated in order to determine
the amount of pool tokens which a validator is entitled to at a particular block.
This term is to be updated during a validator withdrawal.
#### Delegation's entitlement to Global.Pool ```
func (g Global) UpdateTotalValAccum()
TODO
```
### Update total delegator accum
Each delegation holds multiple accumulation factors to specify its entitlement to
the rewards from a validator. `Accum` is used to passively calculate
each bonds entitled rewards from the `RewardPool`. `AccumProposer` is used to
passively calculate each bonds entitled rewards from
`ValidatorDistribution.ProposerRewardPool`
```
TODO
```
### Global Pool to Validator Pool
Everytime a validator or delegator make a withdraw or the validator is the
proposer and receives new tokens - the relavent validator must move tokens from
the passive global pool to thier own pool.
```
TODO
```
### Delegation's entitlement to ValidatorDistribution.Pool
For delegations (including validator's self-delegation) all fees from fee pool For delegations (including validator's self-delegation) all fees from fee pool
are subject to commission rate from the owner of the validator. The global are subject to commission rate from the owner of the validator. The global
shares should be taken as true number of global bonded shares. The recipients shares should be taken as true number of global bonded shares. The recipients
shares should be taken as the bonded tokens less the validator's commission. shares should be taken as the bonded tokens less the validator's commission.
Each delegation holds multiple accumulation factors to specify its entitlement to
the rewards from a validator. `Accum` is used to passively calculate
each bonds entitled rewards from the `RewardPool`. `AccumProposer` is used to
passively calculate each bonds entitled rewards from
`ValidatorDistribution.ProposerRewardPool`
``` ```
TODO
``` ```
#### Validators's commission entitlement to Global.Pool ### Validators's commission entitlement to ValidatorDistribution.Pool
Similar to a delegator's entitlement, but with recipient shares based on the Similar to a delegator's entitlement, but with recipient shares based on the
commission portion of bonded tokens. commission portion of bonded tokens.
``` ```
TODO
``` ```