Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Consensus.Cardano.ProtocolInfo

Contents

ProtocolInfo elaboration parameter types
- Hard-fork specification
ProtocolInfo elaboration

Description

Utility functions to elaborate a Cardano ProtocolInfo from certain parameters.

Synopsis

newtype ByronSlotLengthInSeconds = ByronSlotLengthInSeconds Word64
newtype NumCoreNodes = NumCoreNodes Word64
newtype ShelleySlotLengthInSeconds = ShelleySlotLengthInSeconds Word64
data Era
- = Byron
- | Shelley
- | Allegra
- | Mary
- | Alonzo
- | Babbage
- | Conway
data HardForkSpec = HardForkSpec {
- shelleyHardForkSpec ∷ (ProtVer, TriggerHardFork)
- allegraHardForkSpec ∷ (ProtVer, TriggerHardFork)
- maryHardForkSpec ∷ (ProtVer, TriggerHardFork)
- alonzoHardForkSpec ∷ (ProtVer, TriggerHardFork)
- babbageHardForkSpec ∷ (ProtVer, TriggerHardFork)
- conwayHardForkSpec ∷ (ProtVer, TriggerHardFork)
}
hardForkInto ∷ Era → HardForkSpec
stayInByron ∷ HardForkSpec
mkSimpleTestProtocolInfo ∷ ∀ c. (CardanoHardForkConstraints c, c ~ StandardCrypto) ⇒ DecentralizationParam → SecurityParam → ByronSlotLengthInSeconds → ShelleySlotLengthInSeconds → HardForkSpec → ProtocolInfo (CardanoBlock c)
mkTestProtocolInfo ∷ ∀ m c. (CardanoHardForkConstraints c, IOLike m, c ~ StandardCrypto) ⇒ (CoreNodeId, CoreNode c) → ShelleyGenesis c → ProtocolVersion → Nonce → Config → GeneratedSecrets → Maybe PBftSignatureThreshold → HardForkSpec → (ProtocolInfo (CardanoBlock c), m [BlockForging m (CardanoBlock c)])

ProtocolInfo elaboration parameter types

newtype ByronSlotLengthInSeconds Source #

Constructors

ByronSlotLengthInSeconds Word64

newtype NumCoreNodes Source #

Constructors

NumCoreNodes Word64

Instances

Instances details

Show NumCoreNodes
Instance details Defined in Ouroboros.Consensus.Node.ProtocolInfo Methods showsPrec ∷ Int → NumCoreNodes → ShowS # show ∷ NumCoreNodes → String # showList ∷ [NumCoreNodes] → ShowS #
NoThunks NumCoreNodes
Instance details Defined in Ouroboros.Consensus.Node.ProtocolInfo Methods noThunks ∷ Context → NumCoreNodes → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → NumCoreNodes → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy NumCoreNodes → String Source #

newtype ShelleySlotLengthInSeconds Source #

Constructors

ShelleySlotLengthInSeconds Word64

Hard-fork specification

data Era Source #

Constructors

Byron
Shelley
Allegra
Mary
Alonzo
Babbage
Conway

Instances

Instances details

Enum Era Source #
Instance details Defined in Test.Consensus.Cardano.ProtocolInfo Methods succ ∷ Era → Era # pred ∷ Era → Era # toEnum ∷ Int → Era # fromEnum ∷ Era → Int # enumFrom ∷ Era → [Era] # enumFromThen ∷ Era → Era → [Era] # enumFromTo ∷ Era → Era → [Era] # enumFromThenTo ∷ Era → Era → Era → [Era] #
Show Era Source #
Instance details Defined in Test.Consensus.Cardano.ProtocolInfo Methods showsPrec ∷ Int → Era → ShowS # show ∷ Era → String # showList ∷ [Era] → ShowS #
Eq Era Source #
Instance details Defined in Test.Consensus.Cardano.ProtocolInfo Methods (==) ∷ Era → Era → Bool # (/=) ∷ Era → Era → Bool #
Ord Era Source #
Instance details Defined in Test.Consensus.Cardano.ProtocolInfo Methods compare ∷ Era → Era → Ordering # (<) ∷ Era → Era → Bool # (<=) ∷ Era → Era → Bool # (>) ∷ Era → Era → Bool # (>=) ∷ Era → Era → Bool # max ∷ Era → Era → Era # min ∷ Era → Era → Era #

data HardForkSpec Source #

This data structure is used to specify if and when hardforks should take place, and the version used at each era. See stayInByron and hardForkInto for examples.

Constructors

HardForkSpec
Fields shelleyHardForkSpec ∷ (ProtVer, TriggerHardFork) allegraHardForkSpec ∷ (ProtVer, TriggerHardFork) maryHardForkSpec ∷ (ProtVer, TriggerHardFork) alonzoHardForkSpec ∷ (ProtVer, TriggerHardFork) babbageHardForkSpec ∷ (ProtVer, TriggerHardFork) conwayHardForkSpec ∷ (ProtVer, TriggerHardFork)

hardForkInto ∷ Era → HardForkSpec Source #

stayInByron ∷ HardForkSpec Source #

ProtocolInfo elaboration

mkSimpleTestProtocolInfo Source #

Arguments

∷ ∀ c. (CardanoHardForkConstraints c, c ~ StandardCrypto)
⇒ DecentralizationParam	Network decentralization parameter.
→ SecurityParam
→ ByronSlotLengthInSeconds
→ ShelleySlotLengthInSeconds
→ HardForkSpec
→ ProtocolInfo (CardanoBlock c)

Create a Cardano protocol info for testing purposes, using some predifined settings (see below). For a more general version see mkTestProtocolInfo.

The resulting ProtocolInfo will use a randomly generated core node. This generation will use a fixed seed. See mkTestProtocolInfo for a function that takes a core node as parameter.

The resulting ProtocolInfo will:

Use a NeutralNonce.
Use a fixed number of slots per KES evolution.
Have version 0 0 0 as Byron protocol version.
Use 1 as PbftSignatureThreshold

If you want to tweak the resulting protocol info further see mkTestProtocolInfo.

The resulting ProtocolInfo contains a ledger state. The HardForkSpec parameter will determine to which era this ledger state belongs. See HardForkSpec for more details on how to specify a value of this type.

mkTestProtocolInfo Source #

Arguments

∷ ∀ m c. (CardanoHardForkConstraints c, IOLike m, c ~ StandardCrypto)
⇒ (CoreNodeId, CoreNode c)	Id of the node for which the protocol info will be elaborated.
→ ShelleyGenesis c	These nodes will be part of the initial delegation mapping, and funds will be allocated to these nodes.
→ ProtocolVersion	Protocol version of the Byron era proposal.
→ Nonce
→ Config
→ GeneratedSecrets
→ Maybe PBftSignatureThreshold
→ HardForkSpec	Specification of the era to which the initial state should hard-fork to.
→ (ProtocolInfo (CardanoBlock c), m [BlockForging m (CardanoBlock c)])

A more generalized version of mkSimpleTestProtocolInfo.