Safe Haskell	None
Language	Haskell2010

Test.ThreadNet.Infra.Shelley

Synopsis

data CoreNode c = CoreNode {
- cnGenesisKey ∷ !(SignKeyDSIGN DSIGN)
- cnDelegateKey ∷ !(SignKeyDSIGN DSIGN)
- cnStakingKey ∷ !(SignKeyDSIGN DSIGN)
- cnVRF ∷ !(SignKeyVRF (VRF c))
- cnKES ∷ !(UnsoundPureSignKeyKES (KES c))
- cnOCert ∷ !(OCert c)
}
data CoreNodeKeyInfo c = CoreNodeKeyInfo {
- cnkiKeyPair ∷ (KeyPair 'Payment, KeyPair 'Staking)
- cnkiCoreNode ∷ (KeyPair 'GenesisRole, AllIssuerKeys c 'GenesisDelegate)
}
newtype DecentralizationParam = DecentralizationParam {
- decentralizationParamToRational ∷ Rational
}
data KesConfig = KesConfig {
- maxEvolutions ∷ Word64
- slotsPerEvolution ∷ Word64
}
coreNodeKeys ∷ CoreNode c → CoreNodeKeyInfo c
genCoreNode ∷ Crypto c ⇒ KESPeriod → Gen (CoreNode c)
incrementMinorProtVer ∷ ProtVer → ProtVer
initialLovelacePerCoreNode ∷ Word64
mkCredential ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → Credential r
mkEpochSize ∷ SecurityParam → Rational → EpochSize
mkGenesisConfig ∷ PraosCrypto c ⇒ ProtVer → SecurityParam → Rational → DecentralizationParam → Word64 → SlotLength → KesConfig → [CoreNode c] → ShelleyGenesis
mkKesConfig ∷ ∀ proxy c. Crypto c ⇒ proxy c → NumSlots → KesConfig
mkKeyHash ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → KeyHash r
mkKeyHashVrf ∷ ∀ c (r ∷ KeyRoleVRF). Crypto c ⇒ SignKeyVRF (VRF c) → VRFVerKeyHash r
mkKeyPair ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → KeyPair r
mkLeaderCredentials ∷ CoreNode c → ShelleyLeaderCredentials c
mkMASetDecentralizationParamTxs ∷ ∀ proto era. (ShelleyBasedEra era, AllegraEraTxBody era, ShelleyEraTxBody era, AtMostEra "Alonzo" era) ⇒ [CoreNode (ProtoCrypto proto)] → ProtVer → SlotNo → DecentralizationParam → [GenTx (ShelleyBlock proto era)]
mkProtocolShelley ∷ ∀ m c. (KESAgentContext c m, ShelleyCompatible (TPraos c) ShelleyEra) ⇒ SomeHasFS m → ShelleyGenesis → Nonce → ProtVer → CoreNode c → m (ProtocolInfo (ShelleyBlock (TPraos c) ShelleyEra), Tracer m KESAgentClientTrace → m [MkBlockForging m (ShelleyBlock (TPraos c) ShelleyEra)])
mkSetDecentralizationParamTxs ∷ [CoreNode c] → ProtVer → SlotNo → DecentralizationParam → [GenTx (ShelleyBlock (TPraos c) ShelleyEra)]
mkVerKey ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → VKey r
networkId ∷ Network
tpraosSlotLength ∷ SlotLength

Documentation

data CoreNode c Source #

Constructors

CoreNode

Fields

cnGenesisKey ∷ !(SignKeyDSIGN DSIGN)
cnDelegateKey ∷ !(SignKeyDSIGN DSIGN)
Cold delegate key. The hash of the corresponding verification (public) key will be used as the payment credential.
cnStakingKey ∷ !(SignKeyDSIGN DSIGN)
The hash of the corresponding verification (public) key will be used as the staking credential.
cnVRF ∷ !(SignKeyVRF (VRF c))
cnKES ∷ !(UnsoundPureSignKeyKES (KES c))
cnOCert ∷ !(OCert c)

data CoreNodeKeyInfo c Source #

Constructors

CoreNodeKeyInfo
Fields cnkiKeyPair ∷ (KeyPair 'Payment, KeyPair 'Staking) cnkiCoreNode ∷ (KeyPair 'GenesisRole, AllIssuerKeys c 'GenesisDelegate)

newtype DecentralizationParam Source #

A suitable value for the d protocol parameter

In the range 0 to 1, inclusive. Beware the misnomer: 0 means fully decentralized, and 1 means fully centralized.

Constructors

DecentralizationParam
Fields decentralizationParamToRational ∷ Rational

Instances

Instances details

Arbitrary DecentralizationParam Source #

A fraction with denominator 10 and numerator 0 to 10 inclusive

Instance details

Defined in Test.ThreadNet.Infra.Shelley

Methods

arbitrary ∷ Gen DecentralizationParam Source #

shrink ∷ DecentralizationParam → [DecentralizationParam] Source #

Eq DecentralizationParam Source #

Instance details

Defined in Test.ThreadNet.Infra.Shelley

Methods

(==) ∷ DecentralizationParam → DecentralizationParam → Bool #

(/=) ∷ DecentralizationParam → DecentralizationParam → Bool #

Ord DecentralizationParam Source #

Instance details

Defined in Test.ThreadNet.Infra.Shelley

Methods

compare ∷ DecentralizationParam → DecentralizationParam → Ordering #

(<) ∷ DecentralizationParam → DecentralizationParam → Bool #

(<=) ∷ DecentralizationParam → DecentralizationParam → Bool #

