Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.NodeKernel

Contents

Node kernel

Synopsis

data MempoolCapacityBytesOverride
- = NoMempoolCapacityBytesOverride
- | MempoolCapacityBytesOverride !MempoolCapacityBytes
data NodeKernel m addrNTN addrNTC blk = NodeKernel {
- getChainDB ∷ ChainDB m blk
- getMempool ∷ Mempool m blk
- getTopLevelConfig ∷ TopLevelConfig blk
- getFetchClientRegistry ∷ FetchClientRegistry (ConnectionId addrNTN) (Header blk) blk m
- getFetchMode ∷ STM m FetchMode
- getLedgerStateJudgement ∷ STM m LedgerStateJudgement
- getChainSyncHandles ∷ StrictTVar m (Map (ConnectionId addrNTN) (ChainSyncClientHandle m blk))
- getPeerSharingRegistry ∷ PeerSharingRegistry addrNTN m
- getTracers ∷ Tracers m (ConnectionId addrNTN) addrNTC blk
- setBlockForging ∷ [BlockForging m blk] → m ()
- getPeerSharingAPI ∷ PeerSharingAPI addrNTN StdGen m
- getOutboundConnectionsState ∷ StrictTVar m OutboundConnectionsState
}
data NodeKernelArgs m addrNTN addrNTC blk = NodeKernelArgs {
- 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
- 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)
}
data TraceForgeEvent blk
- = TraceStartLeadershipCheck SlotNo
- | TraceSlotIsImmutable SlotNo (Point blk) BlockNo
- | TraceBlockFromFuture SlotNo SlotNo
- | TraceBlockContext SlotNo BlockNo (Point blk)
- | TraceNoLedgerState SlotNo (Point blk)
- | TraceLedgerState SlotNo (Point blk)
- | TraceNoLedgerView SlotNo OutsideForecastRange
- | TraceLedgerView SlotNo
- | TraceForgeStateUpdateError SlotNo (ForgeStateUpdateError blk)
- | TraceNodeCannotForge SlotNo (CannotForge blk)
- | TraceNodeNotLeader SlotNo
- | TraceNodeIsLeader SlotNo
- | TraceForgeTickedLedgerState SlotNo (Point blk)
- | TraceForgingMempoolSnapshot SlotNo (Point blk) (ChainHash blk) SlotNo
- | TraceForgedBlock SlotNo (Point blk) blk MempoolSize
- | TraceDidntAdoptBlock SlotNo blk
- | TraceAdoptionThreadDied SlotNo blk
- | TraceForgedInvalidBlock SlotNo blk (InvalidBlockReason blk)
- | TraceAdoptedBlock SlotNo blk [Validated (GenTx blk)]
getImmTipSlot ∷ (IOLike m, UpdateLedger blk) ⇒ NodeKernel m addrNTN addrNTC blk → STM m (WithOrigin SlotNo)
getMempoolReader ∷ ∀ m blk. (LedgerSupportsMempool blk, IOLike m, HasTxId (GenTx blk)) ⇒ Mempool m blk → TxSubmissionMempoolReader (GenTxId blk) (Validated (GenTx blk)) TicketNo m
getMempoolWriter ∷ (LedgerSupportsMempool blk, IOLike m, HasTxId (GenTx blk)) ⇒ Mempool m blk → TxSubmissionMempoolWriter (GenTxId blk) (GenTx blk) TicketNo m
getPeersFromCurrentLedger ∷ (IOLike m, LedgerSupportsPeerSelection blk) ⇒ NodeKernel m addrNTN addrNTC blk → (LedgerState blk → Bool) → STM m (Maybe [(PoolStake, NonEmpty RelayAccessPoint)])
getPeersFromCurrentLedgerAfterSlot ∷ ∀ m blk addrNTN addrNTC. (IOLike m, LedgerSupportsPeerSelection blk, UpdateLedger blk) ⇒ NodeKernel m addrNTN addrNTC blk → SlotNo → STM m (Maybe [(PoolStake, NonEmpty RelayAccessPoint)])
initNodeKernel ∷ ∀ m addrNTN addrNTC blk. (IOLike m, MonadTimer m, RunNode blk, Ord addrNTN, Hashable addrNTN, Typeable addrNTN) ⇒ NodeKernelArgs m addrNTN addrNTC blk → m (NodeKernel m addrNTN addrNTC blk)

Node kernel

data MempoolCapacityBytesOverride Source #

An override for the default MempoolCapacityBytes which is 2x the maximum transaction capacity

Constructors

NoMempoolCapacityBytesOverride	Use 2x the maximum transaction capacity of a block. This will change dynamically with the protocol parameters adopted in the current ledger.
MempoolCapacityBytesOverride !MempoolCapacityBytes	Use the following `MempoolCapacityBytes`.

Instances

Instances details

