ouroboros-network

Ouroboros-Network Repository Hackage Documentation

This site contains Haskell documentation of

Ouroboros-Network - networking component of the Haskell implementation of Ouroboros protocols
Ouroboros-Consensus - Ouroboros Consensus family of protocols which integrate with `Ouroboros-Network`

IOSim & Monad Classes
- io-sim - IOSim monad which allows us to test networking code in simulation.
- io-classes - abstract classes under Class which allow to use real IO or the SimIO monad in a polymorphic way.

Network - low level networking libraries, independent of our choices
- Win32-network
- typed-protocols
- network-mux
Ouroboros.Network
- ouroboros-network-framework - our instantiations and implementation of servers, clients, abstractions for working with named pipes and unix sockets. These are higher level components, which don't dependent on ouroboros protocols, but build a solid foundation for the networking library
- ouroboros-network - networking library which supports /Ouroboros family of protocols/. It includes:
  - Implementations, type level specifications, and APIs of all the protocols:
    - ChainSync
    - BlockFetch
    - TxSubmission
    - TxSubmission2
    - LocalTxSubmission
    - LocalStateQuery
    - LocalTxMonitor
    - Handshake
  - /Block chain related data structures that the networking code needs to be aware of:/
    - Block
    - AnchoredFragment
  - Network applications:
    - Block Fetch Application
    - Tx Submission Applications:
      - inbound
      - outbound
    - Peer Selection
    - Data Diffusion which combines all the pieces for supporting a node
    - NodeToNode API
    - NodeToClient API

Signatures

Modules