ouroboros-network:cardano-diffusion
Safe HaskellNone
LanguageHaskell2010

Cardano.Network.Diffusion

Description

This module is expected to be imported qualified (it will clash with the Ouroboros.Network.Diffusion.NonP2P).

Synopsis

Documentation

run Source #

Arguments

:: CardanoNodeArguments IO

node API: instantiated in `cardano-node`.

-> CardanoConsensusArguments RemoteAddress IO

consensus API; instantiated in `ouroboros-consensus-diffusion` (with exception of readUseBootstrapPeers field).

-> CardanoTracers IO

generic diffusion tracers; instantiated in `cardano-node`.

-> CardanoConfiguration IO

generic diffusion configuration; instantiated in `cardano-node`.

-> CardanoApplications IO a

cardano specific applications; instantiated in `ouroboros-consensus-diffusion`.

-> IO Void 

Main entry point for Cardano data diffusion service. It allows to:

  • connect to upstream peers;
  • accept connection from downstream peers, if run in InitiatorAndResponderDiffusionMode.
  • runs a local service which allows to use node-to-client protocol to obtain information from the running system. This is used by 'cardano-cli' or a wallet and a like local services.