Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.ThreadNet.Network

Contents

Tracers
Test Output

Description

Setup network

Synopsis

newtype CalcMessageDelay blk = CalcMessageDelay ((CoreNodeId, CoreNodeId) → SlotNo → Header blk → NumSlots)
data ForgeEbbEnv blk = ForgeEbbEnv {
- forgeEBB ∷ TopLevelConfig blk → SlotNo → BlockNo → ChainHash blk → blk
}
type RekeyM m blk = CoreNodeId → ProtocolInfo blk → m [BlockForging m blk] → SlotNo → (SlotNo → m EpochNo) → m (TestNodeInitialization m blk)
data TestNodeInitialization m blk = TestNodeInitialization {
- tniCrucialTxs ∷ [GenTx blk]
- tniProtocolInfo ∷ ProtocolInfo blk
- tniBlockForging ∷ m [BlockForging m blk]
}
data ThreadNetworkArgs m blk = ThreadNetworkArgs {
- tnaForgeEbbEnv ∷ Maybe (ForgeEbbEnv blk)
- tnaFuture ∷ Future
- tnaJoinPlan ∷ NodeJoinPlan
- tnaNodeInfo ∷ CoreNodeId → TestNodeInitialization m blk
- tnaNumCoreNodes ∷ NumCoreNodes
- tnaNumSlots ∷ NumSlots
- tnaMessageDelay ∷ CalcMessageDelay blk
- tnaSeed ∷ Seed
- tnaMkRekeyM ∷ Maybe (m (RekeyM m blk))
- tnaRestarts ∷ NodeRestarts
- tnaTopology ∷ NodeTopology
- tnaTxGenExtra ∷ TxGenExtra blk
- tnaVersion ∷ NodeToNodeVersion
- tnaBlockVersion ∷ BlockNodeToNodeVersion blk
}
type TracingConstraints blk = (Show blk, Show (ApplyTxErr blk), Show (Header blk), Show (GenTx blk), Show (Validated (GenTx blk)), Show (GenTxId blk), Show (ForgeStateInfo blk), Show (ForgeStateUpdateError blk), Show (CannotForge blk), HasNestedContent Header blk)
noCalcMessageDelay ∷ CalcMessageDelay blk
plainTestNodeInitialization ∷ ProtocolInfo blk → m [BlockForging m blk] → TestNodeInitialization m blk
runThreadNetwork ∷ ∀ m blk. (IOLike m, MonadTime m, MonadTimer m, RunNode blk, TxGen blk, TracingConstraints blk, HasCallStack) ⇒ SystemTime m → ThreadNetworkArgs m blk → m (TestOutput blk)
data MiniProtocolFatalException = MiniProtocolFatalException {
- mpfeType ∷ !TypeRep
- mpfeExn ∷ !SomeException
- mpfeClient ∷ !CoreNodeId
- mpfeServer ∷ !CoreNodeId
}
data MiniProtocolState
- = MiniProtocolDelayed
- | MiniProtocolRestarting
data NodeDBs db = NodeDBs {
- nodeDBsImm ∷ db
- nodeDBsVol ∷ db
- nodeDBsLgr ∷ db
- nodeDBsGsm ∷ db
}
data NodeOutput blk = NodeOutput {
- nodeOutputAdds ∷ Map SlotNo (Set (RealPoint blk, BlockNo))
- nodeOutputCannotForges ∷ Map SlotNo [CannotForge blk]
- nodeOutputFinalChain ∷ Chain blk
- nodeOutputFinalLedger ∷ LedgerState blk
- nodeOutputForges ∷ Map SlotNo blk
- nodeOutputHeaderAdds ∷ Map SlotNo [(RealPoint blk, BlockNo)]
- nodeOutputInvalids ∷ Map (RealPoint blk) [ExtValidationError blk]
- nodeOutputNodeDBs ∷ NodeDBs MockFS
- nodeOutputSelects ∷ Map SlotNo [(RealPoint blk, BlockNo)]
- nodeOutputUpdates ∷ [LedgerUpdate blk]
- nodePipeliningEvents ∷ [TracePipeliningEvent blk]
}
data TestOutput blk = TestOutput {
- testOutputNodes ∷ Map NodeId (NodeOutput blk)
- testOutputTipBlockNos ∷ Map SlotNo (Map NodeId (WithOrigin BlockNo))
}

Documentation

newtype CalcMessageDelay blk Source #

Compute the chain diffusion delay

This is the number of slots a MsgRollForward should arrive after the forge slot of the header it is carrying.

