Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.State

Contents

Primitives
Functions

Synopsis

data AccountState = AccountState {
- asTreasury ∷ !Coin
- asReserves ∷ !Coin
}
class CanGetUTxO t where
- utxoG ∷ SimpleGetter (t era) (UTxO era)
class CanGetUTxO t ⇒ CanSetUTxO t where
- utxoL ∷ Lens' (t era) (UTxO era)
newtype UTxO era = UTxO {
- unUTxO ∷ Map TxIn (TxOut era)
}
class EraTx era ⇒ EraUTxO era where
- type ScriptsNeeded era = (r ∷ Type) | r → era
- getConsumedValue ∷ PParams era → (Credential 'Staking → Maybe Coin) → (Credential 'DRepRole → Maybe Coin) → UTxO era → TxBody era → Value era
- getProducedValue ∷ PParams era → (KeyHash 'StakePool → Bool) → TxBody era → Value era
- getScriptsProvided ∷ UTxO era → Tx era → ScriptsProvided era
- getScriptsNeeded ∷ UTxO era → TxBody era → ScriptsNeeded era
- getScriptsHashesNeeded ∷ ScriptsNeeded era → Set ScriptHash
- getWitsVKeyNeeded ∷ CertState era → UTxO era → TxBody era → Set (KeyHash 'Witness)
- getMinFeeTxUtxo ∷ PParams era → Tx era → UTxO era → Coin
newtype ScriptsProvided era = ScriptsProvided {
- unScriptsProvided ∷ Map ScriptHash (Script era)
}
txins ∷ EraTxBody era ⇒ TxBody era → Set TxIn
txinLookup ∷ TxIn → UTxO era → Maybe (TxOut era)
txInsFilter ∷ UTxO era → Set TxIn → UTxO era
txouts ∷ ∀ era. EraTxBody era ⇒ TxBody era → UTxO era
balance ∷ EraTxOut era ⇒ UTxO era → Value era
coinBalance ∷ EraTxOut era ⇒ UTxO era → Coin
sumAllValue ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Value era
sumAllCoin ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Coin
areAllAdaOnly ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Bool
verifyWitVKey ∷ Typeable kr ⇒ Hash HASH EraIndependentTxBody → WitVKey kr → Bool
getScriptHash ∷ Addr → Maybe ScriptHash
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)
newtype Stake = Stake {
- unStake ∷ VMap VB VP (Credential 'Staking) (CompactForm Coin)
}
sumAllStake ∷ Stake → Coin
sumAllStakeCompact ∷ Stake → CompactForm Coin
sumStakePerPool ∷ VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Stake → Map (KeyHash 'StakePool) Coin
data SnapShot = SnapShot {
- ssStake ∷ !Stake
- ssDelegations ∷ !(VMap VB VB (Credential 'Staking) (KeyHash 'StakePool))
- ssPoolParams ∷ !(VMap VB VB (KeyHash 'StakePool) PoolParams)
}
data SnapShots = SnapShots {
- ssStakeMark ∷ SnapShot
- ssStakeMarkPoolDistr ∷ PoolDistr
- ssStakeSet ∷ !SnapShot
- ssStakeGo ∷ !SnapShot
- ssFee ∷ !Coin
}
emptySnapShot ∷ SnapShot
emptySnapShots ∷ SnapShots
poolStake ∷ KeyHash 'StakePool → VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Stake → Stake
maxPool ∷ EraPParams era ⇒ PParams era → Coin → Rational → Rational → Coin
maxPool' ∷ NonNegativeInterval → NonZero Word16 → Coin → Rational → Rational → Coin
calculatePoolDistr ∷ SnapShot → PoolDistr
calculatePoolDistr' ∷ (KeyHash 'StakePool → Bool) → SnapShot → PoolDistr
calculatePoolStake ∷ (KeyHash 'StakePool → Bool) → VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Stake → Map (KeyHash 'StakePool) Word64
ssStakeMarkL ∷ Lens' SnapShots SnapShot
ssStakeMarkPoolDistrL ∷ Lens' SnapShots PoolDistr
ssStakeSetL ∷ Lens' SnapShots SnapShot
ssStakeGoL ∷ Lens' SnapShots SnapShot
ssFeeL ∷ Lens' SnapShots Coin
ssStakeL ∷ Lens' SnapShot Stake
ssStakeDistrL ∷ Lens' SnapShot (VMap VB VP (Credential 'Staking) (CompactForm Coin))
ssDelegationsL ∷ Lens' SnapShot (VMap VB VB (Credential 'Staking) (KeyHash 'StakePool))
ssPoolParamsL ∷ Lens' SnapShot (VMap VB VB (KeyHash 'StakePool) PoolParams)
class (Era era, Eq (InstantStake era), Show (InstantStake era), Monoid (InstantStake era), Default (InstantStake era), NFData (InstantStake era), NoThunks (InstantStake era), ToJSON (InstantStake era), EncCBOR (InstantStake era), DecShareCBOR (InstantStake era), Share (InstantStake era) ~ Interns (Credential 'Staking)) ⇒ EraStake era where
- type InstantStake era = (r ∷ Type) | r → era
- instantStakeCredentialsL ∷ Lens' (InstantStake era) (Map (Credential 'Staking) (CompactForm Coin))
- addInstantStake ∷ UTxO era → InstantStake era → InstantStake era
- deleteInstantStake ∷ UTxO era → InstantStake era → InstantStake era
- resolveInstantStake ∷ InstantStake era → UMap → Stake
class CanGetInstantStake t where
- instantStakeG ∷ SimpleGetter (t era) (InstantStake era)
class CanGetInstantStake t ⇒ CanSetInstantStake t where
- instantStakeL ∷ Lens' (t era) (InstantStake era)
snapShotFromInstantStake ∷ EraStake era ⇒ InstantStake era → DState era → PState era → SnapShot
resolveActiveInstantStakeCredentials ∷ EraStake era ⇒ InstantStake era → UMap → Map (Credential 'Staking) (CompactForm Coin)
class (EraPParams era, Eq (GovState era), Show (GovState era), NoThunks (GovState era), NFData (GovState era), EncCBOR (GovState era), DecCBOR (GovState era), DecShareCBOR (GovState era), Share (GovState era) ~ (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole)), ToCBOR (GovState era), FromCBOR (GovState era), Default (GovState era), ToJSON (GovState era)) ⇒ EraGov era where
- type GovState era = (r ∷ Type) | r → era
- emptyGovState ∷ GovState era
- curPParamsGovStateL ∷ Lens' (GovState era) (PParams era)
- prevPParamsGovStateL ∷ Lens' (GovState era) (PParams era)
- futurePParamsGovStateL ∷ Lens' (GovState era) (FuturePParams era)
- obligationGovState ∷ GovState era → Obligations
data FuturePParams era
- = NoPParamsUpdate
- | DefinitePParamsUpdate !(PParams era)
- | PotentialPParamsUpdate (Maybe (PParams era))
solidifyFuturePParams ∷ FuturePParams era → FuturePParams era
nextEpochPParams ∷ EraGov era ⇒ GovState era → PParams era
nextEpochUpdatedPParams ∷ EraGov era ⇒ GovState era → StrictMaybe (PParams era)
knownFuturePParams ∷ FuturePParams era → Maybe (PParams era)

