ouroboros

README

Introduction

gOuroboros is a powerful and versatile framework for building Go apps that interact with the Cardano blockchain. Quickly and easily write Go apps that communicate with Cardano nodes or manage blocks/transactions. Sync the blockchain from a local or remote node, query a local node for protocol parameters or UTxOs by address, and much more.

Features

This is not an exhaustive list of existing and planned features, but it covers the bulk of it.

• Ouroboros support
  • Muxer
    • support for multiple mini-protocols over single connection
    • support for separate initiator and responder instance for each protocol
    • support for buffer limits for each mini-protocol
  • Protocols
    • Handshake
      • Client support
      • Server support
    • Keepalive
      • Client support
      • Server support
    • ChainSync
      • Client support
      • Server support
    • BlockFetch
      • Client support
      • Server support
    • TxSubmission
      • Client support
      • Server support
    • PeerSharing
      • Client support
      • Server support
    • LocalTxSubmission
      • Client support
      • Server support
    • LocalTxMonitor
      • Client support
      • Server support
    • LocalStateQuery
      • Client support
      • Server support
      • Queries
        • System start
        • Current era
        • Chain tip
        • Era history
        • Current protocol parameters
        • Future protocol parameters
        • Stake distribution
        • Non-myopic member rewards
        • Proposed protocol parameter updates
        • UTxOs by address
        • UTxO whole
        • UTxO by TxIn
        • Debug epoch state
        • Filtered delegations and reward accounts
        • Genesis config
        • Reward provenance
        • Stake pools
        • Stake pool params
        • Reward info pools
        • Pool state
        • Stake snapshots
        • Pool distribution
        • Constitution (CIP-1694)
        • Governance state (CIP-1694)
        • DRep state (CIP-1694)
        • DRep stake distribution (CIP-1694)
        • SPO stake distribution (CIP-1694)
        • Committee state (CIP-1694)
        • Filtered vote delegatees (CIP-1694)
        • Treasury (CIP-1694)
    • LeiosFetch (CIP-0164)
      • Client support
      • Server support
    • LeiosNotify (CIP-0164)
      • Client support
      • Server support
    • LocalMessageSubmission (CIP-0137 DMQ)
      • Client support
      • Server support
    • MessageSubmission (CIP-0137 DMQ)
      • Client support
      • Server support
    • LocalMessageNotification (CIP-0137 DMQ)
      • Client support
      • Server support
• Ledger
  • Eras
    • Byron
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
    • Shelley
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
      • Parameter updates
    • Allegra
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
      • Parameter updates
    • Mary
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
      • Parameter updates
    • Alonzo
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
      • Parameter updates
    • Babbage
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
      • Parameter updates
    • Conway
      • Blocks
      • Transactions
      • TX inputs
      • TX outputs
      • Parameter updates
  • Transaction attributes
    • Inputs
    • Outputs
    • Metadata
    • Fees
    • TTL
    • Certificates
    • Staking reward withdrawls
    • Protocol parameter updates
    • Auxiliary data hash
    • Validity interval start
    • Mint operations
    • Script data hash
    • Collateral inputs
    • Required signers
    • Collateral return (CIP-0040)
    • Total collateral (CIP-0040)
    • Reference inputs (CIP-0031)
    • Voting procedures (CIP-1694)
    • Proposal procedures (CIP-1694)
    • Current treasury value (CIP-1694)
    • Donation (CIP-1694)
• Block Validation
  • Block body hash validation
  • VRF proof verification
  • KES signature verification
  • Transaction validation (UTxO rules)
  • Stake pool verification
  • Native script evaluation
  • Plutus script validation (via plutigo)
  • Structured error handling (ValidationError)
  • Byron era validation (OBFT consensus, proxy signatures, body proof)
• Cryptography
  • KES (Key-Evolving Signatures)
    • Signature verification
    • Key generation
    • Key evolution
  • VRF (Verifiable Random Function)
    • Proof generation
    • Proof verification
    • Leader election input construction
• Consensus
  • Leader election
  • Block construction
  • Chain selection
  • Threshold calculation
  • Genesis configuration
  • Byron consensus (OBFT header validation)
