Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Shelley.LedgerState

Contents

UTxO
Others to organize
Genesis State
Validation
DelegationState
Epoch boundary
Decay
Remove Bootstrap Redeem Addresses
Lenses from Types
Lenses from CertState
Lenses from SnapShot(s)

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 {
- unUTxO ∷ Map TxIn (TxOut era)
}
class CanGetUTxO (t ∷ Type → Type) where
- utxoG ∷ SimpleGetter (t era) (UTxO era)
class CanGetUTxO t ⇒ CanSetUTxO (t ∷ Type → Type) where
- utxoL ∷ Lens' (t era) (UTxO era)
data AccountState = AccountState {
- asTreasury ∷ !Coin
- asReserves ∷ !Coin
}
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), Generic (CertState era)) ⇒ EraCertState era where
- type CertState era = (r ∷ Type) | r → era
- mkCertState ∷ VState era → PState era → DState era → CertState era
- upgradeCertState ∷ CertState (PreviousEra era) → CertState era
- certDStateL ∷ Lens' (CertState era) (DState era)
- certPStateL ∷ Lens' (CertState era) (PState era)
- certVStateL ∷ Lens' (CertState era) (VState 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 {
- dsUnified ∷ !UMap
- dsFutureGenDelegs ∷ !(Map FutureGenDeleg GenDelegPair)
- dsGenDelegs ∷ !GenDelegs
- dsIRewards ∷ !InstantaneousRewards
}
data VState era = VState {
- vsDReps ∷ !(Map (Credential 'DRepRole) DRepState)
- vsCommitteeState ∷ !(CommitteeState era)
- vsNumDormantEpochs ∷ !EpochNo
}
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 {
- esAccountState ∷ !AccountState
- esLState ∷ !(LedgerState era)
- esSnapshots ∷ !SnapShots
- esNonMyopic ∷ !NonMyopic
}
data PulsingRewUpdate
- = Pulsing !RewardSnapShot !Pulser
- | Complete !RewardUpdate
data FutureGenDeleg = FutureGenDeleg {
- fGenDelegSlot ∷ !SlotNo
- fGenDelegGenKeyHash ∷ !(KeyHash 'Genesis)
}
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 {
- deltaT ∷ !DeltaCoin
- deltaR ∷ !DeltaCoin
- rs ∷ !(Map (Credential 'Staking) (Set Reward))
- deltaF ∷ !DeltaCoin
- nonMyopic ∷ !NonMyopic
}
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)
- utxosStakeDistr ∷ !IncrementalStake
- utxosDonation ∷ !Coin
}
smartUTxOState ∷ EraTxOut era ⇒ PParams era → UTxO era → Coin → Coin → GovState era → Coin → UTxOState era
data IncrementalStake = IStake {
- credMap ∷ !(Map (Credential 'Staking) (CompactForm Coin))
- ptrMap ∷ !(Map Ptr (CompactForm Coin))
}
genesisState ∷ ∀ era. (EraGov era, EraCertState era) ⇒ Map (KeyHash 'Genesis) GenDelegPair → UTxO era → LedgerState era
consumed ∷ (EraUTxO era, EraCertState 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
incrementalStakeDistr ∷ ∀ era. EraPParams era ⇒ PParams era → IncrementalStake → DState era → PState era → SnapShot
updateStakeDistribution ∷ EraTxOut era ⇒ PParams era → IncrementalStake → UTxO era → UTxO era → IncrementalStake
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 → AccountState → 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) AccountState
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' AccountState Coin
asReservesL ∷ Lens' AccountState 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)
utxosStakeDistrL ∷ Lens' (UTxOState era) IncrementalStake
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)
epochStateRegDrepL ∷ EraCertState era ⇒ Lens' (EpochState era) (Map (Credential 'DRepRole) DRepState)
epochStateIncrStakeDistrL ∷ Lens' (EpochState era) (Map (Credential 'Staking) (CompactForm Coin))
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)
vsDRepsL ∷ Lens' (VState era) (Map (Credential 'DRepRole) DRepState)
vsCommitteeStateL ∷ Lens' (VState era) (CommitteeState era)
credMapL ∷ Lens' IncrementalStake (Map (Credential 'Staking) (CompactForm Coin))
ptrMapL ∷ Lens' IncrementalStake (Map Ptr (CompactForm 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

newtype UTxO era Source #

The unspent transaction outputs.

Constructors

UTxO
Fields unUTxO ∷ Map TxIn (TxOut era)

Instances

Instances details

CanGetUTxO UTxO
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoG ∷ SimpleGetter (UTxO era) (UTxO era) Source #
CanSetUTxO UTxO
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoL ∷ Lens' (UTxO era) (UTxO era) Source #
ToJSON (TxOut era) ⇒ ToJSON (UTxO era)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
Instance details Defined in Cardano.Ledger.State.UTxO Methods def ∷ UTxO era Source #
(Era era, NFData (TxOut era)) ⇒ NFData (UTxO era)
Instance details Defined in Cardano.Ledger.State.UTxO Methods rnf ∷ UTxO era → () #
(Era era, Eq (TxOut era)) ⇒ Eq (UTxO era)
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)
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)
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)
Instance details Defined in Cardano.Ledger.State.UTxO type Share (UTxO era) = Interns (Credential 'Staking)

class CanGetUTxO (t ∷ Type → Type) where Source #

Minimal complete definition

Nothing

Methods

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

Instances

Instances details

CanGetUTxO UTxO
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoG ∷ SimpleGetter (UTxO era) (UTxO era) Source #
CanGetUTxO EpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (EpochState era) (UTxO era) Source #
CanGetUTxO LedgerState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (LedgerState era) (UTxO era) Source #
CanGetUTxO NewEpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (NewEpochState era) (UTxO era) Source #
CanGetUTxO UTxOState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (UTxOState era) (UTxO era) Source #

class CanGetUTxO t ⇒ CanSetUTxO (t ∷ Type → Type) where Source #

Methods

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

Instances

Instances details

CanSetUTxO UTxO
Instance details Defined in Cardano.Ledger.State.UTxO Methods utxoL ∷ Lens' (UTxO era) (UTxO era) Source #
CanSetUTxO EpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (EpochState era) (UTxO era) Source #
CanSetUTxO LedgerState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (LedgerState era) (UTxO era) Source #
CanSetUTxO NewEpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (NewEpochState era) (UTxO era) Source #
CanSetUTxO UTxOState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (UTxOState era) (UTxO era) Source #

Others to organize

data AccountState Source #

Constructors

AccountState
Fields asTreasury ∷ !Coin asReserves ∷ !Coin

Instances

Instances details

ToJSON AccountState
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
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
Instance details Defined in Cardano.Ledger.State.AccountState Methods showsPrec ∷ Int → AccountState → ShowS # show ∷ AccountState → String # showList ∷ [AccountState] → ShowS #
DecCBOR AccountState
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
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
Instance details Defined in Cardano.Ledger.State.AccountState Methods def ∷ AccountState Source #
NFData AccountState
Instance details Defined in Cardano.Ledger.State.AccountState Methods rnf ∷ AccountState → () #
Eq AccountState
Instance details Defined in Cardano.Ledger.State.AccountState Methods (==) ∷ AccountState → AccountState → Bool # (/=) ∷ AccountState → AccountState → Bool #
NoThunks AccountState
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
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 (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), Generic (CertState era)) ⇒ EraCertState era where Source #

