Fields

• srnBfcMaxConcurrencyBulkSync ∷ Maybe Word
   
• srnBfcMaxConcurrencyDeadline ∷ Maybe Word
   
• srnChainDbValidateOverride ∷ Bool

  If True, validate the ChainDB on init no matter what

• srnDiskPolicyArgs ∷ DiskPolicyArgs
   
• srnDatabasePath ∷ NodeDatabasePaths

  Location of the DBs

• srnDiffusionArguments ∷ Arguments IO Socket RemoteAddress LocalSocket LocalAddress
   
• srnDiffusionArgumentsExtra ∷ ExtraArguments p2p m
   
• srnDiffusionTracers ∷ Tracers RemoteAddress NodeToNodeVersion LocalAddress NodeToClientVersion IO
   
• srnDiffusionTracersExtra ∷ ExtraTracers p2p
   
• srnEnableInDevelopmentVersions ∷ Bool

  If False, then the node will limit the negotiated NTN and NTC versions to the latest " official " release (as chosen by Network and Consensus Team, with input from Node Team)

• srnTraceChainDB ∷ Tracer m (TraceEvent blk)
   
• srnMaybeMempoolCapacityOverride ∷ Maybe MempoolCapacityBytesOverride

  Determine whether to use the system default mempool capacity or explicitly set capacity of the mempool.

• srnChainSyncTimeout ∷ Maybe (m ChainSyncTimeout)

  A custom timeout for ChainSync.

Fields

• cdbImmDbArgs ∷ ImmutableDbArgs f m blk
   
• cdbVolDbArgs ∷ VolatileDbArgs f m blk
   
• cdbLgrDbArgs ∷ LgrDbArgs f m blk
   
• cdbsArgs ∷ ChainDbSpecificArgs f m blk
   

Fields

• hfbtBackoffDelay ∷ m BackoffDelay

  See BackoffDelay

• hfbtGetLedgerState ∷ STM m (LedgerState blk)
   
• hfbtLedgerConfig ∷ LedgerConfig blk
   
• hfbtRegistry ∷ ResourceRegistry m
   
• hfbtSystemTime ∷ SystemTime m
   
• hfbtTracer ∷ Tracer m (TraceBlockchainTimeEvent RelativeTime)
   
• hfbtMaxClockRewind ∷ NominalDiffTime

  Maximum time the clock can be rewound without throwing a fatal SystemClockMovedBack exception.

  When the slot length is short, e.g., Praos' 1s compared to PBFT's 20s, the chances of an NTP sync causing the clock to go back to the previous slot increase.

  We allow the system clock to rewind up to hfbtMaxClockRewind, tracing a TraceSystemClockMovedBack message in such cases. Note that the current slot *never decreases*, we just wait a bit longer in the same slot.

Fields

• llrnWithCheckedDB ∷ ∀ a. (LastShutDownWasClean → (ChainDB m blk → m a → m a) → m a) → m a

  An action that will receive a marker indicating whether the previous shutdown was considered clean and a wrapper for installing a handler to create a clean file on exit if needed. See runWithCheckedDB.

• llrnChainDbArgsDefaults ∷ Incomplete ChainDbArgs m blk

  The " static " ChainDB arguments

• llrnMkImmutableHasFS ∷ RelativeMountPoint → SomeHasFS m

  File-system on which the directory for the ImmutableDB will be created.

• llrnMkVolatileHasFS ∷ RelativeMountPoint → SomeHasFS m

  File-system on which the directories for databases other than the ImmutableDB will be created.

• llrnCustomiseChainDbArgs ∷ Complete ChainDbArgs m blk → Complete ChainDbArgs m blk

  Customise the ChainDbArgs

• llrnCustomiseNodeKernelArgs ∷ NodeKernelArgs m addrNTN (ConnectionId addrNTC) blk → NodeKernelArgs m addrNTN (ConnectionId addrNTC) blk

  Customise the NodeArgs

• llrnBfcSalt ∷ Int

  Ie bfcSalt

• llrnGsmAntiThunderingHerd ∷ StdGen

  Ie gsmAntiThunderingHerd