Documentation

data AccountState Source #

Constructors

AccountState
Fields asTreasury ∷ !Coin asReserves ∷ !Coin

Instances

Instances details

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

class CanGetUTxO t where Source #

Minimal complete definition

Nothing

Methods

utxoG ∷ SimpleGetter (t era) (UTxO era) Source #

default utxoG ∷ CanSetUTxO t ⇒ SimpleGetter (t era) (UTxO era) Source #

Instances

Instances details

CanGetUTxO UTxO Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoG ∷ SimpleGetter (UTxO era) (UTxO era) Source #

class CanGetUTxO t ⇒ CanSetUTxO t where Source #

Methods

utxoL ∷ Lens' (t era) (UTxO era) Source #

Instances

Instances details

CanSetUTxO UTxO Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoL ∷ Lens' (UTxO era) (UTxO era) Source #

Primitives

newtype UTxO era Source #

The unspent transaction outputs.

Constructors

UTxO
Fields unUTxO ∷ Map TxIn (TxOut era)

Instances

Instances details

CanGetUTxO UTxO Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoG ∷ SimpleGetter (UTxO era) (UTxO era) Source #
CanSetUTxO UTxO Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoL ∷ Lens' (UTxO era) (UTxO era) Source #
ToJSON (TxOut era) ⇒ ToJSON (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods toJSON ∷ UTxO era → Value Source # toEncoding ∷ UTxO era → Encoding Source # toJSONList ∷ [UTxO era] → Value Source # toEncodingList ∷ [UTxO era] → Encoding Source # omitField ∷ UTxO era → Bool Source #
Era era ⇒ Monoid (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods mempty ∷ UTxO era # mappend ∷ UTxO era → UTxO era → UTxO era # mconcat ∷ [UTxO era] → UTxO era #
Semigroup (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods (<>) ∷ UTxO era → UTxO era → UTxO era # sconcat ∷ NonEmpty (UTxO era) → UTxO era # stimes ∷ Integral b ⇒ b → UTxO era → UTxO era #
Generic (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Associated Types type Rep (UTxO era) ∷ Type → Type # Methods from ∷ UTxO era → Rep (UTxO era) x # to ∷ Rep (UTxO era) x → UTxO era #
Show (TxOut era) ⇒ Show (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods showsPrec ∷ Int → UTxO era → ShowS # show ∷ UTxO era → String # showList ∷ [UTxO era] → ShowS #
(DecCBOR (TxOut era), Era era) ⇒ FromCBOR (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods fromCBOR ∷ Decoder s (UTxO era) Source # label ∷ Proxy (UTxO era) → Text Source #
(EncCBOR (TxOut era), Era era) ⇒ ToCBOR (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods toCBOR ∷ UTxO era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (UTxO era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [UTxO era] → Size Source #
(Era era, DecCBOR (TxOut era)) ⇒ DecCBOR (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods decCBOR ∷ Decoder s (UTxO era) Source # dropCBOR ∷ Proxy (UTxO era) → Decoder s () Source # label ∷ Proxy (UTxO era) → Text Source #
(DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ DecShareCBOR (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Associated Types type Share (UTxO era) Source # Methods getShare ∷ UTxO era → Share (UTxO era) Source # decShareCBOR ∷ Share (UTxO era) → Decoder s (UTxO era) Source # decSharePlusCBOR ∷ StateT (Share (UTxO era)) (Decoder s) (UTxO era) Source #
(Era era, EncCBOR (TxOut era)) ⇒ EncCBOR (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods encCBOR ∷ UTxO era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (UTxO era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [UTxO era] → Size Source #
Default (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods def ∷ UTxO era Source #
(Era era, NFData (TxOut era)) ⇒ NFData (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods rnf ∷ UTxO era → () #
(Era era, Eq (TxOut era)) ⇒ Eq (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods (==) ∷ UTxO era → UTxO era → Bool # (/=) ∷ UTxO era → UTxO era → Bool #
NoThunks (TxOut era) ⇒ NoThunks (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods noThunks ∷ Context → UTxO era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → UTxO era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (UTxO era) → String Source #
type Rep (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO type Rep (UTxO era) = D1 ('MetaData "UTxO" "Cardano.Ledger.State.UTxO" "cardano-ledger-core-1.17.0.0-inplace" 'True) (C1 ('MetaCons "UTxO" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map TxIn (TxOut era)))))
type Share (UTxO era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO type Share (UTxO era) = Interns (Credential 'Staking)

class EraTx era ⇒ EraUTxO era where Source #

Associated Types

type ScriptsNeeded era = (r ∷ Type) | r → era Source #

A customizable type on per era basis for the information required to find all scripts needed for the transaction.

Methods

getConsumedValue Source #

Arguments

∷ PParams era
→ (Credential 'Staking → Maybe Coin)	Function that can lookup current delegation deposits
→ (Credential 'DRepRole → Maybe Coin)	Function that can lookup current drep deposits
→ UTxO era
→ TxBody era
→ Value era

Calculate all the value that is being consumed by the transaction.

getProducedValue Source #

Arguments

∷ PParams era
→ (KeyHash 'StakePool → Bool)	Check whether a pool with a supplied PoolStakeId is already registered.
→ TxBody era
→ Value era

getScriptsProvided Source #

Arguments

∷ UTxO era	For some era it is necessary to look into the UTxO to find all of the available scripts for the transaction
→ Tx era
→ ScriptsProvided era

Initial eras will look into witness set to find all of the available scripts, but starting with Babbage we can look for available scripts in the UTxO using reference inputs.

getScriptsNeeded ∷ UTxO era → TxBody era → ScriptsNeeded era Source #

Produce all the information required for figuring out which scripts are required for the transaction to be valid, once those scripts are evaluated

getScriptsHashesNeeded ∷ ScriptsNeeded era → Set ScriptHash Source #

Extract the set of all script hashes that are needed for script validation.

getWitsVKeyNeeded ∷ CertState era → UTxO era → TxBody era → Set (KeyHash 'Witness) Source #

Extract all of the KeyHash witnesses that are required for validating the transaction

getMinFeeTxUtxo ∷ PParams era → Tx era → UTxO era → Coin Source #

Minimum fee computation, excluding witnesses and including ref scripts size

newtype ScriptsProvided era Source #

The only reason it is a newtype instead of just a Map is becuase for later eras is expensive to compute the actual map, so we want to use the type safety guidance to avoid redundant work.

Constructors

ScriptsProvided
Fields unScriptsProvided ∷ Map ScriptHash (Script era)

Instances

Instances details

Generic (ScriptsProvided era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Associated Types type Rep (ScriptsProvided era) ∷ Type → Type # Methods from ∷ ScriptsProvided era → Rep (ScriptsProvided era) x # to ∷ Rep (ScriptsProvided era) x → ScriptsProvided era #
(Era era, Show (Script era)) ⇒ Show (ScriptsProvided era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods showsPrec ∷ Int → ScriptsProvided era → ShowS # show ∷ ScriptsProvided era → String # showList ∷ [ScriptsProvided era] → ShowS #
(Era era, NFData (Script era)) ⇒ NFData (ScriptsProvided era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods rnf ∷ ScriptsProvided era → () #
(Era era, Eq (Script era)) ⇒ Eq (ScriptsProvided era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods (==) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (/=) ∷ ScriptsProvided era → ScriptsProvided era → Bool #
(Era era, Ord (Script era)) ⇒ Ord (ScriptsProvided era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO Methods compare ∷ ScriptsProvided era → ScriptsProvided era → Ordering # (<) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (<=) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (>) ∷ ScriptsProvided era → ScriptsProvided era → Bool # (>=) ∷ ScriptsProvided era → ScriptsProvided era → Bool # max ∷ ScriptsProvided era → ScriptsProvided era → ScriptsProvided era # min ∷ ScriptsProvided era → ScriptsProvided era → ScriptsProvided era #
type Rep (ScriptsProvided era) Source #
Instance details Defined in Cardano.Ledger.State.UTxO type Rep (ScriptsProvided era) = D1 ('MetaData "ScriptsProvided" "Cardano.Ledger.State.UTxO" "cardano-ledger-core-1.17.0.0-inplace" 'True) (C1 ('MetaCons "ScriptsProvided" 'PrefixI 'True) (S1 ('MetaSel ('Just "unScriptsProvided") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ScriptHash (Script era)))))

Functions

txins ∷ EraTxBody era ⇒ TxBody era → Set TxIn Source #

Compute the UTxO inputs of a transaction. txins has the same problems as txouts, see notes below.

txinLookup ∷ TxIn → UTxO era → Maybe (TxOut era) Source #

Lookup a txin for a given UTxO collection

txInsFilter Source #

Arguments

∷ UTxO era	Source `UTxO`
→ Set TxIn	Which of the `TxIn`s you would like to keep.
→ UTxO era

Filter out TxIn's from the UTxO map

txouts ∷ ∀ era. EraTxBody era ⇒ TxBody era → UTxO era Source #

Compute the transaction outputs of a transaction.

balance ∷ EraTxOut era ⇒ UTxO era → Value era Source #

Determine the total balance contained in the UTxO.

coinBalance ∷ EraTxOut era ⇒ UTxO era → Coin Source #

Determine the total Ada only balance contained in the UTxO. This is equivalent to `coin . balance`, but it will be more efficient

sumAllValue ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Value era Source #

Sum all the value in any Foldable with TxOuts

sumAllCoin ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Coin Source #

Sum all the Coins in any Foldable with with TxOuts. Care should be taken since it is susceptible to integer overflow, therefore make sure this function is not applied to unvalidated TxOuts

areAllAdaOnly ∷ (EraTxOut era, Foldable f) ⇒ f (TxOut era) → Bool Source #

Check whether any of the supplied TxOuts contain any MultiAssets. Returns True if non of them do.

verifyWitVKey ∷ Typeable kr ⇒ Hash HASH EraIndependentTxBody → WitVKey kr → Bool Source #

Verify a transaction body witness

getScriptHash ∷ Addr → Maybe ScriptHash Source #

Extract script hash from value address with script.

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.State.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.State.PoolDistr Associated Types type Rep IndividualPoolStake ∷ Type → Type # Methods from ∷ IndividualPoolStake → Rep IndividualPoolStake x # to ∷ Rep IndividualPoolStake x → IndividualPoolStake #
Show IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.State.PoolDistr Methods showsPrec ∷ Int → IndividualPoolStake → ShowS # show ∷ IndividualPoolStake → String # showList ∷ [IndividualPoolStake] → ShowS #
DecCBOR IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.State.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.State.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.State.PoolDistr Methods rnf ∷ IndividualPoolStake → () #
Eq IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.State.PoolDistr Methods (==) ∷ IndividualPoolStake → IndividualPoolStake → Bool # (/=) ∷ IndividualPoolStake → IndividualPoolStake → Bool #
NoThunks IndividualPoolStake Source #
Instance details Defined in Cardano.Ledger.State.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.State.PoolDistr type Rep IndividualPoolStake = D1 ('MetaData "IndividualPoolStake" "Cardano.Ledger.State.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.State.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.State.PoolDistr Associated Types type Rep PoolDistr ∷ Type → Type # Methods from ∷ PoolDistr → Rep PoolDistr x # to ∷ Rep PoolDistr x → PoolDistr #
Show PoolDistr Source #
Instance details Defined in Cardano.Ledger.State.PoolDistr Methods showsPrec ∷ Int → PoolDistr → ShowS # show ∷ PoolDistr → String # showList ∷ [PoolDistr] → ShowS #
DecCBOR PoolDistr Source #
Instance details Defined in Cardano.Ledger.State.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.State.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.State.PoolDistr Methods rnf ∷ PoolDistr → () #
Eq PoolDistr Source #
Instance details Defined in Cardano.Ledger.State.PoolDistr Methods (==) ∷ PoolDistr → PoolDistr → Bool # (/=) ∷ PoolDistr → PoolDistr → Bool #
NoThunks PoolDistr Source #
Instance details Defined in Cardano.Ledger.State.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.State.PoolDistr type Rep PoolDistr = D1 ('MetaData "PoolDistr" "Cardano.Ledger.State.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 #

newtype Stake Source #

Type of stake as map from staking credential to coins associated. Any staking credential that has no stake will not appear in this Map, even if it is registered. For this reason, this data type should not be used for infering whether credential is registered or not.

Constructors

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

Instances

Instances details

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

sumAllStake ∷ Stake → Coin Source #

sumAllStakeCompact ∷ Stake → CompactForm Coin Source #

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

Compute amount of stake each pool has. Any registered stake pool that has no stake will not be inlcuded in the resulting map

data SnapShot Source #

Snapshot of the stake distribution.

Constructors

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

Instances

Instances details

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

data SnapShots 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 ssStakeMarkPoolDistr ∷ PoolDistr ssStakeSet ∷ !SnapShot ssStakeGo ∷ !SnapShot ssFee ∷ !Coin

Instances

Instances details

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

emptySnapShot ∷ SnapShot Source #

emptySnapShots ∷ SnapShots Source #

poolStake ∷ KeyHash 'StakePool → VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Stake → Stake Source #

Get stake of one pool

maxPool ∷ EraPParams era ⇒ PParams era → Coin → Rational → Rational → Coin Source #

Version of maxPool` that extracts ppA0L and ppNOptL from a PParams

maxPool' ∷ NonNegativeInterval → NonZero Word16 → Coin → Rational → Rational → Coin Source #

Calculate maximal pool reward

calculatePoolDistr ∷ SnapShot → PoolDistr Source #

calculatePoolDistr' ∷ (KeyHash 'StakePool → Bool) → SnapShot → PoolDistr Source #

calculatePoolStake ∷ (KeyHash 'StakePool → Bool) → VMap VB VB (Credential 'Staking) (KeyHash 'StakePool) → Stake → Map (KeyHash 'StakePool) Word64 Source #

Sum up the Coin (as CompactForm Coin = Word64) for each StakePool

ssStakeMarkL ∷ Lens' SnapShots SnapShot Source #

ssStakeMarkPoolDistrL ∷ Lens' SnapShots PoolDistr Source #

ssStakeSetL ∷ Lens' SnapShots SnapShot Source #

ssStakeGoL ∷ Lens' SnapShots SnapShot Source #

ssFeeL ∷ Lens' SnapShots Coin Source #

ssStakeL ∷ Lens' SnapShot Stake Source #

ssStakeDistrL ∷ Lens' SnapShot (VMap VB VP (Credential 'Staking) (CompactForm Coin)) Source #

ssDelegationsL ∷ Lens' SnapShot (VMap VB VB (Credential 'Staking) (KeyHash 'StakePool)) Source #

ssPoolParamsL ∷ Lens' SnapShot (VMap VB VB (KeyHash 'StakePool) PoolParams) Source #

class (Era era, Eq (InstantStake era), Show (InstantStake era), Monoid (InstantStake era), Default (InstantStake era), NFData (InstantStake era), NoThunks (InstantStake era), ToJSON (InstantStake era), EncCBOR (InstantStake era), DecShareCBOR (InstantStake era), Share (InstantStake era) ~ Interns (Credential 'Staking)) ⇒ EraStake era where Source #

Associated Types

type InstantStake era = (r ∷ Type) | r → era Source #

This is the current stake in the system. The important part of this stake is that not all of it is active. Any stake credential that is not registred will not contribute to the active stake, however it will be part of the instant stake. Throughout an epoch it is not relevant which part of the stake is active, because it is only when we take the snaphot that we resolve all the active stake.

Methods

instantStakeCredentialsL ∷ Lens' (InstantStake era) (Map (Credential 'Staking) (CompactForm Coin)) Source #

addInstantStake ∷ UTxO era → InstantStake era → InstantStake era Source #

Add new UTxO to the InstantStake. This is invoked for every new TxOut that is added to the ledger state

deleteInstantStake ∷ UTxO era → InstantStake era → InstantStake era Source #

Delete spent UTxO from the InstantStake. This is invoked for every TxOut that is removed from the ledger state

resolveInstantStake ∷ InstantStake era → UMap → Stake Source #

Using known stake credential registrations and delegations resolve the instant stake into a Stake that will be used for SnapShot creation by snapShotFromInstantStake.

class CanGetInstantStake t where Source #

Minimal complete definition

Nothing

Methods

instantStakeG ∷ SimpleGetter (t era) (InstantStake era) Source #

default instantStakeG ∷ CanSetInstantStake t ⇒ SimpleGetter (t era) (InstantStake era) Source #

class CanGetInstantStake t ⇒ CanSetInstantStake t where Source #

Methods

instantStakeL ∷ Lens' (t era) (InstantStake era) Source #

snapShotFromInstantStake ∷ EraStake era ⇒ InstantStake era → DState era → PState era → SnapShot Source #

resolveActiveInstantStakeCredentials ∷ EraStake era ⇒ InstantStake era → UMap → Map (Credential 'Staking) (CompactForm Coin) Source #

This is the total active stake including the rewards, but ignoring all the stake coming from the pointers. Where "active" stake means any stake credential that is registered and delegated to a stake pool.

class (EraPParams era, Eq (GovState era), Show (GovState era), NoThunks (GovState era), NFData (GovState era), EncCBOR (GovState era), DecCBOR (GovState era), DecShareCBOR (GovState era), Share (GovState era) ~ (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole)), ToCBOR (GovState era), FromCBOR (GovState era), Default (GovState era), ToJSON (GovState era)) ⇒ EraGov era where Source #

Minimal complete definition

curPParamsGovStateL, prevPParamsGovStateL, futurePParamsGovStateL, obligationGovState

Associated Types

type GovState era = (r ∷ Type) | r → era Source #

Methods

emptyGovState ∷ GovState era Source #

Construct empty governance state

curPParamsGovStateL ∷ Lens' (GovState era) (PParams era) Source #

Lens for accessing current protocol parameters

prevPParamsGovStateL ∷ Lens' (GovState era) (PParams era) Source #

Lens for accessing the previous protocol parameters

futurePParamsGovStateL ∷ Lens' (GovState era) (FuturePParams era) Source #

Lens for accessing the future protocol parameters.

This lens will produce DefinitePParamsUpdate whenever we are absolutely sure that the new PParams will be updated. Which means there will be no chance of a DefinitePParamsUpdate value until we are past the point of no return, which is 2 stability windows before the end of the epoch. This lens is mostly intended for ledger usage and nextEpochUpdatedPParams should be used instead whenever definite results are desired.

obligationGovState ∷ GovState era → Obligations Source #

data FuturePParams era Source #

Constructors

NoPParamsUpdate	This indicates that there is definitely not going to be an update to PParams expected at the next epoch boundary.
DefinitePParamsUpdate !(PParams era)	This case specifies the PParams that will be adopted at the next epoch boundary.
PotentialPParamsUpdate (Maybe (PParams era))	With this case there is no guarantee that these will be the new PParams, users should not rely on this value to be computed efficiently and should use `nextEpochPParams` instead. The field is lazy on purpose, since we truly need to compute this field only towards the end of the epoch, which is done by `solidifyFuturePParams` two stability windows before the end of the epoch.

Instances

Instances details

ToJSON (PParams era) ⇒ ToJSON (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods toJSON ∷ FuturePParams era → Value Source # toEncoding ∷ FuturePParams era → Encoding Source # toJSONList ∷ [FuturePParams era] → Value Source # toEncodingList ∷ [FuturePParams era] → Encoding Source # omitField ∷ FuturePParams era → Bool Source #
Generic (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Associated Types type Rep (FuturePParams era) ∷ Type → Type # Methods from ∷ FuturePParams era → Rep (FuturePParams era) x # to ∷ Rep (FuturePParams era) x → FuturePParams era #
Show (PParams era) ⇒ Show (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods showsPrec ∷ Int → FuturePParams era → ShowS # show ∷ FuturePParams era → String # showList ∷ [FuturePParams era] → ShowS #
(Typeable era, DecCBOR (PParams era)) ⇒ DecCBOR (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods decCBOR ∷ Decoder s (FuturePParams era) Source # dropCBOR ∷ Proxy (FuturePParams era) → Decoder s () Source # label ∷ Proxy (FuturePParams era) → Text Source #
(Typeable era, EncCBOR (PParams era)) ⇒ EncCBOR (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods encCBOR ∷ FuturePParams era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (FuturePParams era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [FuturePParams era] → Size Source #
Default (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods def ∷ FuturePParams era Source #
NFData (PParams era) ⇒ NFData (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods rnf ∷ FuturePParams era → () #
Eq (PParams era) ⇒ Eq (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods (==) ∷ FuturePParams era → FuturePParams era → Bool # (/=) ∷ FuturePParams era → FuturePParams era → Bool #
NoThunks (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance Methods noThunks ∷ Context → FuturePParams era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → FuturePParams era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (FuturePParams era) → String Source #
type Rep (FuturePParams era) Source #
Instance details Defined in Cardano.Ledger.State.Governance type Rep (FuturePParams era) = D1 ('MetaData "FuturePParams" "Cardano.Ledger.State.Governance" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "NoPParamsUpdate" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DefinitePParamsUpdate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era))) :+: C1 ('MetaCons "PotentialPParamsUpdate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (PParams era))))))

solidifyFuturePParams ∷ FuturePParams era → FuturePParams era Source #

nextEpochPParams ∷ EraGov era ⇒ GovState era → PParams era Source #

This function is guaranteed to produce PParams that will be adopted at the next epoch boundary, whenever this function is applied to the GovState that was produced by ledger at any point that is two stability windows before the end of the epoch. If you need to know if there were actual changes to those PParams then use nextEpochUpdatedPParams instead.

nextEpochUpdatedPParams ∷ EraGov era ⇒ GovState era → StrictMaybe (PParams era) Source #

This function is guaranteed to return updated PParams when it is called during the last two stability windows of the epoch and there were proposals to update PParams that all relevant parties reached consensus on. In other words whenever there is a definite update to PParams coming on the epoch boundary those PParams will be returned, otherwise it will return Nothing. This function is inexpensive and can be invoked at any time without danger of forcing some suspended computation.

knownFuturePParams ∷ FuturePParams era → Maybe (PParams era) Source #

Return new PParams only when it is known that there was an update proposed and it is guaranteed to be applied