• Testing
  • Test framework for mocking Ouroboros conversations
  • Conformance tests (2200+ passing)
    • Ledger rules (314 tests via Amaru vectors)
    • VRF cryptography (29 vectors + 15 unit tests)
    • KES cryptography (14 tests via input-output-hk/kes vectors)
    • Consensus (212 tests for leader election, threshold, selection)
    • Byron blocks (15 tests from mainnet/testnet/conformance)
  • Fuzz testing (75 targets with nightly CI)
  • CBOR deserialization and serialization
    • Protocol messages
    • Ledger
      • Block parsing
      • Transaction parsing
• Misc
  • Address handling (CIP-0019)
    • Decode from bech32 (CIP-0005)
    • Encode as bech32 (CIP-0005)
    • Deserialize from CBOR
    • Retrieve staking key

Testing

gOuroboros includes automated tests that cover various aspects of its functionality, but not all. For more than the basics, manual testing is required.

Running the automated tests

make test

Running the linter

gOuroboros uses golangci-lint for code quality checks. Install it following the official installation guide, then run:

make lint

Manual testing

Various small test programs can be found in the gOuroboros Starter Kit repo. Some of them can be run against public nodes via NtN protocols, but some may require access to the UNIX socket of a local node for NtC protocols.

Run chain-sync from the start of a particular era

This is useful for testing changes to the handling of ledger types for a particular era. It will decode each block and either print a summary line for the block or an error.

You can use the chain-sync program from gouroboros-starter-kit to start a ChainSync from a public node.

Run the chain-sync test program against a public mainnet node, starting at the beginning of the Shelley era:

CARDANO_NODE_ADDRESS=backbone.cardano.iog.io:3001 CARDANO_NODE_NETWORK=mainnet ./chain-sync -bulk -start-era shelley

This will produce a LOT of output and take quite a few hours to reach chain tip. You're mostly looking for it to get through all blocks of the chosen start era before hitting the next era or chain tip

Dump details of a particular block

You can use the block-fetch program from gouroboros-starter-kit to fetch a particular block and dump its details. You must provide at least the block slot and hash. This is useful for debugging decoding problems, since it allows fetching a specific block and decoding it over and over.

BLOCK_FETCH_SLOT=120521627 BLOCK_FETCH_HASH=afd4c97e32003d9803a305011cbd8796e6b36bf61576567206887e35795b6e09 ./block-fetch

Documentation

Overview

Package ouroboros implements support for interacting with Cardano nodes using the Ouroboros network protocol.

The Ouroboros network protocol consists of a muxer and multiple mini-protocols that provide various functions. A handshake and protocol versioning are used to ensure peer compatibility.

This package is the main entry point into this library. The other packages can be used outside of this one, but it's not a primary design goal.

Index

• Constants
• Variables
• type Connection
  • func New(options ...ConnectionOptionFunc) (*Connection, error)
  • func NewConnection(options ...ConnectionOptionFunc) (*Connection, error)
  • func (c *Connection) BlockFetch() *blockfetch.BlockFetch
  • func (c *Connection) ChainSync() *chainsync.ChainSync
  • func (c *Connection) Close() error
  • func (c *Connection) Dial(proto string, address string) error
  • func (c *Connection) DialTimeout(proto string, address string, timeout time.Duration) error
  • func (c *Connection) ErrorChan() chan error
  • func (c *Connection) Handshake() *handshake.Handshake
  • func (c *Connection) Id() ConnectionId
  • func (c *Connection) KeepAlive() *keepalive.KeepAlive
  • func (c *Connection) LeiosFetch() *leiosfetch.LeiosFetch
  • func (c *Connection) LeiosNotify() *leiosnotify.LeiosNotify
  • func (c *Connection) LocalMessageNotification() *localmessagenotification.LocalMessageNotification
  • func (c *Connection) LocalMessageSubmission() *localmessagesubmission.LocalMessageSubmission
  • func (c *Connection) LocalStateQuery() *localstatequery.LocalStateQuery
  • func (c *Connection) LocalTxMonitor() *localtxmonitor.LocalTxMonitor
  • func (c *Connection) LocalTxSubmission() *localtxsubmission.LocalTxSubmission
  • func (c *Connection) Muxer() *muxer.Muxer
  • func (c *Connection) PeerSharing() *peersharing.PeerSharing
  • func (c *Connection) ProtocolVersion() (uint16, protocol.VersionData)
  • func (c *Connection) QueryReplyVersionMap() protocol.ProtocolVersionMap
  • func (c *Connection) TxSubmission() *txsubmission.TxSubmission
