Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.RewardProvenance

Synopsis

data RewardProvenance = RewardProvenance {
- spe ∷ !Word64
- blocks ∷ !BlocksMade
- maxLL ∷ !Coin
- deltaR1 ∷ !Coin
- deltaR2 ∷ !Coin
- r ∷ !Coin
- totalStake ∷ !Coin
- blocksCount ∷ !Integer
- d ∷ !Rational
- expBlocks ∷ !Integer
- eta ∷ !Rational
- rPot ∷ !Coin
- deltaT1 ∷ !Coin
- activeStake ∷ !Coin
- pools ∷ !(Map (KeyHash 'StakePool) RewardProvenancePool)
- desirabilities ∷ !(Map (KeyHash 'StakePool) Desirability)
}
data RewardProvenancePool = RewardProvenancePool {
- poolBlocksP ∷ !Natural
- sigmaP ∷ !Rational
- sigmaAP ∷ !Rational
- ownerStakeP ∷ !Coin
- stakePoolParamsP ∷ !StakePoolParams
- pledgeRatioP ∷ !Rational
- maxPP ∷ !Coin
- appPerfP ∷ !Rational
- poolRP ∷ !Coin
- lRewardP ∷ !Coin
}
data Desirability = Desirability {
- desirabilityScore ∷ !Double
- hitRateEstimate ∷ !Double
}

Documentation

data RewardProvenance Source #

RewardProvenenace captures some of the intermediate calculations when computing the staking reward distribution. Most of these fields are simple scalar values, computed from the current State, and are fixed before we start to compute the distribution. Two of them are aggregates computed when we compute the distribution (pools and desirabilities).

For more background, see "Figure 48: The Reward Calculation" and "Figure 51: Reward Update Creation" of the the formal specification. The variable names here align with those in the specification. See also Section 5 of the https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-delegation.pdf

Constructors

RewardProvenance

Fields

spe ∷ !Word64
The number of slots per epoch.
blocks ∷ !BlocksMade
A map from pool ID (the key hash of the stake pool operator's verification key) to the number of blocks made in the given epoch.
maxLL ∷ !Coin
The maximum Lovelace supply. On mainnet, this value is equal to 45 * 10^15 (45 billion ADA).
deltaR1 ∷ !Coin
The maximum amount of Lovelace which can be removed from the reserves to be given out as rewards for the given epoch.
deltaR2 ∷ !Coin
The difference between the total Lovelace that could have been distributed as rewards this epoch (which is r) and what was actually distributed.
r ∷ !Coin
The total Lovelace available for rewards for the given epoch, equal to rPot less deltaT1.
totalStake ∷ !Coin
The maximum Lovelace supply (maxLL) less the current value of the reserves.
blocksCount ∷ !Integer
The total number of blocks produced during the given epoch.
d ∷ !Rational
The decentralization parameter.
expBlocks ∷ !Integer
The number of blocks expected to be produced during the given epoch.
eta ∷ !Rational
The ratio of the number of blocks actually made versus the number of blocks that were expected.
rPot ∷ !Coin
The reward pot for the given epoch, equal to deltaR1 plus the fee pot.
deltaT1 ∷ !Coin
The amount of Lovelace taken from the treasury for the given epoch.
activeStake ∷ !Coin
The amount of Lovelace that is delegated during the given epoch.
pools ∷ !(Map (KeyHash 'StakePool) RewardProvenancePool)
Individual stake pool provenance.
desirabilities ∷ !(Map (KeyHash 'StakePool) Desirability)
A map from pool ID to the desirability score. See the stake pool ranking document.

Instances

Instances details

FromJSON RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

parseJSON ∷ Value → Parser RewardProvenance Source #

parseJSONList ∷ Value → Parser [RewardProvenance] Source #

omittedField ∷ Maybe RewardProvenance Source #

ToJSON RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

toJSON ∷ RewardProvenance → Value Source #

toEncoding ∷ RewardProvenance → Encoding Source #

toJSONList ∷ [RewardProvenance] → Value Source #

toEncodingList ∷ [RewardProvenance] → Encoding Source #

omitField ∷ RewardProvenance → Bool Source #

DecCBOR RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

decCBOR ∷ Decoder s RewardProvenance Source #

dropCBOR ∷ Proxy RewardProvenance → Decoder s () Source #

label ∷ Proxy RewardProvenance → Text Source #

EncCBOR RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

encCBOR ∷ RewardProvenance → Encoding Source #

Default RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

def ∷ RewardProvenance Source #

NFData RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

rnf ∷ RewardProvenance → () #

Generic RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Associated Types

type Rep RewardProvenance

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

from ∷ RewardProvenance → Rep RewardProvenance x #

to ∷ Rep RewardProvenance x → RewardProvenance #

Show RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

showsPrec ∷ Int → RewardProvenance → ShowS #

show ∷ RewardProvenance → String #

showList ∷ [RewardProvenance] → ShowS #

Eq RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

(==) ∷ RewardProvenance → RewardProvenance → Bool #

(/=) ∷ RewardProvenance → RewardProvenance → Bool #

NoThunks RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

noThunks ∷ Context → RewardProvenance → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → RewardProvenance → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy RewardProvenance → String Source #

type Rep RewardProvenance Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

data RewardProvenancePool Source #

Provenance for an individual stake pool's reward calculation.

Constructors

RewardProvenancePool

Fields

poolBlocksP ∷ !Natural
The number of blocks the pool produced.
sigmaP ∷ !Rational
The stake pool's stake share (portion of the total stake).
sigmaAP ∷ !Rational
The stake pool's active stake share (portion of the active stake).
ownerStakeP ∷ !Coin
The number of Lovelace owned by the stake pool owners. If this value is not at least as large as the pledgeRatioP, the stake pool will not earn any rewards for the given epoch.
stakePoolParamsP ∷ !StakePoolParams
The stake pool's registered parameters.
pledgeRatioP ∷ !Rational
The stake pool's pledge.
maxPP ∷ !Coin
The maximum number of Lovelace this stake pool can earn.
appPerfP ∷ !Rational
The stake pool's apparent performance. See Section 5.5.2 of the https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-delegation.pdf
poolRP ∷ !Coin
The total Lovelace earned by the stake pool.
lRewardP ∷ !Coin
The total Lovelace earned by the stake pool leader.

Instances

Instances details

FromJSON RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

parseJSON ∷ Value → Parser RewardProvenancePool Source #

parseJSONList ∷ Value → Parser [RewardProvenancePool] Source #

omittedField ∷ Maybe RewardProvenancePool Source #

ToJSON RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

toJSON ∷ RewardProvenancePool → Value Source #

toEncoding ∷ RewardProvenancePool → Encoding Source #

toJSONList ∷ [RewardProvenancePool] → Value Source #

toEncodingList ∷ [RewardProvenancePool] → Encoding Source #

omitField ∷ RewardProvenancePool → Bool Source #

DecCBOR RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

decCBOR ∷ Decoder s RewardProvenancePool Source #

dropCBOR ∷ Proxy RewardProvenancePool → Decoder s () Source #

label ∷ Proxy RewardProvenancePool → Text Source #

EncCBOR RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

encCBOR ∷ RewardProvenancePool → Encoding Source #

Default RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

def ∷ RewardProvenancePool Source #

NFData RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

rnf ∷ RewardProvenancePool → () #

Generic RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Associated Types

type Rep RewardProvenancePool

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

from ∷ RewardProvenancePool → Rep RewardProvenancePool x #

to ∷ Rep RewardProvenancePool x → RewardProvenancePool #

Show RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

showsPrec ∷ Int → RewardProvenancePool → ShowS #

show ∷ RewardProvenancePool → String #

showList ∷ [RewardProvenancePool] → ShowS #

Eq RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

(==) ∷ RewardProvenancePool → RewardProvenancePool → Bool #

(/=) ∷ RewardProvenancePool → RewardProvenancePool → Bool #

NoThunks RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

Methods

noThunks ∷ Context → RewardProvenancePool → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → RewardProvenancePool → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy RewardProvenancePool → String Source #

type Rep RewardProvenancePool Source #

Instance details

Defined in Cardano.Ledger.Shelley.RewardProvenance

data Desirability Source #

The desirability score of a stake pool, as described in "Reward Sharing Schemes for Stake Pools". Additionally, the hit rate estimation described in the stake pool ranking document is included.

Constructors