Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Rewards

Synopsis

data RewardType
- = MemberReward
- | LeaderReward
data Reward = Reward {
- rewardType ∷ !RewardType
- rewardPool ∷ !(KeyHash 'StakePool)
- rewardAmount ∷ !Coin
}

Documentation

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 Source #
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 Source #
Instance details Defined in Cardano.Ledger.Rewards Methods minBound ∷ RewardType Source # maxBound ∷ RewardType Source #
Enum RewardType Source #
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 Source #
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 Source #
Instance details Defined in Cardano.Ledger.Rewards Methods showsPrec ∷ Int → RewardType → ShowS Source # show ∷ RewardType → String Source # showList ∷ [RewardType] → ShowS Source #
DecCBOR RewardType Source #
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 Source #
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 Source #
Instance details Defined in Cardano.Ledger.Rewards Methods rnf ∷ RewardType → () Source #
Eq RewardType Source #
Instance details Defined in Cardano.Ledger.Rewards Methods (==) ∷ RewardType → RewardType → Bool Source # (/=) ∷ RewardType → RewardType → Bool Source #
Ord RewardType Source #
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 Source #
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 Source #
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 Source #
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 Source #
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 Source #
Instance details Defined in Cardano.Ledger.Rewards Methods showsPrec ∷ Int → Reward → ShowS Source # show ∷ Reward → String Source # showList ∷ [Reward] → ShowS Source #
DecCBOR Reward Source #
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 Source #
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 Source #
Instance details Defined in Cardano.Ledger.Rewards Methods rnf ∷ Reward → () Source #
Eq Reward Source #
Instance details Defined in Cardano.Ledger.Rewards Methods (==) ∷ Reward → Reward → Bool Source # (/=) ∷ Reward → Reward → Bool Source #
Ord Reward Source #	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 Source #
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 Source #
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))))