• llrnKeepAliveRng ∷ StdGen

  Ie $sel:keepAliveRng:NodeKernelArgs

• llrnCustomiseHardForkBlockchainTimeArgs ∷ HardForkBlockchainTimeArgs m blk → HardForkBlockchainTimeArgs m blk

  Customise the HardForkBlockchainTimeArgs

• llrnChainSyncTimeout ∷ m ChainSyncTimeout

  See ChainSyncTimeout

• llrnGenesisConfig ∷ GenesisConfig
   
• llrnRunDataDiffusion ∷ Applications addrNTN NodeToNodeVersion versionDataNTN addrNTC NodeToClientVersion versionDataNTC m NodeToNodeInitiatorResult → ExtraApplications p2p addrNTN m NodeToNodeInitiatorResult → m ()

  How to run the data diffusion applications

  run will not return before this does.

• llrnVersionDataNTC ∷ versionDataNTC
   
• llrnVersionDataNTN ∷ versionDataNTN
   
• llrnNodeToNodeVersions ∷ Map NodeToNodeVersion (BlockNodeToNodeVersion blk)

  node-to-node protocol versions to run.

• llrnNodeToClientVersions ∷ Map NodeToClientVersion (BlockNodeToClientVersion blk)

  node-to-client protocol versions to run.

• llrnMaxCaughtUpAge ∷ NominalDiffTime

  If the volatile tip is older than this, then the node will exit the CaughtUp state.

• llrnMaxClockSkew ∷ ClockSkew

  Maximum clock skew

• llrnPublicPeerSelectionStateVar ∷ StrictTVar m (PublicPeerSelectionState addrNTN)
   

Fields

• FilePath

  Immutable path, usually pointing to a non-necessarily performant volume. ImmutableDB will be stored under this path, so given /foo, the ImmutableDB will be in fooimmutable.

• FilePath

  Non-immutable (volatile data) path, usually pointing to a performant volume. Databases other than the ImmutableDB will be stored under this path, so given /bar, it will contain bar{volatile,ledger,...}.

Fields

• getChainDB ∷ ChainDB m blk

  The ChainDB of the node

• getMempool ∷ Mempool m blk

  The node's mempool

• getTopLevelConfig ∷ TopLevelConfig blk

  The node's top-level static configuration

• getFetchClientRegistry ∷ FetchClientRegistry (ConnectionId addrNTN) (Header blk) blk m

  The fetch client registry, used for the block fetch clients.

• getFetchMode ∷ STM m FetchMode

  The fetch mode, used by diffusion.

• getGsmState ∷ STM m GsmState

  The GSM state, used by diffusion. A ledger judgement can be derived from it with gsmStateToLedgerJudgement.

• getChainSyncHandles ∷ StrictTVar m (Map (ConnectionId addrNTN) (ChainSyncClientHandle m blk))

  The kill handle and exposed state for each ChainSync client.

• getPeerSharingRegistry ∷ PeerSharingRegistry addrNTN m

  Read the current peer sharing registry, used for interacting with the PeerSharing protocol

• getTracers ∷ Tracers m (ConnectionId addrNTN) addrNTC blk

  The node's tracers

• setBlockForging ∷ [BlockForging m blk] → m ()

  Set block forging

  When set with the empty list '[]' block forging will be disabled.

• getPeerSharingAPI ∷ PeerSharingAPI addrNTN StdGen m
   
• getOutboundConnectionsState ∷ StrictTVar m OutboundConnectionsState
   
• getDiffusionPipeliningSupport ∷ DiffusionPipeliningSupport
   

Fields

• tracers ∷ Tracers m (ConnectionId addrNTN) addrNTC blk
   
• registry ∷ ResourceRegistry m
   
• cfg ∷ TopLevelConfig blk
   
• btime ∷ BlockchainTime m
   
• chainDB ∷ ChainDB m blk
   
• initChainDB ∷ StorageConfig blk → InitChainDB m blk → m ()
   
• chainSyncFutureCheck ∷ SomeHeaderInFutureCheck m blk
   
• chainSyncHistoricityCheck ∷ m GsmState → HistoricityCheck m blk

  See HistoricityCheck for details.

