ouroboros-network-0.1.0.0: A networking layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Network.NodeToNode

Description

This is the starting point for a module that will bring together the overall node to node protocol, as a collection of mini-protocols.

Synopsis

Documentation

nodeToNodeProtocolsMiniProtocolParameters → (ConnectionId addr → STM m ControlMessageNodeToNodeProtocols muxMode bytes m a b) → NodeToNodeVersionOuroborosBundle muxMode addr bytes m a b Source #

Make an OuroborosApplication for the bundle of mini-protocols that make up the overall node-to-node protocol.

This function specifies the wire format protocol numbers.

The application specific protocol numbers start from 2. The MiniProtocolNum 0 is reserved for the Handshake protocol, while MiniProtocolNum 1 is reserved for DeltaQ messages. Handshake protocol is not included in NodeToNodeProtocols as it runs before mux is started but it reusing MuxBearer to send and receive messages. Only when the handshake protocol succeeds, we will know which protocols to run / multiplex.

These are chosen to not overlap with the node to client protocol numbers (and the handshake protocol number). This is not essential for correctness, but is helpful to allow a single shared implementation of tools that can analyse both protocols, e.g. wireshark plugins.

data NodeToNodeProtocols appType bytes m a b Source #

Constructors

NodeToNodeProtocols 

Fields

data MiniProtocolParameters Source #

Constructors

MiniProtocolParameters 

Fields

data NodeToNodeVersion Source #

Enumeration of node to node protocol versions.

Constructors

NodeToNodeV_7

Changes:

  • new KeepAlive codec
  • Enable CardanoNodeToNodeVersion5, i.e., Alonzo
NodeToNodeV_8

Changes:

  • Enable block diffusion pipelining in ChainSync and BlockFetch logic.
NodeToNodeV_9

Changes:

  • Enable CardanoNodeToNodeVersion6, i.e., Babbage
NodeToNodeV_10

Changes:

  • Enable full duplex connections. NOTE: This is an experimental protocol version, which is not yet released. Until initial P2P version it must be kept as the last version, which allows us to keep it as an experimental version.

Instances

Instances details
Bounded NodeToNodeVersion Source # 
Instance details

Defined in Ouroboros.Network.NodeToNode.Version

Enum NodeToNodeVersion Source # 
Instance details

Defined in Ouroboros.Network.NodeToNode.Version

Eq NodeToNodeVersion Source # 
Instance details

Defined in Ouroboros.Network.NodeToNode.Version

Ord NodeToNodeVersion Source # 
Instance details

Defined in Ouroboros.Network.NodeToNode.Version

Show NodeToNodeVersion Source # 
Instance details

Defined in Ouroboros.Network.NodeToNode.Version

data NetworkConnectTracers addr vNumber Source #