It may depend on the (sender, recipient), the current slot, and header.

Constructors

CalcMessageDelay ((CoreNodeId, CoreNodeId) → SlotNo → Header blk → NumSlots)

Instances

Instances details

Show (CalcMessageDelay blk) Source #	This type occurs in records where most of the fields are data
Instance details Defined in Test.ThreadNet.Network Methods showsPrec ∷ Int → CalcMessageDelay blk → ShowS # show ∷ CalcMessageDelay blk → String # showList ∷ [CalcMessageDelay blk] → ShowS #

data ForgeEbbEnv blk Source #

How to forge an EBB

Constructors

ForgeEbbEnv
Fields forgeEBB ∷ TopLevelConfig blk → SlotNo → BlockNo → ChainHash blk → blk

Instances

Instances details

Show (ForgeEbbEnv blk) Source #
Instance details Defined in Test.ThreadNet.Network Methods showsPrec ∷ Int → ForgeEbbEnv blk → ShowS # show ∷ ForgeEbbEnv blk → String # showList ∷ [ForgeEbbEnv blk] → ShowS #

type RekeyM m blk Source #

Arguments

= CoreNodeId
→ ProtocolInfo blk
→ m [BlockForging m blk]
→ SlotNo	The slot in which the node is rekeying
→ (SlotNo → m EpochNo)	Which epoch the slot is in
→ m (TestNodeInitialization m blk)	`tniProtocolInfo` should include new delegation cert/operational key, and `tniCrucialTxs` should include the new delegation certificate transaction

How to rekey a node with a fresh operational key

When there is a NodeRekey scheduled in the NodeRestarts, the test node will restart and use tnaRekeyM to compute its new ProtocolInfo.

data TestNodeInitialization m blk Source #

Data used when starting/restarting a node

Constructors

TestNodeInitialization

Fields

tniCrucialTxs ∷ [GenTx blk]
these transactions are added immediately and repeatedly (whenever the ledgerTipSlot changes)
In particular, a leading node's crucial transactions must (if valid) enter its mempool each slot before the node takes the mempool snapshot that determines which transactions will be included in the block it's about to forge.
tniProtocolInfo ∷ ProtocolInfo blk
tniBlockForging ∷ m [BlockForging m blk]

data ThreadNetworkArgs m blk Source #

Parameters for the test node net

Constructors

ThreadNetworkArgs

Fields

tnaForgeEbbEnv ∷ Maybe (ForgeEbbEnv blk)
tnaFuture ∷ Future
tnaJoinPlan ∷ NodeJoinPlan
tnaNodeInfo ∷ CoreNodeId → TestNodeInitialization m blk
tnaNumCoreNodes ∷ NumCoreNodes
tnaNumSlots ∷ NumSlots
tnaMessageDelay ∷ CalcMessageDelay blk
tnaSeed ∷ Seed
tnaMkRekeyM ∷ Maybe (m (RekeyM m blk))
tnaRestarts ∷ NodeRestarts
tnaTopology ∷ NodeTopology
tnaTxGenExtra ∷ TxGenExtra blk
tnaVersion ∷ NodeToNodeVersion
tnaBlockVersion ∷ BlockNodeToNodeVersion blk

type TracingConstraints blk = (Show blk, Show (ApplyTxErr blk), Show (Header blk), Show (GenTx blk), Show (Validated (GenTx blk)), Show (GenTxId blk), Show (ForgeStateInfo blk), Show (ForgeStateUpdateError blk), Show (CannotForge blk), HasNestedContent Header blk) Source #

noCalcMessageDelay ∷ CalcMessageDelay blk Source #

plainTestNodeInitialization ∷ ProtocolInfo blk → m [BlockForging m blk] → TestNodeInitialization m blk Source #

runThreadNetwork ∷ ∀ m blk. (IOLike m, MonadTime m, MonadTimer m, RunNode blk, TxGen blk, TracingConstraints blk, HasCallStack) ⇒ SystemTime m → ThreadNetworkArgs m blk → m (TestOutput blk) Source #

Setup a network of core nodes, where each joins according to the node join plan and is interconnected according to the node topology

We run for the specified number of blocks, then return the final state of each node.

Tracers

data MiniProtocolFatalException Source #

Any synchronous exception from a directedEdge

Constructors

MiniProtocolFatalException
Fields mpfeType ∷ !TypeRep Including the type explicitly makes it easier for a human to debug mpfeExn ∷ !SomeException mpfeClient ∷ !CoreNodeId mpfeServer ∷ !CoreNodeId