• blockFetchSize ∷ Header blk → SizeInBytes
   
• mempoolCapacityOverride ∷ MempoolCapacityBytesOverride
   
• miniProtocolParameters ∷ MiniProtocolParameters
   
• blockFetchConfiguration ∷ BlockFetchConfiguration
   
• keepAliveRng ∷ StdGen
   
• gsmArgs ∷ GsmNodeKernelArgs m blk
   
• getUseBootstrapPeers ∷ STM m UseBootstrapPeers
   
• peerSharingRng ∷ StdGen
   
• publicPeerSelectionStateVar ∷ StrictTVar m (PublicPeerSelectionState addrNTN)
   
• genesisArgs ∷ GenesisNodeKernelArgs m blk
   
• getDiffusionPipeliningSupport ∷ DiffusionPipeliningSupport
   

Fields

• pInfoConfig ∷ TopLevelConfig b
   
• pInfoInitLedger ∷ ExtLedgerState b

  At genesis

Fields

• rnTraceConsensus ∷ Tracers m (ConnectionId addrNTN) (ConnectionId addrNTC) blk

  Consensus tracers

• rnTraceNTN ∷ Tracers m (ConnectionId addrNTN) blk DeserialiseFailure

  Protocol tracers for node-to-node communication

• rnTraceNTC ∷ Tracers m (ConnectionId addrNTC) blk DeserialiseFailure

  Protocol tracers for node-to-client communication

• rnProtocolInfo ∷ ProtocolInfo blk

  Protocol info

• rnNodeKernelHook ∷ ResourceRegistry m → NodeKernel m addrNTN (ConnectionId addrNTC) blk → m ()

  Hook called after the initialisation of the NodeKernel

  Called on the NodeKernel after creating it, but before the network layer is initialised.

• rnEnableP2P ∷ NetworkP2PMode p2p

  Network P2P Mode switch

• rnPeerSharing ∷ PeerSharing

  Network PeerSharing miniprotocol willingness flag

• rnGetUseBootstrapPeers ∷ STM m UseBootstrapPeers
   
• rnGenesisConfig ∷ GenesisConfig
   

Fields

• chainSyncClientTracer ∷ f (TraceLabelPeer remotePeer (TraceChainSyncClientEvent blk))
   
• chainSyncServerHeaderTracer ∷ f (TraceLabelPeer remotePeer (TraceChainSyncServerEvent blk))
   
• chainSyncServerBlockTracer ∷ f (TraceChainSyncServerEvent blk)
   
• blockFetchDecisionTracer ∷ f [TraceLabelPeer remotePeer (FetchDecision [Point (Header blk)])]
   
• blockFetchClientTracer ∷ f (TraceLabelPeer remotePeer (TraceFetchClientState (Header blk)))
   
• blockFetchServerTracer ∷ f (TraceLabelPeer remotePeer (TraceBlockFetchServerEvent blk))
   
• txInboundTracer ∷ f (TraceLabelPeer remotePeer (TraceTxSubmissionInbound (GenTxId blk) (GenTx blk)))
   
• txOutboundTracer ∷ f (TraceLabelPeer remotePeer (TraceTxSubmissionOutbound (GenTxId blk) (GenTx blk)))
   
• localTxSubmissionServerTracer ∷ f (TraceLocalTxSubmissionServerEvent blk)
   
• mempoolTracer ∷ f (TraceEventMempool blk)
   
• forgeTracer ∷ f (TraceLabelCreds (TraceForgeEvent blk))
   
• blockchainTimeTracer ∷ f (TraceBlockchainTimeEvent UTCTime)
   
• forgeStateInfoTracer ∷ f (TraceLabelCreds (ForgeStateInfo blk))
   
• keepAliveClientTracer ∷ f (TraceKeepAliveClient remotePeer)
   
• consensusSanityCheckTracer ∷ f SanityCheckIssue
   
• consensusErrorTracer ∷ f SomeException
   
• gsmTracer ∷ f (TraceGsmEvent (Tip blk))
   
• gddTracer ∷ f (TraceGDDEvent remotePeer blk)