Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Shelley.Node

Contents

Orphan instances

Synopsis

newtype MaxMajorProtVer = MaxMajorProtVer {
- getMaxMajorProtVer ∷ Version
}
data ProtocolParamsShelleyBased c = ProtocolParamsShelleyBased {
- shelleyBasedInitialNonce ∷ Nonce
- shelleyBasedLeaderCredentials ∷ [ShelleyLeaderCredentials c]
}
data Nonce
- = Nonce !(Hash Blake2b_256 Nonce)
- | NeutralNonce
data ProtVer = ProtVer {
- pvMajor ∷ !Version
- pvMinor ∷ !Natural
}
data ShelleyGenesis = ShelleyGenesis {
- sgSystemStart ∷ !UTCTime
- sgNetworkMagic ∷ !Word32
- sgNetworkId ∷ !Network
- sgActiveSlotsCoeff ∷ !PositiveUnitInterval
- sgSecurityParam ∷ !(NonZero Word64)
- sgEpochLength ∷ !EpochSize
- sgSlotsPerKESPeriod ∷ !Word64
- sgMaxKESEvolutions ∷ !Word64
- sgSlotLength ∷ !NominalDiffTimeMicro
- sgUpdateQuorum ∷ !Word64
- sgMaxLovelaceSupply ∷ !Word64
- sgProtocolParams ∷ !(PParams ShelleyEra)
- sgGenDelegs ∷ !(Map (KeyHash 'Genesis) GenDelegPair)
- sgInitialFunds ∷ ListMap Addr Coin
- sgStaking ∷ ShelleyGenesisStaking
}
data ShelleyGenesisStaking = ShelleyGenesisStaking {
- sgsPools ∷ ListMap (KeyHash 'StakePool) PoolParams
- sgsStake ∷ ListMap (KeyHash 'Staking) (KeyHash 'StakePool)
}
emptyGenesisStaking ∷ ShelleyGenesisStaking
data ShelleyLeaderCredentials c = ShelleyLeaderCredentials {
}
protocolClientInfoShelley ∷ ProtocolClientInfo (ShelleyBlock proto era)
protocolInfoShelley ∷ (IOLike m, ShelleyCompatible (TPraos c) ShelleyEra, TxLimits (ShelleyBlock (TPraos c) ShelleyEra)) ⇒ ShelleyGenesis → ProtocolParamsShelleyBased c → ProtVer → (ProtocolInfo (ShelleyBlock (TPraos c) ShelleyEra), m [BlockForging m (ShelleyBlock (TPraos c) ShelleyEra)])
protocolInfoTPraosShelleyBased ∷ ∀ m era c. (IOLike m, ShelleyCompatible (TPraos c) era, TxLimits (ShelleyBlock (TPraos c) era)) ⇒ ProtocolParamsShelleyBased c → TransitionConfig era → ProtVer → (ProtocolInfo (ShelleyBlock (TPraos c) era), m [BlockForging m (ShelleyBlock (TPraos c) era)])
validateGenesis ∷ ShelleyGenesis → Either String ()

Documentation

newtype MaxMajorProtVer Source #

The maximum major protocol version.

This refers to the largest ledger version that this node supports.

Once the ledger protocol version (as reported by the ledger state) exceeds this version we will consider all blocks invalid. This is called the "obsolete node check" (see the ObsoleteNode error constructor).

Major ledger protocol versions are used to trigger both intra and inter era hard forks, which can potentially change the set of ledger rules that are applied.

Minor ledger protocol versions were intended to signal soft forks but they're currently unused, and they're irrelevant for the consensus logic.

For Cardano mainnet, the Shelley era has major protocol version 2. For more details, see this table

Constructors

MaxMajorProtVer
Fields getMaxMajorProtVer ∷ Version

Instances

Instances details

Generic MaxMajorProtVer

Instance details

Defined in Ouroboros.Consensus.Protocol.Praos.Common

Associated Types

type Rep MaxMajorProtVer
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common type Rep MaxMajorProtVer = D1 ('MetaData "MaxMajorProtVer" "Ouroboros.Consensus.Protocol.Praos.Common" "ouroboros-consensus-protocol-0.12.0.0-inplace" 'True) (C1 ('MetaCons "MaxMajorProtVer" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMaxMajorProtVer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))

Methods

from ∷ MaxMajorProtVer → Rep MaxMajorProtVer x #

to ∷ Rep MaxMajorProtVer x → MaxMajorProtVer #

Show MaxMajorProtVer

Instance details

Defined in Ouroboros.Consensus.Protocol.Praos.Common

Methods

showsPrec ∷ Int → MaxMajorProtVer → ShowS #

show ∷ MaxMajorProtVer → String #

showList ∷ [MaxMajorProtVer] → ShowS #

Eq MaxMajorProtVer

Instance details

Defined in Ouroboros.Consensus.Protocol.Praos.Common

Methods

(==) ∷ MaxMajorProtVer → MaxMajorProtVer → Bool #

(/=) ∷ MaxMajorProtVer → MaxMajorProtVer → Bool #

NoThunks MaxMajorProtVer

Instance details

Defined in Ouroboros.Consensus.Protocol.Praos.Common

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.Protocol.Praos.Common

type Rep MaxMajorProtVer = D1 ('MetaData "MaxMajorProtVer" "Ouroboros.Consensus.Protocol.Praos.Common" "ouroboros-consensus-protocol-0.12.0.0-inplace" 'True) (C1 ('MetaCons "MaxMajorProtVer" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMaxMajorProtVer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))

data ProtocolParamsShelleyBased c Source #

Parameters common to all Shelley-based ledgers.

When running a chain with multiple Shelley-based eras, in addition to the per-era protocol parameters, one value of ProtocolParamsShelleyBased will be needed, which is shared among all Shelley-based eras.

Constructors

ProtocolParamsShelleyBased
Fields shelleyBasedInitialNonce ∷ Nonce The initial nonce, typically derived from the hash of Genesis config JSON file. WARNING: chains using different values of this parameter will be mutually incompatible. shelleyBasedLeaderCredentials ∷ [ShelleyLeaderCredentials c]

data Nonce Source #

Evolving nonce type.

Constructors

Nonce !(Hash Blake2b_256 Nonce)
NeutralNonce	Identity element

Instances

Instances details

FromJSON Nonce

Instance details

∷ ∀ m era c. (IOLike m, ShelleyCompatible (TPraos c) era, TxLimits (ShelleyBlock (TPraos c) era))
⇒ ProtocolParamsShelleyBased c
→ TransitionConfig era
→ ProtVer	see `shelleyProtVer`, mutatis mutandi
→ (ProtocolInfo (ShelleyBlock (TPraos c) era), m [BlockForging m (ShelleyBlock (TPraos c) era)])

ShelleyCompatible proto era ⇒ BlockSupportsMetrics (ShelleyBlock proto era) Source #
Instance details Methods isSelfIssued ∷ BlockConfig (ShelleyBlock proto era) → Header (ShelleyBlock proto era) → WhetherSelfIssued Source #
ConsensusProtocol proto ⇒ BlockSupportsSanityCheck (ShelleyBlock proto era) Source #
Instance details Methods configAllSecurityParams ∷ TopLevelConfig (ShelleyBlock proto era) → NonEmpty SecurityParam Source #
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era), BlockSupportsSanityCheck (ShelleyBlock proto era), TxLimits (ShelleyBlock proto era), SerialiseNodeToClientConstraints (ShelleyBlock proto era), Crypto (ProtoCrypto proto)) ⇒ RunNode (ShelleyBlock proto era) Source #
Instance details

Documentation

Instances

Instances

Instances

Instances

Instances

Orphan instances