Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Node.NetworkProtocolVersion

Contents

Re-exports

Synopsis

class (Show (BlockNodeToNodeVersion blk), Show (BlockNodeToClientVersion blk), Eq (BlockNodeToNodeVersion blk), Eq (BlockNodeToClientVersion blk)) ⇒ HasNetworkProtocolVersion blk where
- type BlockNodeToNodeVersion blk ∷ Type
- type BlockNodeToClientVersion blk ∷ Type
class HasNetworkProtocolVersion blk ⇒ SupportedNetworkProtocolVersion blk where
- supportedNodeToNodeVersions ∷ Proxy blk → Map NodeToNodeVersion (BlockNodeToNodeVersion blk)
- supportedNodeToClientVersions ∷ Proxy blk → Map NodeToClientVersion (BlockNodeToClientVersion blk)
- latestReleasedNodeVersion ∷ Proxy blk → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion)
latestReleasedNodeVersionDefault ∷ SupportedNetworkProtocolVersion blk ⇒ Proxy blk → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion)
data NodeToClientVersion
- = NodeToClientV_9
- | NodeToClientV_10
- | NodeToClientV_11
- | NodeToClientV_12
- | NodeToClientV_13
- | NodeToClientV_14
- | NodeToClientV_15
- | NodeToClientV_16
- | NodeToClientV_17
- | NodeToClientV_18
- | NodeToClientV_19
data NodeToNodeVersion
- = NodeToNodeV_13
- | NodeToNodeV_14

Documentation

class (Show (BlockNodeToNodeVersion blk), Show (BlockNodeToClientVersion blk), Eq (BlockNodeToNodeVersion blk), Eq (BlockNodeToClientVersion blk)) ⇒ HasNetworkProtocolVersion blk Source #

Protocol versioning

IMPORTANT Note that this is entirely independent of the shelleyProtVer field et al.

Its primary purpose is to control the details of on-the-wire codecs. And additionally which queries are allowed, in the case of BlockNodeToClienVersion (this use is already handled by shelleyProtVer in the NTN case).

Associated Types

type BlockNodeToNodeVersion blk ∷ Type Source #

type BlockNodeToNodeVersion blk = ()

type BlockNodeToClientVersion blk ∷ Type Source #

type BlockNodeToClientVersion blk = ()

Instances

Instances details

SerialiseHFC xs ⇒ HasNetworkProtocolVersion (HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common Associated Types type BlockNodeToNodeVersion (HardForkBlock xs) Source # type BlockNodeToClientVersion (HardForkBlock xs) Source #

class HasNetworkProtocolVersion blk ⇒ SupportedNetworkProtocolVersion blk where Source #

Methods

supportedNodeToNodeVersions ∷ Proxy blk → Map NodeToNodeVersion (BlockNodeToNodeVersion blk) Source #

Enumerate all supported node-to-node versions

supportedNodeToClientVersions ∷ Proxy blk → Map NodeToClientVersion (BlockNodeToClientVersion blk) Source #

Enumerate all supported node-to-client versions

latestReleasedNodeVersion ∷ Proxy blk → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion) Source #

The latest released version

This is the latest version intended for deployment.

IMPORTANT Note that this is entirely independent of the shelleyProtVer field et al.

latestReleasedNodeVersionDefault ∷ SupportedNetworkProtocolVersion blk ⇒ Proxy blk → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion) Source #

A default for latestReleasedNodeVersion

Chooses the greatest in supportedNodeToNodeVersions and supportedNodeToClientVersions.

Re-exports

data NodeToClientVersion Source #

Enumeration of node to client protocol versions.

Constructors

NodeToClientV_9	enabled `CardanoNodeToClientVersion7`, i.e., Alonzo
NodeToClientV_10	added `GetChainBlockNo` and `GetChainPoint` queries
NodeToClientV_11	added `GetRewardInfoPools` Block query
NodeToClientV_12	added `LocalTxMonitor` mini-protocol
NodeToClientV_13	enabled `CardanoNodeToClientVersion9`, i.e., Babbage
NodeToClientV_14	added `GetPoolDistr`, `GetPoolState`, `GetSnapshots`
NodeToClientV_15	added `query` to NodeToClientVersionData
NodeToClientV_16	added `ImmutableTip` to `LocalStateQuery`, enabled `CardanoNodeToClientVersion11`, i.e., Conway and `GetStakeDelegDeposits`.
NodeToClientV_17	added `GetProposals` and `GetRatifyState` queries
NodeToClientV_18	added `GetFuturePParams` query
NodeToClientV_19	added `GetLedgerPeerSnapshot`

Instances

Instances details

