Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.EpochBoundary

Description

This modules implements the necessary functions for the changes that can happen at epoch boundaries.

Synopsis

newtype Stake c = Stake {
- unStake ∷ VMap VB VP (Credential 'Staking c) (CompactForm Coin)
}
sumAllStake ∷ Stake c → Coin
sumAllStakeCompact ∷ Stake c → CompactForm Coin
sumStakePerPool ∷ VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c) → Stake c → Map (KeyHash 'StakePool c) Coin
data SnapShot c = SnapShot {
- ssStake ∷ !(Stake c)
- ssDelegations ∷ !(VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c))
- ssPoolParams ∷ !(VMap VB VB (KeyHash 'StakePool c) (PoolParams c))
}
data SnapShots c = SnapShots {
- ssStakeMark ∷ SnapShot c
- ssStakeMarkPoolDistr ∷ PoolDistr c
- ssStakeSet ∷ !(SnapShot c)
- ssStakeGo ∷ !(SnapShot c)
- ssFee ∷ !Coin
}
emptySnapShot ∷ SnapShot c
emptySnapShots ∷ SnapShots c
poolStake ∷ KeyHash 'StakePool c → VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c) → Stake c → Stake c
maxPool ∷ EraPParams era ⇒ PParams era → Coin → Rational → Rational → Coin
maxPool' ∷ NonNegativeInterval → Natural → Coin → Rational → Rational → Coin
calculatePoolDistr ∷ SnapShot c → PoolDistr c
calculatePoolDistr' ∷ ∀ c. (KeyHash 'StakePool c → Bool) → SnapShot c → PoolDistr c
calculatePoolStake ∷ (KeyHash 'StakePool c → Bool) → VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c) → Stake c → Map (KeyHash 'StakePool c) Word64
ssStakeMarkL ∷ Lens' (SnapShots c) (SnapShot c)
ssStakeMarkPoolDistrL ∷ Lens' (SnapShots c) (PoolDistr c)
ssStakeSetL ∷ Lens' (SnapShots c) (SnapShot c)
ssStakeGoL ∷ Lens' (SnapShots c) (SnapShot c)
ssFeeL ∷ Lens' (SnapShots c) Coin
ssStakeL ∷ Lens' (SnapShot c) (Stake c)
ssStakeDistrL ∷ Lens' (SnapShot c) (VMap VB VP (Credential 'Staking c) (CompactForm Coin))
ssDelegationsL ∷ Lens' (SnapShot c) (VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c))
ssPoolParamsL ∷ Lens' (SnapShot c) (VMap VB VB (KeyHash 'StakePool c) (PoolParams c))

Documentation

newtype Stake c Source #

Type of stake as map from hash key to coins associated.

Constructors

