Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.PoolDistr

Description

The stake distribution, aggregated by stake pool (as opposed to stake credential), plays a primary role in Cardano's proof of stake network. Together with the VRF checks, the stake distribution determines leader election. The leader election is the precisely the part of the ledger that is determined by Ouroboros (Praos and Genesis), our consensus mechanism. See Section 16, "Leader Value Calculation", of the formal specification.

Synopsis

data IndividualPoolStake = IndividualPoolStake {
- individualPoolStake ∷ !Rational
- individualTotalPoolStake ∷ !(CompactForm Coin)
- individualPoolStakeVrf ∷ !(VRFVerKeyHash 'StakePoolVRF)
}
data PoolDistr = PoolDistr {
- unPoolDistr ∷ !(Map (KeyHash 'StakePool) IndividualPoolStake)
- pdTotalActiveStake ∷ !(CompactForm Coin)
}
poolDistrDistrL ∷ Lens' PoolDistr (Map (KeyHash 'StakePool) IndividualPoolStake)
poolDistrTotalL ∷ Lens' PoolDistr (CompactForm Coin)
individualTotalPoolStakeL ∷ Lens' IndividualPoolStake (CompactForm Coin)

Documentation

data IndividualPoolStake Source #

The IndividualPoolStake contains all the stake controlled by a single stake pool (the combination of owners and delegates) for a given epoch, and also the hash of the stake pool's registered VRF key.

When a stake pool produces a block, the header contains the full VRF verification key and VRF value for leader election. We check the VRF key against the value in IndividualPoolStake and we check the VRF value using the epoch nonce and the relative stake of the pool as given in IndividualPoolStake. The stake is relative to the total amount of active stake in the network. Stake is active if it is both registered and delegated to a registered stake pool.

Constructors

IndividualPoolStake
Fields individualPoolStake ∷ !Rational Pool stake distribution. This is a ratio of `individualTotalPoolStake`/`pdTotalActiveStake` individualTotalPoolStake ∷ !(CompactForm Coin) Total stake delegated to this pool. In addition to all the stake that is part of `individualPoolStake` we also add proposal-deposits to this field. individualPoolStakeVrf ∷ !(VRFVerKeyHash 'StakePoolVRF)

Instances

Instances details

ToJSON IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods toJSON ∷ IndividualPoolStake → Value Source # toEncoding ∷ IndividualPoolStake → Encoding Source # toJSONList ∷ [IndividualPoolStake] → Value Source # toEncodingList ∷ [IndividualPoolStake] → Encoding Source # omitField ∷ IndividualPoolStake → Bool Source #
Generic IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Associated Types type Rep IndividualPoolStake ∷ Type → Type Source # Methods from ∷ IndividualPoolStake → Rep IndividualPoolStake x Source # to ∷ Rep IndividualPoolStake x → IndividualPoolStake Source #
Show IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods showsPrec ∷ Int → IndividualPoolStake → ShowS Source # show ∷ IndividualPoolStake → String Source # showList ∷ [IndividualPoolStake] → ShowS Source #
DecCBOR IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods decCBOR ∷ Decoder s IndividualPoolStake Source # dropCBOR ∷ Proxy IndividualPoolStake → Decoder s () Source # label ∷ Proxy IndividualPoolStake → Text Source #
EncCBOR IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods encCBOR ∷ IndividualPoolStake → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy IndividualPoolStake → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [IndividualPoolStake] → Size Source #
NFData IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods rnf ∷ IndividualPoolStake → () Source #
Eq IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods (==) ∷ IndividualPoolStake → IndividualPoolStake → Bool Source # (/=) ∷ IndividualPoolStake → IndividualPoolStake → Bool Source #
NoThunks IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods noThunks ∷ Context → IndividualPoolStake → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → IndividualPoolStake → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy IndividualPoolStake → String Source #
type Rep IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.PoolDistr type Rep IndividualPoolStake = D1 ('MetaData "IndividualPoolStake" "Cardano.Ledger.PoolDistr" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "IndividualPoolStake" 'PrefixI 'True) (S1 ('MetaSel ('Just "individualPoolStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Rational) :: (S1 ('MetaSel ('Just "individualTotalPoolStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CompactForm Coin)) :: S1 ('MetaSel ('Just "individualPoolStakeVrf") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VRFVerKeyHash 'StakePoolVRF)))))

data PoolDistr Source #

A map of stake pool IDs (the hash of the stake pool operator's verification key) to IndividualPoolStake. Also holds absolute values necessary for the calculations in the computeDRepDistr.

Constructors

PoolDistr
Fields unPoolDistr ∷ !(Map (KeyHash 'StakePool) IndividualPoolStake) pdTotalActiveStake ∷ !(CompactForm Coin) Total stake delegated to registered stake pools. In addition to the stake considered for the `individualPoolStake` Rational, we add proposal-deposits to this field.

Instances

Instances details

ToJSON PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods toJSON ∷ PoolDistr → Value Source # toEncoding ∷ PoolDistr → Encoding Source # toJSONList ∷ [PoolDistr] → Value Source # toEncodingList ∷ [PoolDistr] → Encoding Source # omitField ∷ PoolDistr → Bool Source #
Generic PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Associated Types type Rep PoolDistr ∷ Type → Type Source # Methods from ∷ PoolDistr → Rep PoolDistr x Source # to ∷ Rep PoolDistr x → PoolDistr Source #
Show PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods showsPrec ∷ Int → PoolDistr → ShowS Source # show ∷ PoolDistr → String Source # showList ∷ [PoolDistr] → ShowS Source #
DecCBOR PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods decCBOR ∷ Decoder s PoolDistr Source # dropCBOR ∷ Proxy PoolDistr → Decoder s () Source # label ∷ Proxy PoolDistr → Text Source #
EncCBOR PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods encCBOR ∷ PoolDistr → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy PoolDistr → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [PoolDistr] → Size Source #
NFData PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods rnf ∷ PoolDistr → () Source #
Eq PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods (==) ∷ PoolDistr → PoolDistr → Bool Source # (/=) ∷ PoolDistr → PoolDistr → Bool Source #
NoThunks PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr Methods noThunks ∷ Context → PoolDistr → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PoolDistr → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy PoolDistr → String Source #
type Rep PoolDistr Source #
Instance details Defined in Cardano.Ledger.PoolDistr type Rep PoolDistr = D1 ('MetaData "PoolDistr" "Cardano.Ledger.PoolDistr" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "PoolDistr" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPoolDistr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) IndividualPoolStake)) :*: S1 ('MetaSel ('Just "pdTotalActiveStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CompactForm Coin))))

poolDistrDistrL ∷ Lens' PoolDistr (Map (KeyHash 'StakePool) IndividualPoolStake) Source #

poolDistrTotalL ∷ Lens' PoolDistr (CompactForm Coin) Source #

individualTotalPoolStakeL ∷ Lens' IndividualPoolStake (CompactForm Coin) Source #