The state associated with the DELPL rule, which combines the DELEG rule and the POOL rule.

Associated Types

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

Methods

mkCertState ∷ VState era → PState era → DState era → CertState era Source #

upgradeCertState ∷ CertState (PreviousEra era) → CertState era Source #

certDStateL ∷ Lens' (CertState era) (DState era) Source #

certPStateL ∷ Lens' (CertState era) (PState era) Source #

certVStateL ∷ Lens' (CertState era) (VState 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

Instances details

EraCertState ShelleyEra Source #

Instance details

Defined in Cardano.Ledger.Shelley.CertState

Associated Types

type CertState ShelleyEra = (r ∷ Type) Source #

Methods

mkCertState ∷ VState ShelleyEra → PState ShelleyEra → DState ShelleyEra → CertState ShelleyEra Source #

upgradeCertState ∷ CertState (PreviousEra ShelleyEra) → CertState ShelleyEra Source #

certDStateL ∷ Lens' (CertState ShelleyEra) (DState ShelleyEra) Source #

certPStateL ∷ Lens' (CertState ShelleyEra) (PState ShelleyEra) Source #

certVStateL ∷ Lens' (CertState ShelleyEra) (VState 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 #

data DState era Source #

The state used by the DELEG rule, which roughly tracks stake delegation and some governance features.

Constructors

DState

Fields

