Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Cardano

Contents

The block type of the Cardano block chain
Supported protocols
Abstract over the various protocols

Synopsis

type CardanoBlock c = HardForkBlock (CardanoEras c)
type ProtocolByron = HardForkProtocol '[ByronBlock]
type ProtocolCardano = HardForkProtocol '[ByronBlock, ShelleyBlock (TPraos StandardCrypto) StandardShelley, ShelleyBlock (TPraos StandardCrypto) StandardAllegra, ShelleyBlock (TPraos StandardCrypto) StandardMary, ShelleyBlock (TPraos StandardCrypto) StandardAlonzo, ShelleyBlock (Praos StandardCrypto) StandardBabbage, ShelleyBlock (Praos StandardCrypto) StandardConway]
type ProtocolShelley = HardForkProtocol '[ShelleyBlock (TPraos StandardCrypto) StandardShelley]
newtype CardanoHardForkTriggers where
- CardanoHardForkTriggers {
  - getCardanoHardForkTriggers ∷ NP (K TriggerHardFork) (CardanoShelleyEras StandardCrypto)
  }
- pattern CardanoHardForkTriggers' ∷ TriggerHardFork → TriggerHardFork → TriggerHardFork → TriggerHardFork → TriggerHardFork → TriggerHardFork → CardanoHardForkTriggers
data family ProtocolParams blk
module Ouroboros.Consensus.Shelley.Node
module Ouroboros.Consensus.Byron.Node

The block type of the Cardano block chain

type CardanoBlock c = HardForkBlock (CardanoEras c) Source #

The Cardano block.

Thanks to the pattern synonyms, you can treat this as a sum type with constructors BlockByron, BlockShelley, etc.

f :: CardanoBlock c -> _
f (BlockByron   b) = _
f (BlockShelley s) = _
f (BlockAllegra a) = _
f (BlockMary    m) = _
f (BlockAlonzo  m) = _

Supported protocols

type ProtocolByron = HardForkProtocol '[ByronBlock] Source #

type ProtocolShelley = HardForkProtocol '[ShelleyBlock (TPraos StandardCrypto) StandardShelley] Source #

Abstract over the various protocols

newtype CardanoHardForkTriggers Source #

Constructors

CardanoHardForkTriggers
Fields getCardanoHardForkTriggers ∷ NP (K TriggerHardFork) (CardanoShelleyEras StandardCrypto)

Bundled Patterns

pattern CardanoHardForkTriggers' ∷ TriggerHardFork → TriggerHardFork → TriggerHardFork → TriggerHardFork → TriggerHardFork → TriggerHardFork → CardanoHardForkTriggers

data family ProtocolParams blk Source #

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) cardanoCheckpoints ∷ CheckpointsMap (CardanoBlock 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)) }

module Ouroboros.Consensus.Shelley.Node

module Ouroboros.Consensus.Byron.Node