localtxmonitor

Documentation

Overview

Package localtxmonitor implements the Ouroboros local-tx-monitor protocol

Index

• Constants
• Variables
• func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)
• type CallbackContext
• type Client
  • func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client
  • func (c *Client) Acquire() error
  • func (c *Client) GetSizes() (uint32, uint32, uint32, error)
  • func (c *Client) HasTx(txId []byte) (bool, error)
  • func (c *Client) NextTx() ([]byte, error)
  • func (c *Client) Release() error
  • func (c *Client) Start()
  • func (c *Client) Stop() error
• type Config
  • func NewConfig(options ...LocalTxMonitorOptionFunc) Config
• type GetMempoolFunc
• type LocalTxMonitor
  • func New(protoOptions protocol.ProtocolOptions, cfg *Config) *LocalTxMonitor
• type LocalTxMonitorOptionFunc
  • func WithAcquireTimeout(timeout time.Duration) LocalTxMonitorOptionFunc
  • func WithGetMempoolFunc(getMempoolFunc GetMempoolFunc) LocalTxMonitorOptionFunc
  • func WithQueryTimeout(timeout time.Duration) LocalTxMonitorOptionFunc
• type MsgAcquire
  • func NewMsgAcquire() *MsgAcquire
• type MsgAcquired
  • func NewMsgAcquired(slotNo uint64) *MsgAcquired
• type MsgDone
  • func NewMsgDone() *MsgDone
• type MsgGetSizes
  • func NewMsgGetSizes() *MsgGetSizes
• type MsgHasTx
  • func NewMsgHasTx(txId []byte) *MsgHasTx
• type MsgNextTx
  • func NewMsgNextTx() *MsgNextTx
• type MsgRelease
  • func NewMsgRelease() *MsgRelease
• type MsgReplyGetSizes
  • func NewMsgReplyGetSizes(capacity uint32, size uint32, numberOfTxs uint32) *MsgReplyGetSizes
• type MsgReplyGetSizesResult
• type MsgReplyHasTx
  • func NewMsgReplyHasTx(result bool) *MsgReplyHasTx
• type MsgReplyNextTx
  • func NewMsgReplyNextTx(eraId uint8, tx []byte) *MsgReplyNextTx
  • func (m *MsgReplyNextTx) MarshalCBOR() ([]byte, error)
  • func (m *MsgReplyNextTx) UnmarshalCBOR(data []byte) error
• type MsgReplyNextTxTransaction
• type Server
  • func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server
• type TxAndEraId

Constants

const (
	ProtocolName        = "local-tx-monitor"
	ProtocolId   uint16 = 9
)

Protocol identifiers

const (
	MessageTypeDone          = 0
	MessageTypeAcquire       = 1
	MessageTypeAcquired      = 2
	MessageTypeRelease       = 3
	MessageTypeNextTx        = 5
	MessageTypeReplyNextTx   = 6
	MessageTypeHasTx         = 7
	MessageTypeReplyHasTx    = 8
	MessageTypeGetSizes      = 9
	MessageTypeReplyGetSizes = 10
)

Message types

Variables

var StateMap = protocol.StateMap{
	// contains filtered or unexported fields
}

LocalTxMonitor protocol state machine

Functions

func NewMsgFromCbor

func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)

NewMsgFromCbor parses a LocalTxMonitor message from CBOR

Types

type CallbackContext

type CallbackContext struct {
	ConnectionId connection.ConnectionId
	Client       *Client
	Server       *Server
}

Callback context

type Client

type Client struct {
	*protocol.Protocol
	// contains filtered or unexported fields
}

Client implements the LocalTxMonitor client

func NewClient

func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client

NewClient returns a new LocalTxMonitor client object

func (*Client) Acquire

func (c *Client) Acquire() error

Acquire starts the acquire process for a current mempool snapshot

func (*Client) GetSizes

func (c *Client) GetSizes() (uint32, uint32, uint32, error)

GetSizes returns the capacity (in bytes), size (in bytes), and number of transactions in the mempool snapshot

func (*Client) HasTx

func (c *Client) HasTx(txId []byte) (bool, error)

HasTx returns whether or not the specified transaction ID exists in the mempool snapshot

func (*Client) NextTx

func (c *Client) NextTx() ([]byte, error)

NextTx returns the next transaction in the mempool snapshot

func (*Client) Release

func (c *Client) Release() error

Release releases the previously acquired mempool snapshot

func (*Client) Start

func (c *Client) Start()

func (*Client) Stop

func (c *Client) Stop() error

Stop transitions the protocol to the Done state. No more operations will be possible

type Config