dsUnified ∷ !UMap
Unified Reward Maps. This contains the reward map (which is the source of truth regarding the registered stake credentials, the deposit map, the delegation map, and the stake credential pointer map.
dsFutureGenDelegs ∷ !(Map FutureGenDeleg GenDelegPair)
Future genesis key delegations
dsGenDelegs ∷ !GenDelegs
Genesis key delegations
dsIRewards ∷ !InstantaneousRewards
Instantaneous Rewards

Instances

Instances details

ToJSON (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods toJSON ∷ DState era → Value Source # toEncoding ∷ DState era → Encoding Source # toJSONList ∷ [DState era] → Value Source # toEncodingList ∷ [DState era] → Encoding Source # omitField ∷ DState era → Bool Source #
Generic (DState era)
Instance details Defined in Cardano.Ledger.CertState Associated Types type Rep (DState era) ∷ Type → Type # Methods from ∷ DState era → Rep (DState era) x # to ∷ Rep (DState era) x → DState era #
Show (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods showsPrec ∷ Int → DState era → ShowS # show ∷ DState era → String # showList ∷ [DState era] → ShowS #
DecShareCBOR (DState era)
Instance details Defined in Cardano.Ledger.CertState Associated Types type Share (DState era) Source # Methods getShare ∷ DState era → Share (DState era) Source # decShareCBOR ∷ Share (DState era) → Decoder s (DState era) Source # decSharePlusCBOR ∷ StateT (Share (DState era)) (Decoder s) (DState era) Source #
Era era ⇒ EncCBOR (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods encCBOR ∷ DState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (DState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [DState era] → Size Source #
Default (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods def ∷ DState era Source #
NFData (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods rnf ∷ DState era → () #
Eq (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods (==) ∷ DState era → DState era → Bool # (/=) ∷ DState era → DState era → Bool #
NoThunks (DState era)
Instance details Defined in Cardano.Ledger.CertState Methods noThunks ∷ Context → DState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → DState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (DState era) → String Source #
type Rep (DState era)
Instance details Defined in Cardano.Ledger.CertState type Rep (DState era) = D1 ('MetaData "DState" "Cardano.Ledger.CertState" "cardano-ledger-core-1.17.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)
Instance details Defined in Cardano.Ledger.CertState type Share (DState era) = (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole))

data VState era Source #

The state that tracks the voting entities (DReps and Constitutional Committee members). In the formal ledger specification this type is called GState

Constructors

VState

Fields

vsDReps ∷ !(Map (Credential 'DRepRole) DRepState)
vsCommitteeState ∷ !(CommitteeState era)
vsNumDormantEpochs ∷ !EpochNo
Number of contiguous epochs in which there are exactly zero active governance proposals to vote on. It is incremented in every EPOCH rule if the number of active governance proposals to vote on continues to be zero. It is reset to zero when a new governance action is successfully proposed. We need this counter in order to bump DRep expiries through dormant periods when DReps do not have an opportunity to vote on anything.

Instances

Instances details

ToJSON (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods toJSON ∷ VState era → Value Source # toEncoding ∷ VState era → Encoding Source # toJSONList ∷ [VState era] → Value Source # toEncodingList ∷ [VState era] → Encoding Source # omitField ∷ VState era → Bool Source #
Generic (VState era)
Instance details Defined in Cardano.Ledger.CertState Associated Types type Rep (VState era) ∷ Type → Type # Methods from ∷ VState era → Rep (VState era) x # to ∷ Rep (VState era) x → VState era #
Show (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods showsPrec ∷ Int → VState era → ShowS # show ∷ VState era → String # showList ∷ [VState era] → ShowS #
Era era ⇒ DecCBOR (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods decCBOR ∷ Decoder s (VState era) Source # dropCBOR ∷ Proxy (VState era) → Decoder s () Source # label ∷ Proxy (VState era) → Text Source #
Era era ⇒ DecShareCBOR (VState era)
Instance details Defined in Cardano.Ledger.CertState Associated Types type Share (VState era) Source # Methods getShare ∷ VState era → Share (VState era) Source # decShareCBOR ∷ Share (VState era) → Decoder s (VState era) Source # decSharePlusCBOR ∷ StateT (Share (VState era)) (Decoder s) (VState era) Source #
Era era ⇒ EncCBOR (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods encCBOR ∷ VState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (VState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [VState era] → Size Source #
Default (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods def ∷ VState era Source #
NFData (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods rnf ∷ VState era → () #
Eq (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods (==) ∷ VState era → VState era → Bool # (/=) ∷ VState era → VState era → Bool #
NoThunks (VState era)
Instance details Defined in Cardano.Ledger.CertState Methods noThunks ∷ Context → VState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → VState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (VState era) → String Source #
type Rep (VState era)
Instance details Defined in Cardano.Ledger.CertState type Rep (VState era) = D1 ('MetaData "VState" "Cardano.Ledger.CertState" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "VState" 'PrefixI 'True) (S1 ('MetaSel ('Just "vsDReps") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'DRepRole) DRepState)) :: (S1 ('MetaSel ('Just "vsCommitteeState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CommitteeState era)) :: S1 ('MetaSel ('Just "vsNumDormantEpochs") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 EpochNo))))
type Share (VState era)
Instance details Defined in Cardano.Ledger.CertState type Share (VState era) = (Interns (Credential 'Staking), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole))

rewards ∷ DState era → UView (Credential 'Staking) RDPair Source #

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

esAccountState ∷ !AccountState
esLState ∷ !(LedgerState era)
esSnapshots ∷ !SnapShots
esNonMyopic ∷ !NonMyopic
This field, esNonMyopic, does not appear in the formal spec and is not a part of the protocol. It is only used for providing data to the stake pool ranking calculation getNonMyopicMemberRewards. See https://github.com/intersectmbo/cardano-ledger/releases/latest/download/pool-ranking.pdf

Instances

Instances details

CanGetUTxO EpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (EpochState era) (UTxO era) Source #
CanSetUTxO EpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (EpochState era) (UTxO era) Source #
(EraTxOut era, EraGov era, EraCertState era) ⇒ ToJSON (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toJSON ∷ EpochState era → Value Source # toEncoding ∷ EpochState era → Encoding Source # toJSONList ∷ [EpochState era] → Value Source # toEncodingList ∷ [EpochState era] → Encoding Source # omitField ∷ EpochState era → Bool Source #
Generic (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Rep (EpochState era) ∷ Type → Type # Methods from ∷ EpochState era → Rep (EpochState era) x # to ∷ Rep (EpochState era) x → EpochState era #
(EraTxOut era, Show (GovState era), Show (CertState era)) ⇒ Show (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods showsPrec ∷ Int → EpochState era → ShowS # show ∷ EpochState era → String # showList ∷ [EpochState era] → ShowS #
(EraTxOut era, EraGov era, EraCertState era) ⇒ FromCBOR (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods fromCBOR ∷ Decoder s (EpochState era) Source # label ∷ Proxy (EpochState era) → Text Source #
(EraTxOut era, EraGov era, EraCertState era) ⇒ ToCBOR (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toCBOR ∷ EpochState era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (EpochState era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [EpochState era] → Size Source #
(EraTxOut era, EraGov era, EraCertState era) ⇒ DecCBOR (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods decCBOR ∷ Decoder s (EpochState era) Source # dropCBOR ∷ Proxy (EpochState era) → Decoder s () Source # label ∷ Proxy (EpochState era) → Text Source #
(EraTxOut era, EncCBOR (GovState era), EncCBOR (CertState era)) ⇒ EncCBOR (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods encCBOR ∷ EpochState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (EpochState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [EpochState era] → Size Source #
Default (LedgerState era) ⇒ Default (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods def ∷ EpochState era Source #
(EraTxOut era, NFData (GovState era), NFData (CertState era)) ⇒ NFData (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods rnf ∷ EpochState era → () #
(EraTxOut era, Eq (GovState era), Eq (CertState era)) ⇒ Eq (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods (==) ∷ EpochState era → EpochState era → Bool # (/=) ∷ EpochState era → EpochState era → Bool #
(EraTxOut era, NoThunks (GovState era), NoThunks (CertState era)) ⇒ NoThunks (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods noThunks ∷ Context → EpochState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → EpochState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (EpochState era) → String Source #
type Rep (EpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Rep (EpochState era) = D1 ('MetaData "EpochState" "Cardano.Ledger.Shelley.LedgerState.Types" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "EpochState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "esAccountState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AccountState) :: S1 ('MetaSel ('Just "esLState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (LedgerState era))) :: (S1 ('MetaSel ('Just "esSnapshots") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SnapShots) :*: S1 ('MetaSel ('Just "esNonMyopic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NonMyopic))))

data PulsingRewUpdate Source #

The state used in the STS rules

Constructors

Pulsing !RewardSnapShot !Pulser
Complete !RewardUpdate

Instances

Instances details

ToJSON PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods toJSON ∷ PulsingRewUpdate → Value Source # toEncoding ∷ PulsingRewUpdate → Encoding Source # toJSONList ∷ [PulsingRewUpdate] → Value Source # toEncodingList ∷ [PulsingRewUpdate] → Encoding Source # omitField ∷ PulsingRewUpdate → Bool Source #
Generic PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Associated Types type Rep PulsingRewUpdate ∷ Type → Type # Methods from ∷ PulsingRewUpdate → Rep PulsingRewUpdate x # to ∷ Rep PulsingRewUpdate x → PulsingRewUpdate #
Show PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods showsPrec ∷ Int → PulsingRewUpdate → ShowS # show ∷ PulsingRewUpdate → String # showList ∷ [PulsingRewUpdate] → ShowS #
DecCBOR PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods decCBOR ∷ Decoder s PulsingRewUpdate Source # dropCBOR ∷ Proxy PulsingRewUpdate → Decoder s () Source # label ∷ Proxy PulsingRewUpdate → Text Source #
EncCBOR PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods encCBOR ∷ PulsingRewUpdate → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy PulsingRewUpdate → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [PulsingRewUpdate] → Size Source #
NFData PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods rnf ∷ PulsingRewUpdate → () #
Eq PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods (==) ∷ PulsingRewUpdate → PulsingRewUpdate → Bool # (/=) ∷ PulsingRewUpdate → PulsingRewUpdate → Bool #
NoThunks PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods noThunks ∷ Context → PulsingRewUpdate → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PulsingRewUpdate → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy PulsingRewUpdate → String Source #
type Rep PulsingRewUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate type Rep PulsingRewUpdate = D1 ('MetaData "PulsingRewUpdate" "Cardano.Ledger.Shelley.RewardUpdate" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "Pulsing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RewardSnapShot) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Pulser)) :+: C1 ('MetaCons "Complete" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RewardUpdate)))

data FutureGenDeleg Source #

Constructors

FutureGenDeleg
Fields fGenDelegSlot ∷ !SlotNo fGenDelegGenKeyHash ∷ !(KeyHash 'Genesis)

Instances

Instances details

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

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 iRReserves ∷ !(Map (Credential 'Staking) Coin) iRTreasury ∷ !(Map (Credential 'Staking) Coin) deltaReserves ∷ !DeltaCoin deltaTreasury ∷ !DeltaCoin

Instances

Instances details

ToJSON InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods toJSON ∷ InstantaneousRewards → Value Source # toEncoding ∷ InstantaneousRewards → Encoding Source # toJSONList ∷ [InstantaneousRewards] → Value Source # toEncodingList ∷ [InstantaneousRewards] → Encoding Source # omitField ∷ InstantaneousRewards → Bool Source #
Generic InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Associated Types type Rep InstantaneousRewards ∷ Type → Type # Methods from ∷ InstantaneousRewards → Rep InstantaneousRewards x # to ∷ Rep InstantaneousRewards x → InstantaneousRewards #
Show InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods showsPrec ∷ Int → InstantaneousRewards → ShowS # show ∷ InstantaneousRewards → String # showList ∷ [InstantaneousRewards] → ShowS #
DecShareCBOR InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Associated Types type Share InstantaneousRewards Source # Methods getShare ∷ InstantaneousRewards → Share InstantaneousRewards Source # decShareCBOR ∷ Share InstantaneousRewards → Decoder s InstantaneousRewards Source # decSharePlusCBOR ∷ StateT (Share InstantaneousRewards) (Decoder s) InstantaneousRewards Source #
EncCBOR InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods encCBOR ∷ InstantaneousRewards → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy InstantaneousRewards → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [InstantaneousRewards] → Size Source #
Default InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods def ∷ InstantaneousRewards Source #
NFData InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods rnf ∷ InstantaneousRewards → () #
Eq InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods (==) ∷ InstantaneousRewards → InstantaneousRewards → Bool # (/=) ∷ InstantaneousRewards → InstantaneousRewards → Bool #
NoThunks InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState Methods noThunks ∷ Context → InstantaneousRewards → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → InstantaneousRewards → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy InstantaneousRewards → String Source #
type Rep InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState type Rep InstantaneousRewards = D1 ('MetaData "InstantaneousRewards" "Cardano.Ledger.CertState" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "InstantaneousRewards" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iRReserves") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) Coin)) :: S1 ('MetaSel ('Just "iRTreasury") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) Coin))) :: (S1 ('MetaSel ('Just "deltaReserves") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DeltaCoin) :*: S1 ('MetaSel ('Just "deltaTreasury") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DeltaCoin))))
type Share InstantaneousRewards
Instance details Defined in Cardano.Ledger.CertState type Share InstantaneousRewards = Interns (Credential 'Staking)

data LedgerState era Source #

The state associated with a Ledger.

Constructors

LedgerState
Fields lsUTxOState ∷ !(UTxOState era) The current unspent transaction outputs. lsCertState ∷ !(CertState era)

Instances

Instances details

CanGetUTxO LedgerState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (LedgerState era) (UTxO era) Source #
CanSetUTxO LedgerState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (LedgerState era) (UTxO era) Source #
(EraTxOut era, EraGov era, EraCertState era) ⇒ ToJSON (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toJSON ∷ LedgerState era → Value Source # toEncoding ∷ LedgerState era → Encoding Source # toJSONList ∷ [LedgerState era] → Value Source # toEncodingList ∷ [LedgerState era] → Encoding Source # omitField ∷ LedgerState era → Bool Source #
Generic (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Rep (LedgerState era) ∷ Type → Type # Methods from ∷ LedgerState era → Rep (LedgerState era) x # to ∷ Rep (LedgerState era) x → LedgerState era #
(EraTxOut era, Show (GovState era), Show (CertState era)) ⇒ Show (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods showsPrec ∷ Int → LedgerState era → ShowS # show ∷ LedgerState era → String # showList ∷ [LedgerState era] → ShowS #
(EraTxOut era, EraGov era, EraCertState era) ⇒ FromCBOR (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods fromCBOR ∷ Decoder s (LedgerState era) Source # label ∷ Proxy (LedgerState era) → Text Source #
(EraTxOut era, EraGov era, EraCertState era) ⇒ ToCBOR (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toCBOR ∷ LedgerState era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (LedgerState era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [LedgerState era] → Size Source #
(EraTxOut era, EraGov era, EraCertState era) ⇒ DecShareCBOR (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Share (LedgerState era) Source # Methods getShare ∷ LedgerState era → Share (LedgerState era) Source # decShareCBOR ∷ Share (LedgerState era) → Decoder s (LedgerState era) Source # decSharePlusCBOR ∷ StateT (Share (LedgerState era)) (Decoder s) (LedgerState era) Source #
(EraTxOut era, EncCBOR (GovState era), EncCBOR (CertState era)) ⇒ EncCBOR (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods encCBOR ∷ LedgerState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (LedgerState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [LedgerState era] → Size Source #
(Default (UTxOState era), Default (CertState era)) ⇒ Default (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods def ∷ LedgerState era Source #
(EraTxOut era, NFData (GovState era), NFData (CertState era)) ⇒ NFData (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods rnf ∷ LedgerState era → () #
(EraTxOut era, Eq (GovState era), Eq (CertState era)) ⇒ Eq (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods (==) ∷ LedgerState era → LedgerState era → Bool # (/=) ∷ LedgerState era → LedgerState era → Bool #
(EraTxOut era, NoThunks (GovState era), NoThunks (CertState era)) ⇒ NoThunks (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods noThunks ∷ Context → LedgerState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → LedgerState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (LedgerState era) → String Source #
type Rep (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Rep (LedgerState era) = D1 ('MetaData "LedgerState" "Cardano.Ledger.Shelley.LedgerState.Types" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "LedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "lsUTxOState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (UTxOState era)) :*: S1 ('MetaSel ('Just "lsCertState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CertState era))))
type Share (LedgerState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Share (LedgerState era) = (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole))

data PState era Source #

The state used by the POOL rule, which tracks stake pool information.

Constructors

PState

Fields

psStakePoolParams ∷ !(Map (KeyHash 'StakePool) PoolParams)
The stake pool parameters.
psFutureStakePoolParams ∷ !(Map (KeyHash 'StakePool) PoolParams)
The future stake pool parameters. Changes to existing stake pool parameters are staged in order to give delegators time to react to changes. See section 11.2, "Example Illustration of the Reward Cycle", of the Shelley Ledger Specification for a sequence diagram.
psRetiring ∷ !(Map (KeyHash 'StakePool) EpochNo)
A map of retiring stake pools to the epoch when they retire.
psDeposits ∷ !(Map (KeyHash 'StakePool) Coin)
A map of the deposits for each pool

Instances

Instances details

ToJSON (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods toJSON ∷ PState era → Value Source # toEncoding ∷ PState era → Encoding Source # toJSONList ∷ [PState era] → Value Source # toEncodingList ∷ [PState era] → Encoding Source # omitField ∷ PState era → Bool Source #
Generic (PState era)
Instance details Defined in Cardano.Ledger.CertState Associated Types type Rep (PState era) ∷ Type → Type # Methods from ∷ PState era → Rep (PState era) x # to ∷ Rep (PState era) x → PState era #
Show (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods showsPrec ∷ Int → PState era → ShowS # show ∷ PState era → String # showList ∷ [PState era] → ShowS #
(Era era, DecShareCBOR (PState era)) ⇒ DecCBOR (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods decCBOR ∷ Decoder s (PState era) Source # dropCBOR ∷ Proxy (PState era) → Decoder s () Source # label ∷ Proxy (PState era) → Text Source #
DecShareCBOR (PState era)
Instance details Defined in Cardano.Ledger.CertState Associated Types type Share (PState era) Source # Methods getShare ∷ PState era → Share (PState era) Source # decShareCBOR ∷ Share (PState era) → Decoder s (PState era) Source # decSharePlusCBOR ∷ StateT (Share (PState era)) (Decoder s) (PState era) Source #
Era era ⇒ EncCBOR (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods encCBOR ∷ PState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (PState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [PState era] → Size Source #
Default (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods def ∷ PState era Source #
NFData (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods rnf ∷ PState era → () #
Eq (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods (==) ∷ PState era → PState era → Bool # (/=) ∷ PState era → PState era → Bool #
NoThunks (PState era)
Instance details Defined in Cardano.Ledger.CertState Methods noThunks ∷ Context → PState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PState era) → String Source #
type Rep (PState era)
Instance details Defined in Cardano.Ledger.CertState type Rep (PState era) = D1 ('MetaData "PState" "Cardano.Ledger.CertState" "cardano-ledger-core-1.17.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)
Instance details Defined in Cardano.Ledger.CertState type Share (PState era) = Interns (KeyHash 'StakePool)

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
Fields deltaT ∷ !DeltaCoin deltaR ∷ !DeltaCoin rs ∷ !(Map (Credential 'Staking) (Set Reward)) deltaF ∷ !DeltaCoin nonMyopic ∷ !NonMyopic

Instances

Instances details

ToJSON RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods toJSON ∷ RewardUpdate → Value Source # toEncoding ∷ RewardUpdate → Encoding Source # toJSONList ∷ [RewardUpdate] → Value Source # toEncodingList ∷ [RewardUpdate] → Encoding Source # omitField ∷ RewardUpdate → Bool Source #
Generic RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Associated Types type Rep RewardUpdate ∷ Type → Type # Methods from ∷ RewardUpdate → Rep RewardUpdate x # to ∷ Rep RewardUpdate x → RewardUpdate #
Show RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods showsPrec ∷ Int → RewardUpdate → ShowS # show ∷ RewardUpdate → String # showList ∷ [RewardUpdate] → ShowS #
DecCBOR RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods decCBOR ∷ Decoder s RewardUpdate Source # dropCBOR ∷ Proxy RewardUpdate → Decoder s () Source # label ∷ Proxy RewardUpdate → Text Source #
EncCBOR RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods encCBOR ∷ RewardUpdate → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy RewardUpdate → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [RewardUpdate] → Size Source #
NFData RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods rnf ∷ RewardUpdate → () #
Eq RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods (==) ∷ RewardUpdate → RewardUpdate → Bool # (/=) ∷ RewardUpdate → RewardUpdate → Bool #
NoThunks RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods noThunks ∷ Context → RewardUpdate → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → RewardUpdate → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy RewardUpdate → String Source #
type Rep RewardUpdate Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate type Rep RewardUpdate = D1 ('MetaData "RewardUpdate" "Cardano.Ledger.Shelley.RewardUpdate" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "RewardUpdate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deltaT") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DeltaCoin) :: S1 ('MetaSel ('Just "deltaR") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DeltaCoin)) :: (S1 ('MetaSel ('Just "rs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) (Set Reward))) :: (S1 ('MetaSel ('Just "deltaF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DeltaCoin) :: S1 ('MetaSel ('Just "nonMyopic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NonMyopic)))))

data RewardSnapShot Source #

To complete the reward update, we need a snap shot of the EpochState particular to this computation

Constructors

RewardSnapShot
Fields rewFees ∷ !Coin rewProtocolVersion ∷ !ProtVer rewNonMyopic ∷ !NonMyopic rewDeltaR1 ∷ !Coin rewR ∷ !Coin rewDeltaT1 ∷ !Coin rewLikelihoods ∷ !(Map (KeyHash 'StakePool) Likelihood) rewLeaders ∷ !(Map (Credential 'Staking) (Set Reward))

Instances

Instances details

Generic RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Associated Types type Rep RewardSnapShot ∷ Type → Type # Methods from ∷ RewardSnapShot → Rep RewardSnapShot x # to ∷ Rep RewardSnapShot x → RewardSnapShot #
Show RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods showsPrec ∷ Int → RewardSnapShot → ShowS # show ∷ RewardSnapShot → String # showList ∷ [RewardSnapShot] → ShowS #
DecCBOR RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods decCBOR ∷ Decoder s RewardSnapShot Source # dropCBOR ∷ Proxy RewardSnapShot → Decoder s () Source # label ∷ Proxy RewardSnapShot → Text Source #
EncCBOR RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods encCBOR ∷ RewardSnapShot → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy RewardSnapShot → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [RewardSnapShot] → Size Source #
NFData RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods rnf ∷ RewardSnapShot → () #
Eq RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods (==) ∷ RewardSnapShot → RewardSnapShot → Bool # (/=) ∷ RewardSnapShot → RewardSnapShot → Bool #
NoThunks RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods noThunks ∷ Context → RewardSnapShot → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → RewardSnapShot → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy RewardSnapShot → String Source #
type Rep RewardSnapShot Source #
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate type Rep RewardSnapShot = D1 ('MetaData "RewardSnapShot" "Cardano.Ledger.Shelley.RewardUpdate" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "RewardSnapShot" 'PrefixI 'True) (((S1 ('MetaSel ('Just "rewFees") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin) :: S1 ('MetaSel ('Just "rewProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtVer)) :: (S1 ('MetaSel ('Just "rewNonMyopic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NonMyopic) :: S1 ('MetaSel ('Just "rewDeltaR1") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin))) :: ((S1 ('MetaSel ('Just "rewR") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin) :: S1 ('MetaSel ('Just "rewDeltaT1") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)) :: (S1 ('MetaSel ('Just "rewLikelihoods") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) Likelihood)) :*: S1 ('MetaSel ('Just "rewLeaders") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) (Set Reward)))))))

data UTxOState era Source #

There is a serious invariant that we must maintain in the UTxOState. Given (UTxOState utxo _ _ _ istake) it must be the case that istake == (updateStakeDistribution (UTxO Map.empty) (UTxO Map.empty) utxo) 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 utxosUtxo ∷ !(UTxO era) utxosDeposited ∷ !Coin utxosFees ∷ !Coin utxosGovState ∷ !(GovState era) utxosStakeDistr ∷ !IncrementalStake utxosDonation ∷ !Coin

Instances

Instances details

CanGetUTxO UTxOState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (UTxOState era) (UTxO era) Source #
CanSetUTxO UTxOState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (UTxOState era) (UTxO era) Source #
(EraTxOut era, EraGov era) ⇒ ToJSON (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toJSON ∷ UTxOState era → Value Source # toEncoding ∷ UTxOState era → Encoding Source # toJSONList ∷ [UTxOState era] → Value Source # toEncodingList ∷ [UTxOState era] → Encoding Source # omitField ∷ UTxOState era → Bool Source #
Generic (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Rep (UTxOState era) ∷ Type → Type # Methods from ∷ UTxOState era → Rep (UTxOState era) x # to ∷ Rep (UTxOState era) x → UTxOState era #
(EraTxOut era, Show (GovState era)) ⇒ Show (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods showsPrec ∷ Int → UTxOState era → ShowS # show ∷ UTxOState era → String # showList ∷ [UTxOState era] → ShowS #
(EraTxOut era, EraGov era) ⇒ FromCBOR (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods fromCBOR ∷ Decoder s (UTxOState era) Source # label ∷ Proxy (UTxOState era) → Text Source #
(EraTxOut era, EraGov era) ⇒ ToCBOR (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toCBOR ∷ UTxOState era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (UTxOState era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [UTxOState era] → Size Source #
(EraTxOut era, EraGov era) ⇒ DecShareCBOR (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Share (UTxOState era) Source # Methods getShare ∷ UTxOState era → Share (UTxOState era) Source # decShareCBOR ∷ Share (UTxOState era) → Decoder s (UTxOState era) Source # decSharePlusCBOR ∷ StateT (Share (UTxOState era)) (Decoder s) (UTxOState era) Source #
(EraTxOut era, EncCBOR (GovState era)) ⇒ EncCBOR (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods encCBOR ∷ UTxOState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (UTxOState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [UTxOState era] → Size Source #
EraGov era ⇒ Default (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods def ∷ UTxOState era Source #
(EraTxOut era, NFData (GovState era)) ⇒ NFData (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods rnf ∷ UTxOState era → () #
(EraTxOut era, Eq (GovState era)) ⇒ Eq (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods (==) ∷ UTxOState era → UTxOState era → Bool # (/=) ∷ UTxOState era → UTxOState era → Bool #
(NoThunks (UTxO era), NoThunks (GovState era)) ⇒ NoThunks (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods noThunks ∷ Context → UTxOState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → UTxOState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (UTxOState era) → String Source #
type Rep (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Rep (UTxOState era) = D1 ('MetaData "UTxOState" "Cardano.Ledger.Shelley.LedgerState.Types" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "UTxOState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "utxosUtxo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (UTxO era)) :: (S1 ('MetaSel ('Just "utxosDeposited") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin) :: S1 ('MetaSel ('Just "utxosFees") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin))) :: (S1 ('MetaSel ('Just "utxosGovState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (GovState era)) :: (S1 ('MetaSel ('Just "utxosStakeDistr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IncrementalStake) :*: S1 ('MetaSel ('Just "utxosDonation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))))
type Share (UTxOState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Share (UTxOState era) = (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole))

smartUTxOState ∷ EraTxOut 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

data IncrementalStake Source #

Incremental Stake, Stake along with possible missed coins from danging Ptrs. Transactions can use Ptrs to refer to a stake credential in a TxOut. The Ptr does not have to point to anything until the epoch boundary, when we compute rewards and aggregate staking information for ranking. This is unusual but legal. In a non incremental system, we use whatever legal Ptrs exist at the epoch boundary. Here we are computing things incrementally, so we need to remember Ptrs that might point to something by the time the epoch boundary is reached. When the epoch boundary is reached we resolve these pointers, to see if any have become non-dangling since the time they were first used in the incremental computation.

Constructors

IStake
Fields credMap ∷ !(Map (Credential 'Staking) (CompactForm Coin)) ptrMap ∷ !(Map Ptr (CompactForm Coin))

Instances

Instances details

ToJSON IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toJSON ∷ IncrementalStake → Value Source # toEncoding ∷ IncrementalStake → Encoding Source # toJSONList ∷ [IncrementalStake] → Value Source # toEncodingList ∷ [IncrementalStake] → Encoding Source # omitField ∷ IncrementalStake → Bool Source #
Monoid IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods mempty ∷ IncrementalStake # mappend ∷ IncrementalStake → IncrementalStake → IncrementalStake # mconcat ∷ [IncrementalStake] → IncrementalStake #
Semigroup IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods (<>) ∷ IncrementalStake → IncrementalStake → IncrementalStake # sconcat ∷ NonEmpty IncrementalStake → IncrementalStake # stimes ∷ Integral b ⇒ b → IncrementalStake → IncrementalStake #
Generic IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Rep IncrementalStake ∷ Type → Type # Methods from ∷ IncrementalStake → Rep IncrementalStake x # to ∷ Rep IncrementalStake x → IncrementalStake #
Show IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods showsPrec ∷ Int → IncrementalStake → ShowS # show ∷ IncrementalStake → String # showList ∷ [IncrementalStake] → ShowS #
DecShareCBOR IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Share IncrementalStake Source # Methods getShare ∷ IncrementalStake → Share IncrementalStake Source # decShareCBOR ∷ Share IncrementalStake → Decoder s IncrementalStake Source # decSharePlusCBOR ∷ StateT (Share IncrementalStake) (Decoder s) IncrementalStake Source #
EncCBOR IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods encCBOR ∷ IncrementalStake → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy IncrementalStake → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [IncrementalStake] → Size Source #
Default IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods def ∷ IncrementalStake Source #
NFData IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods rnf ∷ IncrementalStake → () #
Eq IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods (==) ∷ IncrementalStake → IncrementalStake → Bool # (/=) ∷ IncrementalStake → IncrementalStake → Bool #
Ord IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods compare ∷ IncrementalStake → IncrementalStake → Ordering # (<) ∷ IncrementalStake → IncrementalStake → Bool # (<=) ∷ IncrementalStake → IncrementalStake → Bool # (>) ∷ IncrementalStake → IncrementalStake → Bool # (>=) ∷ IncrementalStake → IncrementalStake → Bool # max ∷ IncrementalStake → IncrementalStake → IncrementalStake # min ∷ IncrementalStake → IncrementalStake → IncrementalStake #
Group IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods invert ∷ IncrementalStake → IncrementalStake Source # (~~) ∷ IncrementalStake → IncrementalStake → IncrementalStake Source # pow ∷ Integral x ⇒ IncrementalStake → x → IncrementalStake Source #
NoThunks IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods noThunks ∷ Context → IncrementalStake → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → IncrementalStake → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy IncrementalStake → String Source #
type Rep IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Rep IncrementalStake = D1 ('MetaData "IncrementalStake" "Cardano.Ledger.Shelley.LedgerState.Types" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "IStake" 'PrefixI 'True) (S1 ('MetaSel ('Just "credMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) (CompactForm Coin))) :*: S1 ('MetaSel ('Just "ptrMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map Ptr (CompactForm Coin)))))
type Share IncrementalStake Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Share IncrementalStake = Interns (Credential 'Staking)

Genesis State

genesisState ∷ ∀ era. (EraGov era, EraCertState 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

consumed ∷ (EraUTxO era, EraCertState era) ⇒ PParams era → CertState era → UTxO era → TxBody era → Value era Source #

For eras before Conway, VState is expected to have an empty Map for vsDReps, and so deposit summed up is zero.

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.

refundPoolDeposit ∷ KeyHash 'StakePool → PState era → (Coin, PState era) Source #

totalObligation ∷ (EraGov era, EraCertState era) ⇒ CertState era → GovState era → Coin Source #

allObligations ∷ (EraGov era, EraCertState era) ⇒ CertState era → GovState era → Obligations Source #

Epoch boundary

incrementalStakeDistr ∷ ∀ era. EraPParams era ⇒ PParams era → IncrementalStake → DState era → PState era → SnapShot Source #

This computes a Snapshot using IncrementalStake (which is an aggregate of the current UTxO) and UMap (which tracks Coin, SPoolUView, and Ptrs simultaneously). Note that logically: 1) IncrementalStake = (credStake, ptrStake) 2) UMap = (rewards, activeDelegs, ptrmap :: Map ptr cred)

Using this scheme the logic can do 3 things in one go, without touching the UTxO. 1) Resolve Pointers 2) Throw away things not actively delegated 3) Add up the coin

The Stake distribution function (Map cred coin) (the first component of a SnapShot) is defined by this SetAlgebra expression: (dom activeDelegs) ◁ (aggregate+ (credStake ∪ ptrStake ∪ rewards))

We can apply meaning preserving operations to get equivalent expressions

(dom activeDelegs) ◁ (aggregate+ (credStake ∪ ptrStake ∪ rewards)) aggregate+ (dom activeDelegs ◁ (credStake ∪ ptrStake ∪ rewards)) aggregate+ ((dom activeDelegs ◁ credStake) ∪ (dom activeDelegs ◁ ptrStake) ∪ (dom activeDelegs ◁ rewards))

We will compute this in several steps step1 = (dom activeDelegs ◁ credStake) ∪ (dom activeDelegs ◁ ptrStake) step2 = aggregate (dom activeDelegs ◁ rewards) step1 This function has a non-incremental analog, stakeDistr, mosty used in tests, which does use the UTxO.

updateStakeDistribution ∷ EraTxOut era ⇒ PParams era → IncrementalStake → UTxO era → UTxO era → IncrementalStake Source #

Incrementally add the inserts utxoAdd and the deletes utxoDel to the IncrementalStake.

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 AccountState 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

frRegistered ∷ !(Map (Credential 'Staking) (Set Reward))
These are registered, in the current Unified map of the CertState
frShelleyIgnored ∷ Map (Credential 'Staking) (Set Reward)
These are registered, but ignored in the ShelleyEra because of backward compatibility in non-Shelley Eras, this field will be Map.empty
frUnregistered ∷ Set (Credential 'Staking)
These are NOT registered in the current Unified map of the CertState
frTotalUnregistered ∷ Coin
Total Coin of the unregistered rewards. These will end up in the Treasury or Reserves.

Instances

Instances details

NFData (FilteredRewards era) Source #
Instance details 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.

completeStep ∷ PulsingRewUpdate → ShelleyBase (PulsingRewUpdate, RewardEvent) Source #

data NewEpochState era Source #

New Epoch state and environment

Constructors

NewEpochState !EpochNo !BlocksMade !BlocksMade !(EpochState era) !(StrictMaybe PulsingRewUpdate) !PoolDistr !(StashedAVVMAddresses era)

Instances

Instances details

CanGetUTxO NewEpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoG ∷ SimpleGetter (NewEpochState era) (UTxO era) Source #
CanSetUTxO NewEpochState Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods utxoL ∷ Lens' (NewEpochState era) (UTxO era) Source #
Generic (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Associated Types type Rep (NewEpochState era) ∷ Type → Type # Methods from ∷ NewEpochState era → Rep (NewEpochState era) x # to ∷ Rep (NewEpochState era) x → NewEpochState era #
(EraTxOut era, Show (StashedAVVMAddresses era), Show (GovState era), Show (CertState era)) ⇒ Show (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods showsPrec ∷ Int → NewEpochState era → ShowS # show ∷ NewEpochState era → String # showList ∷ [NewEpochState era] → ShowS #
(EraTxOut era, EraGov era, DecCBOR (StashedAVVMAddresses era), EraCertState era) ⇒ FromCBOR (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods fromCBOR ∷ Decoder s (NewEpochState era) Source # label ∷ Proxy (NewEpochState era) → Text Source #
(EraTxOut era, EraGov era, EncCBOR (StashedAVVMAddresses era), EraCertState era) ⇒ ToCBOR (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods toCBOR ∷ NewEpochState era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (NewEpochState era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [NewEpochState era] → Size Source #
(EraTxOut era, EraGov era, DecCBOR (StashedAVVMAddresses era), EraCertState era) ⇒ DecCBOR (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods decCBOR ∷ Decoder s (NewEpochState era) Source # dropCBOR ∷ Proxy (NewEpochState era) → Decoder s () Source # label ∷ Proxy (NewEpochState era) → Text Source #
(EraTxOut era, EncCBOR (StashedAVVMAddresses era), EncCBOR (GovState era), EncCBOR (CertState era)) ⇒ EncCBOR (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods encCBOR ∷ NewEpochState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (NewEpochState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [NewEpochState era] → Size Source #
(EraTxOut era, NFData (StashedAVVMAddresses era), NFData (GovState era), NFData (CertState era)) ⇒ NFData (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods rnf ∷ NewEpochState era → () #
(EraTxOut era, Eq (StashedAVVMAddresses era), Eq (GovState era), Eq (CertState era)) ⇒ Eq (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods (==) ∷ NewEpochState era → NewEpochState era → Bool # (/=) ∷ NewEpochState era → NewEpochState era → Bool #
(Era era, NoThunks (EpochState era), NoThunks (StashedAVVMAddresses era)) ⇒ NoThunks (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types Methods noThunks ∷ Context → NewEpochState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → NewEpochState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (NewEpochState era) → String Source #
type Rep (NewEpochState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.LedgerState.Types type Rep (NewEpochState era) = D1 ('MetaData "NewEpochState" "Cardano.Ledger.Shelley.LedgerState.Types" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "NewEpochState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nesEL") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo) :: (S1 ('MetaSel ('Just "nesBprev") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlocksMade) :: S1 ('MetaSel ('Just "nesBcur") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlocksMade))) :: ((S1 ('MetaSel ('Just "nesEs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (EpochState era)) :: S1 ('MetaSel ('Just "nesRu") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe PulsingRewUpdate))) :: (S1 ('MetaSel ('Just "nesPd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PoolDistr) :: S1 ('MetaSel ('Just "stashedAVVMAddresses") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StashedAVVMAddresses era))))))

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

decayFactor ∷ Float Source #

Remove Bootstrap Redeem Addresses

returnRedeemAddrsToReserves ∷ ∀ era. EraTxOut era ⇒ EpochState era → EpochState era Source #

updateNonMyopic ∷ NonMyopic → Coin → Map (KeyHash 'StakePool) Likelihood → NonMyopic Source #

emptyRewardUpdate ∷ RewardUpdate Source #

pvCanFollow Source #

Arguments

∷ ProtVer	Previous protocol version
→ ProtVer	New protocol version
→ Bool

Check whether the new protocol version is a legitimate version bump with respect to the previous one.

availableAfterMIR ∷ MIRPot → AccountState → 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 sgsCurProposals ∷ !(ProposedPPUpdates era) sgsFutureProposals ∷ !(ProposedPPUpdates era) sgsCurPParams ∷ !(PParams era) sgsPrevPParams ∷ !(PParams era) sgsFuturePParams ∷ !(FuturePParams era) Prediction of parameter changes that might happen on the epoch boundary.

Instances

Instances details

EraPParams era ⇒ ToJSON (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods toJSON ∷ ShelleyGovState era → Value Source # toEncoding ∷ ShelleyGovState era → Encoding Source # toJSONList ∷ [ShelleyGovState era] → Value Source # toEncodingList ∷ [ShelleyGovState era] → Encoding Source # omitField ∷ ShelleyGovState era → Bool Source #
Generic (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Associated Types type Rep (ShelleyGovState era) ∷ Type → Type # Methods from ∷ ShelleyGovState era → Rep (ShelleyGovState era) x # to ∷ Rep (ShelleyGovState era) x → ShelleyGovState era #
(Show (PParamsUpdate era), Show (PParams era)) ⇒ Show (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods showsPrec ∷ Int → ShelleyGovState era → ShowS # show ∷ ShelleyGovState era → String # showList ∷ [ShelleyGovState era] → ShowS #
(Era era, DecCBOR (PParamsUpdate era), DecCBOR (PParams era)) ⇒ FromCBOR (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods fromCBOR ∷ Decoder s (ShelleyGovState era) Source # label ∷ Proxy (ShelleyGovState era) → Text Source #
(Era era, EncCBOR (PParamsUpdate era), EncCBOR (PParams era)) ⇒ ToCBOR (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods toCBOR ∷ ShelleyGovState era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (ShelleyGovState era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGovState era] → Size Source #
(Era era, DecCBOR (PParamsUpdate era), DecCBOR (PParams era)) ⇒ DecCBOR (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods decCBOR ∷ Decoder s (ShelleyGovState era) Source # dropCBOR ∷ Proxy (ShelleyGovState era) → Decoder s () Source # label ∷ Proxy (ShelleyGovState era) → Text Source #
(Era era, DecCBOR (PParamsUpdate era), DecCBOR (PParams era)) ⇒ DecShareCBOR (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Associated Types type Share (ShelleyGovState era) Source # Methods getShare ∷ ShelleyGovState era → Share (ShelleyGovState era) Source # decShareCBOR ∷ Share (ShelleyGovState era) → Decoder s (ShelleyGovState era) Source # decSharePlusCBOR ∷ StateT (Share (ShelleyGovState era)) (Decoder s) (ShelleyGovState era) Source #
(Era era, EncCBOR (PParamsUpdate era), EncCBOR (PParams era)) ⇒ EncCBOR (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods encCBOR ∷ ShelleyGovState era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (ShelleyGovState era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGovState era] → Size Source #
EraPParams era ⇒ Default (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods def ∷ ShelleyGovState era Source #
(NFData (PParamsUpdate era), NFData (PParams era)) ⇒ NFData (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods rnf ∷ ShelleyGovState era → () #
(Eq (PParamsUpdate era), Eq (PParams era)) ⇒ Eq (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods (==) ∷ ShelleyGovState era → ShelleyGovState era → Bool # (/=) ∷ ShelleyGovState era → ShelleyGovState era → Bool #
(NoThunks (PParamsUpdate era), NoThunks (PParams era)) ⇒ NoThunks (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance Methods noThunks ∷ Context → ShelleyGovState era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ShelleyGovState era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ShelleyGovState era) → String Source #
type Rep (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance type Rep (ShelleyGovState era) = D1 ('MetaData "ShelleyGovState" "Cardano.Ledger.Shelley.Governance" "cardano-ledger-shelley-1.16.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyGovState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sgsCurProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ProposedPPUpdates era)) :: S1 ('MetaSel ('Just "sgsFutureProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ProposedPPUpdates era))) :: (S1 ('MetaSel ('Just "sgsCurPParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era)) :: (S1 ('MetaSel ('Just "sgsPrevPParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era)) :: S1 ('MetaSel ('Just "sgsFuturePParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (FuturePParams era))))))
type Share (ShelleyGovState era) Source #
Instance details Defined in Cardano.Ledger.Shelley.Governance type Share (ShelleyGovState era) = (Interns (Credential 'Staking), Interns (KeyHash 'StakePool), Interns (Credential 'DRepRole), Interns (Credential 'HotCommitteeRole))