| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.Ledger.Shelley.LedgerState
Description
This module implements the operation rules for treating UTxO transactions (Tx)
as state transformations on a ledger state (LedgerState),
as specified in A Simplified Formal Specification of a UTxO Ledger.
Synopsis
- newtype UTxO era = UTxO {}
- class CanGetUTxO (t ∷ Type → Type) where
- utxoG ∷ SimpleGetter (t era) (UTxO era)
- class CanGetUTxO t ⇒ CanSetUTxO (t ∷ Type → Type) where
- type AccountState = ChainAccountState
- data ChainAccountState where
- pattern AccountState ∷ Coin → Coin → AccountState
- class (Era era, ToJSON (CertState era), EncCBOR (CertState era), DecShareCBOR (CertState era), Share (CertState era) ~ (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole)), Default (CertState era), NoThunks (CertState era), NFData (CertState era), Show (CertState era), Eq (CertState era)) ⇒ EraCertState era where
- type CertState era = (r ∷ Type) | r → era
- certDStateL ∷ Lens' (CertState era) (DState era)
- certPStateL ∷ Lens' (CertState era) (PState era)
- obligationCertState ∷ CertState era → Obligations
- certsTotalDepositsTxBody ∷ PParams era → CertState era → TxBody era → Coin
- certsTotalRefundsTxBody ∷ PParams era → CertState era → TxBody era → Coin
- data DState era = DState {}
- rewards ∷ DState era → UView (Credential 'Staking) RDPair
- delegations ∷ DState era → UView (Credential 'Staking) (KeyHash 'StakePool)
- ptrsMap ∷ DState era → Map Ptr (Credential 'Staking)
- data EpochState era = EpochState {}
- data PulsingRewUpdate
- data FutureGenDeleg = FutureGenDeleg {}
- data InstantaneousRewards = InstantaneousRewards {
- iRReserves ∷ !(Map (Credential 'Staking) Coin)
- iRTreasury ∷ !(Map (Credential 'Staking) Coin)
- deltaReserves ∷ !DeltaCoin
- deltaTreasury ∷ !DeltaCoin
- data LedgerState era = LedgerState {
- lsUTxOState ∷ !(UTxOState era)
- lsCertState ∷ !(CertState era)
- data PState era = PState {
- psStakePoolParams ∷ !(Map (KeyHash 'StakePool) PoolParams)
- psFutureStakePoolParams ∷ !(Map (KeyHash 'StakePool) PoolParams)
- psRetiring ∷ !(Map (KeyHash 'StakePool) EpochNo)
- psDeposits ∷ !(Map (KeyHash 'StakePool) Coin)
- type RewardAccounts = Map (Credential 'Staking) Coin
- data RewardUpdate = RewardUpdate {}
- data RewardSnapShot = RewardSnapShot {
- rewFees ∷ !Coin
- rewProtocolVersion ∷ !ProtVer
- rewNonMyopic ∷ !NonMyopic
- rewDeltaR1 ∷ !Coin
- rewR ∷ !Coin
- rewDeltaT1 ∷ !Coin
- rewLikelihoods ∷ !(Map (KeyHash 'StakePool) Likelihood)
- rewLeaders ∷ !(Map (Credential 'Staking) (Set Reward))
- data UTxOState era = UTxOState {
- utxosUtxo ∷ !(UTxO era)
- utxosDeposited ∷ !Coin
- utxosFees ∷ !Coin
- utxosGovState ∷ !(GovState era)
- utxosInstantStake ∷ !(InstantStake era)
- utxosDonation ∷ !Coin
- smartUTxOState ∷ EraStake era ⇒ PParams era → UTxO era → Coin → Coin → GovState era → Coin → UTxOState era
- mkShelleyCertState ∷ EraCertState era ⇒ PState era → DState era → CertState era
- data ShelleyCertState era = ShelleyCertState {
- shelleyCertPState ∷ !(PState era)
- shelleyCertDState ∷ !(DState era)
- genesisState ∷ ∀ era. (EraGov era, EraCertState era, EraStake era) ⇒ Map (KeyHash 'Genesis) GenDelegPair → UTxO era → LedgerState era
- consumed ∷ EraUTxO era ⇒ PParams era → CertState era → UTxO era → TxBody era → Value era
- produced ∷ (EraUTxO era, EraCertState era) ⇒ PParams era → CertState era → TxBody era → Value era
- payPoolDeposit ∷ EraPParams era ⇒ KeyHash 'StakePool → PParams era → PState era → PState era
- refundPoolDeposit ∷ KeyHash 'StakePool → PState era → (Coin, PState era)
- totalObligation ∷ (EraGov era, EraCertState era) ⇒ CertState era → GovState era → Coin
- allObligations ∷ (EraGov era, EraCertState era) ⇒ CertState era → GovState era → Obligations
- applyRUpd ∷ (EraGov era, EraCertState era) ⇒ RewardUpdate → EpochState era → EpochState era
- applyRUpdFiltered ∷ (EraGov era, EraCertState era) ⇒ RewardUpdate → EpochState era → (EpochState era, FilteredRewards era)
- filterAllRewards ∷ (EraGov era, EraCertState era) ⇒ Map (Credential 'Staking) (Set Reward) → EpochState era → FilteredRewards era
- data FilteredRewards era = FilteredRewards {
- frRegistered ∷ !(Map (Credential 'Staking) (Set Reward))
- frShelleyIgnored ∷ Map (Credential 'Staking) (Set Reward)
- frUnregistered ∷ Set (Credential 'Staking)
- frTotalUnregistered ∷ Coin
- createRUpd ∷ ∀ era. (EraGov era, EraCertState era) ⇒ EpochSize → BlocksMade → EpochState era → Coin → ActiveSlotCoeff → NonZero Word64 → ShelleyBase RewardUpdate
- completeRupd ∷ PulsingRewUpdate → ShelleyBase (RewardUpdate, RewardEvent)
- startStep ∷ ∀ era. (EraGov era, EraCertState era) ⇒ EpochSize → BlocksMade → EpochState era → Coin → ActiveSlotCoeff → NonZero Word64 → PulsingRewUpdate
- pulseStep ∷ PulsingRewUpdate → ShelleyBase (PulsingRewUpdate, RewardEvent)
- completeStep ∷ PulsingRewUpdate → ShelleyBase (PulsingRewUpdate, RewardEvent)
- data NewEpochState era = NewEpochState !EpochNo !BlocksMade !BlocksMade !(EpochState era) !(StrictMaybe PulsingRewUpdate) !PoolDistr !(StashedAVVMAddresses era)
- type family StashedAVVMAddresses era where ...
- stashedAVVMAddresses ∷ NewEpochState era → StashedAVVMAddresses era
- getGKeys ∷ EraCertState era ⇒ NewEpochState era → Set (KeyHash 'Genesis)
- updateNES ∷ EraGov era ⇒ NewEpochState era → BlocksMade → LedgerState era → NewEpochState era
- circulation ∷ EpochState era → Coin → Coin
- decayFactor ∷ Float
- returnRedeemAddrsToReserves ∷ ∀ era. EraTxOut era ⇒ EpochState era → EpochState era
- updateNonMyopic ∷ NonMyopic → Coin → Map (KeyHash 'StakePool) Likelihood → NonMyopic
- emptyRewardUpdate ∷ RewardUpdate
- pvCanFollow ∷ ProtVer → ProtVer → Bool
- availableAfterMIR ∷ MIRPot → ChainAccountState → InstantaneousRewards → Coin
- data ShelleyGovState era = ShelleyGovState {
- sgsCurProposals ∷ !(ProposedPPUpdates era)
- sgsFutureProposals ∷ !(ProposedPPUpdates era)
- sgsCurPParams ∷ !(PParams era)
- sgsPrevPParams ∷ !(PParams era)
- sgsFuturePParams ∷ !(FuturePParams era)
- nesPdL ∷ Lens' (NewEpochState era) PoolDistr
- nesEsL ∷ Lens' (NewEpochState era) (EpochState era)
- unifiedL ∷ EraCertState era ⇒ Lens' (NewEpochState era) UMap
- nesELL ∷ Lens' (NewEpochState era) EpochNo
- nesBprevL ∷ Lens' (NewEpochState era) (Map (KeyHash 'StakePool) Natural)
- nesBcurL ∷ Lens' (NewEpochState era) (Map (KeyHash 'StakePool) Natural)
- nesRuL ∷ Lens' (NewEpochState era) (StrictMaybe PulsingRewUpdate)
- nesStashedAVVMAddressesL ∷ Lens' (NewEpochState era) (StashedAVVMAddresses era)
- nesEpochStateL ∷ Lens' (NewEpochState era) (EpochState era)
- esAccountStateL ∷ Lens' (EpochState era) ChainAccountState
- esSnapshotsL ∷ Lens' (EpochState era) SnapShots
- esLStateL ∷ Lens' (EpochState era) (LedgerState era)
- esNonMyopicL ∷ Lens' (EpochState era) NonMyopic
- curPParamsEpochStateL ∷ EraGov era ⇒ Lens' (EpochState era) (PParams era)
- prevPParamsEpochStateL ∷ EraGov era ⇒ Lens' (EpochState era) (PParams era)
- futurePParamsEpochStateL ∷ EraGov era ⇒ Lens' (EpochState era) (FuturePParams era)
- asTreasuryL ∷ Lens' ChainAccountState Coin
- asReservesL ∷ Lens' ChainAccountState Coin
- lsUTxOStateL ∷ Lens' (LedgerState era) (UTxOState era)
- lsCertStateL ∷ Lens' (LedgerState era) (CertState era)
- utxosUtxoL ∷ Lens' (UTxOState era) (UTxO era)
- utxosDepositedL ∷ Lens' (UTxOState era) Coin
- utxosFeesL ∷ Lens' (UTxOState era) Coin
- utxosGovStateL ∷ Lens' (UTxOState era) (GovState era)
- utxosDonationL ∷ Lens' (UTxOState era) Coin
- epochStateGovStateL ∷ Lens' (EpochState era) (GovState era)
- epochStateStakeDistrL ∷ Lens' (EpochState era) (VMap VB VP (Credential 'Staking) (CompactForm Coin))
- epochStateUMapL ∷ EraCertState era ⇒ Lens' (EpochState era) UMap
- epochStatePoolParamsL ∷ EraCertState era ⇒ Lens' (EpochState era) (Map (KeyHash 'StakePool) PoolParams)
- epochStateDonationL ∷ Lens' (EpochState era) Coin
- newEpochStateGovStateL ∷ Lens' (NewEpochState era) (GovState era)
- epochStateTreasuryL ∷ Lens' (EpochState era) Coin
- dsUnifiedL ∷ Lens' (DState era) UMap
- dsGenDelegsL ∷ Lens' (DState era) GenDelegs
- dsIRewardsL ∷ Lens' (DState era) InstantaneousRewards
- dsFutureGenDelegsL ∷ Lens' (DState era) (Map FutureGenDeleg GenDelegPair)
- psStakePoolParamsL ∷ Lens' (PState era) (Map (KeyHash 'StakePool) PoolParams)
- psFutureStakePoolParamsL ∷ Lens' (PState era) (Map (KeyHash 'StakePool) PoolParams)
- psRetiringL ∷ Lens' (PState era) (Map (KeyHash 'StakePool) EpochNo)
- psDepositsL ∷ Lens' (PState era) (Map (KeyHash 'StakePool) Coin)
- 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)
UTxO
The unspent transaction outputs.
Instances
| CanGetUTxO UTxO | |
Defined in Cardano.Ledger.State.UTxO | |
| CanSetUTxO UTxO | |
| ToJSON (TxOut era) ⇒ ToJSON (UTxO era) | |
| Era era ⇒ Monoid (UTxO era) | |
| Semigroup (UTxO era) | |
| Generic (UTxO era) | |
| Show (TxOut era) ⇒ Show (UTxO era) | |
| (DecCBOR (TxOut era), Era era) ⇒ FromCBOR (UTxO era) | |
| (EncCBOR (TxOut era), Era era) ⇒ ToCBOR (UTxO era) | |
| (Era era, DecCBOR (TxOut era)) ⇒ DecCBOR (UTxO era) | |
| (DecShareCBOR (TxOut era), Share (TxOut era) ~ Interns (Credential 'Staking)) ⇒ DecShareCBOR (UTxO era) | |
| (Era era, EncCBOR (TxOut era)) ⇒ EncCBOR (UTxO era) | |
| Default (UTxO era) | |
Defined in Cardano.Ledger.State.UTxO | |
| (Era era, NFData (TxOut era)) ⇒ NFData (UTxO era) | |
Defined in Cardano.Ledger.State.UTxO | |
| (Era era, Eq (TxOut era)) ⇒ Eq (UTxO era) | |
| NoThunks (TxOut era) ⇒ NoThunks (UTxO era) | |
| type Rep (UTxO era) | |
Defined in Cardano.Ledger.State.UTxO | |
| type Share (UTxO era) | |
class CanGetUTxO (t ∷ Type → Type) where Source #
Minimal complete definition
Nothing
Methods
utxoG ∷ SimpleGetter (t era) (UTxO era) Source #
Instances
| CanGetUTxO UTxO | |
Defined in Cardano.Ledger.State.UTxO | |
| CanGetUTxO EpochState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (EpochState era) (UTxO era) Source # | |
| CanGetUTxO LedgerState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (LedgerState era) (UTxO era) Source # | |
| CanGetUTxO NewEpochState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (NewEpochState era) (UTxO era) Source # | |
| CanGetUTxO UTxOState Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.Types | |
class CanGetUTxO t ⇒ CanSetUTxO (t ∷ Type → Type) where Source #
Instances
Others to organize
type AccountState = ChainAccountState Source #
data ChainAccountState where Source #
Bundled Patterns
| pattern AccountState ∷ Coin → Coin → AccountState |
Instances
class (Era era, ToJSON (CertState era), EncCBOR (CertState era), DecShareCBOR (CertState era), Share (CertState era) ~ (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole)), Default (CertState era), NoThunks (CertState era), NFData (CertState era), Show (CertState era), Eq (CertState era)) ⇒ EraCertState era where Source #
The state associated with the DELPL rule, which combines the DELEG rule and the POOL rule.
Methods
certDStateL ∷ Lens' (CertState era) (DState era) Source #
certPStateL ∷ Lens' (CertState era) (PState era) Source #
obligationCertState ∷ CertState era → Obligations Source #
Calculate total possible refunds in the system that are related to certificates
There is an invariant that the sum of all the fields should be the same as the utxosDeposited field of the UTxOState. Note that this does not depend upon the current values of the Key and Pool deposits of the PParams.
certsTotalDepositsTxBody ∷ PParams era → CertState era → TxBody era → Coin Source #
Compute the total deposits from the Certs of a TxBody.
This is the contribution of a TxBody towards the deposit pot (utxosDeposit field of the UTxOState) of the system
certsTotalRefundsTxBody ∷ PParams era → CertState era → TxBody era → Coin Source #
Compute the total refunds from the Certs of a TxBody.
This is the contribution of a TxBody towards the total Obligations of the system
See Obligations and obligationCertState for more information.
Instances
| EraCertState ShelleyEra Source # | |
Defined in Cardano.Ledger.Shelley.State.CertState Associated Types type CertState ShelleyEra = (r ∷ Type) Source # Methods certDStateL ∷ Lens' (CertState ShelleyEra) (DState ShelleyEra) Source # certPStateL ∷ Lens' (CertState ShelleyEra) (PState ShelleyEra) Source # obligationCertState ∷ CertState ShelleyEra → Obligations Source # certsTotalDepositsTxBody ∷ PParams ShelleyEra → CertState ShelleyEra → TxBody ShelleyEra → Coin Source # certsTotalRefundsTxBody ∷ PParams ShelleyEra → CertState ShelleyEra → TxBody ShelleyEra → Coin Source # | |
The state used by the DELEG rule, which roughly tracks stake delegation and some governance features.
Constructors
| DState | |
Fields
| |
Instances
| ToJSON (DState era) | |
| Generic (DState era) | |
| Show (DState era) | |
| DecShareCBOR (DState era) | |
| Era era ⇒ EncCBOR (DState era) | |
| Default (DState era) | |
Defined in Cardano.Ledger.State.CertState | |
| NFData (DState era) | |
Defined in Cardano.Ledger.State.CertState | |
| Eq (DState era) | |
| NoThunks (DState era) | |
| type Rep (DState era) | |
Defined in Cardano.Ledger.State.CertState type Rep (DState era) = D1 ('MetaData "DState" "Cardano.Ledger.State.CertState" "cardano-ledger-core-1.18.0.0-inplace" 'False) (C1 ('MetaCons "DState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dsUnified") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UMap) :*: S1 ('MetaSel ('Just "dsFutureGenDelegs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map FutureGenDeleg GenDelegPair))) :*: (S1 ('MetaSel ('Just "dsGenDelegs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GenDelegs) :*: S1 ('MetaSel ('Just "dsIRewards") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 InstantaneousRewards)))) | |
| type Share (DState era) | |
delegations ∷ DState era → UView (Credential 'Staking) (KeyHash 'StakePool) Source #
ptrsMap ∷ DState era → Map Ptr (Credential 'Staking) Source #
get the actual ptrs map, we don't need a view
data EpochState era Source #
Constructors
| EpochState | |
Fields
| |
Instances
data PulsingRewUpdate Source #
The state used in the STS rules
Constructors
| Pulsing !RewardSnapShot !Pulser | |
| Complete !RewardUpdate |
Instances
data FutureGenDeleg Source #
Constructors
| FutureGenDeleg | |
Fields
| |
Instances
data InstantaneousRewards Source #
InstantaneousRewards captures the pending changes to the ledger state caused by MIR certificates. It consists of two mappings, the rewards which will be paid out from the reserves and the rewards which will be paid out from the treasury. It also consists of two coin values which represent the transfer of coins from one pot to the other pot. NOTE that the following property should always hold: deltaReserves + deltaTreasury = 0
Constructors
| InstantaneousRewards | |
Fields
| |
Instances
data LedgerState era Source #
The state associated with a Ledger.
Constructors
| LedgerState | |
Fields
| |
Instances
The state used by the POOL rule, which tracks stake pool information.
Constructors
| PState | |
Fields
| |
Instances
| ToJSON (PState era) | |
| Generic (PState era) | |
| Show (PState era) | |
| (Era era, DecShareCBOR (PState era)) ⇒ DecCBOR (PState era) | |
| DecShareCBOR (PState era) | |
| Era era ⇒ EncCBOR (PState era) | |
| Default (PState era) | |
Defined in Cardano.Ledger.State.CertState | |
| NFData (PState era) | |
Defined in Cardano.Ledger.State.CertState | |
| Eq (PState era) | |
| NoThunks (PState era) | |
| type Rep (PState era) | |
Defined in Cardano.Ledger.State.CertState type Rep (PState era) = D1 ('MetaData "PState" "Cardano.Ledger.State.CertState" "cardano-ledger-core-1.18.0.0-inplace" 'False) (C1 ('MetaCons "PState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "psStakePoolParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) PoolParams)) :*: S1 ('MetaSel ('Just "psFutureStakePoolParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) PoolParams))) :*: (S1 ('MetaSel ('Just "psRetiring") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) EpochNo)) :*: S1 ('MetaSel ('Just "psDeposits") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) Coin))))) | |
| type Share (PState era) | |
type RewardAccounts = Map (Credential 'Staking) Coin Source #
Deprecated: In favor of Map (Credential Staking) Coin
data RewardUpdate Source #
The ultimate goal of a reward update computation. Aggregating rewards for each staking credential.
Constructors
| RewardUpdate | |
Instances
data RewardSnapShot Source #
To complete the reward update, we need a snap shot of the EpochState particular to this computation
Constructors
| RewardSnapShot | |
Fields
| |
Instances
There is a serious invariant that we must maintain in the UTxOState. Given (UTxOState utxo _ _ _ istake) it must be the case that Of course computing the RHS of the above equality can be very expensive, so we only use this route in the testing function smartUTxO. But we are very careful, wherever we update the UTxO, we carefully make INCREMENTAL changes to istake to maintain this invariant. This happens in the UTxO rule.
Constructors
| UTxOState | |
Fields
| |
Instances
smartUTxOState ∷ EraStake era ⇒ PParams era → UTxO era → Coin → Coin → GovState era → Coin → UTxOState era Source #
A valid (or self-consistent) UTxOState{utxosUtxo, utxosDeposited , utxosFees , utxosPpups , utxosStakeDistr} maintains an invariant between the utxosUtxo and utxosStakeDistr fields. the utxosStakeDistr field is the aggregation of Coin over the StakeReferences in the UTxO. It can be computed by a pure function from the _utxo field. In some situations, mostly unit or example tests, or when initializing a small UTxO, we want to create a UTxOState that computes the utxosStakeDistr from the utxosUtxo. This is aways safe to do, but if the utxosUtxo field is big, this can be very expensive, which defeats the purpose of memoizing the utxosStakeDistr field. So use of this function should be restricted to tests and initializations, where the invariant should be maintained.
TO IncrementalStake
mkShelleyCertState ∷ EraCertState era ⇒ PState era → DState era → CertState era Source #
data ShelleyCertState era Source #
Constructors
| ShelleyCertState | |
Fields
| |
Instances
Genesis State
genesisState ∷ ∀ era. (EraGov era, EraCertState era, EraStake era) ⇒ Map (KeyHash 'Genesis) GenDelegPair → UTxO era → LedgerState era Source #
Creates the ledger state for an empty ledger which contains the specified transaction outputs.
Validation
produced ∷ (EraUTxO era, EraCertState era) ⇒ PParams era → CertState era → TxBody era → Value era Source #
Compute the lovelace which are created by the transaction For eras before Conway, VState is expected to have an empty Map for vsDReps, and so deposit summed up is zero.
DelegationState
payPoolDeposit ∷ EraPParams era ⇒ KeyHash 'StakePool → PParams era → PState era → PState era Source #
One only pays a deposit on the initial pool registration. So return the the Deposits unchanged if the keyhash already exists. There are legal situations where a pool may be registered multiple times.
totalObligation ∷ (EraGov era, EraCertState era) ⇒ CertState era → GovState era → Coin Source #
allObligations ∷ (EraGov era, EraCertState era) ⇒ CertState era → GovState era → Obligations Source #
Epoch boundary
applyRUpd ∷ (EraGov era, EraCertState era) ⇒ RewardUpdate → EpochState era → EpochState era Source #
Apply a RewardUpdate to the EpochState. Does several things 1) Adds reward coins to Rewards component of the UMap field of the DState, for actively delegated Stake 2) Adds to the Treasury of the ChainAccountState for non-actively delegated stake 3) Adds fees to the UTxOState
applyRUpdFiltered ∷ (EraGov era, EraCertState era) ⇒ RewardUpdate → EpochState era → (EpochState era, FilteredRewards era) Source #
filterAllRewards ∷ (EraGov era, EraCertState era) ⇒ Map (Credential 'Staking) (Set Reward) → EpochState era → FilteredRewards era Source #
data FilteredRewards era Source #
Constructors
| FilteredRewards | |
Fields
| |
Instances
| NFData (FilteredRewards era) Source # | |
Defined in Cardano.Ledger.Shelley.LedgerState.IncrementalStake Methods rnf ∷ FilteredRewards era → () # | |
createRUpd ∷ ∀ era. (EraGov era, EraCertState era) ⇒ EpochSize → BlocksMade → EpochState era → Coin → ActiveSlotCoeff → NonZero Word64 → ShelleyBase RewardUpdate Source #
To create a reward update, run all 3 phases This function is not used in the rules, so it ignores RewardEvents
completeRupd ∷ PulsingRewUpdate → ShelleyBase (RewardUpdate, RewardEvent) Source #
Phase 3 of reward update has several parts a) completeM the pulser (in case there are still computions to run) b) Combine the pulser provenance with the RewardProvenance c) Construct the final RewardUpdate d) Add the leader rewards to both the events and the computed Rewards
startStep ∷ ∀ era. (EraGov era, EraCertState era) ⇒ EpochSize → BlocksMade → EpochState era → Coin → ActiveSlotCoeff → NonZero Word64 → PulsingRewUpdate Source #
pulseStep ∷ PulsingRewUpdate → ShelleyBase (PulsingRewUpdate, RewardEvent) Source #
Run the pulser for a bit. If is has nothing left to do, complete it.
data NewEpochState era Source #
New Epoch state and environment
Constructors
| NewEpochState !EpochNo !BlocksMade !BlocksMade !(EpochState era) !(StrictMaybe PulsingRewUpdate) !PoolDistr !(StashedAVVMAddresses era) |
Instances
type family StashedAVVMAddresses era where ... Source #
Equations
| StashedAVVMAddresses ShelleyEra = UTxO ShelleyEra | |
| StashedAVVMAddresses _ = () |
stashedAVVMAddresses ∷ NewEpochState era → StashedAVVMAddresses era Source #
AVVM addresses to be removed at the end of the Shelley era. Note that the existence of this field is a hack, related to the transition of UTxO to disk. We remove AVVM addresses from the UTxO on the Shelley/Allegra boundary. However, by this point the UTxO will be moved to disk, and hence doing a scan of the UTxO for AVVM addresses will be expensive. Our solution to this is to do a scan of the UTxO on the Byron/Shelley boundary (since Byron UTxO are still on disk), stash the results here, and then remove them at the Shelley/Allegra boundary.
This is very much an awkward implementation hack, and hence we hide it from as many places as possible.
getGKeys ∷ EraCertState era ⇒ NewEpochState era → Set (KeyHash 'Genesis) Source #
updateNES ∷ EraGov era ⇒ NewEpochState era → BlocksMade → LedgerState era → NewEpochState era Source #
Update new epoch state
circulation ∷ EpochState era → Coin → Coin Source #
Calculate the current circulation
This is used in the rewards calculation, and for API endpoints for pool ranking.
Decay
Remove Bootstrap Redeem Addresses
returnRedeemAddrsToReserves ∷ ∀ era. EraTxOut era ⇒ EpochState era → EpochState era Source #
updateNonMyopic ∷ NonMyopic → Coin → Map (KeyHash 'StakePool) Likelihood → NonMyopic Source #
Check whether the new protocol version is a legitimate version bump with respect to the previous one.
availableAfterMIR ∷ MIRPot → ChainAccountState → InstantaneousRewards → Coin Source #
This function returns the coin balance of a given pot, either the reserves or the treasury, after the instantaneous rewards and pot transfers are accounted for.
data ShelleyGovState era Source #
Constructors
| ShelleyGovState | |
Fields
| |
Instances
Lenses from Types
nesEsL ∷ Lens' (NewEpochState era) (EpochState era) Source #
unifiedL ∷ EraCertState era ⇒ Lens' (NewEpochState era) UMap Source #
nesRuL ∷ Lens' (NewEpochState era) (StrictMaybe PulsingRewUpdate) Source #
nesStashedAVVMAddressesL ∷ Lens' (NewEpochState era) (StashedAVVMAddresses era) Source #
nesEpochStateL ∷ Lens' (NewEpochState era) (EpochState era) Source #
esAccountStateL ∷ Lens' (EpochState era) ChainAccountState Source #
Deprecated: In favor of chainAccountStateL
esSnapshotsL ∷ Lens' (EpochState era) SnapShots Source #
esLStateL ∷ Lens' (EpochState era) (LedgerState era) Source #
esNonMyopicL ∷ Lens' (EpochState era) NonMyopic Source #
curPParamsEpochStateL ∷ EraGov era ⇒ Lens' (EpochState era) (PParams era) Source #
prevPParamsEpochStateL ∷ EraGov era ⇒ Lens' (EpochState era) (PParams era) Source #
futurePParamsEpochStateL ∷ EraGov era ⇒ Lens' (EpochState era) (FuturePParams era) Source #
asTreasuryL ∷ Lens' ChainAccountState Coin Source #
Deprecated: In favor of casTreasuryL
asReservesL ∷ Lens' ChainAccountState Coin Source #
Deprecated: In favor of casReservesL
lsUTxOStateL ∷ Lens' (LedgerState era) (UTxOState era) Source #
lsCertStateL ∷ Lens' (LedgerState era) (CertState era) Source #
epochStateGovStateL ∷ Lens' (EpochState era) (GovState era) Source #
epochStateStakeDistrL ∷ Lens' (EpochState era) (VMap VB VP (Credential 'Staking) (CompactForm Coin)) Source #
epochStateUMapL ∷ EraCertState era ⇒ Lens' (EpochState era) UMap Source #
epochStatePoolParamsL ∷ EraCertState era ⇒ Lens' (EpochState era) (Map (KeyHash 'StakePool) PoolParams) Source #
epochStateDonationL ∷ Lens' (EpochState era) Coin Source #
newEpochStateGovStateL ∷ Lens' (NewEpochState era) (GovState era) Source #
epochStateTreasuryL ∷ Lens' (EpochState era) Coin Source #
Deprecated: In favor of treasuryL
Lenses from CertState
dsIRewardsL ∷ Lens' (DState era) InstantaneousRewards Source #
dsFutureGenDelegsL ∷ Lens' (DState era) (Map FutureGenDeleg GenDelegPair) Source #
psStakePoolParamsL ∷ Lens' (PState era) (Map (KeyHash 'StakePool) PoolParams) Source #
psFutureStakePoolParamsL ∷ Lens' (PState era) (Map (KeyHash 'StakePool) PoolParams) Source #
Lenses from SnapShot(s)
ssStakeDistrL ∷ Lens' SnapShot (VMap VB VP (Credential 'Staking) (CompactForm Coin)) Source #