type Config struct {
	GetMempoolFunc GetMempoolFunc
	AcquireTimeout time.Duration
	QueryTimeout   time.Duration
}

Config is used to configure the LocalTxMonitor protocol instance

func NewConfig

func NewConfig(options ...LocalTxMonitorOptionFunc) Config

NewConfig returns a new LocalTxMonitor config object with the provided options

type GetMempoolFunc

type GetMempoolFunc func(CallbackContext) (uint64, uint32, []TxAndEraId, error)

Callback function types

type LocalTxMonitor

type LocalTxMonitor struct {
	Client *Client
	Server *Server
}

LocalTxMonitor is a wrapper object that holds the client and server instances

func New

func New(protoOptions protocol.ProtocolOptions, cfg *Config) *LocalTxMonitor

New returns a new LocalTxMonitor object

type LocalTxMonitorOptionFunc

type LocalTxMonitorOptionFunc func(*Config)

LocalTxMonitorOptionFunc represents a function used to modify the LocalTxMonitor protocol config

func WithAcquireTimeout

func WithAcquireTimeout(timeout time.Duration) LocalTxMonitorOptionFunc

WithAcquireTimeout specifies the timeout for acquire operations when acting as a client

func WithGetMempoolFunc

func WithGetMempoolFunc(
	getMempoolFunc GetMempoolFunc,
) LocalTxMonitorOptionFunc

WithGetMempoolFunc specifies the callback function for retrieving the mempool

func WithQueryTimeout

func WithQueryTimeout(timeout time.Duration) LocalTxMonitorOptionFunc

WithQueryTimeout specifies the timeout for query operations when acting as a client

type MsgAcquire

type MsgAcquire struct {
	protocol.MessageBase
}

func NewMsgAcquire

func NewMsgAcquire() *MsgAcquire

type MsgAcquired

type MsgAcquired struct {
	protocol.MessageBase
	SlotNo uint64
}

func NewMsgAcquired

func NewMsgAcquired(slotNo uint64) *MsgAcquired

type MsgDone

type MsgDone struct {
	protocol.MessageBase
}

func NewMsgDone

func NewMsgDone() *MsgDone

type MsgGetSizes

type MsgGetSizes struct {
	protocol.MessageBase
}

func NewMsgGetSizes

func NewMsgGetSizes() *MsgGetSizes

type MsgHasTx

type MsgHasTx struct {
	protocol.MessageBase
	TxId []byte
}

func NewMsgHasTx

func NewMsgHasTx(txId []byte) *MsgHasTx

type MsgNextTx

type MsgNextTx struct {
	protocol.MessageBase
}

func NewMsgNextTx

func NewMsgNextTx() *MsgNextTx

type MsgRelease

type MsgRelease struct {
	protocol.MessageBase
}

func NewMsgRelease

func NewMsgRelease() *MsgRelease

type MsgReplyGetSizes

type MsgReplyGetSizes struct {
	protocol.MessageBase
	Result MsgReplyGetSizesResult
}

func NewMsgReplyGetSizes

func NewMsgReplyGetSizes(
	capacity uint32,
	size uint32,
	numberOfTxs uint32,
) *MsgReplyGetSizes

type MsgReplyGetSizesResult

type MsgReplyGetSizesResult struct {
	Capacity    uint32
	Size        uint32
	NumberOfTxs uint32
	// contains filtered or unexported fields
}

type MsgReplyHasTx

type MsgReplyHasTx struct {
	protocol.MessageBase
	Result bool
}

func NewMsgReplyHasTx

func NewMsgReplyHasTx(result bool) *MsgReplyHasTx

type MsgReplyNextTx

type MsgReplyNextTx struct {
	protocol.MessageBase
	Transaction MsgReplyNextTxTransaction
}

func NewMsgReplyNextTx

func NewMsgReplyNextTx(eraId uint8, tx []byte) *MsgReplyNextTx

func (*MsgReplyNextTx) MarshalCBOR

func (m *MsgReplyNextTx) MarshalCBOR() ([]byte, error)

func (*MsgReplyNextTx) UnmarshalCBOR

func (m *MsgReplyNextTx) UnmarshalCBOR(data []byte) error

type MsgReplyNextTxTransaction

type MsgReplyNextTxTransaction struct {
	EraId uint8
	Tx    []byte
	// contains filtered or unexported fields
}

type Server

type Server struct {
	*protocol.Protocol
	// contains filtered or unexported fields
}

Server implements the LocalTxMonitor server

func NewServer

func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server

NewServer returns a new Server object

type TxAndEraId

type TxAndEraId struct {
	EraId uint
	Tx    []byte
	// contains filtered or unexported fields
}

Helper types