Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.RewardProvenance

Contents

Orphan instances

Synopsis

data RewardProvenance crypto = RewardProvenance {
- spe :: ! Word64
- blocks :: !( BlocksMade crypto)
- 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 crypto) ( RewardProvenancePool crypto))
- desirabilities :: !( Map ( KeyHash ' StakePool crypto) Desirability )
}
data RewardProvenancePool crypto = RewardProvenancePool {
- poolBlocksP :: ! Natural
- sigmaP :: ! Rational
- sigmaAP :: ! Rational
- ownerStakeP :: ! Coin
- poolParamsP :: !( PoolParams crypto)
- pledgeRatioP :: ! Rational
- maxPP :: ! Coin
- appPerfP :: ! Rational
- poolRP :: ! Coin
- lRewardP :: ! Coin
}
data Desirability = Desirability {
- desirabilityScore :: ! Double
- hitRateEstimate :: ! Double
}

Documentation

data RewardProvenance crypto 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 Design Specification .

Constructors

RewardProvenance

Fields

spe :: ! Word64

The number of slots per epoch.
blocks :: !( BlocksMade crypto)

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 crypto) ( RewardProvenancePool crypto))

Individual stake pool provenance.
desirabilities :: !( Map ( KeyHash ' StakePool crypto) Desirability )

A map from pool ID to the desirability score. See the stake pool ranking document .

Instances

Instances details

Eq ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods (==) :: RewardProvenance crypto -> RewardProvenance crypto -> Bool Source # (/=) :: RewardProvenance crypto -> RewardProvenance crypto -> Bool Source #
Show ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods showsPrec :: Int -> RewardProvenance crypto -> ShowS Source # show :: RewardProvenance crypto -> String Source # showList :: [ RewardProvenance crypto] -> ShowS Source #
Generic ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Associated Types type Rep ( RewardProvenance crypto) :: Type -> Type Source # Methods from :: RewardProvenance crypto -> Rep ( RewardProvenance crypto) x Source # to :: Rep ( RewardProvenance crypto) x -> RewardProvenance crypto Source #
NFData ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods rnf :: RewardProvenance crypto -> () Source #
Crypto crypto => ToJSON ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods toJSON :: RewardProvenance crypto -> Value Source # toEncoding :: RewardProvenance crypto -> Encoding Source # toJSONList :: [ RewardProvenance crypto] -> Value Source # toEncodingList :: [ RewardProvenance crypto] -> Encoding Source #
Crypto crypto => FromJSON ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods parseJSON :: Value -> Parser ( RewardProvenance crypto) Source # parseJSONList :: Value -> Parser [ RewardProvenance crypto] Source #
Crypto crypto => ToCBOR ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods toCBOR :: RewardProvenance crypto -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( RewardProvenance crypto) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ RewardProvenance crypto] -> Size Source #
Crypto crypto => FromCBOR ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods fromCBOR :: Decoder s ( RewardProvenance crypto) Source # label :: Proxy ( RewardProvenance crypto) -> Text Source #
Default ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods def :: RewardProvenance crypto Source #
NoThunks ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods noThunks :: Context -> RewardProvenance crypto -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> RewardProvenance crypto -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( RewardProvenance crypto) -> String Source #
type Rep ( RewardProvenance crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance type Rep ( RewardProvenance crypto) = D1 (' MetaData "RewardProvenance" "Cardano.Ledger.Shelley.RewardProvenance" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' False ) ( C1 (' MetaCons "RewardProvenance" ' PrefixI ' True ) (((( S1 (' MetaSel (' Just "spe") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word64 ) :: S1 (' MetaSel (' Just "blocks") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( BlocksMade crypto))) :: ( S1 (' MetaSel (' Just "maxLL") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "deltaR1") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ))) :: (( S1 (' MetaSel (' Just "deltaR2") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "r") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin )) :: ( S1 (' MetaSel (' Just "totalStake") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "blocksCount") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Integer )))) :: ((( S1 (' MetaSel (' Just "d") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Rational ) :: S1 (' MetaSel (' Just "expBlocks") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Integer )) :: ( S1 (' MetaSel (' Just "eta") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Rational ) :: S1 (' MetaSel (' Just "rPot") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ))) :: (( S1 (' MetaSel (' Just "deltaT1") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "activeStake") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin )) :: ( S1 (' MetaSel (' Just "pools") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( KeyHash ' StakePool crypto) ( RewardProvenancePool crypto))) :*: S1 (' MetaSel (' Just "desirabilities") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( KeyHash ' StakePool crypto) Desirability )))))))

data RewardProvenancePool crypto 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.
poolParamsP :: !( PoolParams crypto)

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 Design Specification .
poolRP :: ! Coin

The total Lovelace earned by the stake pool.
lRewardP :: ! Coin

The total Lovelace earned by the stake pool leader.

Instances

Instances details

Eq ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods (==) :: RewardProvenancePool crypto -> RewardProvenancePool crypto -> Bool Source # (/=) :: RewardProvenancePool crypto -> RewardProvenancePool crypto -> Bool Source #
Show ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods showsPrec :: Int -> RewardProvenancePool crypto -> ShowS Source # show :: RewardProvenancePool crypto -> String Source # showList :: [ RewardProvenancePool crypto] -> ShowS Source #
Generic ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Associated Types type Rep ( RewardProvenancePool crypto) :: Type -> Type Source # Methods from :: RewardProvenancePool crypto -> Rep ( RewardProvenancePool crypto) x Source # to :: Rep ( RewardProvenancePool crypto) x -> RewardProvenancePool crypto Source #
NFData ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods rnf :: RewardProvenancePool crypto -> () Source #
Crypto crypto => ToJSON ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods toJSON :: RewardProvenancePool crypto -> Value Source # toEncoding :: RewardProvenancePool crypto -> Encoding Source # toJSONList :: [ RewardProvenancePool crypto] -> Value Source # toEncodingList :: [ RewardProvenancePool crypto] -> Encoding Source #
Crypto crypto => FromJSON ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods parseJSON :: Value -> Parser ( RewardProvenancePool crypto) Source # parseJSONList :: Value -> Parser [ RewardProvenancePool crypto] Source #
Crypto crypto => ToCBOR ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods toCBOR :: RewardProvenancePool crypto -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( RewardProvenancePool crypto) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ RewardProvenancePool crypto] -> Size Source #
Crypto crypto => FromCBOR ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods fromCBOR :: Decoder s ( RewardProvenancePool crypto) Source # label :: Proxy ( RewardProvenancePool crypto) -> Text Source #
Crypto crypto => Default ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods def :: RewardProvenancePool crypto Source #
NoThunks ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods noThunks :: Context -> RewardProvenancePool crypto -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> RewardProvenancePool crypto -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( RewardProvenancePool crypto) -> String Source #
type Rep ( RewardProvenancePool crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance type Rep ( RewardProvenancePool crypto) = D1 (' MetaData "RewardProvenancePool" "Cardano.Ledger.Shelley.RewardProvenance" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' False ) ( C1 (' MetaCons "RewardProvenancePool" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "poolBlocksP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Natural ) :: S1 (' MetaSel (' Just "sigmaP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Rational )) :: ( S1 (' MetaSel (' Just "sigmaAP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Rational ) :: ( S1 (' MetaSel (' Just "ownerStakeP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :: S1 (' MetaSel (' Just "poolParamsP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( PoolParams crypto))))) :: (( S1 (' MetaSel (' Just "pledgeRatioP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Rational ) :: S1 (' MetaSel (' Just "maxPP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin )) :: ( S1 (' MetaSel (' Just "appPerfP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Rational ) :: ( S1 (' MetaSel (' Just "poolRP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ) :*: S1 (' MetaSel (' Just "lRewardP") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin ))))))

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

Desirability
Fields desirabilityScore :: ! Double hitRateEstimate :: ! Double

Instances

Instances details

Eq Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods (==) :: Desirability -> Desirability -> Bool Source # (/=) :: Desirability -> Desirability -> Bool Source #
Show Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods showsPrec :: Int -> Desirability -> ShowS Source # show :: Desirability -> String Source # showList :: [ Desirability ] -> ShowS Source #
Generic Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Associated Types type Rep Desirability :: Type -> Type Source # Methods from :: Desirability -> Rep Desirability x Source # to :: Rep Desirability x -> Desirability Source #
NFData Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods rnf :: Desirability -> () Source #
ToJSON Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods toJSON :: Desirability -> Value Source # toEncoding :: Desirability -> Encoding Source # toJSONList :: [ Desirability ] -> Value Source # toEncodingList :: [ Desirability ] -> Encoding Source #
FromJSON Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods parseJSON :: Value -> Parser Desirability Source # parseJSONList :: Value -> Parser [ Desirability ] Source #
ToCBOR Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods toCBOR :: Desirability -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Desirability -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Desirability ] -> Size Source #
FromCBOR Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods fromCBOR :: Decoder s Desirability Source # label :: Proxy Desirability -> Text Source #
NoThunks Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance Methods noThunks :: Context -> Desirability -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Desirability -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Desirability -> String Source #
type Rep Desirability Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardProvenance type Rep Desirability = D1 (' MetaData "Desirability" "Cardano.Ledger.Shelley.RewardProvenance" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' False ) ( C1 (' MetaCons "Desirability" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "desirabilityScore") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Double ) :*: S1 (' MetaSel (' Just "hitRateEstimate") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Double )))

Orphan instances

Crypto crypto => Default ( RewardAcnt crypto) Source #
Instance details Methods def :: RewardAcnt crypto Source #
Crypto crypto => Default ( PoolParams crypto) Source #
Instance details Methods def :: PoolParams crypto Source #
Crypto e => Default ( Credential r e) Source #
Instance details Methods def :: Credential r e Source #
Crypto c => Default ( SafeHash c i) Source #
Instance details Methods def :: SafeHash c i Source #