Bounded NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods minBound ∷ NodeToClientVersion # maxBound ∷ NodeToClientVersion #
Enum NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods succ ∷ NodeToClientVersion → NodeToClientVersion # pred ∷ NodeToClientVersion → NodeToClientVersion # toEnum ∷ Int → NodeToClientVersion # fromEnum ∷ NodeToClientVersion → Int # enumFrom ∷ NodeToClientVersion → [NodeToClientVersion] # enumFromThen ∷ NodeToClientVersion → NodeToClientVersion → [NodeToClientVersion] # enumFromTo ∷ NodeToClientVersion → NodeToClientVersion → [NodeToClientVersion] # enumFromThenTo ∷ NodeToClientVersion → NodeToClientVersion → NodeToClientVersion → [NodeToClientVersion] #
Generic NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Associated Types type Rep NodeToClientVersion ∷ Type → Type # Methods from ∷ NodeToClientVersion → Rep NodeToClientVersion x # to ∷ Rep NodeToClientVersion x → NodeToClientVersion #
Show NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods showsPrec ∷ Int → NodeToClientVersion → ShowS # show ∷ NodeToClientVersion → String # showList ∷ [NodeToClientVersion] → ShowS #
NFData NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods rnf ∷ NodeToClientVersion → () #
Eq NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods (==) ∷ NodeToClientVersion → NodeToClientVersion → Bool # (/=) ∷ NodeToClientVersion → NodeToClientVersion → Bool #
Ord NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods compare ∷ NodeToClientVersion → NodeToClientVersion → Ordering # (<) ∷ NodeToClientVersion → NodeToClientVersion → Bool # (<=) ∷ NodeToClientVersion → NodeToClientVersion → Bool # (>) ∷ NodeToClientVersion → NodeToClientVersion → Bool # (>=) ∷ NodeToClientVersion → NodeToClientVersion → Bool # max ∷ NodeToClientVersion → NodeToClientVersion → NodeToClientVersion # min ∷ NodeToClientVersion → NodeToClientVersion → NodeToClientVersion #
type Rep NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version type Rep NodeToClientVersion = D1 ('MetaData "NodeToClientVersion" "Ouroboros.Network.NodeToClient.Version" "ouroboros-network-api-0.11.0.0-51203573fcfcfd3b2c06491320742b9da13f8f293bfcf4fc69f087b3c7b975f1" 'False) (((C1 ('MetaCons "NodeToClientV_9" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NodeToClientV_10" 'PrefixI 'False) (U1 ∷ Type → Type)) :+: (C1 ('MetaCons "NodeToClientV_11" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "NodeToClientV_12" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NodeToClientV_13" 'PrefixI 'False) (U1 ∷ Type → Type)))) :+: ((C1 ('MetaCons "NodeToClientV_14" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "NodeToClientV_15" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NodeToClientV_16" 'PrefixI 'False) (U1 ∷ Type → Type))) :+: (C1 ('MetaCons "NodeToClientV_17" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "NodeToClientV_18" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NodeToClientV_19" 'PrefixI 'False) (U1 ∷ Type → Type)))))

data NodeToNodeVersion Source #

Enumeration of node to node protocol versions.

Constructors

NodeToNodeV_13

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. | NodeToNodeV_11 -- ^ Changes: -- -- * Adds a new extra parameter to handshake: PeerSharing -- This version is needed to support the new Peer Sharing miniprotocol -- older versions that are negotiated will appear as not participating -- in Peer Sharing to newer versions. -- * Adds query to NodeToClientVersionData. | NodeToNodeV_12 -- ^ No changes. -- -- (In the past, this enabled Conway, but the negotiated NodeToNodeVersion -- no longer en-/disables eras.)

NodeToNodeV_14

Chang+1 HF

Instances

Instances details

Bounded NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods minBound ∷ NodeToNodeVersion # maxBound ∷ NodeToNodeVersion #
Enum NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods succ ∷ NodeToNodeVersion → NodeToNodeVersion # pred ∷ NodeToNodeVersion → NodeToNodeVersion # toEnum ∷ Int → NodeToNodeVersion # fromEnum ∷ NodeToNodeVersion → Int # enumFrom ∷ NodeToNodeVersion → [NodeToNodeVersion] # enumFromThen ∷ NodeToNodeVersion → NodeToNodeVersion → [NodeToNodeVersion] # enumFromTo ∷ NodeToNodeVersion → NodeToNodeVersion → [NodeToNodeVersion] # enumFromThenTo ∷ NodeToNodeVersion → NodeToNodeVersion → NodeToNodeVersion → [NodeToNodeVersion] #
Generic NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Associated Types type Rep NodeToNodeVersion ∷ Type → Type # Methods from ∷ NodeToNodeVersion → Rep NodeToNodeVersion x # to ∷ Rep NodeToNodeVersion x → NodeToNodeVersion #
Show NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods showsPrec ∷ Int → NodeToNodeVersion → ShowS # show ∷ NodeToNodeVersion → String # showList ∷ [NodeToNodeVersion] → ShowS #
NFData NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods rnf ∷ NodeToNodeVersion → () #
Eq NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods (==) ∷ NodeToNodeVersion → NodeToNodeVersion → Bool # (/=) ∷ NodeToNodeVersion → NodeToNodeVersion → Bool #
Ord NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version Methods compare ∷ NodeToNodeVersion → NodeToNodeVersion → Ordering # (<) ∷ NodeToNodeVersion → NodeToNodeVersion → Bool # (<=) ∷ NodeToNodeVersion → NodeToNodeVersion → Bool # (>) ∷ NodeToNodeVersion → NodeToNodeVersion → Bool # (>=) ∷ NodeToNodeVersion → NodeToNodeVersion → Bool # max ∷ NodeToNodeVersion → NodeToNodeVersion → NodeToNodeVersion # min ∷ NodeToNodeVersion → NodeToNodeVersion → NodeToNodeVersion #
type Rep NodeToNodeVersion
Instance details Defined in Ouroboros.Network.NodeToNode.Version type Rep NodeToNodeVersion = D1 ('MetaData "NodeToNodeVersion" "Ouroboros.Network.NodeToNode.Version" "ouroboros-network-api-0.11.0.0-51203573fcfcfd3b2c06491320742b9da13f8f293bfcf4fc69f087b3c7b975f1" 'False) (C1 ('MetaCons "NodeToNodeV_13" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "NodeToNodeV_14" 'PrefixI 'False) (U1 ∷ Type → Type))