mempool

Documentation

Overview

Package mempool is a generated GoMock package.

Index

• Constants
• Variables
• type Mempool
  • func New(namespace string, registerer prometheus.Registerer, ...) (Mempool, error)
• type MockMempool
  • func NewMockMempool(ctrl *gomock.Controller) *MockMempool
  • func (m *MockMempool) Add(arg0 *txs.Tx) error
  • func (m *MockMempool) EXPECT() *MockMempoolMockRecorder
  • func (m *MockMempool) Get(arg0 ids.ID) (*txs.Tx, bool)
  • func (m *MockMempool) GetDropReason(arg0 ids.ID) error
  • func (m *MockMempool) Iterate(arg0 func(*txs.Tx) bool)
  • func (m *MockMempool) Len() int
  • func (m *MockMempool) MarkDropped(arg0 ids.ID, arg1 error)
  • func (m *MockMempool) Peek() (*txs.Tx, bool)
  • func (m *MockMempool) Remove(arg0 ...*txs.Tx)
  • func (m *MockMempool) RequestBuildBlock(arg0 bool)
• type MockMempoolMockRecorder
  • func (mr *MockMempoolMockRecorder) Add(arg0 any) *gomock.Call
  • func (mr *MockMempoolMockRecorder) Get(arg0 any) *gomock.Call
  • func (mr *MockMempoolMockRecorder) GetDropReason(arg0 any) *gomock.Call
  • func (mr *MockMempoolMockRecorder) Iterate(arg0 any) *gomock.Call
  • func (mr *MockMempoolMockRecorder) Len() *gomock.Call
  • func (mr *MockMempoolMockRecorder) MarkDropped(arg0, arg1 any) *gomock.Call
  • func (mr *MockMempoolMockRecorder) Peek() *gomock.Call
  • func (mr *MockMempoolMockRecorder) Remove(arg0 ...any) *gomock.Call
  • func (mr *MockMempoolMockRecorder) RequestBuildBlock(arg0 any) *gomock.Call

Constants

const (
	// MaxTxSize is the maximum number of bytes a transaction can use to be
	// allowed into the mempool.
	MaxTxSize = 64 * units.KiB
)

Variables

var (
	ErrDuplicateTx                = errors.New("duplicate tx")
	ErrTxTooLarge                 = errors.New("tx too large")
	ErrMempoolFull                = errors.New("mempool is full")
	ErrConflictsWithOtherTx       = errors.New("tx conflicts with other tx")
	ErrCantIssueAdvanceTimeTx     = errors.New("can not issue an advance time tx")
	ErrCantIssueRewardValidatorTx = errors.New("can not issue a reward validator tx")
)

Types

type Mempool

type Mempool interface {
	Add(tx *txs.Tx) error
	Get(txID ids.ID) (*txs.Tx, bool)
	// Remove [txs] and any conflicts of [txs] from the mempool.
	Remove(txs ...*txs.Tx)

	// Peek returns the oldest tx in the mempool.
	Peek() (tx *txs.Tx, exists bool)

	// Iterate iterates over the txs until f returns false
	Iterate(f func(tx *txs.Tx) bool)

	// RequestBuildBlock notifies the consensus engine that a block should be
	// built. If [emptyBlockPermitted] is true, the notification will be sent
	// regardless of whether there are no transactions in the mempool. If not,
	// a notification will only be sent if there is at least one transaction in
	// the mempool.
	RequestBuildBlock(emptyBlockPermitted bool)

	// Note: dropped txs are added to droppedTxIDs but are not evicted from
	// unissued decision/staker txs. This allows previously dropped txs to be
	// possibly reissued.
	MarkDropped(txID ids.ID, reason error)
	GetDropReason(txID ids.ID) error

	// Len returns the number of txs in the mempool.
	Len() int
}

func New

func New(
	namespace string,
	registerer prometheus.Registerer,
	toEngine chan<- common.Message,
) (Mempool, error)

type MockMempool

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

MockMempool is a mock of Mempool interface.

func NewMockMempool

func NewMockMempool(ctrl *gomock.Controller) *MockMempool

NewMockMempool creates a new mock instance.

func (*MockMempool) Add

func (m *MockMempool) Add(arg0 *txs.Tx) error

Add mocks base method.

func (*MockMempool) EXPECT

func (m *MockMempool) EXPECT() *MockMempoolMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMempool) Get

func (m *MockMempool) Get(arg0 ids.ID) (*txs.Tx, bool)

Get mocks base method.

func (*MockMempool) GetDropReason

func (m *MockMempool) GetDropReason(arg0 ids.ID) error

GetDropReason mocks base method.

func (*MockMempool) Iterate

func (m *MockMempool) Iterate(arg0 func(*txs.Tx) bool)

Iterate mocks base method.

func (*MockMempool) Len

func (m *MockMempool) Len() int

Len mocks base method.

func (*MockMempool) MarkDropped

func (m *MockMempool) MarkDropped(arg0 ids.ID, arg1 error)

MarkDropped mocks base method.

func (*MockMempool) Peek

func (m *MockMempool) Peek() (*txs.Tx, bool)

Peek mocks base method.

func (*MockMempool) Remove

func (m *MockMempool) Remove(arg0 ...*txs.Tx)

Remove mocks base method.

func (*MockMempool) RequestBuildBlock

func (m *MockMempool) RequestBuildBlock(arg0 bool)

RequestBuildBlock mocks base method.

type MockMempoolMockRecorder

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

MockMempoolMockRecorder is the mock recorder for MockMempool.

func (*MockMempoolMockRecorder) Add

func (mr *MockMempoolMockRecorder) Add(arg0 any) *gomock.Call

Add indicates an expected call of Add.

func (*MockMempoolMockRecorder) Get

func (mr *MockMempoolMockRecorder) Get(arg0 any) *gomock.Call

Get indicates an expected call of Get.

func (*MockMempoolMockRecorder) GetDropReason

func (mr *MockMempoolMockRecorder) GetDropReason(arg0 any) *gomock.Call

GetDropReason indicates an expected call of GetDropReason.

func (*MockMempoolMockRecorder) Iterate

func (mr *MockMempoolMockRecorder) Iterate(arg0 any) *gomock.Call

Iterate indicates an expected call of Iterate.

func (*MockMempoolMockRecorder) Len

func (mr *MockMempoolMockRecorder) Len() *gomock.Call

Len indicates an expected call of Len.

func (*MockMempoolMockRecorder) MarkDropped

func (mr *MockMempoolMockRecorder) MarkDropped(arg0, arg1 any) *gomock.Call

MarkDropped indicates an expected call of MarkDropped.

func (*MockMempoolMockRecorder) Peek

func (mr *MockMempoolMockRecorder) Peek() *gomock.Call

Peek indicates an expected call of Peek.

func (*MockMempoolMockRecorder) Remove

func (mr *MockMempoolMockRecorder) Remove(arg0 ...any) *gomock.Call

Remove indicates an expected call of Remove.

func (*MockMempoolMockRecorder) RequestBuildBlock

func (mr *MockMempoolMockRecorder) RequestBuildBlock(arg0 any) *gomock.Call

RequestBuildBlock indicates an expected call of RequestBuildBlock.