bcc-node-1.99.0
Safe HaskellNone
LanguageHaskell2010

Bcc.Node.Protocol.Sophie

Synopsis

Documentation

mkSomeConsensusProtocolSophie ∷ NodeSophieProtocolConfiguration → Maybe ProtocolFilepaths → ExceptT SophieProtocolInstantiationError IO SomeConsensusProtocol Source #

Make SomeConsensusProtocol using the Sophie 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 SophieProtocolInstantiationError Source #

Constructors

GenesisReadError GenesisReadError 
GenesisValidationError GenesisValidationError 
OptimumLeaderCredentialsError OptimumLeaderCredentialsError 

Instances

Instances details
Show SophieProtocolInstantiationError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

showsPrec ∷ Int → SophieProtocolInstantiationError → ShowS Source #

show ∷ SophieProtocolInstantiationError → String Source #

showList ∷ [SophieProtocolInstantiationError] → ShowS Source #

Error SophieProtocolInstantiationError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

displayError ∷ SophieProtocolInstantiationError → String Source #

data GenesisReadError Source #

Constructors

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

Instances

Instances details
Show GenesisReadError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

showsPrec ∷ Int → GenesisReadError → ShowS Source #

show ∷ GenesisReadError → String Source #

showList ∷ [GenesisReadError] → ShowS Source #

Error GenesisReadError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

displayError ∷ GenesisReadError → String Source #

newtype GenesisValidationError Source #

Constructors

GenesisValidationErrors [ValidationErr] 

Instances

Instances details
Show GenesisValidationError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

showsPrec ∷ Int → GenesisValidationError → ShowS Source #

show ∷ GenesisValidationError → String Source #

showList ∷ [GenesisValidationError] → ShowS Source #

Error GenesisValidationError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

displayError ∷ GenesisValidationError → String Source #

data OptimumLeaderCredentialsError Source #

Constructors

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

Instances

Instances details
Show OptimumLeaderCredentialsError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

showsPrec ∷ Int → OptimumLeaderCredentialsError → ShowS Source #

show ∷ OptimumLeaderCredentialsError → String Source #

showList ∷ [OptimumLeaderCredentialsError] → ShowS Source #

Error OptimumLeaderCredentialsError Source # 
Instance details

Defined in Bcc.Node.Protocol.Sophie

Methods

displayError ∷ OptimumLeaderCredentialsError → String Source #

Reusable parts

readGenesis ∷ GenesisFile → Maybe GenesisHash → ExceptT GenesisReadError IO (SophieGenesis StandardSophie, GenesisHash) Source #

readGenesisAny ∷ FromJSON genesis ⇒ GenesisFile → Maybe GenesisHash → ExceptT GenesisReadError IO (genesis, GenesisHash) Source #

readLeaderCredentials ∷ Maybe ProtocolFilepaths → ExceptT OptimumLeaderCredentialsError IO [TOptimumLeaderCredentials StandardCrypto] Source #

genesisHashToOptimumNonce ∷ GenesisHash → Nonce Source #

validateGenesis ∷ SophieGenesis StandardSophie → ExceptT GenesisValidationError IO () Source #