txpool

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func (conf *Config) BasicCheck() error
• type ConfigError
  • func (e ConfigError) Error() string
• type FeeConfig
  • func DefaultFeeConfig() *FeeConfig
• type InvalidFeeError
  • func (e InvalidFeeError) Error() string
• type MockTxPool
  • func MockingTxPool() *MockTxPool
  • func (m *MockTxPool) AllPendingTxs() []*tx.Tx
  • func (m *MockTxPool) AppendTx(trx *tx.Tx) error
  • func (m *MockTxPool) AppendTxAndBroadcast(trx *tx.Tx) error
  • func (*MockTxPool) EstimatedFee(_ amount.Amount, _ payload.Type) amount.Amount
  • func (*MockTxPool) HandleCommittedBlock(_ *block.Block)
  • func (m *MockTxPool) HasTx(txID tx.ID) bool
  • func (m *MockTxPool) PendingTx(txID tx.ID) *tx.Tx
  • func (m *MockTxPool) PrepareBlockTransactions() block.Txs
  • func (m *MockTxPool) QueryTx(txID tx.ID) *tx.Tx
  • func (m *MockTxPool) RemoveTx(id hash.Hash)
  • func (*MockTxPool) SetNewSandboxAndRecheck(_ sandbox.Sandbox)
  • func (m *MockTxPool) Size() int
  • func (*MockTxPool) String() string
• type Reader
• type TxPool
  • func NewTxPool(conf *Config, storeReader store.Reader, broadcastCh chan message.Message) TxPool

Types

type Config

type Config struct {
	MaxSize int        `toml:"max_size"`
	Fee     *FeeConfig `toml:"fee"`

	// Private configs
	ConsumptionWindow uint32 `toml:"-"`
}

func DefaultConfig

func DefaultConfig() *Config

func (*Config) BasicCheck

func (conf *Config) BasicCheck() error

BasicCheck performs basic checks on the configuration.

type ConfigError

type ConfigError struct {
	Reason string
}

ConfigError is returned when the txPool configuration is invalid.

func (ConfigError) Error

func (e ConfigError) Error() string

type FeeConfig

type FeeConfig struct {
	FixedFee   float64 `toml:"fixed_fee"`
	DailyLimit int     `toml:"daily_limit"`
	UnitPrice  float64 `toml:"unit_price"`
}

func DefaultFeeConfig

func DefaultFeeConfig() *FeeConfig

type InvalidFeeError

type InvalidFeeError struct {
	MinimumFee amount.Amount
}

InvalidFeeError indicates that the transaction fee is below the minimum required.

func (InvalidFeeError) Error

func (e InvalidFeeError) Error() string

type MockTxPool

type MockTxPool struct {
	Txs         []*tx.Tx
	AppendError error
}

MockTxPool is a testing mock.

func MockingTxPool

func MockingTxPool() *MockTxPool

func (*MockTxPool) AllPendingTxs

func (m *MockTxPool) AllPendingTxs() []*tx.Tx

func (*MockTxPool) AppendTx

func (m *MockTxPool) AppendTx(trx *tx.Tx) error

func (*MockTxPool) AppendTxAndBroadcast

func (m *MockTxPool) AppendTxAndBroadcast(trx *tx.Tx) error

func (*MockTxPool) EstimatedFee

func (*MockTxPool) EstimatedFee(_ amount.Amount, _ payload.Type) amount.Amount

func (*MockTxPool) HandleCommittedBlock

func (*MockTxPool) HandleCommittedBlock(_ *block.Block)

func (*MockTxPool) HasTx

func (m *MockTxPool) HasTx(txID tx.ID) bool

func (*MockTxPool) PendingTx

func (m *MockTxPool) PendingTx(txID tx.ID) *tx.Tx

func (*MockTxPool) PrepareBlockTransactions

func (m *MockTxPool) PrepareBlockTransactions() block.Txs

func (*MockTxPool) QueryTx

func (m *MockTxPool) QueryTx(txID tx.ID) *tx.Tx

func (*MockTxPool) RemoveTx

func (m *MockTxPool) RemoveTx(id hash.Hash)

func (*MockTxPool) SetNewSandboxAndRecheck

func (*MockTxPool) SetNewSandboxAndRecheck(_ sandbox.Sandbox)

func (*MockTxPool) Size

func (m *MockTxPool) Size() int

func (*MockTxPool) String

func (*MockTxPool) String() string

type Reader

type Reader interface {
	PrepareBlockTransactions() block.Txs
	PendingTx(txID tx.ID) *tx.Tx
	HasTx(txID tx.ID) bool
	Size() int
	EstimatedFee(amt amount.Amount, payloadType payload.Type) amount.Amount
	AllPendingTxs() []*tx.Tx
}

type TxPool

type TxPool interface {
	Reader

	SetNewSandboxAndRecheck(sbx sandbox.Sandbox)
	AppendTxAndBroadcast(trx *tx.Tx) error
	AppendTx(trx *tx.Tx) error
	HandleCommittedBlock(blk *block.Block)
}

func NewTxPool

func NewTxPool(conf *Config, storeReader store.Reader, broadcastCh chan message.Message) TxPool

NewTxPool constructs a new transaction pool with various sub-pools for different transaction types. The transaction pool also maintains a consumption map for tracking byte usage per address.