Show MempoolCapacityBytesOverride
Instance details Defined in Ouroboros.Consensus.Mempool.Capacity Methods showsPrec ∷ Int → MempoolCapacityBytesOverride → ShowS # show ∷ MempoolCapacityBytesOverride → String # showList ∷ [MempoolCapacityBytesOverride] → ShowS #
Eq MempoolCapacityBytesOverride
Instance details Defined in Ouroboros.Consensus.Mempool.Capacity Methods (==) ∷ MempoolCapacityBytesOverride → MempoolCapacityBytesOverride → Bool # (/=) ∷ MempoolCapacityBytesOverride → MempoolCapacityBytesOverride → Bool #

data NodeKernel m addrNTN addrNTC blk Source #

Interface against running relay node

Constructors

NodeKernel

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.
getLedgerStateJudgement ∷ STM m LedgerStateJudgement
The ledger judgement, used by diffusion.
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

data NodeKernelArgs m addrNTN addrNTC blk Source #

Arguments required when initializing a node

Constructors

NodeKernelArgs

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
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)

data TraceForgeEvent blk Source #

Trace the forging of a block as a slot leader.

The flow of trace events here can be visualized as follows:

TraceStartLeadershipCheck
         |
         +--- TraceSlotIsImmutable (leadership check failed)
         |
         +--- TraceBlockFromFuture (leadership check failed)
         |
 TraceBlockContext
         |
         +--- TraceNoLedgerState (leadership check failed)
         |
  TraceLedgerState
         |
         +--- TraceNoLedgerView (leadership check failed)
         |
  TraceLedgerView
         |
         +--- TraceForgeStateUpdateError (leadership check failed)
         |
         +--- TraceNodeCannotForge (leadership check failed)
         |
         +--- TraceNodeNotLeader
         |
  TraceNodeIsLeader
         |
   TraceForgedBlock
         |
         +--- TraceDidntAdoptBlock
         |
         +--- TraceForgedInvalidBlock
         |
 TraceAdoptedBlock

Constructors

TraceStartLeadershipCheck SlotNo	Start of the leadership check We record the current slot number.
TraceSlotIsImmutable SlotNo (Point blk) BlockNo	Leadership check failed: the tip of the ImmutableDB inhabits the current slot This might happen in two cases. the clock moved backwards, on restart we ignored everything from the VolatileDB since it's all in the future, and now the tip of the ImmutableDB points to a block produced in the same slot we're trying to produce a block in k = 0 and we already adopted a block from another leader of the same slot. We record both the current slot number as well as the tip of the ImmutableDB. See also https://github.com/IntersectMBO/ouroboros-network/issues/1462
TraceBlockFromFuture SlotNo SlotNo	Leadership check failed: the current chain contains a block from a slot after the current slot This can only happen if the system is under heavy load. We record both the current slot number as well as the slot number of the block at the tip of the chain. See also https://github.com/IntersectMBO/ouroboros-network/issues/1462
TraceBlockContext SlotNo BlockNo (Point blk)	We found out to which block we are going to connect the block we are about to forge. We record the current slot number, the block number of the block to connect to and its point. Note that block number of the block we will try to forge is one more than the recorded block number.
TraceNoLedgerState SlotNo (Point blk)	Leadership check failed: we were unable to get the ledger state for the point of the block we want to connect to This can happen if after choosing which block to connect to the node switched to a different fork. We expect this to happen only rather rarely, so this certainly merits a warning; if it happens a lot, that merits an investigation. We record both the current slot number as well as the point of the block we attempt to connect the new block to (that we requested the ledger state for).
TraceLedgerState SlotNo (Point blk)	We obtained a ledger state for the point of the block we want to connect to We record both the current slot number as well as the point of the block we attempt to connect the new block to (that we requested the ledger state for).
TraceNoLedgerView SlotNo OutsideForecastRange	Leadership check failed: we were unable to get the ledger view for the current slot number This will only happen if there are many missing blocks between the tip of our chain and the current slot. We record also the failure returned by `forecastFor`.
TraceLedgerView SlotNo	We obtained a ledger view for the current slot number We record the current slot number.
TraceForgeStateUpdateError SlotNo (ForgeStateUpdateError blk)	Updating the forge state failed. For example, the KES key could not be evolved anymore. We record the error returned by `updateForgeState`.
TraceNodeCannotForge SlotNo (CannotForge blk)	We did the leadership check and concluded that we should lead and forge a block, but cannot. This should only happen rarely and should be logged with warning severity. Records why we cannot forge a block.
TraceNodeNotLeader SlotNo	We did the leadership check and concluded we are not the leader We record the current slot number
TraceNodeIsLeader SlotNo	We did the leadership check and concluded we are the leader The node will soon forge; it is about to read its transactions from the Mempool. This will be followed by TraceForgedBlock.
TraceForgeTickedLedgerState SlotNo (Point blk)	We ticked the ledger state for the slot of the to-be-forged block. We record the current slot number and the point of the block we attempt to connect the new block to.
TraceForgingMempoolSnapshot SlotNo (Point blk) (ChainHash blk) SlotNo	We acquired a mempool snapshot. We record the the point of the state we are starting from (ie the point from `TraceLedgerState`) and point the mempool had most last synced wrt.
TraceForgedBlock SlotNo (Point blk) blk MempoolSize	We forged a block We record the current slot number, the point of the predecessor, the block itself, and the total size of the mempool snapshot at the time we produced the block (which may be significantly larger than the block, due to maximum block size) This will be followed by one of three messages: TraceAdoptedBlock (normally) TraceDidntAdoptBlock (rarely) TraceForgedInvalidBlock (hopefully never -- this would indicate a bug)
TraceDidntAdoptBlock SlotNo blk	We did not adopt the block we produced, but the block was valid. We must have adopted a block that another leader of the same slot produced before we got the chance of adopting our own block. This is very rare, this warrants a warning.
TraceAdoptionThreadDied SlotNo blk	We did not adopt the block we produced, because the adoption thread died. Most likely because of an async exception.
TraceForgedInvalidBlock SlotNo blk (InvalidBlockReason blk)	We forged a block that is invalid according to the ledger in the ChainDB. This means there is an inconsistency between the mempool validation and the ledger validation. This is a serious error!
TraceAdoptedBlock SlotNo blk [Validated (GenTx blk)]	We adopted the block we produced, we also trace the transactions that were adopted.