• type ConnectionId
• type ConnectionOptionFunc
  • func WithBlockFetchConfig(cfg blockfetch.Config) ConnectionOptionFunc
  • func WithChainSyncConfig(cfg chainsync.Config) ConnectionOptionFunc
  • func WithConnection(conn net.Conn) ConnectionOptionFunc
  • func WithDMQ(useDMQ bool) ConnectionOptionFunc
  • func WithDelayMuxerStart(delayMuxerStart bool) ConnectionOptionFunc
  • func WithDelayProtocolStart(delayProtocolStart bool) ConnectionOptionFunc
  • func WithErrorChan(errorChan chan error) ConnectionOptionFunc
  • func WithFullDuplex(fullDuplex bool) ConnectionOptionFunc
  • func WithKeepAlive(keepAlive bool) ConnectionOptionFunc
  • func WithKeepAliveConfig(cfg keepalive.Config) ConnectionOptionFunc
  • func WithLeiosFetchConfig(cfg leiosfetch.Config) ConnectionOptionFunc
  • func WithLeiosNotifyConfig(cfg leiosnotify.Config) ConnectionOptionFunc
  • func WithLocalMessageNotificationConfig(cfg localmessagenotification.Config) ConnectionOptionFunc
  • func WithLocalMessageSubmissionConfig(cfg localmessagesubmission.Config) ConnectionOptionFunc
  • func WithLocalStateQueryConfig(cfg localstatequery.Config) ConnectionOptionFunc
  • func WithLocalTxMonitorConfig(cfg localtxmonitor.Config) ConnectionOptionFunc
  • func WithLocalTxSubmissionConfig(cfg localtxsubmission.Config) ConnectionOptionFunc
  • func WithLogger(logger *slog.Logger) ConnectionOptionFunc
  • func WithNetwork(network Network) ConnectionOptionFunc
  • func WithNetworkMagic(networkMagic uint32) ConnectionOptionFunc
  • func WithNodeToNode(nodeToNode bool) ConnectionOptionFunc
  • func WithPeerSharing(peerSharing bool) ConnectionOptionFunc
  • func WithPeerSharingConfig(cfg peersharing.Config) ConnectionOptionFunc
  • func WithQueryMode(queryMode bool) ConnectionOptionFunc
  • func WithServer(server bool) ConnectionOptionFunc
  • func WithTxSubmissionConfig(cfg txsubmission.Config) ConnectionOptionFunc
• type Network
  • func NetworkById(id uint8) (Network, bool)
  • func NetworkByName(name string) (Network, bool)
  • func NetworkByNetworkMagic(networkMagic uint32) (Network, bool)
  • func (n Network) String() string
• type NetworkAccessPoint
• type NetworkBootstrapPeer
• type NetworkPublicRoot

Constants

const (
	// Default connection timeout
	DefaultConnectTimeout = 30 * time.Second
)

Variables

