Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Node.Network

Description

Concrete Network stack used in a hydra-node.

This module provides a withNetwork function which is the composition of several layers in order to provide various capabilities:

withAuthentication handles messages' authentication and signature verification
withEtcdNetwork uses an etcd cluster to implement reliable broadcast

The following diagram details the various types of messages each layer is exchanging with its predecessors and successors.

          ▲
          │                        │
      Authenticated msg           msg
          │                        │
          │                        │
┌─────────┼────────────────────────▼──────┐
│                                         │
│               Authenticate              │
│                                         │
└─────────▲────────────────────────┼──────┘
          │                        │
          │                        │
         msg                      msg
          │                        │
┌─────────┼────────────────────────▼──────┐
│                                         │
│                   Etcd                  │
│                                         │
└─────────▲────────────────────────┼──────┘
          │                        │
          │        (bytes)         │
          │                        ▼

Synopsis

data NetworkConfiguration = NetworkConfiguration {
- persistenceDir :: FilePath
- signingKey :: SigningKey HydraKey
- otherParties :: [Party]
- listen :: Host
- advertise :: Host
- peers :: [Host]
- nodeId :: NodeId
}
withNetwork :: forall tx. IsTx tx => Tracer IO NetworkLog -> NetworkConfiguration -> NetworkComponent IO (Authenticated (Message tx)) (Message tx) ()
data NetworkLog

Documentation

data NetworkConfiguration Source #

Configuration for a Node network layer.

Constructors

NetworkConfiguration

Fields

persistenceDir :: FilePath
Persistence directory
signingKey :: SigningKey HydraKey
This node's signing key. This is used to sign messages sent to peers.
otherParties :: [Party]
The list of peers Party known to this node.
listen :: Host
Address to listen on for incoming connections.
advertise :: Host
Address to advertise to peers.
peers :: [Host]
Addresses and ports of remote peers.
nodeId :: NodeId
This node's id.

withNetwork Source #

Arguments

:: forall tx. IsTx tx
=> Tracer IO NetworkLog	Tracer to use for logging messages.
-> NetworkConfiguration	The network configuration
-> NetworkComponent IO (Authenticated (Message tx)) (Message tx) ()	Produces a `NetworkComponent` that can send `msg` and consumes `Authenticated` `msg`.

Starts the network layer of a node, passing configured Network to its continuation.

data NetworkLog Source #

Instances

Instances details

Arbitrary NetworkLog Source #
Instance details Defined in Hydra.Node.Network Methods arbitrary :: Gen NetworkLog shrink :: NetworkLog -> [NetworkLog]
ToJSON NetworkLog Source #
Instance details Defined in Hydra.Node.Network Methods toJSON :: NetworkLog -> Value toEncoding :: NetworkLog -> Encoding toJSONList :: [NetworkLog] -> Value toEncodingList :: [NetworkLog] -> Encoding omitField :: NetworkLog -> Bool
Generic NetworkLog Source #
Instance details Defined in Hydra.Node.Network Associated Types type Rep NetworkLog :: Type -> Type Source # Methods from :: NetworkLog -> Rep NetworkLog x Source # to :: Rep NetworkLog x -> NetworkLog Source #
Show NetworkLog Source #
Instance details Defined in Hydra.Node.Network Methods showsPrec :: Int -> NetworkLog -> ShowS Source # show :: NetworkLog -> String Source # showList :: [NetworkLog] -> ShowS Source #
Eq NetworkLog Source #
Instance details Defined in Hydra.Node.Network Methods (==) :: NetworkLog -> NetworkLog -> Bool Source # (/=) :: NetworkLog -> NetworkLog -> Bool Source #
type Rep NetworkLog Source #
Instance details Defined in Hydra.Node.Network type Rep NetworkLog = D1 ('MetaData "NetworkLog" "Hydra.Node.Network" "hydra-node-0.21.0-IAzUD3nPoh4KjMRMHOKHuC" 'False) (C1 ('MetaCons "Authenticate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthLog)) :+: C1 ('MetaCons "Etcd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EtcdLog)))