Safe Haskell	None
Language	Haskell2010

Cardano.Api.LedgerState

Contents

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

Synopsis

envSecurityParam :: Env -> Word64
newtype LedgerState where
- LedgerState {
  - clsState :: CardanoLedgerState StandardCrypto
  }
- pattern LedgerStateByron :: LedgerState ByronBlock -> LedgerState
- pattern LedgerStateShelley :: LedgerState StandardShelleyBlock -> LedgerState
- pattern LedgerStateAllegra :: LedgerState StandardAllegraBlock -> LedgerState
- pattern LedgerStateMary :: LedgerState StandardMaryBlock -> LedgerState
- pattern LedgerStateAlonzo :: LedgerState StandardAlonzoBlock -> LedgerState
- pattern LedgerStateBabbage :: LedgerState StandardBabbageBlock -> LedgerState
- pattern LedgerStateConway :: LedgerState StandardConwayBlock -> LedgerState
encodeLedgerState :: CardanoCodecConfig StandardCrypto -> LedgerState -> Encoding
decodeLedgerState :: CardanoCodecConfig StandardCrypto -> forall s. Decoder s LedgerState
initialLedgerState :: forall t (m :: Type -> Type). MonadIOTransError InitialLedgerStateError t m => 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) -> AnyNewEpochState
getAnyNewEpochState :: ShelleyBasedEra era -> LedgerState -> Either LedgerStateError AnyNewEpochState
foldBlocks :: forall a t (m :: Type -> Type). (Show a, MonadIOTransError FoldBlocksError t m) => 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. 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. 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. MonadIOTransError FoldBlocksError t m => NodeConfigFile 'In -> SocketPath -> ValidationMode -> EpochNo -> s -> (AnyNewEpochState -> SlotNo -> BlockNo -> StateT s IO ConditionResult) -> t m (ConditionResult, s)
data LedgerStateError
- = ApplyBlockHashMismatch Text
- | ApplyBlockError (CardanoLedgerError StandardCrypto)
- | InvalidRollback SlotNo ChainPoint
- | TerminationEpochReached EpochNo
- | UnexpectedLedgerState AnyShelleyBasedEra (CardanoLedgerState StandardCrypto)
- | ByronEraUnsupported
- | DebugError !String
data FoldBlocksError
- = FoldBlocksInitialLedgerStateError !InitialLedgerStateError
- | FoldBlocksApplyBlockError !LedgerStateError
- | FoldBlocksIOException !IOException
- | FoldBlocksMuxError !MuxError
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
- | LeaderErrGenesisSlot
- | LeaderErrStakePoolHasNoStake PoolId
- | LeaderErrStakeDistribUnstable SlotNo SlotNo SlotNo SlotNo
- | LeaderErrSlotRangeCalculationFailure Text
- | LeaderErrCandidateNonceStillEvolving
constructGlobals :: ShelleyGenesis StandardCrypto -> EpochInfo (Either Text) -> ProtVer -> Globals
currentEpochEligibleLeadershipSlots :: ShelleyBasedEra era -> ShelleyGenesis StandardCrypto -> EpochInfo (Either Text) -> PParams (ShelleyLedgerEra era) -> ProtocolState era -> PoolId -> SigningKey VrfKey -> SerialisedPoolDistribution era -> EpochNo -> Either LeadershipError (Set SlotNo)
nextEpochEligibleLeadershipSlots :: ShelleyBasedEra era -> ShelleyGenesis StandardCrypto -> 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 :: !GenesisHashByron
- ncShelleyGenesisFile :: !(File ShelleyGenesisConfig 'In)
- ncShelleyGenesisHash :: !GenesisHashShelley
- ncAlonzoGenesisFile :: !(File AlonzoGenesis 'In)
- ncAlonzoGenesisHash :: !GenesisHashAlonzo
- ncConwayGenesisFile :: !(Maybe (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 StandardCrypto))
readCardanoGenesisConfig :: forall t (m :: Type -> Type) era. MonadIOTransError GenesisConfigError t m => Maybe (CardanoEra era) -> NodeConfig -> t m GenesisConfig
mkProtocolInfoCardano :: GenesisConfig -> (ProtocolInfo (CardanoBlock StandardCrypto), IO [BlockForging IO (CardanoBlock StandardCrypto)])
readByronGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m Config
data ShelleyConfig = ShelleyConfig {
- scConfig :: !(ShelleyGenesis StandardCrypto)
- scGenesisHash :: !GenesisHashShelley
}
newtype GenesisHashShelley = GenesisHashShelley {
- unGenesisHashShelley :: Hash Blake2b_256 ByteString
}
readShelleyGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m ShelleyConfig
shelleyPraosNonce :: GenesisHashShelley -> Nonce
newtype GenesisHashAlonzo = GenesisHashAlonzo {
- unGenesisHashAlonzo :: Hash Blake2b_256 ByteString
}
readAlonzoGenesisConfig :: forall t (m :: Type -> Type) era. MonadIOTransError GenesisConfigError t m => Maybe (CardanoEra era) -> 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 StandardCrypto)
data Env = Env {
- envLedgerConfig :: CardanoLedgerConfig StandardCrypto
- envConsensusConfig :: CardanoConsensusConfig StandardCrypto
}
genesisConfigToEnv :: GenesisConfig -> Either GenesisConfigError Env

Initialization / Accumulation

envSecurityParam :: Env -> Word64 Source #

newtype LedgerState Source #

Constructors

LedgerState
Fields clsState :: CardanoLedgerState StandardCrypto

Bundled Patterns

pattern LedgerStateByron :: LedgerState ByronBlock -> LedgerState
pattern LedgerStateShelley :: LedgerState StandardShelleyBlock -> LedgerState
pattern LedgerStateAllegra :: LedgerState StandardAllegraBlock -> LedgerState
pattern LedgerStateMary :: LedgerState StandardMaryBlock -> LedgerState
pattern LedgerStateAlonzo :: LedgerState StandardAlonzoBlock -> LedgerState
pattern LedgerStateBabbage :: LedgerState StandardBabbageBlock -> LedgerState
pattern LedgerStateConway :: LedgerState StandardConwayBlock -> LedgerState

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 :: CardanoCodecConfig StandardCrypto -> LedgerState -> Encoding Source #

decodeLedgerState :: CardanoCodecConfig StandardCrypto -> forall s. Decoder s LedgerState Source #

initialLedgerState Source #

Arguments

:: forall t (m :: Type -> Type). MonadIOTransError InitialLedgerStateError t m
=> 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) -> 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

Traversing the block chain

foldBlocks Source #

Arguments

:: forall a t (m :: Type -> Type). (Show a, MonadIOTransError FoldBlocksError t m)
=> 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

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

chainSyncClientWithLedgerState Source #

Arguments

:: forall (m :: Type -> Type) a. 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. 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

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

fromConditionResult :: ConditionResult -> Bool Source #

toConditionResult :: Bool -> ConditionResult Source #

foldEpochState Source #

Arguments

:: forall t (m :: Type -> Type) s. MonadIOTransError FoldBlocksError t m
=> 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.

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 (CardanoLedgerState StandardCrypto) Ledgerstate from an unexpected era
ByronEraUnsupported
DebugError !String

Instances

Instances details

Exception LedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: LedgerStateError -> SomeException Source # fromException :: SomeException -> Maybe LedgerStateError Source # displayException :: LedgerStateError -> String 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 #
Error LedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: LedgerStateError -> Doc ann Source #

data FoldBlocksError Source #

Constructors

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

Instances

Instances details

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

data GenesisConfigError Source #

Constructors

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

Instances

Instances details

Exception GenesisConfigError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: GenesisConfigError -> SomeException Source # fromException :: SomeException -> Maybe GenesisConfigError Source # displayException :: GenesisConfigError -> String 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 #
Error GenesisConfigError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: GenesisConfigError -> Doc ann 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

Exception InitialLedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods toException :: InitialLedgerStateError -> SomeException Source # fromException :: SomeException -> Maybe InitialLedgerStateError Source # displayException :: InitialLedgerStateError -> String 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 #
Error InitialLedgerStateError Source #
Instance details Defined in Cardano.Api.LedgerState Methods prettyError :: InitialLedgerStateError -> Doc ann Source #

Leadership schedule

data LeadershipError Source #

Constructors

LeaderErrDecodeLedgerStateFailure
LeaderErrDecodeProtocolStateFailure (ByteString, DecoderError)
LeaderErrDecodeProtocolEpochStateFailure 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

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

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

currentEpochEligibleLeadershipSlots Source #

Arguments

:: ShelleyBasedEra era
-> ShelleyGenesis StandardCrypto
-> EpochInfo (Either Text)
-> PParams (ShelleyLedgerEra era)
-> ProtocolState era
-> PoolId
-> SigningKey VrfKey
-> SerialisedPoolDistribution 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 StandardCrypto
-> 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

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 StandardCrypto))

readCardanoGenesisConfig Source #

Arguments

:: forall t (m :: Type -> Type) era. MonadIOTransError GenesisConfigError t m
=> Maybe (CardanoEra era)	Provide era witness to read Alonzo Genesis in an era-sensitive manner (see `decodeAlonzGenesis` for more details)
-> NodeConfig
-> t m GenesisConfig

mkProtocolInfoCardano :: GenesisConfig -> (ProtocolInfo (CardanoBlock StandardCrypto), IO [BlockForging IO (CardanoBlock StandardCrypto)]) Source #

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 StandardCrypto) scGenesisHash :: !GenesisHashShelley

newtype GenesisHashShelley Source #

Constructors

GenesisHashShelley
Fields unGenesisHashShelley :: Hash Blake2b_256 ByteString

Instances

Instances details

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

readShelleyGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m ShelleyConfig 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

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

readAlonzoGenesisConfig Source #

Arguments

:: forall t (m :: Type -> Type) era. MonadIOTransError GenesisConfigError t m
=> Maybe (CardanoEra era)	Provide era witness to read Alonzo Genesis in an era-sensitive manner (see `decodeAlonzGenesis` for more details)
-> NodeConfig
-> t m AlonzoGenesis

Conway Genesis Config

newtype GenesisHashConway Source #

Constructors

GenesisHashConway
Fields unGenesisHashConway :: Hash Blake2b_256 ByteString

Instances

Instances details

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

readConwayGenesisConfig :: forall t (m :: Type -> Type). MonadIOTransError GenesisConfigError t m => NodeConfig -> t m (ConwayGenesis StandardCrypto) 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 :: GenesisConfig -> Either GenesisConfigError Env Source #