var (
	NetworkCardanoMainnet = Network{
		Id:           common.AddressNetworkMainnet,
		Name:         "mainnet",
		NetworkMagic: 764824073,
		BootstrapPeers: []NetworkBootstrapPeer{
			{
				Address: "backbone.cardano.iog.io",
				Port:    3001,
			},
			{
				Address: "backbone.mainnet.emurgornd.com",
				Port:    3001,
			},
			{
				Address: "backbone.mainnet.cardanofoundation.org",
				Port:    3001,
			},
		},
	}
	NetworkCardanoPreprod = Network{
		Id:           common.AddressNetworkTestnet,
		Name:         "preprod",
		NetworkMagic: 1,
		BootstrapPeers: []NetworkBootstrapPeer{
			{
				Address: "preprod-node.play.dev.cardano.org",
				Port:    3001,
			},
		},
	}
	NetworkCardanoPreview = Network{
		Id:           common.AddressNetworkTestnet,
		Name:         "preview",
		NetworkMagic: 2,
		BootstrapPeers: []NetworkBootstrapPeer{
			{
				Address: "preview-node.play.dev.cardano.org",
				Port:    3001,
			},
		},
	}
	NetworkCardanoSancho = Network{
		Id:           common.AddressNetworkTestnet,
		Name:         "sanchonet",
		NetworkMagic: 4,
		BootstrapPeers: []NetworkBootstrapPeer{
			{
				Address: "sancho-testnet.able-pool.io",
				Port:    6002,
			},
		},
	}
	// NetworkPrimeMainnet intentionally shares the same NetworkMagic as NetworkCardanoMainnet
	// because both networks use unaltered cardano-node binaries. Network differentiation
	// occurs through the bootstrap peers configuration.
	NetworkPrimeMainnet = Network{
		Id:           common.AddressNetworkMainnet,
		Name:         "prime-mainnet",
		NetworkMagic: 764824073,
		BootstrapPeers: []NetworkBootstrapPeer{
			{
				Address: "bootstrap.prime.mainnet.apexfusion.org",
				Port:    5521,
			},
		},
		PublicRoots: []NetworkPublicRoot{
			{
				AccessPoints: []NetworkAccessPoint{
					{
						Address: "relay-g1.prime.mainnet.apexfusion.org",
						Port:    5521,
					},
					{
						Address: "relay-g2.prime.mainnet.apexfusion.org",
						Port:    5521,
					},
				},
				Advertise: true,
				Valency:   1,
			},
		},
	}
	NetworkPrimeTestnet = Network{
		Id:           common.AddressNetworkTestnet,
		Name:         "prime-testnet",
		NetworkMagic: 3311,
		PublicRoots: []NetworkPublicRoot{
			{
				AccessPoints: []NetworkAccessPoint{
					{
						Address: "relay-0.prime.testnet.apexfusion.org",
						Port:    5521,
					},
					{
						Address: "relay-1.prime.testnet.apexfusion.org",
						Port:    5521,
					},
				},
				Advertise: true,
				Valency:   1,
			},
		},
	}
	NetworkDevnet = Network{
		Id:           common.AddressNetworkTestnet,
		Name:         "devnet",
		NetworkMagic: 42,
	}
	// Compatibility assignments (deprecated: use NetworkCardano* variants)
	NetworkMainnet = NetworkCardanoMainnet
	NetworkPreprod = NetworkCardanoPreprod
	NetworkPreview = NetworkCardanoPreview
	NetworkSancho  = NetworkCardanoSancho
)

Network definitions

Types

type Connection

type Connection struct {
	// contains filtered or unexported fields
}

The Connection type is a wrapper around a net.Conn object that handles communication using the Ouroboros network protocol over that connection

func New

func New(options ...ConnectionOptionFunc) (*Connection, error)

New is an alias to NewConnection for backward compatibility

func NewConnection

func NewConnection(options ...ConnectionOptionFunc) (*Connection, error)

NewConnection returns a new Connection object with the specified options. If a connection is provided, the handshake will be started. An error will be returned if the handshake fails

func (*Connection) BlockFetch

func (c *Connection) BlockFetch() *blockfetch.BlockFetch

BlockFetch returns the block-fetch protocol handler

func (*Connection) ChainSync

func (c *Connection) ChainSync() *chainsync.ChainSync

ChainSync returns the chain-sync protocol handler

func (*Connection) Close

func (c *Connection) Close() error

Close will shutdown the Ouroboros connection

func (*Connection) Dial

func (c *Connection) Dial(proto string, address string) error

Dial will establish a connection using the specified protocol and address. It works the same as [DialTimeout], except that it provides a default connect timeout

func (*Connection) DialTimeout

func (c *Connection) DialTimeout(
	proto string,
	address string,
	timeout time.Duration,
) error

DialTimeout will establish a connection using the specified protocol, address, and timeout. These parameters are passed to the net.DialTimeout func. The handshake will be started when a connection is established. An error will be returned if the connection fails, a connection was already established, or the handshake fails

func (*Connection) ErrorChan

func (c *Connection) ErrorChan() chan error

ErrorChan returns the channel for asynchronous errors

func (*Connection) Handshake

func (c *Connection) Handshake() *handshake.Handshake

Handshake returns the handshake protocol handler

func (*Connection) Id

func (c *Connection) Id() ConnectionId

Id returns the connection ID

func (*Connection) KeepAlive

func (c *Connection) KeepAlive() *keepalive.KeepAlive

KeepAlive returns the keep-alive protocol handler

func (*Connection) LeiosFetch

func (c *Connection) LeiosFetch() *leiosfetch.LeiosFetch

LeiosFetch returns the leios-fetch protocol handler

func (*Connection) LeiosNotify

func (c *Connection) LeiosNotify() *leiosnotify.LeiosNotify

LeiosNotify returns the leios-notify protocol handler

func (*Connection) LocalMessageNotification

func (c *Connection) LocalMessageNotification() *localmessagenotification.LocalMessageNotification

LocalMessageNotification returns the DMQ local-message-notification protocol handler. Only non-nil on a Connection constructed with WithDMQ(true).

