ouroboros-consensus-byron-0.1.0.0: Byron ledger integration in the Ouroboros consensus layer
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Byron.Node

Synopsis

Documentation

newtype PBftSignatureThreshold Source #

Signature threshold. This represents the proportion of blocks in a pbftSignatureWindow-sized window which may be signed by any single key.

Constructors

PBftSignatureThreshold 

Fields

Instances

Instances details
Eq PBftSignatureThreshold 
Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

(==) ∷ PBftSignatureThreshold → PBftSignatureThreshold → Bool Source #

(/=) ∷ PBftSignatureThreshold → PBftSignatureThreshold → Bool Source #

Show PBftSignatureThreshold 
Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

showsPrec ∷ Int → PBftSignatureThreshold → ShowS Source #

show ∷ PBftSignatureThreshold → String Source #

showList ∷ [PBftSignatureThreshold] → ShowS Source #

Generic PBftSignatureThreshold 
Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Associated Types

type Rep PBftSignatureThreshold ∷ Type → Type Source #

Methods

from ∷ PBftSignatureThreshold → Rep PBftSignatureThreshold x Source #

to ∷ Rep PBftSignatureThreshold x → PBftSignatureThreshold Source #

NoThunks PBftSignatureThreshold 
Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

Methods

noThunks ∷ Context → PBftSignatureThreshold → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → PBftSignatureThreshold → IO (Maybe ThunkInfo) #

showTypeOf ∷ Proxy PBftSignatureThreshold → String #

type Rep PBftSignatureThreshold 
Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

type Rep PBftSignatureThreshold = D1 ('MetaData "PBftSignatureThreshold" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.1.0.0-inplace" 'True) (C1 ('MetaCons "PBftSignatureThreshold" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftSignatureThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

data ProtocolParamsByron Source #

Parameters needed to run Byron

Constructors

ProtocolParamsByron 

Fields

byronBlockForging ∷ Monad m ⇒ Overrides ByronBlock → ByronLeaderCredentials → BlockForging m ByronBlock Source #

defaultPBftSignatureThreshold ∷ PBftSignatureThreshold Source #

See chapter 4.1 of https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/byronChainSpec/latest/download-by-type/doc-pdf/blockchain-spec

mkByronConfig ∷ Config → ProtocolVersion → SoftwareVersion → BlockConfig ByronBlock Source #

protocolClientInfoByron ∷ EpochSlots → ProtocolClientInfo ByronBlock Source #

protocolInfoByron ∷ ∀ m. Monad m ⇒ ProtocolParamsByron → ProtocolInfo m ByronBlock Source #

Secrets

data ByronLeaderCredentials Source #

Credentials needed to produce blocks in the Byron era.

Constructors

ByronLeaderCredentials 

Fields

  • blcSignKey ∷ SigningKey
     
  • blcDlgCert ∷ Certificate
     
  • blcCoreNodeId ∷ CoreNodeId

    Only core nodes can produce blocks. The CoreNodeId is used to determine the order (round-robin) in which core nodes produce blocks.

  • blcLabel ∷ Text

    Identifier for this set of credentials.

    Useful when the node is running with multiple sets of credentials.

Instances

Instances details
Show ByronLeaderCredentials Source # 
Instance details

Defined in Ouroboros.Consensus.Byron.Node

Methods

showsPrec ∷ Int → ByronLeaderCredentials → ShowS Source #

show ∷ ByronLeaderCredentials → String Source #

showList ∷ [ByronLeaderCredentials] → ShowS Source #

data ByronLeaderCredentialsError Source #

Instances

Instances details
Eq ByronLeaderCredentialsError Source # 
Instance details

Defined in Ouroboros.Consensus.Byron.Node

Methods

(==) ∷ ByronLeaderCredentialsError → ByronLeaderCredentialsError → Bool Source #

(/=) ∷ ByronLeaderCredentialsError → ByronLeaderCredentialsError → Bool Source #

Show ByronLeaderCredentialsError Source # 
Instance details

Defined in Ouroboros.Consensus.Byron.Node

Methods

showsPrec ∷ Int → ByronLeaderCredentialsError → ShowS Source #

show ∷ ByronLeaderCredentialsError → String Source #

showList ∷ [ByronLeaderCredentialsError] → ShowS Source #

mkByronLeaderCredentials ∷ Config → SigningKey → Certificate → Text → Either ByronLeaderCredentialsError ByronLeaderCredentials Source #

Make the ByronLeaderCredentials, with a couple sanity checks:

  • That the block signing key and the delegation certificate match.
  • That the delegation certificate does correspond to one of the genesis keys from the genesis file.

mkPBftCanBeLeader ∷ ByronLeaderCredentials → CanBeLeader (PBft PBftByronCrypto) Source #

Orphan instances