Instances

Instances details

Exception MiniProtocolFatalException Source #
Instance details Defined in Test.ThreadNet.Network Methods toException ∷ MiniProtocolFatalException → SomeException # fromException ∷ SomeException → Maybe MiniProtocolFatalException # displayException ∷ MiniProtocolFatalException → String #
Show MiniProtocolFatalException Source #
Instance details Defined in Test.ThreadNet.Network Methods showsPrec ∷ Int → MiniProtocolFatalException → ShowS # show ∷ MiniProtocolFatalException → String # showList ∷ [MiniProtocolFatalException] → ShowS #

data MiniProtocolState Source #

Constructors

MiniProtocolDelayed
MiniProtocolRestarting

Instances

Instances details

Show MiniProtocolState Source #
Instance details Defined in Test.ThreadNet.Network Methods showsPrec ∷ Int → MiniProtocolState → ShowS # show ∷ MiniProtocolState → String # showList ∷ [MiniProtocolState] → ShowS #

Test Output

data NodeDBs db Source #

A vector with an element for each database of a node

The db type parameter is instantiated by this module at types for mock filesystems; either the MockFS type or reference cells thereof.

Constructors

NodeDBs
Fields nodeDBsImm ∷ db nodeDBsVol ∷ db nodeDBsLgr ∷ db nodeDBsGsm ∷ db

Instances

Instances details

Foldable NodeDBs
Instance details Defined in Test.Util.ChainDB Methods fold ∷ Monoid m ⇒ NodeDBs m → m # foldMap ∷ Monoid m ⇒ (a → m) → NodeDBs a → m # foldMap' ∷ Monoid m ⇒ (a → m) → NodeDBs a → m # foldr ∷ (a → b → b) → b → NodeDBs a → b # foldr' ∷ (a → b → b) → b → NodeDBs a → b # foldl ∷ (b → a → b) → b → NodeDBs a → b # foldl' ∷ (b → a → b) → b → NodeDBs a → b # foldr1 ∷ (a → a → a) → NodeDBs a → a # foldl1 ∷ (a → a → a) → NodeDBs a → a # toList ∷ NodeDBs a → [a] # null ∷ NodeDBs a → Bool # length ∷ NodeDBs a → Int # elem ∷ Eq a ⇒ a → NodeDBs a → Bool # maximum ∷ Ord a ⇒ NodeDBs a → a # minimum ∷ Ord a ⇒ NodeDBs a → a # sum ∷ Num a ⇒ NodeDBs a → a # product ∷ Num a ⇒ NodeDBs a → a #
Traversable NodeDBs
Instance details Defined in Test.Util.ChainDB Methods traverse ∷ Applicative f ⇒ (a → f b) → NodeDBs a → f (NodeDBs b) # sequenceA ∷ Applicative f ⇒ NodeDBs (f a) → f (NodeDBs a) # mapM ∷ Monad m ⇒ (a → m b) → NodeDBs a → m (NodeDBs b) # sequence ∷ Monad m ⇒ NodeDBs (m a) → m (NodeDBs a) #
Functor NodeDBs
Instance details Defined in Test.Util.ChainDB Methods fmap ∷ (a → b) → NodeDBs a → NodeDBs b # (<$) ∷ a → NodeDBs b → NodeDBs a #

data NodeOutput blk Source #

Constructors

NodeOutput

Fields

nodeOutputAdds ∷ Map SlotNo (Set (RealPoint blk, BlockNo))
nodeOutputCannotForges ∷ Map SlotNo [CannotForge blk]
nodeOutputFinalChain ∷ Chain blk
nodeOutputFinalLedger ∷ LedgerState blk
nodeOutputForges ∷ Map SlotNo blk
nodeOutputHeaderAdds ∷ Map SlotNo [(RealPoint blk, BlockNo)]
nodeOutputInvalids ∷ Map (RealPoint blk) [ExtValidationError blk]
nodeOutputNodeDBs ∷ NodeDBs MockFS
nodeOutputSelects ∷ Map SlotNo [(RealPoint blk, BlockNo)]
nodeOutputUpdates ∷ [LedgerUpdate blk]
nodePipeliningEvents ∷ [TracePipeliningEvent blk]

data TestOutput blk Source #

Constructors

TestOutput
Fields testOutputNodes ∷ Map NodeId (NodeOutput blk) testOutputTipBlockNos ∷ Map SlotNo (Map NodeId (WithOrigin BlockNo))