func (*Connection) LocalMessageSubmission

func (c *Connection) LocalMessageSubmission() *localmessagesubmission.LocalMessageSubmission

LocalMessageSubmission returns the DMQ local-message-submission protocol handler. Only non-nil on a Connection constructed with WithDMQ(true).

func (*Connection) LocalStateQuery

func (c *Connection) LocalStateQuery() *localstatequery.LocalStateQuery

LocalStateQuery returns the local-state-query protocol handler

func (*Connection) LocalTxMonitor

func (c *Connection) LocalTxMonitor() *localtxmonitor.LocalTxMonitor

LocalTxMonitor returns the local-tx-monitor protocol handler

func (*Connection) LocalTxSubmission

func (c *Connection) LocalTxSubmission() *localtxsubmission.LocalTxSubmission

LocalTxSubmission returns the local-tx-submission protocol handler

func (*Connection) Muxer

func (c *Connection) Muxer() *muxer.Muxer

Muxer returns the muxer object for the Ouroboros connection

func (*Connection) PeerSharing

func (c *Connection) PeerSharing() *peersharing.PeerSharing

PeerSharing returns the peer-sharing protocol handler

func (*Connection) ProtocolVersion

func (c *Connection) ProtocolVersion() (uint16, protocol.VersionData)

ProtocolVersion returns the negotiated protocol version and the version data from the remote peer

func (*Connection) QueryReplyVersionMap

func (c *Connection) QueryReplyVersionMap() protocol.ProtocolVersionMap

QueryReplyVersionMap returns the version map received in response to a handshake query, or nil if a query was not performed

func (*Connection) TxSubmission

func (c *Connection) TxSubmission() *txsubmission.TxSubmission

TxSubmission returns the tx-submission protocol handler

type ConnectionId

type ConnectionId = connection.ConnectionId

type ConnectionOptionFunc

type ConnectionOptionFunc func(*Connection)

ConnectionOptionFunc is a type that represents functions that modify the Connection config

func WithBlockFetchConfig

func WithBlockFetchConfig(cfg blockfetch.Config) ConnectionOptionFunc

WithBlockFetchConfig specifies BlockFetch protocol config

func WithChainSyncConfig

func WithChainSyncConfig(cfg chainsync.Config) ConnectionOptionFunc

WithChainSyncConfig secifies ChainSync protocol config

func WithConnection

func WithConnection(conn net.Conn) ConnectionOptionFunc

WithConnection specifies an existing connection to use. If none is provided, the Dial() function can be used to create one later

func WithDMQ

func WithDMQ(useDMQ bool) ConnectionOptionFunc

WithDMQ enables CIP-0137 DMQ node-to-client mode. The connection negotiates the DMQ N2C handshake (NodeToClientV_1, bit-12 encoded) using the configured network magic as the DMQ topic identifier, and exposes only the LocalMessageSubmission and LocalMessageNotification mini- protocols. Mutually exclusive with WithNodeToNode.

func WithDelayMuxerStart

func WithDelayMuxerStart(delayMuxerStart bool) ConnectionOptionFunc

WithDelayMuxerStart specifies whether to delay the muxer start. This is useful if you need to take some custom actions before the muxer starts processing messages, generally when acting as a server

func WithDelayProtocolStart

func WithDelayProtocolStart(delayProtocolStart bool) ConnectionOptionFunc

WithDelayProtocolStart specifies whether to delay the start of the relevant mini-protocols. This is useful if you are maintaining lots of connections and want to reduce resource overhead by only starting particular protocols

func WithErrorChan

func WithErrorChan(errorChan chan error) ConnectionOptionFunc

WithErrorChan specifies the error channel to use. If none is provided, one will be created

func WithFullDuplex

func WithFullDuplex(fullDuplex bool) ConnectionOptionFunc

WithFullDuplex specifies whether to enable full-duplex mode when acting as a client

func WithKeepAlive

func WithKeepAlive(keepAlive bool) ConnectionOptionFunc

WithKeepAlives specifies whether to use keep-alives. This is disabled by default

func WithKeepAliveConfig

func WithKeepAliveConfig(cfg keepalive.Config) ConnectionOptionFunc

WithKeepAliveConfig specifies KeepAlive protocol config

func WithLeiosFetchConfig

func WithLeiosFetchConfig(cfg leiosfetch.Config) ConnectionOptionFunc

WithLeiosFetchConfig specifies LeiosFetch protocol config

