ouroboros-consensus-cardano-0.1.0.0: The instantation of the Ouroboros consensus layer used by Cardano
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Cardano.Node

Synopsis

Documentation

protocolInfoCardano :: forall c m. (IOLike m, CardanoHardForkConstraints c) => ProtocolParamsByron -> ProtocolParamsShelley c Maybe -> ProtocolParamsAllegra c Maybe -> ProtocolParamsMary c Maybe -> ProtocolParamsTransition ByronBlock (ShelleyBlock (ShelleyEra c)) -> ProtocolParamsTransition (ShelleyBlock (ShelleyEra c)) (ShelleyBlock (AllegraEra c)) -> ProtocolParamsTransition (ShelleyBlock (AllegraEra c)) (ShelleyBlock (MaryEra c)) -> ProtocolInfo m (CardanoBlock c) Source #

data ProtocolParamsTransition eraFrom eraTo Source #

Parameters needed to transition between two eras.

The two eras are phantom type parameters of this type to avoid mixing up multiple ProtocolParamsTransitions

Constructors

ProtocolParamsTransition 

Fields

  • transitionLowerBound :: Maybe EpochNo

    Lower bound on first epoch of eraTo

    Setting this to Just when a true lower bound is known may particularly improve performance of bulk syncing. For example, for the transition from Byron to Shelley, Just 208 would be sound for the Cardano mainnet, since we know now that the Shelley era began in epoch 208.

    The Nothing case is useful for test and possible alternative nets.

  • transitionTrigger :: TriggerHardFork
     

data ProtocolParamsAllegra c (f :: Type -> Type) Source #

Parameters needed to run Allegra

Constructors

ProtocolParamsAllegra 

Fields

data ProtocolParamsMary c (f :: Type -> Type) Source #

Parameters needed to run Mary

Constructors

ProtocolParamsMary 

Fields

protocolClientInfoCardano :: forall c. EpochSlots -> ProtocolClientInfo (CardanoBlock c) Source #

type CardanoHardForkConstraints c = (PraosCrypto c, ShelleyBasedEra (ShelleyEra c), ShelleyBasedEra (AllegraEra c), ShelleyBasedEra (MaryEra c), HASH c ~ Blake2b_256, ADDRHASH c ~ Blake2b_224, DSIGN c ~ Ed25519DSIGN) Source #

newtype MaxMajorProtVer Source #

The maximum major protocol version.

Must be at least the current major protocol version. For Cardano mainnet, the Shelley era has major protocol verison 2.

Constructors

MaxMajorProtVer 

Fields

Instances

Instances details
Eq MaxMajorProtVer 
Instance details

Defined in Ouroboros.Consensus.Shelley.Protocol

Methods

(==) :: MaxMajorProtVer -> MaxMajorProtVer -> Bool #

(/=) :: MaxMajorProtVer -> MaxMajorProtVer -> Bool #

Show MaxMajorProtVer 
Instance details

Defined in Ouroboros.Consensus.Shelley.Protocol

Methods

showsPrec :: Int -> MaxMajorProtVer -> ShowS #

show :: MaxMajorProtVer -> String #

showList :: [MaxMajorProtVer] -> ShowS #

Generic MaxMajorProtVer 
Instance details

Defined in Ouroboros.Consensus.Shelley.Protocol

Associated Types

type Rep MaxMajorProtVer :: Type -> Type #

Methods

from :: MaxMajorProtVer -> Rep MaxMajorProtVer x #

to :: Rep MaxMajorProtVer x -> MaxMajorProtVer #

NoThunks MaxMajorProtVer 
Instance details

Defined in Ouroboros.Consensus.Shelley.Protocol

Methods

noThunks :: Context -> MaxMajorProtVer -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> MaxMajorProtVer -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy MaxMajorProtVer -> String Source #

type Rep MaxMajorProtVer 
Instance details

Defined in Ouroboros.Consensus.Shelley.Protocol