Instances

Instances details

(LedgerSupportsProtocol blk, Show blk, Show (Validated (GenTx blk)), Show (ForgeStateUpdateError blk), Show (CannotForge blk)) ⇒ Show (TraceForgeEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Node.Tracers Methods showsPrec ∷ Int → TraceForgeEvent blk → ShowS # show ∷ TraceForgeEvent blk → String # showList ∷ [TraceForgeEvent blk] → ShowS #
(LedgerSupportsProtocol blk, Eq blk, Eq (Validated (GenTx blk)), Eq (ForgeStateUpdateError blk), Eq (CannotForge blk)) ⇒ Eq (TraceForgeEvent blk) Source #
Instance details Defined in Ouroboros.Consensus.Node.Tracers Methods (==) ∷ TraceForgeEvent blk → TraceForgeEvent blk → Bool # (/=) ∷ TraceForgeEvent blk → TraceForgeEvent blk → Bool #

getImmTipSlot ∷ (IOLike m, UpdateLedger blk) ⇒ NodeKernel m addrNTN addrNTC blk → STM m (WithOrigin SlotNo) Source #

Retrieve the slot of the immutable tip

getMempoolReader ∷ ∀ m blk. (LedgerSupportsMempool blk, IOLike m, HasTxId (GenTx blk)) ⇒ Mempool m blk → TxSubmissionMempoolReader (GenTxId blk) (Validated (GenTx blk)) TicketNo m Source #

getMempoolWriter ∷ (LedgerSupportsMempool blk, IOLike m, HasTxId (GenTx blk)) ⇒ Mempool m blk → TxSubmissionMempoolWriter (GenTxId blk) (GenTx blk) TicketNo m Source #

getPeersFromCurrentLedger ∷ (IOLike m, LedgerSupportsPeerSelection blk) ⇒ NodeKernel m addrNTN addrNTC blk → (LedgerState blk → Bool) → STM m (Maybe [(PoolStake, NonEmpty RelayAccessPoint)]) Source #

Retrieve the peers registered in the current chain/ledger state by descending stake.

For example, for Shelley, this will return the stake pool relays ordered by descending stake.

Only returns a Just when the given predicate returns True. This predicate can for example check whether the slot of the ledger state is older or newer than some slot number.

We don't use the ledger state at the tip of the chain, but the ledger state k blocks back, i.e., at the tip of the immutable chain, because any stake pools registered in that ledger state are guaranteed to be stable. This justifies merging the future and current stake pools.

getPeersFromCurrentLedgerAfterSlot ∷ ∀ m blk addrNTN addrNTC. (IOLike m, LedgerSupportsPeerSelection blk, UpdateLedger blk) ⇒ NodeKernel m addrNTN addrNTC blk → SlotNo → STM m (Maybe [(PoolStake, NonEmpty RelayAccessPoint)]) Source #

Like getPeersFromCurrentLedger but with a "after slot number X" condition.

initNodeKernel ∷ ∀ m addrNTN addrNTC blk. (IOLike m, MonadTimer m, RunNode blk, Ord addrNTN, Hashable addrNTN, Typeable addrNTN) ⇒ NodeKernelArgs m addrNTN addrNTC blk → m (NodeKernel m addrNTN addrNTC blk) Source #