Package chainsync implements the Ouroboros chain-sync protocol.

The common package contains types used by multiple mini-protocols.

Package handshake implements the Ouroboros handshake protocol.

Package localstatequery implements the Ouroboros local-state-query protocol.

Package localtxmonitor implements the Ouroboros local-tx-monitor protocol.

Package localtxsubmission implements the Ouroboros local-tx-submission protocol.

Package peersharing implements the Ouroboros PeerSharing protocol.

Package txsubmission implements the Ouroboros TxSubmission protocol.

GetProtocolVersion returns the protocol version config for the specified protocol version.

GetProtocolVersionMap returns a data structure suitable for use with the protocol handshake.

GetProtocolVersionsNtC returns a list of supported NtC protocol versions.

GetProtocolVersionsNtN returns a list of supported NtN protocol versions.

New returns a new Protocol object.

NewState returns a new State object with the provided numeric ID and string identifier.

Client agency.

Default (invalid) value.

Server agency.

Diffusion modes.

Diffusion modes.

Peer sharing modes.

Peer sharing modes.

Peer sharing modes.

Peer sharing modes.

Peer sharing modes.

Node-to-client protocol mode.

Node-to-node protocol mode.

Default (invalid) protocol mode.

Client protocol role.

Default (invalid) protocol role.

Server protocol role.

The NtC protocol versions have the 15th bit set in the handshake.

Query modes.

Query modes.

MessageBase is the minimum implementation for a mini-protocol message.

Protocol implements the base functionality of an Ouroboros mini-protocol.

ProtocolConfig provides the configuration for Protocol.

ProtocolOptions provides common arguments for all mini-protocols.

State represents protocol state with both a numeric ID and a string identifer.

StateMapEntry represents a protocol state, it's possible state transitions, and an optional timeout.

StateTransition represents a protocol state transition.

NOTE: the format stays the same, but the values for PeerSharing change.

Message provides a common interface for message utility functions.

MessageFromCborFunc represents a function that parses a mini-protocol message.

MessageHandlerFunc represents a function that handles an incoming message.

ProtocolMode is an enum of the protocol modes.

ProtocolRole is an enum of the protocol roles.

ProtocolStateAgency is an enum representing the possible protocol state agency values.

StateMap represents the state machine definition for a mini-protocol.

StateTransitionMatchFunc represents a function that will take a Message and return a bool that indicates whether the message is a match for the state transition rule.