Safe Haskell	None
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 ]
type ProtocolShelley = HardForkProtocol '[ ShelleyBlock ( TPraos StandardCrypto ) StandardShelley ]
data ProtocolParamsAllegra c = ProtocolParamsAllegra {
- allegraProtVer :: ProtVer
- allegraMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AllegraEra c))
}
data ProtocolParamsAlonzo c = ProtocolParamsAlonzo {
- alonzoProtVer :: ProtVer
- alonzoMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AlonzoEra c))
}
data ProtocolParamsByron = ProtocolParamsByron {
}
data ProtocolParamsMary c = ProtocolParamsMary {
- maryProtVer :: ProtVer
- maryMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( MaryEra c))
}
data ProtocolParamsShelley c = ProtocolParamsShelley {
- shelleyProtVer :: ProtVer
- shelleyMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( ShelleyEra c))
}
data ProtocolTransitionParamsShelleyBased era = ProtocolTransitionParamsShelleyBased {
- transitionTranslationContext :: TranslationContext era
- transitionTrigger :: TriggerHardFork
}
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 and BlockShelley .

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 ProtocolCardano = HardForkProtocol '[ ByronBlock , ShelleyBlock ( TPraos StandardCrypto ) StandardShelley , ShelleyBlock ( TPraos StandardCrypto ) StandardAllegra , ShelleyBlock ( TPraos StandardCrypto ) StandardMary , ShelleyBlock ( TPraos StandardCrypto ) StandardAlonzo , ShelleyBlock ( Praos StandardCrypto ) StandardBabbage ] Source #

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

Abstract over the various protocols

data ProtocolParamsAllegra c Source #

Parameters needed to run Allegra

Constructors

ProtocolParamsAllegra
Fields allegraProtVer :: ProtVer allegraMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AllegraEra c))

data ProtocolParamsAlonzo c Source #

Parameters needed to run Alonzo

Constructors

ProtocolParamsAlonzo
Fields alonzoProtVer :: ProtVer alonzoMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AlonzoEra c))

data ProtocolParamsByron Source #

Parameters needed to run Byron

Constructors

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

data ProtocolParamsMary c Source #

Parameters needed to run Mary

Constructors

ProtocolParamsMary
Fields maryProtVer :: ProtVer maryMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( MaryEra c))

data ProtocolParamsShelley c Source #

Parameters needed to run Shelley

Constructors

ProtocolParamsShelley
Fields shelleyProtVer :: ProtVer shelleyMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( ShelleyEra c))

data ProtocolTransitionParamsShelleyBased era Source #

Parameters needed to transition to a Shelley era.

Constructors

ProtocolTransitionParamsShelleyBased
Fields transitionTranslationContext :: TranslationContext era transitionTrigger :: TriggerHardFork

module Ouroboros.Consensus.Shelley.Node

module Ouroboros.Consensus.Byron.Node