Tracer used by connectToNode (and derivatives, like connectTo or 'Ouroboros.Network.NodeToClient.connectTo).

Constructors

NetworkConnectTracers 

Fields

connectToSnocket IO Socket SockAddr → NetworkConnectTracers SockAddr NodeToNodeVersionVersions NodeToNodeVersion NodeToNodeVersionData (OuroborosApplication InitiatorMode SockAddr ByteString IO a b) → Maybe SockAddr → SockAddr → IO () Source #

A specialised version of connectToNode.

data NetworkServerTracers addr vNumber Source #

Tracers required by a server which handles inbound connections.

Constructors

NetworkServerTracers 

Fields

data NetworkMutableState addr Source #

Mutable state maintained by the network component.

Constructors

NetworkMutableState 

Fields

data AcceptedConnectionsLimit Source #

Policy which governs how to limit the number of accepted connections.

Constructors

AcceptedConnectionsLimit 

Fields

withServerSocketSnocketNetworkServerTracers SockAddr NodeToNodeVersionNetworkMutableState SockAddr → AcceptedConnectionsLimitSocketVersions NodeToNodeVersion NodeToNodeVersionData (OuroborosApplication ResponderMode SockAddr ByteString IO a b) → ErrorPoliciesIO Void Source #

A specialised version of withServerNode. It forks a thread which runs an accept loop (server thread):

  • when the server thread throws an exception the main thread rethrows it (by wait)
  • when an async exception is thrown to kill the main thread the server thread will be cancelled as well (by withAsync)

P2P Governor

data DomainAccessPoint Source #

A product of a Domain and PortNumber. After resolving the domain we will use the PortNumber to form SockAddr.

Instances

Instances details
Eq DomainAccessPoint Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Ord DomainAccessPoint Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Show DomainAccessPoint Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

FromJSON DomainAccessPoint Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

parseJSON ∷ Value → Parser DomainAccessPoint

parseJSONList ∷ Value → Parser [DomainAccessPoint]

ToJSON DomainAccessPoint Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.RelayAccessPoint

Methods

toJSONDomainAccessPoint → Value

toEncodingDomainAccessPoint → Encoding

toJSONList ∷ [DomainAccessPoint] → Value

toEncodingList ∷ [DomainAccessPoint] → Encoding

data PeerAdvertise Source #

Should this peer be advertised to other peers asking for known peers? For certain peers specified by configuration it would be an appropriate policy to keep them private.

Instances

Instances details
Eq PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

Ord PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

Show PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

Generic PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

Associated Types

type Rep PeerAdvertiseTypeType Source #

FromJSON PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

Methods

parseJSON ∷ Value → Parser PeerAdvertise

parseJSONList ∷ Value → Parser [PeerAdvertise]

ToJSON PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

Methods

toJSONPeerAdvertise → Value

toEncodingPeerAdvertise → Encoding

toJSONList ∷ [PeerAdvertise] → Value

toEncodingList ∷ [PeerAdvertise] → Encoding

type Rep PeerAdvertise Source # 
Instance details

Defined in Ouroboros.Network.PeerSelection.Types

type Rep PeerAdvertise = D1 ('MetaData "PeerAdvertise" "Ouroboros.Network.PeerSelection.Types" "ouroboros-network-0.1.0.0-inplace" 'False) (C1 ('MetaCons "DoNotAdvertisePeer" 'PrefixI 'False) (U1TypeType) :+: C1 ('MetaCons "DoAdvertisePeer" 'PrefixI 'False) (U1TypeType))

data PeerSelectionTargets Source #

Adjustable targets for the peer selection mechanism.

These are used by the peer selection governor as targets. They are used by the peer churn governor loop as knobs to adjust, to influence the peer selection governor.

The known, established and active peer targets are targets both from below and from above: the governor will attempt to grow or shrink the sets to hit these targets.

Unlike the other targets, the root peer target is "one sided", it is only a target from below. The governor does not try to shrink the root set to hit it, it simply stops looking for more.

There is also an implicit target that enough local root peers are selected as active. This comes from the configuration for local roots, and is not an independently adjustable target.

Subscription Workers

IP subscription worker

data IPSubscriptionTarget Source #

Constructors

IPSubscriptionTarget 

Fields

  • ispIps ∷ ![SockAddr]

    List of destinations to possibly connect to

  • ispValency ∷ !Int

    Number of parallel connections to keep actice.

data NetworkSubscriptionTracers withIPList addr vNumber Source #

IP subscription tracers.

Constructors

NetworkSubscriptionTracers 

Fields

data SubscriptionParams a target Source #

ipSubscriptionWorker and dnsSubscriptionWorker parameters

Constructors

SubscriptionParams 

Fields

ipSubscriptionWorker ∷ ∀ mode x y. HasInitiator mode ~ TrueSocketSnocketNetworkIPSubscriptionTracers SockAddr NodeToNodeVersionNetworkMutableState SockAddr → IPSubscriptionParams () → Versions NodeToNodeVersion NodeToNodeVersionData (OuroborosApplication mode SockAddr ByteString IO x y) → IO Void Source #

ipSubscriptionWorker which starts given application versions on each established connection.

DNS subscription worker

data NetworkDNSSubscriptionTracers vNumber addr Source #

DNS subscription tracers.

Constructors

NetworkDNSSubscriptionTracers 

Fields

dnsSubscriptionWorker ∷ ∀ mode x y. HasInitiator mode ~ TrueSocketSnocketNetworkDNSSubscriptionTracers NodeToNodeVersion SockAddr → NetworkMutableState SockAddr → DnsSubscriptionParams () → Versions NodeToNodeVersion NodeToNodeVersionData (OuroborosApplication mode SockAddr ByteString IO x y) → IO Void Source #

dnsSubscriptionWorker which starts given application versions on each established connection.

Versions

newtype Versions vNum vData r Source #

The version map supported by the local agent keyed on the version identifier.

Each Version contains a function which takes negotiated version data and returns negotiated application (the r type variable).

If one needs to combine multiple versions the simplest way is to use one of the combinators: foldMapVersions, combineVersions or the Semigroup instance directly:

fold $ (simpleSingletonVersions ...)
      :| [ (simpleSingletonVersions ...)
         , (simpleSingletonVersions ...)
         , ...
         ]

Constructors

Versions 

Fields

Instances

Instances details
Functor (Versions vNum extra) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Version

Methods

fmap ∷ (a → b) → Versions vNum extra a → Versions vNum extra b Source #

(<$) ∷ a → Versions vNum extra b → Versions vNum extra a Source #

Ord vNum ⇒ Semigroup (Versions vNum vData r) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Version

Methods

(<>)Versions vNum vData r → Versions vNum vData r → Versions vNum vData r Source #

sconcatNonEmpty (Versions vNum vData r) → Versions vNum vData r Source #

stimesIntegral b ⇒ b → Versions vNum vData r → Versions vNum vData r Source #

data DiffusionMode Source #

The flag which indicates whether the node runs only initiator or both initiator or responder node.

This data structure has two proposes:

  • instruct the diffusion layer if it should listen on incoming connections;
  • it is communicated via NodeToNodeVersionData during handshake negotiation. In non-p2p mode we always send InitiatorOnlyDiffusionMode, in p2p mode we send exactly what the diffusion is given. In non-p2p mode every connection outbound port is ephemeral, the remote side cannot connect to it, however in p2p mode the outbound port is actually the port on which the node is listening (if it runs in InitiatorAndResponderDiffusionMode).

simpleSingletonVersions ∷ vNum → vData → r → Versions vNum vData r Source #

Singleton smart constructor for Versions.

foldMapVersions ∷ (Ord vNum, Foldable f, HasCallStack) ⇒ (x → Versions vNum extra r) → f x → Versions vNum extra r Source #

Useful for folding multiple Versions.

A foldMap restricted to the Versions Semigroup.

PRECONDITION: f x is non-empty.

combineVersions ∷ (Ord vNum, Foldable f, HasCallStack) ⇒ f (Versions vNum extra r) → Versions vNum extra r Source #

Codecs

nodeToNodeHandshakeCodec ∷ MonadST m ⇒ Codec (Handshake NodeToNodeVersion Term) DeserialiseFailure m ByteString Source #

Handshake codec for the node-to-node protocol suite.

Re-exports

data ConnectionId addr Source #

Connection is identified by local and remote address.

TODO: the type variable which this data type fills in is called peerid. We should renamed to connectionId.

Constructors

ConnectionId 

Fields

Instances

Instances details
Eq addr ⇒ Eq (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

(==)ConnectionId addr → ConnectionId addr → Bool Source #

(/=)ConnectionId addr → ConnectionId addr → Bool Source #

Ord addr ⇒ Ord (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

compareConnectionId addr → ConnectionId addr → Ordering Source #

(<)ConnectionId addr → ConnectionId addr → Bool Source #

(<=)ConnectionId addr → ConnectionId addr → Bool Source #

(>)ConnectionId addr → ConnectionId addr → Bool Source #

(>=)ConnectionId addr → ConnectionId addr → Bool Source #

maxConnectionId addr → ConnectionId addr → ConnectionId addr Source #

minConnectionId addr → ConnectionId addr → ConnectionId addr Source #

Show addr ⇒ Show (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

showsPrecIntConnectionId addr → ShowS Source #

showConnectionId addr → String Source #

showList ∷ [ConnectionId addr] → ShowS Source #

Generic (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Associated Types

type Rep (ConnectionId addr) ∷ TypeType Source #

Methods

fromConnectionId addr → Rep (ConnectionId addr) x Source #

toRep (ConnectionId addr) x → ConnectionId addr Source #

Typeable addr ⇒ NoThunks (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

noThunks ∷ Context → ConnectionId addr → IO (Maybe ThunkInfo)

wNoThunks ∷ Context → ConnectionId addr → IO (Maybe ThunkInfo)

showTypeOfProxy (ConnectionId addr) → String

Hashable a ⇒ Hashable (ConnectionId a) 
Instance details

Defined in Ouroboros.Network.ConnectionId

Methods

hashWithSaltIntConnectionId a → Int

hashConnectionId a → Int

type Rep (ConnectionId addr) 
Instance details

Defined in Ouroboros.Network.ConnectionId

type Rep (ConnectionId addr) = D1 ('MetaData "ConnectionId" "Ouroboros.Network.ConnectionId" "ouroboros-network-framework-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConnectionId" 'PrefixI 'True) (S1 ('MetaSel ('Just "localAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 addr) :*: S1 ('MetaSel ('Just "remoteAddress") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 addr)))

type RemoteAddress = SockAddr Source #

data Handshake (vNumber ∷ k) (vParams ∷ k1) Source #

The handshake mini-protocol is used initially to agree the version and associated parameters of the protocol to use for all subsequent communication.

Instances

Instances details
ShowProxy (Handshake vNumber vParams ∷ Type) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

showProxyProxy (Handshake vNumber vParams) → String Source #

Show (ServerHasAgency st) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Show (ClientHasAgency st) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

(Show vNumber, Show vParams) ⇒ Show (Message (Handshake vNumber vParams) from to) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Methods

showsPrecIntMessage (Handshake vNumber vParams) from to → ShowS Source #

showMessage (Handshake vNumber vParams) from to → String Source #

showList ∷ [Message (Handshake vNumber vParams) from to] → ShowS Source #

Protocol (Handshake vNumber vParams) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

Associated Types

data Message (Handshake vNumber vParams) st st' #

data ClientHasAgency st #

data ServerHasAgency st #

data NobodyHasAgency st #

data ServerHasAgency (st ∷ Handshake vNumber vParams) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data ServerHasAgency (st ∷ Handshake vNumber vParams) where
data NobodyHasAgency (st ∷ Handshake vNumber vParams) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data NobodyHasAgency (st ∷ Handshake vNumber vParams) where
data Message (Handshake vNumber vParams) (from ∷ Handshake vNumber vParams) (to ∷ Handshake vNumber vParams) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data Message (Handshake vNumber vParams) (from ∷ Handshake vNumber vParams) (to ∷ Handshake vNumber vParams) where
data ClientHasAgency (st ∷ Handshake vNumber vParams) 
Instance details

Defined in Ouroboros.Network.Protocol.Handshake.Type

data ClientHasAgency (st ∷ Handshake vNumber vParams) where

data LocalAddresses addr Source #

Constructors

LocalAddresses 

Fields

  • laIpv4Maybe addr

    Local IPv4 address to use, Nothing indicates don't use IPv4

  • laIpv6Maybe addr

    Local IPv6 address to use, Nothing indicates don't use IPv6

  • laUnixMaybe addr

    Local Unix address to use, Nothing indicates don't use Unix sockets

Instances

Instances details
Eq addr ⇒ Eq (LocalAddresses addr) 
Instance details

Defined in Ouroboros.Network.Subscription.Worker

Methods

(==)LocalAddresses addr → LocalAddresses addr → Bool Source #

(/=)LocalAddresses addr → LocalAddresses addr → Bool Source #

Show addr ⇒ Show (LocalAddresses addr) 
Instance details

Defined in Ouroboros.Network.Subscription.Worker

Semigroup (LocalAddresses addr) 
Instance details

Defined in Ouroboros.Network.Subscription.Worker

data Socket #

Instances

Instances details
Eq Socket 
Instance details

Defined in Network.Socket.Types

Methods

(==)SocketSocketBool Source #

(/=)SocketSocketBool Source #

Show Socket 
Instance details

Defined in Network.Socket.Types

isPipeliningEnabledNodeToNodeVersionBool Source #

Check whether a version enabling diffusion pipelining has been negotiated.

Error Policies and Peer state

data ErrorPolicies Source #

List of error policies for exception handling and a policy for handing application return values.

Constructors

ErrorPolicies 

Fields

remoteNetworkErrorPolicyErrorPolicies Source #

A minimal error policy for remote peers, which only handles exceptions raised by `ouroboros-network`.

localNetworkErrorPolicyErrorPolicies Source #

Error policy for local clients. This is equivalent to nullErrorPolicies, but explicit in the errors which can be caught.

We are very permissive here, and very strict in the networkErrorPolicy. After any failure the client will be killed and not penalised by this policy. This allows to restart the local client without a delay.

data ErrorPolicy where Source #

Constructors

ErrorPolicy 

Fields

Instances

Instances details
Show ErrorPolicy 
Instance details

Defined in Ouroboros.Network.ErrorPolicy

data SuspendDecision t Source #

Semigroup of commands which acts on PeerState. The t variable might be initiated to DiffTime or Time m.

This semigroup allows to either suspend both consumer and producer or just the consumer part.

Constructors

SuspendPeer !t !t

peer is suspend; The first t is the time until which a local producer is suspended, the second one is the time until which a local consumer is suspended.

SuspendConsumer !t

suspend local consumer / initiator side until t (this mean we are not allowing to communicate with the producer / responder of a remote peer).

Throw

throw an error from the main thread.

Instances

Instances details
Functor SuspendDecision 
Instance details

Defined in Ouroboros.Network.Subscription.PeerState

Methods

fmap ∷ (a → b) → SuspendDecision a → SuspendDecision b Source #

(<$) ∷ a → SuspendDecision b → SuspendDecision a Source #

Eq t ⇒ Eq (SuspendDecision t) 
Instance details

Defined in Ouroboros.Network.Subscription.PeerState

Ord t ⇒ Ord (SuspendDecision t) 
Instance details

Defined in Ouroboros.Network.Subscription.PeerState

Show t ⇒ Show (SuspendDecision t) 
Instance details

Defined in Ouroboros.Network.Subscription.PeerState

Ord t ⇒ Semigroup (SuspendDecision t)

The semigroup instance. Note that composing SuspendPeer with SuspendConsumer gives SuspendPeer. SuspendPeer and SuspendConsumer form a sub-semigroup.

Instance details

Defined in Ouroboros.Network.Subscription.PeerState

SAct (SuspendDecision Time) (Maybe (PeerState m))

Action of SuspendDecision on Maybe PeerState. We use this action together with alter function.

Note: SuspendDecision does not act on PeerState, only the sub-semigroup generated by SuspendConsumer and SuspendPeer does.

Instance details

Defined in Ouroboros.Network.Subscription.PeerState

Methods

(<|)Maybe (PeerState m) → SuspendDecision Time → Maybe (PeerState m)

Traces

data AcceptConnectionsPolicyTrace Source #

Trace for the AcceptConnectionsLimit policy.

data TraceSendRecv ps where Source #

Structured Tracer output for runPeer and derivitives.

Constructors

TraceSendMsg ∷ ∀ ps. AnyMessageAndAgency ps → TraceSendRecv ps 
TraceRecvMsg ∷ ∀ ps. AnyMessageAndAgency ps → TraceSendRecv ps 

Instances

Instances details
Show (AnyMessageAndAgency ps) ⇒ Show (TraceSendRecv ps) 
Instance details

Defined in Ouroboros.Network.Driver.Simple

data ErrorPolicyTrace Source #

Trace data for error policies

Constructors

ErrorPolicySuspendPeer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime DiffTime

suspending peer with a given exception until

ErrorPolicySuspendConsumer (Maybe (ConnectionOrApplicationExceptionTrace SomeException)) DiffTime

suspending consumer until

ErrorPolicyLocalNodeError (ConnectionOrApplicationExceptionTrace SomeException)

caught a local exception

ErrorPolicyResumePeer

resume a peer (both consumer and producer)

ErrorPolicyKeepSuspended

consumer was suspended until producer will resume

ErrorPolicyResumeConsumer

resume consumer

ErrorPolicyResumeProducer

resume producer

ErrorPolicyUnhandledApplicationException SomeException

an application throwed an exception, which was not handled by any ErrorPolicy.

ErrorPolicyUnhandledConnectionException SomeException

connect throwed an exception, which was not handled by any ErrorPolicy.

ErrorPolicyAcceptException IOException

accept throwed an exception

Instances

Instances details
Show ErrorPolicyTrace 
Instance details

Defined in Ouroboros.Network.ErrorPolicy

data WithIPList a Source #

Constructors

WithIPList 

Fields

Instances

Instances details
Show a ⇒ Show (WithIPList a) 
Instance details

Defined in Ouroboros.Network.Subscription.Ip

data WithDomainName a Source #

Constructors

WithDomainName 

Fields

Instances

Instances details
Show a ⇒ Show (WithDomainName a) 
Instance details

Defined in Ouroboros.Network.Subscription.Dns

data WithAddr addr a Source #

Constructors

WithAddr 

Fields

Instances

Instances details
(Show addr, Show a) ⇒ Show (WithAddr addr a) 
Instance details

Defined in Ouroboros.Network.ErrorPolicy

Methods

showsPrecIntWithAddr addr a → ShowS Source #

showWithAddr addr a → String Source #

showList ∷ [WithAddr addr a] → ShowS Source #

type HandshakeTr ntnAddr ntnVersion = WithMuxBearer (ConnectionId ntnAddr) (TraceSendRecv (Handshake ntnVersion Term)) Source #

For Consensus ThreadNet Tests