Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Byron.Node

Contents

Secrets
ProtocolInfo
Orphan instances

Synopsis

newtype PBftSignatureThreshold = PBftSignatureThreshold {
- getPBftSignatureThreshold :: Double
}
blockForgingByron :: Monad m => ProtocolParams ByronBlock -> [BlockForging m ByronBlock]
byronBlockForging :: Monad m => TxOverrides ByronBlock -> 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)
data family ProtocolParams blk
defaultPBftSignatureThreshold :: PBftSignatureThreshold
mkByronConfig :: Config -> ProtocolVersion -> SoftwareVersion -> BlockConfig ByronBlock
protocolClientInfoByron :: EpochSlots -> ProtocolClientInfo ByronBlock
protocolInfoByron :: ProtocolParams ByronBlock -> ProtocolInfo ByronBlock

Documentation

newtype PBftSignatureThreshold #

Constructors

PBftSignatureThreshold
Fields getPBftSignatureThreshold :: Double

Instances

Instances details

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 #
Show PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods showsPrec :: Int -> PBftSignatureThreshold -> ShowS Source # show :: PBftSignatureThreshold -> String Source # showList :: [PBftSignatureThreshold] -> ShowS Source #
Eq PBftSignatureThreshold
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods (==) :: PBftSignatureThreshold -> PBftSignatureThreshold -> Bool Source # (/=) :: PBftSignatureThreshold -> PBftSignatureThreshold -> Bool 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.14.0.0-121Znn1OCbJFCod8haNyF" 'True) (C1 ('MetaCons "PBftSignatureThreshold" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPBftSignatureThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

blockForgingByron :: Monad m => ProtocolParams ByronBlock -> [BlockForging m ByronBlock] Source #

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

data ByronLeaderCredentialsError Source #

Instances

Instances details

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 #
Eq ByronLeaderCredentialsError Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node Methods (==) :: ByronLeaderCredentialsError -> ByronLeaderCredentialsError -> Bool Source # (/=) :: ByronLeaderCredentialsError -> ByronLeaderCredentialsError -> Bool 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 #

ProtocolInfo

data family ProtocolParams blk #

Instances

Instances details

data ProtocolParams ByronBlock Source #	Parameters needed to run Byron
Instance details Defined in Ouroboros.Consensus.Byron.Node data ProtocolParams ByronBlock = ProtocolParamsByron { byronGenesis :: Config byronPbftSignatureThreshold :: Maybe PBftSignatureThreshold byronProtocolVersion :: ProtocolVersion byronSoftwareVersion :: SoftwareVersion byronLeaderCredentials :: Maybe ByronLeaderCredentials byronMaxTxCapacityOverrides :: TxOverrides ByronBlock }
data ProtocolParams (CardanoBlock c) Source #	Parameters needed to run Cardano.
Instance details Defined in Ouroboros.Consensus.Cardano.Node data ProtocolParams (CardanoBlock c) = ProtocolParamsCardano { cardanoProtocolParamsPerEra :: PerEraProtocolParams (CardanoEras c) shelleyBasedProtocolParams :: ProtocolParamsShelleyBased c cardanoHardForkTriggers :: CardanoHardForkTriggers cardanoLedgerTransitionConfig :: TransitionConfig (LatestKnownEra c) }
data ProtocolParams (ShelleyBlock (Praos c) (BabbageEra c)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Praos data ProtocolParams (ShelleyBlock (Praos c) (BabbageEra c)) = ProtocolParamsBabbage { babbageProtVer :: ProtVer babbageMaxTxCapacityOverrides :: TxOverrides (ShelleyBlock (Praos c) (BabbageEra c)) }
data ProtocolParams (ShelleyBlock (Praos c) (ConwayEra c)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Praos data ProtocolParams (ShelleyBlock (Praos c) (ConwayEra c)) = ProtocolParamsConway { conwayProtVer :: ProtVer conwayMaxTxCapacityOverrides :: TxOverrides (ShelleyBlock (Praos c) (ConwayEra c)) }
data ProtocolParams (ShelleyBlock (TPraos c) (AllegraEra c)) Source #	Parameters needed to run Allegra
Instance details Defined in Ouroboros.Consensus.Shelley.Node.TPraos data ProtocolParams (ShelleyBlock (TPraos c) (AllegraEra c)) = ProtocolParamsAllegra { allegraProtVer :: ProtVer allegraMaxTxCapacityOverrides :: TxOverrides (ShelleyBlock (TPraos c) (AllegraEra c)) }
data ProtocolParams (ShelleyBlock (TPraos c) (AlonzoEra c)) Source #	Parameters needed to run Alonzo
Instance details Defined in Ouroboros.Consensus.Shelley.Node.TPraos data ProtocolParams (ShelleyBlock (TPraos c) (AlonzoEra c)) = ProtocolParamsAlonzo { alonzoProtVer :: ProtVer alonzoMaxTxCapacityOverrides :: TxOverrides (ShelleyBlock (TPraos c) (AlonzoEra c)) }
data ProtocolParams (ShelleyBlock (TPraos c) (MaryEra c)) Source #	Parameters needed to run Mary
Instance details Defined in Ouroboros.Consensus.Shelley.Node.TPraos data ProtocolParams (ShelleyBlock (TPraos c) (MaryEra c)) = ProtocolParamsMary { maryProtVer :: ProtVer maryMaxTxCapacityOverrides :: TxOverrides (ShelleyBlock (TPraos c) (MaryEra c)) }
data ProtocolParams (ShelleyBlock (TPraos c) (ShelleyEra c)) Source #	Parameters needed to run Shelley
Instance details Defined in Ouroboros.Consensus.Shelley.Node.TPraos data ProtocolParams (ShelleyBlock (TPraos c) (ShelleyEra c)) = ProtocolParamsShelley { shelleyProtVer :: ProtVer shelleyMaxTxCapacityOverrides :: TxOverrides (ShelleyBlock (TPraos c) (ShelleyEra c)) }

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 :: ProtocolParams ByronBlock -> ProtocolInfo ByronBlock Source #

Orphan instances

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