revert docs
This commit is contained in:
parent
e145676fcc
commit
3bf3643176
|
@ -297,12 +297,12 @@ type TxProveLive struct {
|
||||||
## Delegator bond
|
## Delegator bond
|
||||||
|
|
||||||
Atom holders may delegate coins to validators, under this circumstance their
|
Atom holders may delegate coins to validators, under this circumstance their
|
||||||
funds are held in a `Delegation`. It is owned by one delegator, and is
|
funds are held in a `DelegatorBond`. It is owned by one delegator, and is
|
||||||
associated with the shares for one validator. The sender of the transaction is
|
associated with the shares for one validator. The sender of the transaction is
|
||||||
considered to be the owner of the bond,
|
considered to be the owner of the bond,
|
||||||
|
|
||||||
``` golang
|
``` golang
|
||||||
type Delegation struct {
|
type DelegatorBond struct {
|
||||||
Candidate crypto.PubKey
|
Candidate crypto.PubKey
|
||||||
Shares rational.Rat
|
Shares rational.Rat
|
||||||
AdjustmentFeePool coin.Coins
|
AdjustmentFeePool coin.Coins
|
||||||
|
@ -318,11 +318,11 @@ Description:
|
||||||
- AdjustmentRewardPool: Adjustment factor used to passively calculate each
|
- AdjustmentRewardPool: Adjustment factor used to passively calculate each
|
||||||
bonds entitled fees from `Candidate.ProposerRewardPool``
|
bonds entitled fees from `Candidate.ProposerRewardPool``
|
||||||
|
|
||||||
Each `Delegation` is individually indexed within the store by delegator
|
Each `DelegatorBond` is individually indexed within the store by delegator
|
||||||
address and candidate pubkey.
|
address and candidate pubkey.
|
||||||
|
|
||||||
- key: Delegator and Candidate-Pubkey
|
- key: Delegator and Candidate-Pubkey
|
||||||
- value: Delegation
|
- value: DelegatorBond
|
||||||
|
|
||||||
|
|
||||||
### Delegating
|
### Delegating
|
||||||
|
@ -330,7 +330,7 @@ address and candidate pubkey.
|
||||||
Delegator bonds are created using the TxDelegate transaction. Within this
|
Delegator bonds are created using the TxDelegate transaction. Within this
|
||||||
transaction the validator candidate queried with an amount of coins, whereby
|
transaction the validator candidate queried with an amount of coins, whereby
|
||||||
given the current exchange rate of candidate's delegator-shares-to-atoms the
|
given the current exchange rate of candidate's delegator-shares-to-atoms the
|
||||||
candidate will return shares which are assigned in `Delegation.Shares`.
|
candidate will return shares which are assigned in `DelegatorBond.Shares`.
|
||||||
|
|
||||||
``` golang
|
``` golang
|
||||||
type TxDelegate struct {
|
type TxDelegate struct {
|
||||||
|
@ -671,5 +671,5 @@ rate, all commission on fees must be simultaneously withdrawn.
|
||||||
`candidate.Adjustment` must be set to the value of `canidate.Count` for the
|
`candidate.Adjustment` must be set to the value of `canidate.Count` for the
|
||||||
height which the candidate is added on the validator set.
|
height which the candidate is added on the validator set.
|
||||||
- The feePool of a new delegator bond will be 0 for the height at which the bond
|
- The feePool of a new delegator bond will be 0 for the height at which the bond
|
||||||
was added. This is achieved by setting `Delegation.FeeWithdrawalHeight` to
|
was added. This is achieved by setting `DelegatorBond.FeeWithdrawalHeight` to
|
||||||
the height which the bond was added.
|
the height which the bond was added.
|
||||||
|
|
|
@ -34,7 +34,7 @@ The staking module persists the following to the store:
|
||||||
- `GlobalState`, describing the global pools
|
- `GlobalState`, describing the global pools
|
||||||
- a `Candidate` for each candidate validator, indexed by public key
|
- a `Candidate` for each candidate validator, indexed by public key
|
||||||
- a `Candidate` for each candidate validator, indexed by shares in the global pool (ie. ordered)
|
- a `Candidate` for each candidate validator, indexed by shares in the global pool (ie. ordered)
|
||||||
- a `Delegation` for each delegation to a candidate by a delegator, indexed by delegator and candidate
|
- a `DelegatorBond` for each delegation to a candidate by a delegator, indexed by delegator and candidate
|
||||||
public keys
|
public keys
|
||||||
- a `Queue` of unbonding delegations (TODO)
|
- a `Queue` of unbonding delegations (TODO)
|
||||||
|
|
||||||
|
@ -146,15 +146,15 @@ When validators are kicked from the validator set they are removed from this
|
||||||
list.
|
list.
|
||||||
|
|
||||||
|
|
||||||
### Delegation
|
### DelegatorBond
|
||||||
|
|
||||||
Atom holders may delegate coins to validators, under this circumstance their
|
Atom holders may delegate coins to validators, under this circumstance their
|
||||||
funds are held in a `Delegation`. It is owned by one delegator, and is
|
funds are held in a `DelegatorBond`. It is owned by one delegator, and is
|
||||||
associated with the shares for one validator. The sender of the transaction is
|
associated with the shares for one validator. The sender of the transaction is
|
||||||
considered to be the owner of the bond,
|
considered to be the owner of the bond,
|
||||||
|
|
||||||
``` golang
|
``` golang
|
||||||
type Delegation struct {
|
type DelegatorBond struct {
|
||||||
Candidate crypto.PubKey
|
Candidate crypto.PubKey
|
||||||
Shares rational.Rat
|
Shares rational.Rat
|
||||||
AdjustmentFeePool coin.Coins
|
AdjustmentFeePool coin.Coins
|
||||||
|
@ -170,11 +170,11 @@ Description:
|
||||||
- AdjustmentRewardPool: Adjustment factor used to passively calculate each
|
- AdjustmentRewardPool: Adjustment factor used to passively calculate each
|
||||||
bonds entitled fees from `Candidate.ProposerRewardPool``
|
bonds entitled fees from `Candidate.ProposerRewardPool``
|
||||||
|
|
||||||
Each `Delegation` is individually indexed within the store by delegator
|
Each `DelegatorBond` is individually indexed within the store by delegator
|
||||||
address and candidate pubkey.
|
address and candidate pubkey.
|
||||||
|
|
||||||
- key: Delegator and Candidate-Pubkey
|
- key: Delegator and Candidate-Pubkey
|
||||||
- value: Delegation
|
- value: DelegatorBond
|
||||||
|
|
||||||
|
|
||||||
### Unbonding Queue
|
### Unbonding Queue
|
||||||
|
@ -308,7 +308,7 @@ All bonding, whether self-bonding or delegation, is done via
|
||||||
Delegator bonds are created using the TxDelegate transaction. Within this
|
Delegator bonds are created using the TxDelegate transaction. Within this
|
||||||
transaction the validator candidate queried with an amount of coins, whereby
|
transaction the validator candidate queried with an amount of coins, whereby
|
||||||
given the current exchange rate of candidate's delegator-shares-to-atoms the
|
given the current exchange rate of candidate's delegator-shares-to-atoms the
|
||||||
candidate will return shares which are assigned in `Delegation.Shares`.
|
candidate will return shares which are assigned in `DelegatorBond.Shares`.
|
||||||
|
|
||||||
``` golang
|
``` golang
|
||||||
type TxDelegate struct {
|
type TxDelegate struct {
|
||||||
|
@ -616,7 +616,7 @@ synced past the height of the oldest `powerChange`. This trim procedure will
|
||||||
occur on an epoch basis.
|
occur on an epoch basis.
|
||||||
|
|
||||||
```golang
|
```golang
|
||||||
type powerChange struct
|
type powerChange struct {
|
||||||
height int64 // block height at change
|
height int64 // block height at change
|
||||||
power rational.Rat // total power at change
|
power rational.Rat // total power at change
|
||||||
prevpower rational.Rat // total power at previous height-1
|
prevpower rational.Rat // total power at previous height-1
|
||||||
|
@ -694,5 +694,5 @@ rate, all commission on fees must be simultaneously withdrawn.
|
||||||
`candidate.Adjustment` must be set to the value of `canidate.Count` for the
|
`candidate.Adjustment` must be set to the value of `canidate.Count` for the
|
||||||
height which the candidate is added on the validator set.
|
height which the candidate is added on the validator set.
|
||||||
- The feePool of a new delegator bond will be 0 for the height at which the bond
|
- The feePool of a new delegator bond will be 0 for the height at which the bond
|
||||||
was added. This is achieved by setting `Delegation.FeeWithdrawalHeight` to
|
was added. This is achieved by setting `DelegatorBond.FeeWithdrawalHeight` to
|
||||||
the height which the bond was added.
|
the height which the bond was added.
|
||||||
|
|
|
@ -203,7 +203,7 @@ unbond(tx TxUnbond):
|
||||||
return
|
return
|
||||||
|
|
||||||
removeShares(candidate Candidate, shares rational.Rat):
|
removeShares(candidate Candidate, shares rational.Rat):
|
||||||
globalPoolSharesToRemove = DelegatorShareExRate(candidate) * shares
|
globalPoolSharesToRemove = delegatorShareExRate(candidate) * shares
|
||||||
|
|
||||||
if candidate.Status == Bonded
|
if candidate.Status == Bonded
|
||||||
gs.BondedShares -= globalPoolSharesToRemove
|
gs.BondedShares -= globalPoolSharesToRemove
|
||||||
|
@ -218,7 +218,7 @@ removeShares(candidate Candidate, shares rational.Rat):
|
||||||
candidate.IssuedDelegatorShares -= shares
|
candidate.IssuedDelegatorShares -= shares
|
||||||
return returnedCoins
|
return returnedCoins
|
||||||
|
|
||||||
DelegatorShareExRate(candidate Candidate):
|
delegatorShareExRate(candidate Candidate):
|
||||||
if candidate.IssuedDelegatorShares.IsZero() then return rational.One
|
if candidate.IssuedDelegatorShares.IsZero() then return rational.One
|
||||||
return candidate.GlobalStakeShares / candidate.IssuedDelegatorShares
|
return candidate.GlobalStakeShares / candidate.IssuedDelegatorShares
|
||||||
|
|
||||||
|
|
|
@ -71,7 +71,7 @@ UpdateValidatorSet():
|
||||||
|
|
||||||
updateVotingPower(candidates Candidates):
|
updateVotingPower(candidates Candidates):
|
||||||
foreach candidate in candidates do
|
foreach candidate in candidates do
|
||||||
candidate.VotingPower = (candidate.IssuedDelegatorShares - candidate.RedelegatingShares) * DelegatorShareExRate(candidate)
|
candidate.VotingPower = (candidate.IssuedDelegatorShares - candidate.RedelegatingShares) * delegatorShareExRate(candidate)
|
||||||
|
|
||||||
candidates.Sort()
|
candidates.Sort()
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue