ouroboros-consensus-cardano-0.20.0.0: The instantation of the Ouroboros consensus layer used by Cardano
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Node.Protocol.Byron

Synopsis

Documentation

mkSomeConsensusProtocolByron ∷ NodeByronProtocolConfiguration → Maybe ProtocolFilepaths → ExceptT ByronProtocolInstantiationError IO SomeConsensusProtocol Source #

Make SomeConsensusProtocol using the Byron instance.

This lets us handle multiple protocols in a generic way.

This also serves a purpose as a sanity check that we have all the necessary type class instances available.

Errors

data ByronProtocolInstantiationError Source #

Constructors

CanonicalDecodeFailure !FilePath !Text 
GenesisHashMismatch !GenesisHash !GenesisHash 
DelegationCertificateFilepathNotSpecified 
GenesisConfigurationError !FilePath !ConfigurationError 
GenesisReadError !FilePath !GenesisDataError 
CredentialsError !ByronLeaderCredentialsError 
SigningKeyDeserialiseFailure !FilePath 
SigningKeyFilepathNotSpecified 

Instances

Instances details
Show ByronProtocolInstantiationError Source # 
Instance details

Defined in Cardano.Node.Protocol.Byron

Methods

showsPrec ∷ Int → ByronProtocolInstantiationError → ShowS #

show ∷ ByronProtocolInstantiationError → String #

showList ∷ [ByronProtocolInstantiationError] → ShowS #

Error ByronProtocolInstantiationError Source # 
Instance details

Defined in Cardano.Node.Protocol.Byron

Methods

displayError ∷ ByronProtocolInstantiationError → String Source #

Reusable parts

readGenesis ∷ GenesisFile → Maybe GenesisHash → RequiresNetworkMagic → ExceptT ByronProtocolInstantiationError IO Config Source #

readLeaderCredentials ∷ Config → Maybe ProtocolFilepaths → ExceptT ByronProtocolInstantiationError IO (Maybe ByronLeaderCredentials) Source #