(>) ∷ DecentralizationParam → DecentralizationParam → Bool #

(>=) ∷ DecentralizationParam → DecentralizationParam → Bool #

max ∷ DecentralizationParam → DecentralizationParam → DecentralizationParam #

min ∷ DecentralizationParam → DecentralizationParam → DecentralizationParam #

Generic DecentralizationParam Source #

Instance details

Defined in Test.ThreadNet.Infra.Shelley

Associated Types

type Rep DecentralizationParam

Instance details

Defined in Test.ThreadNet.Infra.Shelley

type Rep DecentralizationParam = D1 ('MetaData "DecentralizationParam" "Test.ThreadNet.Infra.Shelley" "ouroboros-consensus-4.0.0.0-inplace-unstable-shelley-testlib" 'True) (C1 ('MetaCons "DecentralizationParam" 'PrefixI 'True) (S1 ('MetaSel ('Just "decentralizationParamToRational") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)))

Methods

from ∷ DecentralizationParam → Rep DecentralizationParam x #

to ∷ Rep DecentralizationParam x → DecentralizationParam #

Show DecentralizationParam Source #

Instance details

Defined in Test.ThreadNet.Infra.Shelley

Methods

showsPrec ∷ Int → DecentralizationParam → ShowS #

show ∷ DecentralizationParam → String #

showList ∷ [DecentralizationParam] → ShowS #

type Rep DecentralizationParam Source #

Instance details

Defined in Test.ThreadNet.Infra.Shelley

type Rep DecentralizationParam = D1 ('MetaData "DecentralizationParam" "Test.ThreadNet.Infra.Shelley" "ouroboros-consensus-4.0.0.0-inplace-unstable-shelley-testlib" 'True) (C1 ('MetaCons "DecentralizationParam" 'PrefixI 'True) (S1 ('MetaSel ('Just "decentralizationParamToRational") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)))

data KesConfig Source #

Currently maxEvolutions * slotsPerEvolution is the max number of slots the test can run without needing new ocerts.

TODO This limitation may be lifted by PR #2107, see https://github.com/IntersectMBO/ouroboros-network/issues/2107.

Constructors

KesConfig
Fields maxEvolutions ∷ Word64 slotsPerEvolution ∷ Word64

coreNodeKeys ∷ CoreNode c → CoreNodeKeyInfo c Source #

genCoreNode ∷ Crypto c ⇒ KESPeriod → Gen (CoreNode c) Source #

incrementMinorProtVer ∷ ProtVer → ProtVer Source #

initialLovelacePerCoreNode ∷ Word64 Source #

mkCredential ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → Credential r Source #

mkEpochSize ∷ SecurityParam → Rational → EpochSize Source #

The epoch size, given k and f.

INVARIANT: 10 * k / f must be a whole number.

mkGenesisConfig Source #

Arguments

∷ PraosCrypto c
⇒ ProtVer	Initial protocol version
→ SecurityParam
→ Rational	Initial active slot coefficient
→ DecentralizationParam
→ Word64	Max Lovelace supply, must be >= #coreNodes * initialLovelacePerCoreNode
→ SlotLength
→ KesConfig
→ [CoreNode c]
→ ShelleyGenesis

Note: a KES algorithm supports a particular max number of KES evolutions, but we can configure a potentially lower maximum for the ledger, that's why we take it as an argument.

mkKesConfig ∷ ∀ proxy c. Crypto c ⇒ proxy c → NumSlots → KesConfig Source #

A KesConfig that will not require more evolutions than this test's crypto allows.

mkKeyHash ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → KeyHash r Source #

mkKeyHashVrf ∷ ∀ c (r ∷ KeyRoleVRF). Crypto c ⇒ SignKeyVRF (VRF c) → VRFVerKeyHash r Source #

mkKeyPair ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → KeyPair r Source #

mkLeaderCredentials ∷ CoreNode c → ShelleyLeaderCredentials c Source #

mkMASetDecentralizationParamTxs Source #

Arguments

∷ ∀ proto era. (ShelleyBasedEra era, AllegraEraTxBody era, ShelleyEraTxBody era, AtMostEra "Alonzo" era)
⇒ [CoreNode (ProtoCrypto proto)]
→ ProtVer	The proposed protocol version
→ SlotNo	The TTL
→ DecentralizationParam	The new value
→ [GenTx (ShelleyBlock proto era)]

TODO This is a copy-paste-edit of mkSetDecentralizationParamTxs

Our current plan is to replace all of this infrastructure with the ThreadNet rewrite; so we're minimizing the work and maintenance here for now.

mkProtocolShelley ∷ ∀ m c. (KESAgentContext c m, ShelleyCompatible (TPraos c) ShelleyEra) ⇒ SomeHasFS m → ShelleyGenesis → Nonce → ProtVer → CoreNode c → m (ProtocolInfo (ShelleyBlock (TPraos c) ShelleyEra), Tracer m KESAgentClientTrace → m [MkBlockForging m (ShelleyBlock (TPraos c) ShelleyEra)]) Source #

mkSetDecentralizationParamTxs Source #

Arguments

∷ [CoreNode c]
→ ProtVer	The proposed protocol version
→ SlotNo	The TTL
→ DecentralizationParam	The new value
→ [GenTx (ShelleyBlock (TPraos c) ShelleyEra)]

mkVerKey ∷ ∀ (r ∷ KeyRole). SignKeyDSIGN DSIGN → VKey r Source #

networkId ∷ Network Source #

tpraosSlotLength ∷ SlotLength Source #