func WithLeiosNotifyConfig

func WithLeiosNotifyConfig(cfg leiosnotify.Config) ConnectionOptionFunc

WithLeiosNotifyConfig specifies LeiosNotify protocol config

func WithLocalMessageNotificationConfig

func WithLocalMessageNotificationConfig(
	cfg localmessagenotification.Config,
) ConnectionOptionFunc

WithLocalMessageNotificationConfig specifies LocalMessageNotification protocol config (CIP-0137 DMQ N2C). Only effective when WithDMQ(true) is also set.

func WithLocalMessageSubmissionConfig

func WithLocalMessageSubmissionConfig(
	cfg localmessagesubmission.Config,
) ConnectionOptionFunc

WithLocalMessageSubmissionConfig specifies LocalMessageSubmission protocol config (CIP-0137 DMQ N2C). Only effective when WithDMQ(true) is also set.

func WithLocalStateQueryConfig

func WithLocalStateQueryConfig(
	cfg localstatequery.Config,
) ConnectionOptionFunc

WithLocalStateQueryConfig specifies LocalStateQuery protocol config

func WithLocalTxMonitorConfig

func WithLocalTxMonitorConfig(
	cfg localtxmonitor.Config,
) ConnectionOptionFunc

WithLocalTxMonitorConfig specifies LocalTxMonitor protocol config

func WithLocalTxSubmissionConfig

func WithLocalTxSubmissionConfig(
	cfg localtxsubmission.Config,
) ConnectionOptionFunc

WithLocalTxSubmissionConfig specifies LocalTxSubmission protocol config

func WithLogger

func WithLogger(logger *slog.Logger) ConnectionOptionFunc

WithLogger specifies the slog.Logger to use. This is empty by default

func WithNetwork

func WithNetwork(network Network) ConnectionOptionFunc

WithNetwork specifies the network

func WithNetworkMagic

func WithNetworkMagic(networkMagic uint32) ConnectionOptionFunc

WithNetworkMagic specifies the network magic value

func WithNodeToNode

func WithNodeToNode(nodeToNode bool) ConnectionOptionFunc

WithNodeToNode specifies whether to use the node-to-node protocol. The default is to use node-to-client

func WithPeerSharing

func WithPeerSharing(peerSharing bool) ConnectionOptionFunc

WithPeerSharing specifies whether to enable peer sharing. This affects both the protocol handshake and whether the PeerSharing protocol is enabled

func WithPeerSharingConfig

func WithPeerSharingConfig(cfg peersharing.Config) ConnectionOptionFunc

WithPeerSharingConfig specifies PeerSharing protocol config

func WithQueryMode

func WithQueryMode(queryMode bool) ConnectionOptionFunc

WithQueryMode specifies whether to enable handshake query mode. When enabled, a ProposeVersions message with the query flag set is sent. The remote peer replies with all supported versions via MsgQueryReply and terminates the connection. Use Connection.QueryReplyVersionMap() to access the reply after a successful connection setup.

func WithServer

func WithServer(server bool) ConnectionOptionFunc

WithServer specifies whether to act as a server

func WithTxSubmissionConfig

func WithTxSubmissionConfig(cfg txsubmission.Config) ConnectionOptionFunc

WithTxSubmissionConfig specifies TxSubmission protocol config

type Network

type Network struct {
	Id             uint8 // network ID used for addresses
	Name           string
	NetworkMagic   uint32
	BootstrapPeers []NetworkBootstrapPeer
	PublicRoots    []NetworkPublicRoot
}

Network represents a Cardano network

func NetworkById

func NetworkById(id uint8) (Network, bool)

NetworkById returns a predefined network by ID

func NetworkByName

func NetworkByName(name string) (Network, bool)

NetworkByName returns a predefined network by name

func NetworkByNetworkMagic

func NetworkByNetworkMagic(networkMagic uint32) (Network, bool)

NetworkByNetworkMagic returns a predefined network by network magic This will return NetworkCardanoMainnet and not NetworkPrimeMainnet for magic 764824073

func (Network) String

func (n Network) String() string

type NetworkAccessPoint

type NetworkAccessPoint struct {
	Address string
	Port    uint
}

type NetworkBootstrapPeer

type NetworkBootstrapPeer struct {
	Address string
	Port    uint
}

type NetworkPublicRoot

type NetworkPublicRoot struct {
	AccessPoints []NetworkAccessPoint
	Advertise    bool
	Valency      int
}