Fields

• consensusMode :: ConsensusMode

  Field which comes from `cardano-node` configuration file (ncConsensusMode).

• genesisPeerSelectionTargets :: PeerSelectionTargets

  Fields which come from `cardano-node` configuration file.

• minNumOfBigLedgerPeers :: NumberOfBigLedgerPeers

  Field which comes from `cardano-node` configuration file.

• tracerChurnMode :: Tracer m TraceChurnMode

  Field which comes from `cardano-node` tracing system.

Fields

• churnModeVar :: StrictTVar m ChurnMode

  churn mode var is created in `ouroboros-consensus-diffusion` and shared with diffusion and peer selection policy (instantiated in `ouroboros-consensus-diffusion):

  • peer selection is updating it;
  • peer selection policy is reading it.
• churnMetrics :: PeerMetrics m ntnAddr

  churn metrics are used in cardano diffusion by SIGUSR1 handler; in consensus they are passed to

  • applications (e.g. `chain-sync` and `block-fetch`), where they are updated;
  • peer selection policy, where they are read.
• ledgerPeersAPI :: LedgerPeersConsensusInterface (LedgerPeersConsensusInterface m) m

  ledger and consensus APIs

• readUseBootstrapPeers :: STM m UseBootstrapPeers

  UseBootstrapPeers from topology file.

  readUseBootstrapPeers is created in `cardano-node`, then passed to consensus through RunNodeArgs, from which it is passed to diffusion.

Fields

• dtMuxTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) Trace)

  Mux tracer

• dtChannelTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) ChannelTrace)

  Mux's channel tracer

• dtBearerTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) BearerTrace)

  Bearer tracer

• dtHandshakeTracer :: Tracer m (WithBearer (ConnectionId ntnAddr) (TraceSendRecv (Handshake ntnVersion Term)))

  Handshake protocol tracer

• dtLocalMuxTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) Trace)

  Mux tracer for local clients

• dtLocalChannelTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) ChannelTrace)

  Mux's channel tracer for local clients

• dtLocalBearerTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) BearerTrace)

  Bearer tracer for local clients

• dtLocalHandshakeTracer :: Tracer m (WithBearer (ConnectionId ntcAddr) (TraceSendRecv (Handshake ntcVersion Term)))

  Handshake protocol tracer for local clients

• dtDiffusionTracer :: Tracer m (DiffusionTracer ntnAddr ntcAddr)

  Diffusion initialisation tracer

• dtTraceLocalRootPeersTracer :: Tracer m (TraceLocalRootPeers extraFlags ntnAddr)
   
• dtTracePublicRootPeersTracer :: Tracer m TracePublicRootPeers
   
• dtTraceLedgerPeersTracer :: Tracer m TraceLedgerPeers

  Ledger Peers tracer

• dtTracePeerSelectionTracer :: Tracer m (TracePeerSelection extraDebugState extraFlags extraPeers ntnAddr)
   
• dtDebugPeerSelectionTracer :: Tracer m (DebugPeerSelection extraState extraFlags extraPeers ntnAddr)
   
• dtTracePeerSelectionCounters :: Tracer m (PeerSelectionCounters (ViewExtraPeers extraPeers))
   
• dtPeerSelectionActionsTracer :: Tracer m (PeerSelectionActionsTrace ntnAddr ntnVersion)
   
• dtConnectionManagerTracer :: Tracer m (Trace ntnAddr (ConnectionHandlerTrace ntnVersion ntnVersionData))
   
• dtConnectionManagerTransitionTracer :: Tracer m (AbstractTransitionTrace ConnStateId)
   
• dtServerTracer :: Tracer m (Trace ntnAddr)
   
• dtInboundGovernorTracer :: Tracer m (Trace ntnAddr)
   
• dtInboundGovernorTransitionTracer :: Tracer m (RemoteTransitionTrace ntnAddr)
   
• dtDnsTracer :: Tracer m DNSTrace
   
• dtLocalConnectionManagerTracer :: Tracer m (Trace ntcAddr (ConnectionHandlerTrace ntcVersion ntcVersionData))

  Connection manager tracer for local clients

• dtLocalServerTracer :: Tracer m (Trace ntcAddr)

  Server tracer for local clients

• dtLocalInboundGovernorTracer :: Tracer m (Trace ntcAddr)

  Inbound protocol governor tracer for local clients

Fields

• dcIPv4Address :: Maybe (Either ntnFd ntnAddr)

  an IPv4 socket ready to accept connections or an IPv4 addresses

• dcIPv6Address :: Maybe (Either ntnFd ntnAddr)

  an IPv6 socket ready to accept connections or an IPv6 addresses

• dcLocalAddress :: Maybe (Either ntcFd ntcAddr)

  an AF_UNIX socket ready to accept connections or an AF_UNIX socket path or name of `named-pipe` on Windows.

  Windows Named Pipes Names of named-pipes must follow https://learn.microsoft.com/en-us/windows/win32/ipc/pipe-names, in particular:

  • It must be well formed, e.g. \.pipePipeName
  • The pipe name string specified by PipeName can include any character other than a backslash, including numbers and special characters.
  • The entire pipe name string can be up to 256 characters long. Pipe names are not case-sensitive.
  • PipeName has to include an app name to avoid clashes with other applications, e.g. cardano-node-mainnet.
  • PipeName should be different for different parallel-installable instances, e.g. mainnet vs testnet.
  • default file permissions should be right: it will be accessible to the same user.
• dcAcceptedConnectionsLimit :: AcceptedConnectionsLimit

  parameters for limiting number of accepted connections

• dcMode :: DiffusionMode

  run in initiator only mode

• dcPublicPeerSelectionVar :: StrictTVar m (PublicPeerSelectionState ntnAddr)

  public peer selection state

  It is created outside of diffusion, since it is needed to create some apps (e.g. peer sharing).

• dcPeerSelectionTargets :: PeerSelectionTargets

  selection targets for the peer governor

• dcReadLocalRootPeers :: STM m (Config extraFlags RelayAccessPoint)
   
• dcReadPublicRootPeers :: STM m (Map RelayAccessPoint PeerAdvertise)
   
• dcReadLedgerPeerSnapshot :: STM m (Maybe (LedgerPeerSnapshot 'BigLedgerPeers))

  Depending on configuration, node may provide us with a snapshot of big ledger peers taken at some slot on the chain. These peers may be selected by ledgerPeersThread when requested by the peer selection governor when the node is syncing up. This is especially useful for Genesis consensus mode.

• dcReadUseLedgerPeers :: STM m UseLedgerPeers

  UseLedgerPeers from topology file.

• dcPeerSharing :: PeerSharing

  Peer's own PeerSharing value.

  This value comes from the node's configuration file and is static.

• dcProtocolIdleTimeout :: DiffTime

  Timeout which starts once all responder protocols are idle. If the responders stay idle for duration of the timeout, the connection will be demoted, if it wasn't used by the p2p-governor it will be closed.

  Applies to Unidirectional as well as Duplex node-to-node connections.

  See serverProtocolIdleTimeout.

• dcTimeWaitTimeout :: DiffTime

  Time for which node-to-node connections are kept in TerminatingState, it should correspond to the OS configured TCP TIME_WAIT timeout.

  This timeout will apply to after a connection has been closed, its purpose is to be resilient for delayed packets in the same way TCP is using TIME_WAIT.

• dcDeadlineChurnInterval :: DiffTime

  Churn interval between churn events in deadline mode. A small fuzz is added (max 10 minutes) so that not all nodes churn at the same time.

  By default it is set to 3300 seconds.

• dcBulkChurnInterval :: DiffTime

  Churn interval between churn events in bulk sync mode. A small fuzz is added (max 1 minute) so that not all nodes churn at the same time.

  By default it is set to 300 seconds.

• dcMuxForkPolicy :: ForkPolicy ntnAddr

  A fork policy for node-to-node mini-protocol threads spawn by mux.

• dcLocalMuxForkPolicy :: ForkPolicy ntcAddr

  A fork policy for node-to-client mini-protocols threads spawn by mux.

• dcEgressPollInterval :: DiffTime

  Mux egress queue's poll interval

Fields

• daApplicationInitiatorMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorMode ntnAddr extraFlags ByteString m a Void)

  NodeToNode initiator applications for initiator only mode.

  TODO: we should accept one or the other, but not both: daApplicationInitiatorMode, daApplicationInitiatorResponderMode.

• daApplicationInitiatorResponderMode :: Versions ntnVersion ntnVersionData (OuroborosBundleWithExpandedCtx 'InitiatorResponderMode ntnAddr extraFlags ByteString m a ())

  NodeToNode initiator & responder applications for bidirectional mode.

• daLocalResponderApplication :: Versions ntcVersion ntcVersionData (OuroborosApplicationWithMinimalCtx 'ResponderMode ntcAddr ByteString m Void ())

  NodeToClient responder application (server role)

  Because p2p mode does not infect local connections we we use non-p2p apps.

• daRethrowPolicy :: RethrowPolicy

  node-to-node rethrow policy.

  TODO: should it be part of ExitPolicy?

• daReturnPolicy :: ReturnPolicy a

  node-to-node return policy

  Internally packed into ExitPolicy record.

• daRepromoteErrorDelay :: RepromoteDelay

  node-to-node error delay.

  Internally packed into ExitPolicy record.

• daLocalRethrowPolicy :: RethrowPolicy

  node-to-client rethrow policy

• daPeerSelectionPolicy :: PeerSelectionPolicy ntnAddr m

  PeerSelectionPolicy used by the outbound governor to pick peers to promote/demote ((see simplePeerSelectionPolicy).

• daPeerSharingRegistry :: PeerSharingRegistry ntnAddr m

  Used for peer sharing protocol

Fields

• lpGetLatestSlot :: STM m (WithOrigin SlotNo)
   
• lpGetLedgerPeers :: STM m [(PoolStake, NonEmpty LedgerRelayAccessPoint)]
   
• lpExtraAPI :: extraAPI