Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Byron.Node

Contents

Secrets
Orphan instances

Synopsis

protocolInfoByron :: forall m. Monad m => ProtocolParamsByron -> ProtocolInfo m ByronBlock
data ProtocolParamsByron = ProtocolParamsByron {
}
protocolClientInfoByron :: EpochSlots -> ProtocolClientInfo ByronBlock
mkByronConfig :: Config -> ProtocolVersion -> SoftwareVersion -> BlockConfig ByronBlock
newtype PBftSignatureThreshold = PBftSignatureThreshold {
- getPBftSignatureThreshold :: Double
}
defaultPBftSignatureThreshold :: PBftSignatureThreshold
byronBlockForging :: Monad m => ByronLeaderCredentials -> BlockForging m ByronBlock
data ByronLeaderCredentials = ByronLeaderCredentials {
- blcSignKey :: SigningKey
- blcDlgCert :: Certificate
- blcCoreNodeId :: CoreNodeId
- blcLabel :: Text
}
data ByronLeaderCredentialsError
mkByronLeaderCredentials :: Config -> SigningKey -> Certificate -> Text -> Either ByronLeaderCredentialsError ByronLeaderCredentials
mkPBftCanBeLeader :: ByronLeaderCredentials -> CanBeLeader (PBft PBftByronCrypto)

Documentation

protocolInfoByron :: forall m. Monad m => ProtocolParamsByron -> ProtocolInfo m ByronBlock Source #

data ProtocolParamsByron Source #

Parameters needed to run Byron

Constructors

ProtocolParamsByron
Fields byronGenesis :: Config byronPbftSignatureThreshold :: Maybe PBftSignatureThreshold byronProtocolVersion :: ProtocolVersion byronSoftwareVersion :: SoftwareVersion byronLeaderCredentials :: Maybe ByronLeaderCredentials

protocolClientInfoByron :: EpochSlots -> ProtocolClientInfo ByronBlock Source #

mkByronConfig :: Config -> ProtocolVersion -> SoftwareVersion -> BlockConfig ByronBlock Source #

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 getPBftSignatureThreshold :: Double

Instances

Instances details

Eq PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods (==) :: PBftSignatureThreshold -> PBftSignatureThreshold -> Bool # (/=) :: PBftSignatureThreshold -> PBftSignatureThreshold -> Bool #
Show PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods showsPrec :: Int -> PBftSignatureThreshold -> ShowS # show :: PBftSignatureThreshold -> String # showList :: [PBftSignatureThreshold] -> ShowS #
Generic PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Associated Types type Rep PBftSignatureThreshold :: Type -> Type # Methods from :: PBftSignatureThreshold -> Rep PBftSignatureThreshold x # to :: Rep PBftSignatureThreshold x -> PBftSignatureThreshold #
NoThunks PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods noThunks :: Context -> PBftSignatureThreshold -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> PBftSignatureThreshold -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy PBftSignatureThreshold -> String Source #
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-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "PBftSignatureThreshold" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftSignatureThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

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

byronBlockForging :: Monad m => ByronLeaderCredentials -> BlockForging 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 # show :: ByronLeaderCredentials -> String # showList :: [ByronLeaderCredentials] -> ShowS #

data ByronLeaderCredentialsError Source #

Instances

Instances details

Eq ByronLeaderCredentialsError Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node Methods (==) :: ByronLeaderCredentialsError -> ByronLeaderCredentialsError -> Bool # (/=) :: ByronLeaderCredentialsError -> ByronLeaderCredentialsError -> Bool #
Show ByronLeaderCredentialsError Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node Methods showsPrec :: Int -> ByronLeaderCredentialsError -> ShowS # show :: ByronLeaderCredentialsError -> String # showList :: [ByronLeaderCredentialsError] -> ShowS #

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

RunNode ByronBlock Source #
Instance details
ConfigSupportsNode ByronBlock Source #
Instance details Methods getSystemStart :: BlockConfig ByronBlock -> SystemStart Source # getNetworkMagic :: BlockConfig ByronBlock -> NetworkMagic Source #
NodeInitStorage ByronBlock Source #
Instance details Methods nodeImmutableDbChunkInfo :: StorageConfig ByronBlock -> ChunkInfo Source # nodeCheckIntegrity :: StorageConfig ByronBlock -> ByronBlock -> Bool Source # nodeInitChainDB :: IOLike m => StorageConfig ByronBlock -> InitChainDB m ByronBlock -> m () Source #