type Rep MaxMajorProtVer = D1 ('MetaData "MaxMajorProtVer" "Ouroboros.Consensus.Shelley.Protocol" "ouroboros-consensus-shelley-0.1.0.0-59swnF21REM9YduArUJWll" 'True) (C1 ('MetaCons "MaxMajorProtVer" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMaxMajorProtVer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

data TriggerHardFork Source #

The trigger condition that will cause the hard fork transition.

Constructors

TriggerHardForkAtVersion !Word16

Trigger the transition when the on-chain protocol major version (from the ledger state) reaches this number.

TriggerHardForkAtEpoch !EpochNo

For testing only, trigger the transition at a specific hard-coded epoch, irrespective of the ledger state.

TriggerHardForkNever

Never trigger a hard fork

Instances

Instances details
Show TriggerHardFork Source # 
Instance details

Defined in Ouroboros.Consensus.Cardano.CanHardFork

Methods

showsPrec :: Int -> TriggerHardFork -> ShowS #

show :: TriggerHardFork -> String #

showList :: [TriggerHardFork] -> ShowS #

Generic TriggerHardFork Source # 
Instance details

Defined in Ouroboros.Consensus.Cardano.CanHardFork

Associated Types

type Rep TriggerHardFork :: Type -> Type #

Methods

from :: TriggerHardFork -> Rep TriggerHardFork x #

to :: Rep TriggerHardFork x -> TriggerHardFork #

NoThunks TriggerHardFork Source # 
Instance details

Defined in Ouroboros.Consensus.Cardano.CanHardFork

Methods

noThunks :: Context -> TriggerHardFork -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> TriggerHardFork -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy TriggerHardFork -> String Source #

type Rep TriggerHardFork Source # 
Instance details

Defined in Ouroboros.Consensus.Cardano.CanHardFork

type Rep TriggerHardFork = D1 ('MetaData "TriggerHardFork" "Ouroboros.Consensus.Cardano.CanHardFork" "ouroboros-consensus-cardano-0.1.0.0-7Nmjb1YtTWmH6zdQxPRhTh" 'False) (C1 ('MetaCons "TriggerHardForkAtVersion" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16)) :+: (C1 ('MetaCons "TriggerHardForkAtEpoch" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo)) :+: C1 ('MetaCons "TriggerHardForkNever" 'PrefixI 'False) (U1 :: Type -> Type)))

SupportedNetworkProtocolVersion

pattern CardanoNodeToNodeVersion1 :: BlockNodeToNodeVersion (CardanoBlock c) Source #

We support only Byron V1 with the hard fork disabled, as no other versions have been released before the hard fork

pattern CardanoNodeToNodeVersion2 :: BlockNodeToNodeVersion (CardanoBlock c) Source #

The hard fork enabled with the latest Byron version and the Shelley era enabled.

pattern CardanoNodeToNodeVersion3 :: BlockNodeToNodeVersion (CardanoBlock c) Source #

The hard fork enabled with the latest Byron version, the Shelley and Allegra eras enabled.

pattern CardanoNodeToNodeVersion4 :: BlockNodeToNodeVersion (CardanoBlock c) Source #

The hard fork enabled with the latest Byron version, the Shelley, Allegra, and Mary eras enabled.

pattern CardanoNodeToClientVersion1 :: BlockNodeToClientVersion (CardanoBlock c) Source #

We support the sole Byron version with the hard fork disabled.

pattern CardanoNodeToClientVersion2 :: BlockNodeToClientVersion (CardanoBlock c) Source #

The hard fork enabled and the Shelley era enabled.

pattern CardanoNodeToClientVersion3 :: BlockNodeToClientVersion (CardanoBlock c) Source #

The hard fork enabled and the Shelley era enabled, but using ShelleyNodeToClientVersion2 and HardForkSpecificNodeToClientVersion2.

pattern CardanoNodeToClientVersion4 :: BlockNodeToClientVersion (CardanoBlock c) Source #

The hard fork enabled, and the Shelley and Allegra eras enabled.

We don't bother with ShelleyNodeToClientVersion1 and HardForkSpecificNodeToClientVersion1.

pattern CardanoNodeToClientVersion5 :: BlockNodeToClientVersion (CardanoBlock c) Source #

The hard fork enabled, and the Shelley, Allegra, and Mary eras enabled.

We don't bother with ShelleyNodeToClientVersion1.

Orphan instances

SerialiseConstraintsHFC ByronBlock Source # 
Instance details

ShelleyBasedEra era => SerialiseConstraintsHFC (ShelleyBlock era) Source # 
Instance details

CardanoHardForkConstraints c => SerialiseHFC (CardanoEras c) Source #

Important: we need to maintain binary compatibility with Byron blocks, as they are already stored on disk.

We also want to be able to efficiently detect (without having to peek far ahead) whether we're dealing with a Byron or Shelley block, so that we can invoke the right decoder. We plan to have a few more hard forks after Shelley (Goguen, Basho, Voltaire), so we want a future-proof envelope for distinguishing the different block types, i.e., a byte indicating the era.

Byron does not provide such an envelope. However, a Byron block is a CBOR 2-tuple with the first element being a tag (Word: 0 = EBB; 1 = regular block) and the second being the payload. We can easily extend this encoding format with support for Shelley, Goguen, etc.

We encode a CardanoBlock as the same CBOR 2-tuple as a Byron block, but we use the tags after 1 for the hard forks after Byron:

  1. Byron EBB
  2. Byron regular block
  3. Shelley block
  4. Allegra block
  5. Mary block
  6. Goguen block
  7. etc.

For more details, see: https://github.com/input-output-hk/ouroboros-network/pull/1175#issuecomment-558147194

Instance details

Methods

encodeDiskHfcBlock :: CodecConfig (HardForkBlock (CardanoEras c)) -> HardForkBlock (CardanoEras c) -> Encoding Source #

decodeDiskHfcBlock :: CodecConfig (HardForkBlock (CardanoEras c)) -> forall s. Decoder s (ByteString -> HardForkBlock (CardanoEras c)) Source #

reconstructHfcPrefixLen :: proxy (Header (HardForkBlock (CardanoEras c))) -> PrefixLen Source #

reconstructHfcNestedCtxt :: proxy (Header (HardForkBlock (CardanoEras c))) -> ShortByteString -> SizeInBytes -> SomeSecond (NestedCtxt Header) (HardForkBlock (CardanoEras c)) Source #

getHfcBinaryBlockInfo :: HardForkBlock (CardanoEras c) -> BinaryBlockInfo Source #

estimateHfcBlockSize :: Header (HardForkBlock (CardanoEras c)) -> SizeInBytes Source #

CardanoHardForkConstraints c => SupportedNetworkProtocolVersion (CardanoBlock c) Source # 
Instance details

Methods

supportedNodeToNodeVersions :: Proxy (CardanoBlock c) -> Map NodeToNodeVersion (BlockNodeToNodeVersion (CardanoBlock c)) Source #

supportedNodeToClientVersions :: Proxy (CardanoBlock c) -> Map NodeToClientVersion (BlockNodeToClientVersion (CardanoBlock c)) Source #