Safe Haskell	None
Language	Haskell2010

Test.Cardano.Ledger.Shelley.Examples.Combinators

Description

A collection of combinators for manipulating Chain State. The idea is to provide a clear way of describing the changes to the chain state when a block is processed.

Synopsis

evolveNonceFrozen ∷ Nonce → ChainState era → ChainState era
evolveNonceUnfrozen ∷ Nonce → ChainState era → ChainState era
newLab ∷ Block (BHeader MockCrypto) era → ChainState era → ChainState era
addFees ∷ Coin → ChainState era → ChainState era
newUTxO ∷ (EraTx era, EraStake era) ⇒ TxBody 'TopTx era → ChainState era → ChainState era
newStakeCred ∷ (EraCertState era, EraGov era, ShelleyEraAccounts era) ⇒ Credential 'Staking → Ptr → ChainState era → ChainState era
deregStakeCred ∷ (HasCallStack, EraCertState era, ShelleyEraAccounts era) ⇒ Credential 'Staking → ChainState era → ChainState era
delegation ∷ EraCertState era ⇒ Credential 'Staking → KeyHash 'StakePool → ChainState era → ChainState era
regPool ∷ (EraCertState era, EraGov era) ⇒ StakePoolParams → ChainState era → ChainState era
updatePoolParams ∷ (EraCertState era, EraGov era) ⇒ Network → StakePoolParams → ChainState era → ChainState era
stageRetirement ∷ EraCertState era ⇒ KeyHash 'StakePool → EpochNo → ChainState era → ChainState era
reapPool ∷ (EraGov era, EraCertState era) ⇒ StakePoolParams → ChainState era → ChainState era
mir ∷ EraCertState era ⇒ Credential 'Staking → MIRPot → Coin → ChainState era → ChainState era
applyMIR ∷ EraCertState era ⇒ MIRPot → Map (Credential 'Staking) Coin → ChainState era → ChainState era
rewardUpdate ∷ RewardUpdate → ChainState era → ChainState era
pulserUpdate ∷ PulsingRewUpdate → ChainState era → ChainState era
applyRewardUpdate ∷ (EraGov era, EraCertState era) ⇒ RewardUpdate → ChainState era → ChainState era
setPoolDistr ∷ PoolDistr → ChainState era → ChainState era
setOCertCounter ∷ KeyHash 'BlockIssuer → Word64 → ChainState era → ChainState era
newSnapshot ∷ SnapShot → Coin → ChainState era → ChainState era
incrBlockCount ∷ KeyHash 'StakePool → ChainState era → ChainState era
newEpoch ∷ (AtMostEra "Alonzo" era, EraGov era) ⇒ Block (BHeader MockCrypto) era → ChainState era → ChainState era
setCurrentProposals ∷ (GovState era ~ ShelleyGovState era, EraPParams era) ⇒ ProposedPPUpdates era → ChainState era → ChainState era
setFutureProposals ∷ GovState era ~ ShelleyGovState era ⇒ ProposedPPUpdates era → ChainState era → ChainState era
solidifyProposals ∷ EraGov era ⇒ ChainState era → ChainState era
setPParams ∷ EraGov era ⇒ PParams era → ChainState era → ChainState era
setPrevPParams ∷ EraGov era ⇒ PParams era → ChainState era → ChainState era
setFutureGenDeleg ∷ EraCertState era ⇒ (FutureGenDeleg, GenDelegPair) → ChainState era → ChainState era
adoptFutureGenDeleg ∷ EraCertState era ⇒ (FutureGenDeleg, GenDelegPair) → ChainState era → ChainState era

Documentation

evolveNonceFrozen ∷ Nonce → ChainState era → ChainState era Source #

Evolve Nonces - Frozen

Evolve the appropriate nonces under the assumption that the candidate nonce is now frozen.

evolveNonceUnfrozen ∷ Nonce → ChainState era → ChainState era Source #

Evolve Nonces - Unfrozen

Evolve the appropriate nonces under the assumption that the candidate nonce is not frozen. Note: do not use this function when crossing the epoch boundary, instead use newEpoch.

newLab ∷ Block (BHeader MockCrypto) era → ChainState era → ChainState era Source #

New `LastAppliedBlock` (NOT on epoch boundaries)

Update the chain state with the details of LastAppliedBlock that occur when a new block is processed. Note: do not use this function when crossing the epoch boundary, instead use newEpoch.

addFees ∷ Coin → ChainState era → ChainState era Source #

newUTxO ∷ (EraTx era, EraStake era) ⇒ TxBody 'TopTx era → ChainState era → ChainState era Source #

Update the UTxO

Update the UTxO for given transaction body.

newStakeCred ∷ (EraCertState era, EraGov era, ShelleyEraAccounts era) ⇒ Credential 'Staking → Ptr → ChainState era → ChainState era Source #

New Stake Credential

Add a newly registered stake credential.

deregStakeCred ∷ (HasCallStack, EraCertState era, ShelleyEraAccounts era) ⇒ Credential 'Staking → ChainState era → ChainState era Source #

De-Register Stake Credential

De-register a stake credential and all associated data.

delegation ∷ EraCertState era ⇒ Credential 'Staking → KeyHash 'StakePool → ChainState era → ChainState era Source #

New Delegation

Create a delegation from the given stake credential to the given stake pool.

regPool ∷ (EraCertState era, EraGov era) ⇒ StakePoolParams → ChainState era → ChainState era Source #

Register a stake pool.

updatePoolParams ∷ (EraCertState era, EraGov era) ⇒ Network → StakePoolParams → ChainState era → ChainState era Source #

Re-Register Stake Pool

stageRetirement ∷ EraCertState era ⇒ KeyHash 'StakePool → EpochNo → ChainState era → ChainState era Source #

Pool Retirement

Stage a stake pool for retirement.

reapPool ∷ (EraGov era, EraCertState era) ⇒ StakePoolParams → ChainState era → ChainState era Source #

Reap Pool

Remove a stake pool.

mir ∷ EraCertState era ⇒ Credential 'Staking → MIRPot → Coin → ChainState era → ChainState era Source #

MIR

Add a credential to the MIR mapping for the given pot (reserves or treasury)

applyMIR ∷ EraCertState era ⇒ MIRPot → Map (Credential 'Staking) Coin → ChainState era → ChainState era Source #

Apply MIR

On the epoch boundary, reset the MIR mappings and augment the rewards.

rewardUpdate ∷ RewardUpdate → ChainState era → ChainState era Source #

Reward Update

Update the chain state with the given reward update

pulserUpdate ∷ PulsingRewUpdate → ChainState era → ChainState era Source #

Pulser

Update the chain state with the given reward update pulser

applyRewardUpdate ∷ (EraGov era, EraCertState era) ⇒ RewardUpdate → ChainState era → ChainState era Source #

Apply a Reward Update

Apply the given reward update to the chain state

setPoolDistr ∷ PoolDistr → ChainState era → ChainState era Source #

Set Pool Distribution

Set the stake pool distribution to the given one.

setOCertCounter ∷ KeyHash 'BlockIssuer → Word64 → ChainState era → ChainState era Source #

Set Operation Certificate Counter

Set the operational certificates counter for a given stake pool.

newSnapshot ∷ SnapShot → Coin → ChainState era → ChainState era Source #

New Snapshot

Add a new snapshot and rotate the others

incrBlockCount ∷ KeyHash 'StakePool → ChainState era → ChainState era Source #

Increase Block Count

Record that the given stake pool (non-core node) produced a block.

newEpoch ∷ (AtMostEra "Alonzo" era, EraGov era) ⇒ Block (BHeader MockCrypto) era → ChainState era → ChainState era Source #

New Epoch

Update the new epoch number, set the nonces, set the last applied block, and reset blocks made. Note: This function subsumes the manipulations done by newLab, evolveNonceUnfrozen, and evolveNonceFrozen.

setCurrentProposals ∷ (GovState era ~ ShelleyGovState era, EraPParams era) ⇒ ProposedPPUpdates era → ChainState era → ChainState era Source #