cardano-node-8.8.1: The cardano full node
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Node.Protocol.Shelley

Synopsis

Documentation

mkSomeConsensusProtocolShelley :: NodeShelleyProtocolConfiguration -> Maybe ProtocolFilepaths -> ExceptT ShelleyProtocolInstantiationError IO SomeConsensusProtocol Source #

Make SomeConsensusProtocol using the Shelley 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 ShelleyProtocolInstantiationError Source #

Constructors

GenesisReadError GenesisReadError 
GenesisValidationError GenesisValidationError 
PraosLeaderCredentialsError PraosLeaderCredentialsError 

Instances

Instances details
Show ShelleyProtocolInstantiationError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

showsPrec :: Int -> ShelleyProtocolInstantiationError -> ShowS Source #

show :: ShelleyProtocolInstantiationError -> String Source #

showList :: [ShelleyProtocolInstantiationError] -> ShowS Source #

Error ShelleyProtocolInstantiationError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

prettyError :: ShelleyProtocolInstantiationError -> Doc ann #

data GenesisReadError Source #

Constructors

GenesisReadFileError !FilePath !IOException 
GenesisHashMismatch !GenesisHash !GenesisHash 
GenesisDecodeError !FilePath !String 

Instances

Instances details
Show GenesisReadError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

showsPrec :: Int -> GenesisReadError -> ShowS Source #

show :: GenesisReadError -> String Source #

showList :: [GenesisReadError] -> ShowS Source #

Error GenesisReadError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

prettyError :: GenesisReadError -> Doc ann #

newtype GenesisValidationError Source #

Constructors

GenesisValidationErrors [ValidationErr] 

Instances

Instances details
Show GenesisValidationError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

showsPrec :: Int -> GenesisValidationError -> ShowS Source #

show :: GenesisValidationError -> String Source #

showList :: [GenesisValidationError] -> ShowS Source #

Error GenesisValidationError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

prettyError :: GenesisValidationError -> Doc ann #

data PraosLeaderCredentialsError Source #

Constructors

CredentialsReadError !FilePath !IOException 
EnvelopeParseError !FilePath !String 
FileError !(FileError TextEnvelopeError) 
OCertNotSpecified 
VRFKeyNotSpecified 
KESKeyNotSpecified 
MismatchedKesKey FilePath FilePath 

Instances

Instances details
Show PraosLeaderCredentialsError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

showsPrec :: Int -> PraosLeaderCredentialsError -> ShowS Source #

show :: PraosLeaderCredentialsError -> String Source #

showList :: [PraosLeaderCredentialsError] -> ShowS Source #

Error PraosLeaderCredentialsError Source # 
Instance details

Defined in Cardano.Node.Protocol.Shelley

Methods

prettyError :: PraosLeaderCredentialsError -> Doc ann #

Reusable parts

readGenesis :: GenesisFile -> Maybe GenesisHash -> ExceptT GenesisReadError IO (ShelleyGenesis StandardCrypto, GenesisHash) Source #

readGenesisAny :: FromJSON genesis => GenesisFile -> Maybe GenesisHash -> ExceptT GenesisReadError IO (genesis, GenesisHash) Source #

readLeaderCredentials :: Maybe ProtocolFilepaths -> ExceptT PraosLeaderCredentialsError IO [ShelleyLeaderCredentials StandardCrypto] Source #

genesisHashToPraosNonce :: GenesisHash -> Nonce Source #

validateGenesis :: ShelleyGenesis StandardCrypto -> ExceptT GenesisValidationError IO () Source #