Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Shelley.Rewards

Synopsis

newtype StakeShare = StakeShare {
- unStakeShare ∷ Rational
}
data PoolRewardInfo = PoolRewardInfo {
- poolRelativeStake ∷ !StakeShare
- poolPot ∷ !Coin
- poolPs ∷ !PoolParams
- poolBlocks ∷ !Natural
- poolLeaderReward ∷ !LeaderOnlyReward
}
mkApparentPerformance ∷ UnitInterval → Rational → Natural → Natural → Rational
data RewardType
- = MemberReward
- | LeaderReward
data Reward = Reward {
- rewardType ∷ !RewardType
- rewardPool ∷ !(KeyHash 'StakePool)
- rewardAmount ∷ !Coin
}
data LeaderOnlyReward = LeaderOnlyReward {
- lRewardPool ∷ !(KeyHash 'StakePool)
- lRewardAmount ∷ !Coin
}
leaderRewardToGeneral ∷ LeaderOnlyReward → Reward
leaderRew ∷ Coin → PoolParams → StakeShare → StakeShare → Coin
memberRew ∷ Coin → PoolParams → StakeShare → StakeShare → Coin
aggregateRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → Map (Credential 'Staking) Coin
filterRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → (Map (Credential 'Staking) (Set Reward), Map (Credential 'Staking) (Set Reward))
sumRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → Coin
aggregateCompactRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → Map (Credential 'Staking) (CompactForm Coin)
sumCompactRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → CompactForm Coin
rewardOnePoolMember ∷ ProtVer → Coin → Set (Credential 'Staking) → PoolRewardInfo → Credential 'Staking → Coin → Maybe Coin
mkPoolRewardInfo ∷ EraPParams era ⇒ PParams era → Coin → BlocksMade → Natural → Stake → VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Map (KeyHash 'StakePool) Coin → Coin → Coin → PoolParams → Either StakeShare PoolRewardInfo

Documentation

newtype StakeShare Source #

StakeShare type

Constructors

StakeShare
Fields unStakeShare ∷ Rational

Instances

Instances details

Generic StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Associated Types type Rep StakeShare ∷ Type → Type Source # Methods from ∷ StakeShare → Rep StakeShare x Source # to ∷ Rep StakeShare x → StakeShare Source #
Show StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods showsPrec ∷ Int → StakeShare → ShowS Source # show ∷ StakeShare → String Source # showList ∷ [StakeShare] → ShowS Source #
NFData StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods rnf ∷ StakeShare → () Source #
Eq StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods (==) ∷ StakeShare → StakeShare → Bool Source # (/=) ∷ StakeShare → StakeShare → Bool Source #
Ord StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods compare ∷ StakeShare → StakeShare → Ordering Source # (<) ∷ StakeShare → StakeShare → Bool Source # (<=) ∷ StakeShare → StakeShare → Bool Source # (>) ∷ StakeShare → StakeShare → Bool Source # (>=) ∷ StakeShare → StakeShare → Bool Source # max ∷ StakeShare → StakeShare → StakeShare Source # min ∷ StakeShare → StakeShare → StakeShare Source #
NoThunks StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods noThunks ∷ Context → StakeShare → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → StakeShare → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy StakeShare → String Source #
type Rep StakeShare Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards type Rep StakeShare = D1 ('MetaData "StakeShare" "Cardano.Ledger.Shelley.Rewards" "cardano-ledger-shelley-1.16.0.0-inplace" 'True) (C1 ('MetaCons "StakeShare" 'PrefixI 'True) (S1 ('MetaSel ('Just "unStakeShare") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)))

data PoolRewardInfo Source #

Stake Pool specific information needed to compute the rewards for its members.

Constructors

PoolRewardInfo
Fields poolRelativeStake ∷ !StakeShare The stake pool's stake divided by the total stake poolPot ∷ !Coin The maximum rewards available for the entire pool poolPs ∷ !PoolParams The stake pool parameters poolBlocks ∷ !Natural The number of blocks the stake pool produced poolLeaderReward ∷ !LeaderOnlyReward The leader reward

Instances

Instances details

Generic PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Associated Types type Rep PoolRewardInfo ∷ Type → Type Source # Methods from ∷ PoolRewardInfo → Rep PoolRewardInfo x Source # to ∷ Rep PoolRewardInfo x → PoolRewardInfo Source #
Show PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods showsPrec ∷ Int → PoolRewardInfo → ShowS Source # show ∷ PoolRewardInfo → String Source # showList ∷ [PoolRewardInfo] → ShowS Source #
DecCBOR PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods decCBOR ∷ Decoder s PoolRewardInfo Source # dropCBOR ∷ Proxy PoolRewardInfo → Decoder s () Source # label ∷ Proxy PoolRewardInfo → Text Source #
EncCBOR PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods encCBOR ∷ PoolRewardInfo → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy PoolRewardInfo → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [PoolRewardInfo] → Size Source #
NFData PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods rnf ∷ PoolRewardInfo → () Source #
Eq PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods (==) ∷ PoolRewardInfo → PoolRewardInfo → Bool Source # (/=) ∷ PoolRewardInfo → PoolRewardInfo → Bool Source #
Ord PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods compare ∷ PoolRewardInfo → PoolRewardInfo → Ordering Source # (<) ∷ PoolRewardInfo → PoolRewardInfo → Bool Source # (<=) ∷ PoolRewardInfo → PoolRewardInfo → Bool Source # (>) ∷ PoolRewardInfo → PoolRewardInfo → Bool Source # (>=) ∷ PoolRewardInfo → PoolRewardInfo → Bool Source # max ∷ PoolRewardInfo → PoolRewardInfo → PoolRewardInfo Source # min ∷ PoolRewardInfo → PoolRewardInfo → PoolRewardInfo Source #
NoThunks PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods noThunks ∷ Context → PoolRewardInfo → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PoolRewardInfo → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy PoolRewardInfo → String Source #
type Rep PoolRewardInfo Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards type Rep PoolRewardInfo = D1 ('MetaData "PoolRewardInfo" "Cardano.Ledger.Shelley.Rewards" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "PoolRewardInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "poolRelativeStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeShare) :: S1 ('MetaSel ('Just "poolPot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)) :: (S1 ('MetaSel ('Just "poolPs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PoolParams) :: (S1 ('MetaSel ('Just "poolBlocks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "poolLeaderReward") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeaderOnlyReward)))))

mkApparentPerformance ∷ UnitInterval → Rational → Natural → Natural → Rational Source #

Calculate pool reward

data RewardType Source #

The staking rewards in Cardano are all either:

member rewards - rewards given to a registered stake credential which has delegated to a stake pool, or
leader rewards - rewards given to a registered stake pool (in particular, given to the stake credential in the stake pool registration certificate).

See Figure 47, "Functions used in the Reward Splitting", of the formal specification for more details.

Constructors

MemberReward
LeaderReward

Instances

Instances details

ToJSON RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods toJSON ∷ RewardType → Value Source # toEncoding ∷ RewardType → Encoding Source # toJSONList ∷ [RewardType] → Value Source # toEncodingList ∷ [RewardType] → Encoding Source # omitField ∷ RewardType → Bool Source #
Bounded RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods minBound ∷ RewardType Source # maxBound ∷ RewardType Source #
Enum RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods succ ∷ RewardType → RewardType Source # pred ∷ RewardType → RewardType Source # toEnum ∷ Int → RewardType Source # fromEnum ∷ RewardType → Int Source # enumFrom ∷ RewardType → [RewardType] Source # enumFromThen ∷ RewardType → RewardType → [RewardType] Source # enumFromTo ∷ RewardType → RewardType → [RewardType] Source # enumFromThenTo ∷ RewardType → RewardType → RewardType → [RewardType] Source #
Generic RewardType
Instance details Defined in Cardano.Ledger.Rewards Associated Types type Rep RewardType ∷ Type → Type Source # Methods from ∷ RewardType → Rep RewardType x Source # to ∷ Rep RewardType x → RewardType Source #
Show RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods showsPrec ∷ Int → RewardType → ShowS Source # show ∷ RewardType → String Source # showList ∷ [RewardType] → ShowS Source #
DecCBOR RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods decCBOR ∷ Decoder s RewardType Source # dropCBOR ∷ Proxy RewardType → Decoder s () Source # label ∷ Proxy RewardType → Text Source #
EncCBOR RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods encCBOR ∷ RewardType → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy RewardType → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [RewardType] → Size Source #
NFData RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods rnf ∷ RewardType → () Source #
Eq RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods (==) ∷ RewardType → RewardType → Bool Source # (/=) ∷ RewardType → RewardType → Bool Source #
Ord RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods compare ∷ RewardType → RewardType → Ordering Source # (<) ∷ RewardType → RewardType → Bool Source # (<=) ∷ RewardType → RewardType → Bool Source # (>) ∷ RewardType → RewardType → Bool Source # (>=) ∷ RewardType → RewardType → Bool Source # max ∷ RewardType → RewardType → RewardType Source # min ∷ RewardType → RewardType → RewardType Source #
NoThunks RewardType
Instance details Defined in Cardano.Ledger.Rewards Methods noThunks ∷ Context → RewardType → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → RewardType → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy RewardType → String Source #
type Rep RewardType
Instance details Defined in Cardano.Ledger.Rewards type Rep RewardType = D1 ('MetaData "RewardType" "Cardano.Ledger.Rewards" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "MemberReward" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "LeaderReward" 'PrefixI 'False) (U1 ∷ Type → Type))

data Reward Source #

The Reward type captures:

if the reward is a member or leader reward
the stake pool ID associated with the reward
the number of Lovelace in the reward

Constructors

Reward
Fields rewardType ∷ !RewardType rewardPool ∷ !(KeyHash 'StakePool) rewardAmount ∷ !Coin

Instances

Instances details

ToJSON Reward
Instance details Defined in Cardano.Ledger.Rewards Methods toJSON ∷ Reward → Value Source # toEncoding ∷ Reward → Encoding Source # toJSONList ∷ [Reward] → Value Source # toEncodingList ∷ [Reward] → Encoding Source # omitField ∷ Reward → Bool Source #
Generic Reward
Instance details Defined in Cardano.Ledger.Rewards Associated Types type Rep Reward ∷ Type → Type Source # Methods from ∷ Reward → Rep Reward x Source # to ∷ Rep Reward x → Reward Source #
Show Reward
Instance details Defined in Cardano.Ledger.Rewards Methods showsPrec ∷ Int → Reward → ShowS Source # show ∷ Reward → String Source # showList ∷ [Reward] → ShowS Source #
DecCBOR Reward
Instance details Defined in Cardano.Ledger.Rewards Methods decCBOR ∷ Decoder s Reward Source # dropCBOR ∷ Proxy Reward → Decoder s () Source # label ∷ Proxy Reward → Text Source #
EncCBOR Reward
Instance details Defined in Cardano.Ledger.Rewards Methods encCBOR ∷ Reward → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Reward → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Reward] → Size Source #
NFData Reward
Instance details Defined in Cardano.Ledger.Rewards Methods rnf ∷ Reward → () Source #
Eq Reward
Instance details Defined in Cardano.Ledger.Rewards Methods (==) ∷ Reward → Reward → Bool Source # (/=) ∷ Reward → Reward → Bool Source #
Ord Reward	Note that this Ord instance is chosen to align precisely with the Allegra reward aggregation, as given by the function `aggregateRewards` so that `findMax` returns the expected value.
Instance details Defined in Cardano.Ledger.Rewards Methods compare ∷ Reward → Reward → Ordering Source # (<) ∷ Reward → Reward → Bool Source # (<=) ∷ Reward → Reward → Bool Source # (>) ∷ Reward → Reward → Bool Source # (>=) ∷ Reward → Reward → Bool Source # max ∷ Reward → Reward → Reward Source # min ∷ Reward → Reward → Reward Source #
NoThunks Reward
Instance details Defined in Cardano.Ledger.Rewards Methods noThunks ∷ Context → Reward → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Reward → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy Reward → String Source #
type Rep Reward
Instance details Defined in Cardano.Ledger.Rewards type Rep Reward = D1 ('MetaData "Reward" "Cardano.Ledger.Rewards" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "Reward" 'PrefixI 'True) (S1 ('MetaSel ('Just "rewardType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RewardType) :: (S1 ('MetaSel ('Just "rewardPool") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool)) :: S1 ('MetaSel ('Just "rewardAmount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin))))

data LeaderOnlyReward Source #

Constructors

LeaderOnlyReward
Fields lRewardPool ∷ !(KeyHash 'StakePool) lRewardAmount ∷ !Coin

Instances

Instances details

Generic LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Associated Types type Rep LeaderOnlyReward ∷ Type → Type Source # Methods from ∷ LeaderOnlyReward → Rep LeaderOnlyReward x Source # to ∷ Rep LeaderOnlyReward x → LeaderOnlyReward Source #
Show LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods showsPrec ∷ Int → LeaderOnlyReward → ShowS Source # show ∷ LeaderOnlyReward → String Source # showList ∷ [LeaderOnlyReward] → ShowS Source #
DecCBOR LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods decCBOR ∷ Decoder s LeaderOnlyReward Source # dropCBOR ∷ Proxy LeaderOnlyReward → Decoder s () Source # label ∷ Proxy LeaderOnlyReward → Text Source #
EncCBOR LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods encCBOR ∷ LeaderOnlyReward → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy LeaderOnlyReward → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [LeaderOnlyReward] → Size Source #
NFData LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods rnf ∷ LeaderOnlyReward → () Source #
Eq LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods (==) ∷ LeaderOnlyReward → LeaderOnlyReward → Bool Source # (/=) ∷ LeaderOnlyReward → LeaderOnlyReward → Bool Source #
Ord LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods compare ∷ LeaderOnlyReward → LeaderOnlyReward → Ordering Source # (<) ∷ LeaderOnlyReward → LeaderOnlyReward → Bool Source # (<=) ∷ LeaderOnlyReward → LeaderOnlyReward → Bool Source # (>) ∷ LeaderOnlyReward → LeaderOnlyReward → Bool Source # (>=) ∷ LeaderOnlyReward → LeaderOnlyReward → Bool Source # max ∷ LeaderOnlyReward → LeaderOnlyReward → LeaderOnlyReward Source # min ∷ LeaderOnlyReward → LeaderOnlyReward → LeaderOnlyReward Source #
NoThunks LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards Methods noThunks ∷ Context → LeaderOnlyReward → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → LeaderOnlyReward → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy LeaderOnlyReward → String Source #
type Rep LeaderOnlyReward Source #
Instance details Defined in Cardano.Ledger.Shelley.Rewards type Rep LeaderOnlyReward = D1 ('MetaData "LeaderOnlyReward" "Cardano.Ledger.Shelley.Rewards" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "LeaderOnlyReward" 'PrefixI 'True) (S1 ('MetaSel ('Just "lRewardPool") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool)) :*: S1 ('MetaSel ('Just "lRewardAmount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))

leaderRewardToGeneral ∷ LeaderOnlyReward → Reward Source #

leaderRew ∷ Coin → PoolParams → StakeShare → StakeShare → Coin Source #

Calculate pool leader reward

memberRew ∷ Coin → PoolParams → StakeShare → StakeShare → Coin Source #

Calculate pool member reward

aggregateRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → Map (Credential 'Staking) Coin Source #

for each (Set (Reward c)) entry in the map, sum up the coin. In the ShelleyEra some of the coins are ignored (because of backward compatibility) see filterRewards Note that domain of the returned map is a subset of the input map rewards

filterRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → (Map (Credential 'Staking) (Set Reward), Map (Credential 'Staking) (Set Reward)) Source #

Filter the reward payments to those that will actually be delivered. This function exists since in Shelley, a stake credential earning rewards from multiple sources would only receive one reward. So some of the coins are ignored, because of this backward compatibility issue in early protocolVersions. Note that both of the domains of the returned maps are a subset of the the domain of the input map rewards

sumRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → Coin Source #

aggregateCompactRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → Map (Credential 'Staking) (CompactForm Coin) Source #

for each (Set (Reward c)) entry in the map, sum up the coin. In the ShelleyEra some of the coins are ignored (because of backward compatibility) see filterRewards Note that the domain of the output map is a subset of the domain of the input rewards.

sumCompactRewards ∷ ProtVer → Map (Credential 'Staking) (Set Reward) → CompactForm Coin Source #

rewardOnePoolMember Source #

Arguments

∷ ProtVer	The protocol version
→ Coin	The total amount of stake in the system
→ Set (Credential 'Staking)	The set of registered stake credentials
→ PoolRewardInfo	Stake pool specific intermediate values needed to compute member rewards.
→ Credential 'Staking	The stake credential whose reward is being calculated.
→ Coin	The stake controlled by the stake credential in the previous parameter above.
→ Maybe Coin	The reward for the given stake credential. This could be Nothing if the credential is no longer registered, if it is an owner, or if the reward is zero.

The stake pool member reward calculation

mkPoolRewardInfo ∷ EraPParams era ⇒ PParams era → Coin → BlocksMade → Natural → Stake → VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Map (KeyHash 'StakePool) Coin → Coin → Coin → PoolParams → Either StakeShare PoolRewardInfo Source #

Calculate single stake pool specific values for the reward computation.

Note that if a stake pool has made no blocks in the given epoch, it will get no rewards, and so we do not need to return PoolRewardInfo. We do, however, need to return the relative stake of the pool in order to compute data for the stake pool ranking. Eventually we will remove the ranking information out of the ledger code and into a separate service, and at that point we can simplify this function to not care about ranking.