Stake
Fields unStake ∷ VMap VB VP (Credential 'Staking c) (CompactForm Coin)

Instances

Instances details

Crypto c ⇒ ToJSON (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods toJSON ∷ Stake c → Value Source # toEncoding ∷ Stake c → Encoding Source # toJSONList ∷ [Stake c] → Value Source # toEncodingList ∷ [Stake c] → Encoding Source # omitField ∷ Stake c → Bool Source #
Generic (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Associated Types type Rep (Stake c) ∷ Type → Type Source # Methods from ∷ Stake c → Rep (Stake c) x Source # to ∷ Rep (Stake c) x → Stake c Source #
Show (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods showsPrec ∷ Int → Stake c → ShowS Source # show ∷ Stake c → String Source # showList ∷ [Stake c] → ShowS Source #
Crypto c ⇒ DecShareCBOR (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Associated Types type Share (Stake c) Source # Methods getShare ∷ Stake c → Share (Stake c) Source # decShareCBOR ∷ Share (Stake c) → Decoder s (Stake c) Source # decSharePlusCBOR ∷ StateT (Share (Stake c)) (Decoder s) (Stake c) Source #
Crypto c ⇒ EncCBOR (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods encCBOR ∷ Stake c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Stake c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Stake c] → Size Source #
NFData (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods rnf ∷ Stake c → () Source #
Eq (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods (==) ∷ Stake c → Stake c → Bool Source # (/=) ∷ Stake c → Stake c → Bool Source #
Typeable c ⇒ NoThunks (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods noThunks ∷ Context → Stake c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Stake c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Stake c) → String Source #
type Rep (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary type Rep (Stake c) = D1 ('MetaData "Stake" "Cardano.Ledger.EpochBoundary" "cardano-ledger-core-1.16.0.0-inplace" 'True) (C1 ('MetaCons "Stake" 'PrefixI 'True) (S1 ('MetaSel ('Just "unStake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VMap VB VP (Credential 'Staking c) (CompactForm Coin)))))
type Share (Stake c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary type Share (Stake c) = Share (VMap VB VP (Credential 'Staking c) (CompactForm Coin))

sumAllStake ∷ Stake c → Coin Source #

sumAllStakeCompact ∷ Stake c → CompactForm Coin Source #

sumStakePerPool ∷ VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c) → Stake c → Map (KeyHash 'StakePool c) Coin Source #

data SnapShot c Source #

Snapshot of the stake distribution.

Constructors

SnapShot
Fields ssStake ∷ !(Stake c) ssDelegations ∷ !(VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c)) ssPoolParams ∷ !(VMap VB VB (KeyHash 'StakePool c) (PoolParams c))

Instances

Instances details

Crypto c ⇒ ToJSON (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods toJSON ∷ SnapShot c → Value Source # toEncoding ∷ SnapShot c → Encoding Source # toJSONList ∷ [SnapShot c] → Value Source # toEncodingList ∷ [SnapShot c] → Encoding Source # omitField ∷ SnapShot c → Bool Source #
Generic (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Associated Types type Rep (SnapShot c) ∷ Type → Type Source # Methods from ∷ SnapShot c → Rep (SnapShot c) x Source # to ∷ Rep (SnapShot c) x → SnapShot c Source #
Show (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods showsPrec ∷ Int → SnapShot c → ShowS Source # show ∷ SnapShot c → String Source # showList ∷ [SnapShot c] → ShowS Source #
Crypto c ⇒ DecShareCBOR (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Associated Types type Share (SnapShot c) Source # Methods getShare ∷ SnapShot c → Share (SnapShot c) Source # decShareCBOR ∷ Share (SnapShot c) → Decoder s (SnapShot c) Source # decSharePlusCBOR ∷ StateT (Share (SnapShot c)) (Decoder s) (SnapShot c) Source #
Crypto c ⇒ EncCBOR (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods encCBOR ∷ SnapShot c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (SnapShot c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [SnapShot c] → Size Source #
NFData (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods rnf ∷ SnapShot c → () Source #
Eq (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods (==) ∷ SnapShot c → SnapShot c → Bool Source # (/=) ∷ SnapShot c → SnapShot c → Bool Source #
Typeable c ⇒ NoThunks (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods noThunks ∷ Context → SnapShot c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SnapShot c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (SnapShot c) → String Source #
type Rep (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary type Rep (SnapShot c) = D1 ('MetaData "SnapShot" "Cardano.Ledger.EpochBoundary" "cardano-ledger-core-1.16.0.0-inplace" 'False) (C1 ('MetaCons "SnapShot" 'PrefixI 'True) (S1 ('MetaSel ('Just "ssStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Stake c)) :: (S1 ('MetaSel ('Just "ssDelegations") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VMap VB VB (Credential 'Staking c) (KeyHash 'StakePool c))) :: S1 ('MetaSel ('Just "ssPoolParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VMap VB VB (KeyHash 'StakePool c) (PoolParams c))))))
type Share (SnapShot c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary type Share (SnapShot c) = (Interns (Credential 'Staking c), Interns (KeyHash 'StakePool c))

data SnapShots c Source #

Snapshots of the stake distribution.

Note that ssStakeMark and ssStakeMarkPoolDistr are lazy on purpose since we only want to force the thunk after one stability window when we know that they are stable (so that we do not compute them if we do not have to). See more info in the Optimize TICKF ADR

Constructors

SnapShots
Fields ssStakeMark ∷ SnapShot c ssStakeMarkPoolDistr ∷ PoolDistr c ssStakeSet ∷ !(SnapShot c) ssStakeGo ∷ !(SnapShot c) ssFee ∷ !Coin

Instances

Instances details

Crypto c ⇒ ToJSON (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods toJSON ∷ SnapShots c → Value Source # toEncoding ∷ SnapShots c → Encoding Source # toJSONList ∷ [SnapShots c] → Value Source # toEncodingList ∷ [SnapShots c] → Encoding Source # omitField ∷ SnapShots c → Bool Source #
Generic (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Associated Types type Rep (SnapShots c) ∷ Type → Type Source # Methods from ∷ SnapShots c → Rep (SnapShots c) x Source # to ∷ Rep (SnapShots c) x → SnapShots c Source #
Show (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods showsPrec ∷ Int → SnapShots c → ShowS Source # show ∷ SnapShots c → String Source # showList ∷ [SnapShots c] → ShowS Source #
Crypto c ⇒ DecCBOR (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods decCBOR ∷ Decoder s (SnapShots c) Source # dropCBOR ∷ Proxy (SnapShots c) → Decoder s () Source # label ∷ Proxy (SnapShots c) → Text Source #
Crypto c ⇒ DecShareCBOR (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Associated Types type Share (SnapShots c) Source # Methods getShare ∷ SnapShots c → Share (SnapShots c) Source # decShareCBOR ∷ Share (SnapShots c) → Decoder s (SnapShots c) Source # decSharePlusCBOR ∷ StateT (Share (SnapShots c)) (Decoder s) (SnapShots c) Source #
Crypto c ⇒ EncCBOR (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods encCBOR ∷ SnapShots c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (SnapShots c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [SnapShots c] → Size Source #
Default (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods def ∷ SnapShots c Source #
NFData (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods rnf ∷ SnapShots c → () Source #
Eq (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods (==) ∷ SnapShots c → SnapShots c → Bool Source # (/=) ∷ SnapShots c → SnapShots c → Bool Source #
Typeable c ⇒ NoThunks (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary Methods noThunks ∷ Context → SnapShots c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SnapShots c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (SnapShots c) → String Source #
type Rep (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary type Rep (SnapShots c) = D1 ('MetaData "SnapShots" "Cardano.Ledger.EpochBoundary" "cardano-ledger-core-1.16.0.0-inplace" 'False) (C1 ('MetaCons "SnapShots" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ssStakeMark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SnapShot c)) :: S1 ('MetaSel ('Just "ssStakeMarkPoolDistr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PoolDistr c))) :: (S1 ('MetaSel ('Just "ssStakeSet") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SnapShot c)) :: (S1 ('MetaSel ('Just "ssStakeGo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SnapShot c)) :: S1 ('MetaSel ('Just "ssFee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))))
type Share (SnapShots c) Source #
Instance details Defined in Cardano.Ledger.EpochBoundary type Share (SnapShots c) = Share (SnapShot c)