Safe Haskell	None
Language	Haskell2010

Cardano.Api.LedgerState

Contents

Initialization / Accumulation
Traversing the block chain
Ledger state conditions
Ledger events
Errors
Leadership schedule
Node Config

Synopsis

envSecurityParam :: Env -> Word64
data LedgerState where
- LedgerState {
  - clsState :: CardanoLedgerState StandardCrypto EmptyMK
  - clsTables :: LedgerTables (HardForkBlock (CardanoEras StandardCrypto)) ValuesMK
  }
- pattern LedgerStateByron :: LedgerState ByronBlock EmptyMK -> LedgerState
- pattern LedgerStateShelley :: LedgerState StandardShelleyBlock EmptyMK -> LedgerState
- pattern LedgerStateAllegra :: LedgerState StandardAllegraBlock EmptyMK -> LedgerState
- pattern LedgerStateMary :: LedgerState StandardMaryBlock EmptyMK -> LedgerState
- pattern LedgerStateAlonzo :: LedgerState StandardAlonzoBlock EmptyMK -> LedgerState
- pattern LedgerStateBabbage :: LedgerState StandardBabbageBlock EmptyMK -> LedgerState
- pattern LedgerStateConway :: LedgerState StandardConwayBlock EmptyMK -> LedgerState
encodeLedgerState :: LedgerState -> Encoding
decodeLedgerState :: Decoder s LedgerState
initialLedgerState :: forall t (m :: Type -> Type). MonadIOTransError InitialLedgerStateError t m => SomeHasFS IO -> NodeConfigFile 'In -> t m (Env, LedgerState)
applyBlock :: Env -> LedgerState -> ValidationMode -> BlockInMode -> Either LedgerStateError (LedgerState, [LedgerEvent])
data ValidationMode
- = FullValidation
- | QuickValidation
applyBlockWithEvents :: Env -> LedgerState -> Bool -> CardanoBlock StandardCrypto -> Either LedgerStateError LedgerStateEvents
data AnyNewEpochState where
- AnyNewEpochState :: forall era. ShelleyBasedEra era -> NewEpochState (ShelleyLedgerEra era) -> LedgerTables (CardanoBlock StandardCrypto) ValuesMK -> AnyNewEpochState
getAnyNewEpochState :: ShelleyBasedEra era -> LedgerState -> Either LedgerStateError AnyNewEpochState
getLedgerTablesUTxOValues :: ShelleyBasedEra era -> LedgerTables (CardanoBlock StandardCrypto) ValuesMK -> Map TxIn (TxOut CtxUTxO era)
foldBlocks :: forall a t (m :: Type -> Type). (HasCallStack, Show a, MonadIOTransError FoldBlocksError t m) => SomeHasFS IO -> NodeConfigFile 'In -> SocketPath -> ValidationMode -> a -> (Env -> LedgerState -> [LedgerEvent] -> BlockInMode -> a -> IO (a, FoldStatus)) -> t m a
data FoldStatus
- = ContinueFold
- | StopFold
- | DebugFold
chainSyncClientWithLedgerState :: forall (m :: Type -> Type) a. (HasCallStack, Monad m) => Env -> LedgerState -> ValidationMode -> ChainSyncClient (BlockInMode, Either LedgerStateError (LedgerState, [LedgerEvent])) ChainPoint ChainTip m a -> ChainSyncClient BlockInMode ChainPoint ChainTip m a
chainSyncClientPipelinedWithLedgerState :: forall (m :: Type -> Type) a. (HasCallStack, Monad m) => Env -> LedgerState -> ValidationMode -> ChainSyncClientPipelined (BlockInMode, Either LedgerStateError (LedgerState, [LedgerEvent])) ChainPoint ChainTip m a -> ChainSyncClientPipelined BlockInMode ChainPoint ChainTip m a
data ConditionResult
- = ConditionNotMet
- | ConditionMet
fromConditionResult :: ConditionResult -> Bool
toConditionResult :: Bool -> ConditionResult
foldEpochState :: forall t (m :: Type -> Type) s. (HasCallStack, MonadIOTransError FoldBlocksError t m) => SomeHasFS IO -> NodeConfigFile 'In -> SocketPath -> ValidationMode -> EpochNo -> s -> (AnyNewEpochState -> SlotNo -> BlockNo -> StateT s IO ConditionResult) -> t m (ConditionResult, s)
data LedgerEvent
- = PoolRegistration
- | PoolReRegistration
- | IncrementalRewardsDistribution EpochNo (Map StakeCredential (Set Reward))
- | RewardsDistribution EpochNo (Map StakeCredential (Set Reward))
- | MIRDistribution MIRDistributionDetails
- | PoolReap PoolReapDetails
- | SuccessfulPlutusScript (NonEmpty PlutusWithContext)
- | FailedPlutusScript (NonEmpty PlutusWithContext)
- | NewGovernanceProposals TxId AnyProposals
- | RemovedGovernanceVotes TxId (Set (Voter, GovActionId)) (Set (Credential 'DRepRole))
- | EpochBoundaryRatificationState AnyRatificationState
data AnyProposals = EraPParams era => AnyProposals (Proposals era)
data AnyRatificationState = EraPParams era => AnyRatificationState (RatifyState era)
data MIRDistributionDetails = MIRDistributionDetails {
- mirddReservePayouts :: Map StakeCredential Coin
- mirddTreasuryPayouts :: Map StakeCredential Coin
- mirddReservesToTreasury :: Coin
- mirddTreasuryToReserves :: Coin
}
data PoolReapDetails = PoolReapDetails {
- prdEpochNo :: EpochNo
- prdRefunded :: Map StakeCredential (Map (Hash StakePoolKey) Coin)
- prdUnclaimed :: Map StakeCredential (Map (Hash StakePoolKey) Coin)
}
convertRetiredPoolsMap :: Map (Credential 'Staking) (Map (KeyHash 'StakePool) (CompactForm Coin)) -> Map StakeCredential (Map (Hash StakePoolKey) Coin)
data LedgerStateError
- = ApplyBlockHashMismatch Text
- | ApplyBlockError (CardanoLedgerError StandardCrypto)
- | InvalidRollback SlotNo ChainPoint
- | TerminationEpochReached EpochNo
- | UnexpectedLedgerState AnyShelleyBasedEra (NS (Current (Flip LedgerState EmptyMK)) (CardanoEras StandardCrypto))
- | ByronEraUnsupported
- | DebugError !String
data FoldBlocksError
- = FoldBlocksInitialLedgerStateError !InitialLedgerStateError
- | FoldBlocksApplyBlockError !LedgerStateError
- | FoldBlocksIOException !IOException
- | FoldBlocksMuxError !Error
data GenesisConfigError
- = NEError !Text
- | NEByronConfig !FilePath !ConfigurationError
- | NEShelleyConfig !FilePath !Text
- | NEAlonzoConfig !FilePath !Text
- | NEConwayConfig !FilePath !Text
- | NECardanoConfig !Text
data InitialLedgerStateError
- = ILSEConfigFile Text
- | ILSEGenesisFile GenesisConfigError
- | ILSELedgerConsensusConfig GenesisConfigError
data LeadershipError
- = LeaderErrDecodeLedgerStateFailure
- | LeaderErrDecodeProtocolStateFailure (ByteString, DecoderError)
- | LeaderErrDecodeProtocolEpochStateFailure DecoderError
- | LeaderErrDecodePoolDistributionFailure DecoderError
- | LeaderErrGenesisSlot
- | LeaderErrStakePoolHasNoStake PoolId
- | LeaderErrStakeDistribUnstable SlotNo SlotNo SlotNo SlotNo
- | LeaderErrSlotRangeCalculationFailure Text
- | LeaderErrCandidateNonceStillEvolving
constructGlobals :: ShelleyGenesis -> EpochInfo (Either Text) -> Globals
currentEpochEligibleLeadershipSlots :: ShelleyBasedEra era -> ShelleyGenesis -> EpochInfo (Either Text) -> PParams (ShelleyLedgerEra era) -> ProtocolState era -> PoolId -> SigningKey VrfKey -> Serialised (PoolDistribution era) -> EpochNo -> Either LeadershipError (Set SlotNo)
nextEpochEligibleLeadershipSlots :: ShelleyBasedEra era -> ShelleyGenesis -> SerialisedCurrentEpochState era -> ProtocolState era -> PoolId -> SigningKey VrfKey -> PParams (ShelleyLedgerEra era) -> EpochInfo (Either Text) -> (ChainTip, EpochNo) -> Either LeadershipError (Set SlotNo)
data NodeConfig = NodeConfig {
- ncPBftSignatureThreshold :: !(Maybe Double)
- ncByronGenesisFile :: !(File ByronGenesisConfig 'In)
- ncByronGenesisHash :: !(Maybe GenesisHashByron)
- ncShelleyGenesisFile :: !(File ShelleyGenesisConfig 'In)
- ncShelleyGenesisHash :: !(Maybe GenesisHashShelley)
- ncAlonzoGenesisFile :: !(File AlonzoGenesis 'In)
- ncAlonzoGenesisHash :: !(Maybe GenesisHashAlonzo)
- ncConwayGenesisFile :: !(File ConwayGenesisConfig 'In)
- ncConwayGenesisHash :: !(Maybe GenesisHashConway)
- ncRequiresNetworkMagic :: !RequiresNetworkMagic
- ncByronProtocolVersion :: !ProtocolVersion
- ncHardForkTriggers :: !CardanoHardForkTriggers
}
type NodeConfigFile = File NodeConfig
readNodeConfig :: (MonadError Text m, MonadIO m) => NodeConfigFile 'In -> m NodeConfig
data GenesisConfig = GenesisCardano !NodeConfig !Config !GenesisHashShelley !(TransitionConfig LatestKnownEra)
readCardanoGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m GenesisConfig
mkProtocolInfoCardano :: SomeHasFS IO -> GenesisConfig -> IO (ProtocolInfo (CardanoBlock StandardCrypto), Tracer IO KESAgentClientTrace -> IO [MkBlockForging IO (CardanoBlock StandardCrypto)])
resolveShelleyInitialFunds :: (MonadST m, MonadThrow m) => SomeHasFS m -> ShelleyGenesis -> m ShelleyGenesis
readByronGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m Config
data ShelleyConfig = ShelleyConfig {
- scConfig :: !ShelleyGenesis
- scGenesisHash :: !GenesisHashShelley
}
newtype GenesisHashShelley = GenesisHashShelley {
- unGenesisHashShelley :: Hash Blake2b_256 ByteString
}
readShelleyGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m ShelleyConfig
readShelleyGenesis :: forall (m :: Type -> Type) t. MonadIOTransError ShelleyGenesisError t m => ShelleyGenesisFile 'In -> Maybe GenesisHashShelley -> t m ShelleyConfig
data ShelleyGenesisError
- = ShelleyGenesisReadError !FilePath !Text
- | ShelleyGenesisHashMismatch !GenesisHashShelley !GenesisHashShelley
- | ShelleyGenesisDecodeError !FilePath !Text
renderShelleyGenesisError :: ShelleyGenesisError -> Text
shelleyPraosNonce :: GenesisHashShelley -> Nonce
newtype GenesisHashAlonzo = GenesisHashAlonzo {
- unGenesisHashAlonzo :: Hash Blake2b_256 ByteString
}
readAlonzoGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m AlonzoGenesis
newtype GenesisHashConway = GenesisHashConway {
- unGenesisHashConway :: Hash Blake2b_256 ByteString
}
readConwayGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m ConwayGenesis
data Env = Env {
- envLedgerConfig :: CardanoLedgerConfig StandardCrypto
- envConsensusConfig :: CardanoConsensusConfig StandardCrypto
}
genesisConfigToEnv :: SomeHasFS IO -> GenesisConfig -> IO (Either GenesisConfigError Env)

Initialization / Accumulation

envSecurityParam :: Env -> Word64 Source #

data LedgerState Source #

Constructors

LedgerState
Fields clsState :: CardanoLedgerState StandardCrypto EmptyMK clsTables :: LedgerTables (HardForkBlock (CardanoEras StandardCrypto)) ValuesMK

Bundled Patterns

pattern LedgerStateByron :: LedgerState ByronBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerStateByron' instead
pattern LedgerStateShelley :: LedgerState StandardShelleyBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerStateShelley' instead
pattern LedgerStateAllegra :: LedgerState StandardAllegraBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerStateAllegra' instead
pattern LedgerStateMary :: LedgerState StandardMaryBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerStateMary' instead
pattern LedgerStateAlonzo :: LedgerState StandardAlonzoBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerAlonzo' instead
pattern LedgerStateBabbage :: LedgerState StandardBabbageBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerBabbage' instead
pattern LedgerStateConway :: LedgerState StandardConwayBlock EmptyMK -> LedgerState	Deprecated: Use 'LedgerState $ Consensus.LedgerConway' instead

Instances

Instances details

Show LedgerState Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> LedgerState -> ShowS Source # show :: LedgerState -> String Source # showList :: [LedgerState] -> ShowS Source #

encodeLedgerState :: LedgerState -> Encoding Source #

decodeLedgerState :: Decoder s LedgerState Source #

initialLedgerState Source #

Arguments

:: forall t (m :: Type -> Type). MonadIOTransError InitialLedgerStateError t m
=> SomeHasFS IO	Filesystem capability used by Ledger for testing/benchmarking, to stream Shelley/Conway genesis data from the extraConfig.
-> NodeConfigFile 'In	Path to the cardano-node config file (e.g. to cardano-node projectconfigurationcardano/mainnet-config.json)
-> t m (Env, LedgerState)	The environment and initial ledger state

Get the environment and initial ledger state.

applyBlock Source #

Arguments

:: Env	The environment returned by `initialLedgerState`
-> LedgerState	The current ledger state
-> ValidationMode
-> BlockInMode	Some block to apply
-> Either LedgerStateError (LedgerState, [LedgerEvent])	The new ledger state (or an error).

Apply a single block to the current ledger state.

data ValidationMode Source #

How to do validation when applying a block to a ledger state.

Constructors

FullValidation	Do all validation implied by the ledger layer's `applyBlock`.
QuickValidation	Only check that the previous hash from the block matches the head hash of the ledger state.

applyBlockWithEvents Source #

Arguments

:: Env
-> LedgerState
-> Bool	True to validate
-> CardanoBlock StandardCrypto
-> Either LedgerStateError LedgerStateEvents

data AnyNewEpochState where Source #

Constructors

AnyNewEpochState :: forall era. ShelleyBasedEra era -> NewEpochState (ShelleyLedgerEra era) -> LedgerTables (CardanoBlock StandardCrypto) ValuesMK -> AnyNewEpochState

Instances

Instances details

Show AnyNewEpochState Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> AnyNewEpochState -> ShowS Source # show :: AnyNewEpochState -> String Source # showList :: [AnyNewEpochState] -> ShowS Source #

getAnyNewEpochState :: ShelleyBasedEra era -> LedgerState -> Either LedgerStateError AnyNewEpochState Source #

Retrieve new epoch state from the ledger state, or an error on failure

getLedgerTablesUTxOValues :: ShelleyBasedEra era -> LedgerTables (CardanoBlock StandardCrypto) ValuesMK -> Map TxIn (TxOut CtxUTxO era) Source #

Traversing the block chain

foldBlocks Source #

Arguments

:: forall a t (m :: Type -> Type). (HasCallStack, Show a, MonadIOTransError FoldBlocksError t m)
=> SomeHasFS IO	Filesystem capability used by Ledger for testing/benchmarking, to stream Shelley/Conway genesis data from the extraConfig.
-> NodeConfigFile 'In	Path to the cardano-node config file (e.g. to cardano-node projectconfigurationcardano/mainnet-config.json)
-> SocketPath	Path to local cardano-node socket. This is the path specified by the `--socket-path` command line option when running the node.
-> ValidationMode
-> a	The initial accumulator state.
-> (Env -> LedgerState -> [LedgerEvent] -> BlockInMode -> a -> IO (a, FoldStatus))	Accumulator function Takes: Environment (this is a constant over the whole fold). The Ledger state (with block `i` applied) at block `i`. The Ledger events resulting from applying block `i`. Block `i`. The accumulator state at block `i - 1`. And returns: The accumulator state at block `i` A type indicating whether to stop or continue folding. Note: This function can safely assume no rollback will occur even though internally this is implemented with a client protocol that may require rollback. This is achieved by only calling the accumulator on states/blocks that are older than the security parameter, k. This has the side effect of truncating the last k blocks before the node's tip.
-> t m a	The final state

Monadic fold over all blocks and ledger states. Stopping k blocks before the node's tip where k is the security parameter.

data FoldStatus Source #

Type that lets us decide whether to continue or stop the fold from within our accumulation function.

Constructors

ContinueFold
StopFold
DebugFold

Instances

Instances details

Eq FoldStatus Source #
Instance details Defined in Cardano.Api.LedgerState Methods (==) :: FoldStatus -> FoldStatus -> Bool Source # (/=) :: FoldStatus -> FoldStatus -> Bool Source #
Show FoldStatus Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> FoldStatus -> ShowS Source # show :: FoldStatus -> String Source # showList :: [FoldStatus] -> ShowS Source #

chainSyncClientWithLedgerState Source #

Arguments

:: forall (m :: Type -> Type) a. (HasCallStack, Monad m)
=> Env
-> LedgerState	Initial ledger state
-> ValidationMode
-> ChainSyncClient (BlockInMode, Either LedgerStateError (LedgerState, [LedgerEvent])) ChainPoint ChainTip m a	A client to wrap. The block is annotated with a 'Either LedgerStateError LedgerState'. This is either an error from validating a block or the current `LedgerState` from applying the current block. If we trust the node, then we generally expect blocks to validate. Also note that after a block fails to validate we may still roll back to a validated block, in which case the valid `LedgerState` will be passed here again.
-> ChainSyncClient BlockInMode ChainPoint ChainTip m a	A client that acts just like the wrapped client but doesn't require the `LedgerState` annotation on the block type.

Wrap a ChainSyncClient with logic that tracks the ledger state.

chainSyncClientPipelinedWithLedgerState :: forall (m :: Type -> Type) a. (HasCallStack, Monad m) => Env -> LedgerState -> ValidationMode -> ChainSyncClientPipelined (BlockInMode, Either LedgerStateError (LedgerState, [LedgerEvent])) ChainPoint ChainTip m a -> ChainSyncClientPipelined BlockInMode ChainPoint ChainTip m a Source #

See chainSyncClientWithLedgerState.

Ledger state conditions

data ConditionResult Source #

Type isomorphic to bool, representing condition check result

Constructors

ConditionNotMet
ConditionMet

Instances

Instances details

Eq ConditionResult Source #
Instance details Defined in Cardano.Api.LedgerState Methods (==) :: ConditionResult -> ConditionResult -> Bool Source # (/=) :: ConditionResult -> ConditionResult -> Bool Source #
Ord ConditionResult Source #
Instance details Defined in Cardano.Api.LedgerState Methods compare :: ConditionResult -> ConditionResult -> Ordering Source # (<) :: ConditionResult -> ConditionResult -> Bool Source # (<=) :: ConditionResult -> ConditionResult -> Bool Source # (>) :: ConditionResult -> ConditionResult -> Bool Source # (>=) :: ConditionResult -> ConditionResult -> Bool Source # max :: ConditionResult -> ConditionResult -> ConditionResult Source # min :: ConditionResult -> ConditionResult -> ConditionResult Source #
Bounded ConditionResult Source #
Instance details Defined in Cardano.Api.LedgerState Methods minBound :: ConditionResult Source # maxBound :: ConditionResult Source #
Enum ConditionResult Source #
Instance details Defined in Cardano.Api.LedgerState Methods succ :: ConditionResult -> ConditionResult Source # pred :: ConditionResult -> ConditionResult Source # toEnum :: Int -> ConditionResult Source # fromEnum :: ConditionResult -> Int Source # enumFrom :: ConditionResult -> [ConditionResult] Source # enumFromThen :: ConditionResult -> ConditionResult -> [ConditionResult] Source # enumFromTo :: ConditionResult -> ConditionResult -> [ConditionResult] Source # enumFromThenTo :: ConditionResult -> ConditionResult -> ConditionResult -> [ConditionResult] Source #
Read ConditionResult Source #
Instance details Defined in Cardano.Api.LedgerState Methods readsPrec :: Int -> ReadS ConditionResult Source # readList :: ReadS [ConditionResult] Source # readPrec :: ReadPrec ConditionResult Source # readListPrec :: ReadPrec [ConditionResult] Source #
Show ConditionResult Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> ConditionResult -> ShowS Source # show :: ConditionResult -> String Source # showList :: [ConditionResult] -> ShowS Source #

fromConditionResult :: ConditionResult -> Bool Source #

toConditionResult :: Bool -> ConditionResult Source #

foldEpochState Source #

Arguments

:: forall t (m :: Type -> Type) s. (HasCallStack, MonadIOTransError FoldBlocksError t m)
=> SomeHasFS IO	Filesystem capability used by Ledger for testing/benchmarking, to stream Shelley/Conway genesis data from the extraConfig.
-> NodeConfigFile 'In	Path to the cardano-node config file (e.g. to cardano-node projectconfigurationcardano/mainnet-config.json)
-> SocketPath	Path to local cardano-node socket. This is the path specified by the `--socket-path` command line option when running the node.
-> ValidationMode
-> EpochNo	Termination epoch
-> s	an initial value for the condition state
-> (AnyNewEpochState -> SlotNo -> BlockNo -> StateT s IO ConditionResult)	Condition you want to check against the new epoch state. `SlotNo` - Current (not necessarily the tip) slot number `BlockNo` - Current (not necessarily the tip) block number Note: This function can safely assume no rollback will occur even though internally this is implemented with a client protocol that may require rollback. This is achieved by only calling the accumulator on states/blocks that are older than the security parameter, k. This has the side effect of truncating the last k blocks before the node's tip.
-> t m (ConditionResult, s)	The final state

Reconstructs the ledger's new epoch state and applies a supplied condition to it for every block. This function only terminates if the condition is met or we have reached the termination epoch. We need to provide a termination epoch otherwise blocks would be applied indefinitely.

Ledger events

data LedgerEvent Source #

Constructors

PoolRegistration	The given pool is being registered for the first time on chain.
PoolReRegistration	The given pool already exists and is being re-registered.
IncrementalRewardsDistribution EpochNo (Map StakeCredential (Set Reward))	Incremental rewards are being computed.
RewardsDistribution EpochNo (Map StakeCredential (Set Reward))	Reward distribution has completed.
MIRDistribution MIRDistributionDetails	MIR are being distributed.
PoolReap PoolReapDetails	Pools have been reaped and deposits refunded.
SuccessfulPlutusScript (NonEmpty PlutusWithContext)	A number of succeeded Plutus script evaluations.
FailedPlutusScript (NonEmpty PlutusWithContext)	A number of failed Plutus script evaluations.
NewGovernanceProposals TxId AnyProposals	Newly submittted governance proposals in a single transaction.
RemovedGovernanceVotes	Governance votes that were invalidated.
Fields TxId (Set (Voter, GovActionId)) Votes that were replaced in this tx. (Set (Credential 'DRepRole)) Any votes from these DReps in this or in previous txs are removed
EpochBoundaryRatificationState AnyRatificationState	The current state of governance matters at the epoch boundary. I.E the current constitution, committee, protocol parameters, etc.

Instances

Instances details

Show LedgerEvent Source #
Instance details Defined in Cardano.Api.LedgerState.Internal.LedgerEvent Methods showsPrec :: Int -> LedgerEvent -> ShowS Source # show :: LedgerEvent -> String Source # showList :: [LedgerEvent] -> ShowS Source #

data AnyProposals Source #

Constructors

EraPParams era => AnyProposals (Proposals era)

Instances

Instances details

Show AnyProposals Source #
Instance details Defined in Cardano.Api.LedgerState.Internal.LedgerEvent Methods showsPrec :: Int -> AnyProposals -> ShowS Source # show :: AnyProposals -> String Source # showList :: [AnyProposals] -> ShowS Source #

data AnyRatificationState Source #

Constructors

EraPParams era => AnyRatificationState (RatifyState era)

Instances

Instances details

Show AnyRatificationState Source #
Instance details Defined in Cardano.Api.LedgerState.Internal.LedgerEvent Methods showsPrec :: Int -> AnyRatificationState -> ShowS Source # show :: AnyRatificationState -> String Source # showList :: [AnyRatificationState] -> ShowS Source #

data MIRDistributionDetails Source #

Details of fund transfers due to MIR certificates.

Note that the transfers from reserves to treasury and treasury to reserves are inverse; a transfer of 100 ADA in either direction will result in a net movement of 0, but we include both directions for assistance in debugging.

Constructors

MIRDistributionDetails
Fields mirddReservePayouts :: Map StakeCredential Coin mirddTreasuryPayouts :: Map StakeCredential Coin mirddReservesToTreasury :: Coin mirddTreasuryToReserves :: Coin

Instances

Instances details

Show MIRDistributionDetails Source #
Instance details Defined in Cardano.Api.LedgerState.Internal.LedgerEvent Methods showsPrec :: Int -> MIRDistributionDetails -> ShowS Source # show :: MIRDistributionDetails -> String Source # showList :: [MIRDistributionDetails] -> ShowS Source #

data PoolReapDetails Source #

Constructors

PoolReapDetails

Fields

prdEpochNo :: EpochNo
prdRefunded :: Map StakeCredential (Map (Hash StakePoolKey) Coin)
Refunded deposits. The pools referenced are now retired, and the StakeCredential accounts are credited with the deposits.
prdUnclaimed :: Map StakeCredential (Map (Hash StakePoolKey) Coin)
Unclaimed deposits. The StakeCredential referenced in this map is not actively registered at the time of the pool reaping, and as such the funds are returned to the treasury.

Instances

Instances details

Show PoolReapDetails Source #
Instance details Defined in Cardano.Api.LedgerState.Internal.LedgerEvent Methods showsPrec :: Int -> PoolReapDetails -> ShowS Source # show :: PoolReapDetails -> String Source # showList :: [PoolReapDetails] -> ShowS Source #

convertRetiredPoolsMap :: Map (Credential 'Staking) (Map (KeyHash 'StakePool) (CompactForm Coin)) -> Map StakeCredential (Map (Hash StakePoolKey) Coin) Source #

Errors

data LedgerStateError Source #

Constructors

ApplyBlockHashMismatch Text	When using QuickValidation, the block hash did not match the expected block hash after applying a new block to the current ledger state.
ApplyBlockError (CardanoLedgerError StandardCrypto)	When using FullValidation, an error occurred when applying a new block to the current ledger state.
InvalidRollback	Encountered a rollback larger than the security parameter.
Fields SlotNo Oldest known slot number that we can roll back to. ChainPoint Rollback was attempted to this point.
TerminationEpochReached EpochNo	The ledger state condition you were interested in was not met prior to the termination epoch.
UnexpectedLedgerState
Fields AnyShelleyBasedEra Expected era (NS (Current (Flip LedgerState EmptyMK)) (CardanoEras StandardCrypto)) Ledgerstate from an unexpected era
ByronEraUnsupported
DebugError !String

Instances

Instances details

Error LedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: LedgerStateError -> Doc ann Source #
Exception LedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: LedgerStateError -> SomeException Source # fromException :: SomeException -> Maybe LedgerStateError Source # displayException :: LedgerStateError -> String Source # backtraceDesired :: LedgerStateError -> Bool Source #
Show LedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> LedgerStateError -> ShowS Source # show :: LedgerStateError -> String Source # showList :: [LedgerStateError] -> ShowS Source #

data FoldBlocksError Source #

Constructors

FoldBlocksInitialLedgerStateError !InitialLedgerStateError
FoldBlocksApplyBlockError !LedgerStateError
FoldBlocksIOException !IOException
FoldBlocksMuxError !Error

Instances

Instances details

Error FoldBlocksError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: FoldBlocksError -> Doc ann Source #
Show FoldBlocksError Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> FoldBlocksError -> ShowS Source # show :: FoldBlocksError -> String Source # showList :: [FoldBlocksError] -> ShowS Source #

data GenesisConfigError Source #

Constructors

NEError !Text
NEByronConfig !FilePath !ConfigurationError
NEShelleyConfig !FilePath !Text
NEAlonzoConfig !FilePath !Text
NEConwayConfig !FilePath !Text
NECardanoConfig !Text

Instances

Instances details

Error GenesisConfigError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: GenesisConfigError -> Doc ann Source #
Exception GenesisConfigError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: GenesisConfigError -> SomeException Source # fromException :: SomeException -> Maybe GenesisConfigError Source # displayException :: GenesisConfigError -> String Source # backtraceDesired :: GenesisConfigError -> Bool Source #
Show GenesisConfigError Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> GenesisConfigError -> ShowS Source # show :: GenesisConfigError -> String Source # showList :: [GenesisConfigError] -> ShowS Source #

data InitialLedgerStateError Source #

Constructors

ILSEConfigFile Text	Failed to read or parse the network config file.
ILSEGenesisFile GenesisConfigError	Failed to read or parse a genesis file linked from the network config file.
ILSELedgerConsensusConfig GenesisConfigError	Failed to derive the Ledger or Consensus config.

Instances

Instances details

Error InitialLedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: InitialLedgerStateError -> Doc ann Source #
Exception InitialLedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: InitialLedgerStateError -> SomeException Source # fromException :: SomeException -> Maybe InitialLedgerStateError Source # displayException :: InitialLedgerStateError -> String Source # backtraceDesired :: InitialLedgerStateError -> Bool Source #
Show InitialLedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> InitialLedgerStateError -> ShowS Source # show :: InitialLedgerStateError -> String Source # showList :: [InitialLedgerStateError] -> ShowS Source #

Leadership schedule

data LeadershipError Source #

Constructors

LeaderErrDecodeLedgerStateFailure
LeaderErrDecodeProtocolStateFailure (ByteString, DecoderError)
LeaderErrDecodeProtocolEpochStateFailure DecoderError
LeaderErrDecodePoolDistributionFailure DecoderError
LeaderErrGenesisSlot
LeaderErrStakePoolHasNoStake PoolId
LeaderErrStakeDistribUnstable
Fields SlotNo Current slot SlotNo Stable after SlotNo Stability window size SlotNo Predicted last slot of the epoch
LeaderErrSlotRangeCalculationFailure Text
LeaderErrCandidateNonceStillEvolving

Instances

Instances details

Error LeadershipError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: LeadershipError -> Doc ann Source #
Show LeadershipError Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> LeadershipError -> ShowS Source # show :: LeadershipError -> String Source # showList :: [LeadershipError] -> ShowS Source #

constructGlobals :: ShelleyGenesis -> EpochInfo (Either Text) -> Globals Source #

currentEpochEligibleLeadershipSlots Source #

Arguments

:: ShelleyBasedEra era
-> ShelleyGenesis
-> EpochInfo (Either Text)
-> PParams (ShelleyLedgerEra era)
-> ProtocolState era
-> PoolId
-> SigningKey VrfKey
-> Serialised (PoolDistribution era)
-> EpochNo	Current EpochInfo
-> Either LeadershipError (Set SlotNo)

Return the slots at which a particular stake pool operator is expected to mint a block.

nextEpochEligibleLeadershipSlots Source #

Arguments

:: ShelleyBasedEra era
-> ShelleyGenesis
-> SerialisedCurrentEpochState era	We need the mark stake distribution in order to predict the following epoch's leadership schedule
-> ProtocolState era
-> PoolId	Potential slot leading stake pool
-> SigningKey VrfKey	VRF signing key of the stake pool
-> PParams (ShelleyLedgerEra era)
-> EpochInfo (Either Text)
-> (ChainTip, EpochNo)
-> Either LeadershipError (Set SlotNo)

Node Config

data NodeConfig Source #

Constructors

NodeConfig

Fields

ncPBftSignatureThreshold :: !(Maybe Double)
ncByronGenesisFile :: !(File ByronGenesisConfig 'In)
ncByronGenesisHash :: !(Maybe GenesisHashByron)
ncShelleyGenesisFile :: !(File ShelleyGenesisConfig 'In)
ncShelleyGenesisHash :: !(Maybe GenesisHashShelley)
ncAlonzoGenesisFile :: !(File AlonzoGenesis 'In)
ncAlonzoGenesisHash :: !(Maybe GenesisHashAlonzo)
ncConwayGenesisFile :: !(File ConwayGenesisConfig 'In)
ncConwayGenesisHash :: !(Maybe GenesisHashConway)
ncRequiresNetworkMagic :: !RequiresNetworkMagic
ncByronProtocolVersion :: !ProtocolVersion
ncHardForkTriggers :: !CardanoHardForkTriggers

Instances

Instances details

FromJSON NodeConfig Source #
Instance details Defined in Cardano.Api.LedgerState Methods parseJSON :: Value -> Parser NodeConfig # parseJSONList :: Value -> Parser [NodeConfig] # omittedField :: Maybe NodeConfig #

Network Config

type NodeConfigFile = File NodeConfig Source #

readNodeConfig :: (MonadError Text m, MonadIO m) => NodeConfigFile 'In -> m NodeConfig Source #

Genesis Config

data GenesisConfig Source #

Constructors

GenesisCardano !NodeConfig !Config !GenesisHashShelley !(TransitionConfig LatestKnownEra)

readCardanoGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m GenesisConfig Source #

mkProtocolInfoCardano :: SomeHasFS IO -> GenesisConfig -> IO (ProtocolInfo (CardanoBlock StandardCrypto), Tracer IO KESAgentClientTrace -> IO [MkBlockForging IO (CardanoBlock StandardCrypto)]) Source #

resolveShelleyInitialFunds Source #

Arguments

:: (MonadST m, MonadThrow m)
=> SomeHasFS m	Filesystem capability used to stream an `InjectionFromFile` source, mounted at the Shelley genesis file's directory.
-> ShelleyGenesis	The Shelley genesis whose initial funds to resolve.
-> m ShelleyGenesis

Resolve a Shelley genesis' sgInitialFunds against its sgExtraConfig, mirroring the resolution ledger's own registerInitialFunds performs when building the initial ledger state from genesis.

A ShelleyGenesis carries two sources of initial funds: the legacy sgInitialFunds field, and sgExtraConfig, which is where cardano-cli create-testnet-data puts the funded addresses, embedded or in an external hash-verified file. The ledger reconciles the two only while building the initial ledger state and never writes the result back into the ShelleyGenesis value, so a parsed genesis read outside that path must repeat the resolution. Once the ledger drops the legacy field, the two-source reconciliation here can go, but turning secInitialFunds into actual funds (including reading and hash-checking an injection file) is still needed.

Throws InjectionConflictingSources if the genesis specifies initial funds through both the legacy field and the extra config, and InjectionHashMismatch if an InjectionFromFile source does not hash to the value the genesis declares for it.

Byron Genesis Config

readByronGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m Config Source #

Shelley Genesis Config

data ShelleyConfig Source #

Constructors

ShelleyConfig
Fields scConfig :: !ShelleyGenesis scGenesisHash :: !GenesisHashShelley

newtype GenesisHashShelley Source #

Constructors

GenesisHashShelley
Fields unGenesisHashShelley :: Hash Blake2b_256 ByteString

Instances

Instances details

Eq GenesisHashShelley Source #
Instance details Defined in Cardano.Api.Genesis.Internal Methods (==) :: GenesisHashShelley -> GenesisHashShelley -> Bool Source # (/=) :: GenesisHashShelley -> GenesisHashShelley -> Bool Source #
Show GenesisHashShelley Source #
Instance details Defined in Cardano.Api.Genesis.Internal Methods showsPrec :: Int -> GenesisHashShelley -> ShowS Source # show :: GenesisHashShelley -> String Source # showList :: [GenesisHashShelley] -> ShowS Source #

readShelleyGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m ShelleyConfig Source #

readShelleyGenesis :: forall (m :: Type -> Type) t. MonadIOTransError ShelleyGenesisError t m => ShelleyGenesisFile 'In -> Maybe GenesisHashShelley -> t m ShelleyConfig Source #

data ShelleyGenesisError Source #

Constructors

ShelleyGenesisReadError !FilePath !Text
ShelleyGenesisHashMismatch !GenesisHashShelley !GenesisHashShelley
ShelleyGenesisDecodeError !FilePath !Text

Instances

Instances details

Exception ShelleyGenesisError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: ShelleyGenesisError -> SomeException Source # fromException :: SomeException -> Maybe ShelleyGenesisError Source # displayException :: ShelleyGenesisError -> String Source # backtraceDesired :: ShelleyGenesisError -> Bool Source #
Show ShelleyGenesisError Source #
Instance details Defined in Cardano.Api.LedgerState Methods showsPrec :: Int -> ShelleyGenesisError -> ShowS Source # show :: ShelleyGenesisError -> String Source # showList :: [ShelleyGenesisError] -> ShowS Source #

renderShelleyGenesisError :: ShelleyGenesisError -> Text Source #

shelleyPraosNonce :: GenesisHashShelley -> Nonce Source #

Compute the Nonce from the hash of the Genesis file.

Alonzo Genesis Config

newtype GenesisHashAlonzo Source #

Constructors

GenesisHashAlonzo
Fields unGenesisHashAlonzo :: Hash Blake2b_256 ByteString

Instances

Instances details

Eq GenesisHashAlonzo Source #
Instance details Defined in Cardano.Api.Genesis.Internal Methods (==) :: GenesisHashAlonzo -> GenesisHashAlonzo -> Bool Source # (/=) :: GenesisHashAlonzo -> GenesisHashAlonzo -> Bool Source #
Show GenesisHashAlonzo Source #
Instance details Defined in Cardano.Api.Genesis.Internal Methods showsPrec :: Int -> GenesisHashAlonzo -> ShowS Source # show :: GenesisHashAlonzo -> String Source # showList :: [GenesisHashAlonzo] -> ShowS Source #

readAlonzoGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m AlonzoGenesis Source #

Conway Genesis Config

newtype GenesisHashConway Source #

Constructors

GenesisHashConway
Fields unGenesisHashConway :: Hash Blake2b_256 ByteString

Instances

Instances details

Eq GenesisHashConway Source #
Instance details Defined in Cardano.Api.Genesis.Internal Methods (==) :: GenesisHashConway -> GenesisHashConway -> Bool Source # (/=) :: GenesisHashConway -> GenesisHashConway -> Bool Source #
Show GenesisHashConway Source #
Instance details Defined in Cardano.Api.Genesis.Internal Methods showsPrec :: Int -> GenesisHashConway -> ShowS Source # show :: GenesisHashConway -> String Source # showList :: [GenesisHashConway] -> ShowS Source #

readConwayGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m ConwayGenesis Source #

If the conway genesis file does not exist we simply put in a default.

Environment

data Env Source #

Constructors

Env
Fields envLedgerConfig :: CardanoLedgerConfig StandardCrypto envConsensusConfig :: CardanoConsensusConfig StandardCrypto

genesisConfigToEnv :: SomeHasFS IO -> GenesisConfig -> IO (Either GenesisConfigError Env) Source #