mempool

package
v3.0.2+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 10, 2019 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MempoolChannel = byte(0x30)

	// UnknownPeerID is the peer ID to use when running CheckTx when there is
	// no peer (e.g. RPC)
	UnknownPeerID uint16 = 0
)
View Source 
const (
	// MetricsSubsystem is a subsystem shared by all metrics exposed by this
	// package.
	MetricsSubsystem = "mempool"
)

Variables

View Source 
var (
	// ErrTxInCache is returned to the client if we saw tx earlier
	ErrTxInCache = errors.New("Tx already exists in cache")

	// ErrTxTooLarge means the tx is too big to be sent in a message to other peers
	ErrTxTooLarge = fmt.Errorf("Tx too large. Max size is %d", maxTxSize)
)

Functions

func IsPreCheckError added in v0.26.1 

func IsPreCheckError(err error) bool

IsPreCheckError returns true if err is due to pre check failure.

func RegisterMempoolMessages added in v0.19.0 

func RegisterMempoolMessages(cdc *amino.Codec)

func TxID added in v0.22.0 

func TxID(tx []byte) string

TxID is the hex encoded hash of the bytes as a types.Tx.

Types

type ErrMempoolIsFull added in v0.19.5 

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

ErrMempoolIsFull means Tendermint & an application can't handle that much load

func (ErrMempoolIsFull) Error 

func (e ErrMempoolIsFull) Error() string

type ErrPreCheck added in v0.26.1 

type ErrPreCheck struct {
	Reason error
}

ErrPreCheck is returned when tx is too big

func (ErrPreCheck) Error added in v0.26.1 

func (e ErrPreCheck) Error() string

type Mempool 

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

Mempool is an ordered in-memory pool for transactions before they are proposed in a consensus round. Transaction validity is checked using the CheckTx abci message before the transaction is added to the pool. The Mempool uses a concurrent list structure for storing transactions that can be efficiently accessed by multiple concurrent readers.

func NewMempool 

func NewMempool(
	config *cfg.MempoolConfig,
	proxyAppConn proxy.AppConnMempool,
	height int64,
	options ...MempoolOption,
) *Mempool

NewMempool returns a new Mempool with the given configuration and connection to an application.

func (*Mempool) CheckTx 

func (mem *Mempool) CheckTx(tx types.Tx, cb func(*abci.Response)) (err error)

CheckTx executes a new transaction against the application to determine its validity and whether it should be added to the mempool. It blocks if we're waiting on Update() or Reap(). cb: A callback from the CheckTx command. 

It gets called from another goroutine.

CONTRACT: Either cb will get called, or err returned.

func (*Mempool) CheckTxWithInfo 

func (mem *Mempool) CheckTxWithInfo(tx types.Tx, cb func(*abci.Response), txInfo TxInfo) (err error)

CheckTxWithInfo performs the same operation as CheckTx, but with extra meta data about the tx. Currently this metadata is the peer who sent it, used to prevent the tx from being gossiped back to them.

func (*Mempool) CloseWAL added in v0.13.0 

func (mem *Mempool) CloseWAL()

CloseWAL closes and discards the underlying WAL file. Any further writes will not be relayed to disk.

func (*Mempool) EnableTxsAvailable added in v0.10.3 

func (mem *Mempool) EnableTxsAvailable()

EnableTxsAvailable initializes the TxsAvailable channel, ensuring it will trigger once every height when transactions are available. NOTE: not thread safe - should only be called once, on startup

func (*Mempool) Flush 

func (mem *Mempool) Flush()

Flush removes all transactions from the mempool and cache

func (*Mempool) FlushAppConn added in v0.16.0 

func (mem *Mempool) FlushAppConn() error

FlushAppConn flushes the mempool connection to ensure async reqResCb calls are done. E.g. from CheckTx.

func (*Mempool) InitWAL added in v0.16.0 

func (mem *Mempool) InitWAL()

InitWAL creates a directory for the WAL file and opens a file itself.

*panics* if can't create directory or open file. *not thread safe*

func (*Mempool) Lock 

func (mem *Mempool) Lock()

Lock locks the mempool. The consensus must be able to hold lock to safely update.

func (*Mempool) ReapMaxBytesMaxGas added in v0.25.0 

func (mem *Mempool) ReapMaxBytesMaxGas(maxBytes, maxGas int64) types.Txs

ReapMaxBytesMaxGas reaps transactions from the mempool up to maxBytes bytes total with the condition that the total gasWanted must be less than maxGas. If both maxes are negative, there is no cap on the size of all returned transactions (~ all available transactions).

func (*Mempool) ReapMaxTxs added in v0.24.0 

func (mem *Mempool) ReapMaxTxs(max int) types.Txs

ReapMaxTxs reaps up to max transactions from the mempool. If max is negative, there is no cap on the size of all returned transactions (~ all available transactions).

func (*Mempool) SetLogger added in v0.10.0 

func (mem *Mempool) SetLogger(l log.Logger)

SetLogger sets the Logger.

func (*Mempool) Size 

func (mem *Mempool) Size() int

Size returns the number of transactions in the mempool.

func (*Mempool) TxsAvailable added in v0.10.3 

func (mem *Mempool) TxsAvailable() <-chan struct{}

TxsAvailable returns a channel which fires once for every height, and only when transactions are available in the mempool. NOTE: the returned channel may be nil if EnableTxsAvailable was not called.

func (*Mempool) TxsBytes 

func (mem *Mempool) TxsBytes() int64

TxsBytes returns the total size of all txs in the mempool.

func (*Mempool) TxsFront added in v0.16.0 

func (mem *Mempool) TxsFront() *clist.CElement

TxsFront returns the first transaction in the ordered list for peer goroutines to call .NextWait() on.

func (*Mempool) TxsWaitChan added in v0.16.0 

func (mem *Mempool) TxsWaitChan() <-chan struct{}

TxsWaitChan returns a channel to wait on transactions. It will be closed once the mempool is not empty (ie. the internal `mem.txs` has at least one element)

func (*Mempool) Unlock 

func (mem *Mempool) Unlock()

Unlock unlocks the mempool.

func (*Mempool) Update 

func (mem *Mempool) Update(
	height int64,
	txs types.Txs,
	preCheck PreCheckFunc,
	postCheck PostCheckFunc,
) error

Update informs the mempool that the given txs were committed and can be discarded. NOTE: this should be called *after* block is committed by consensus. NOTE: unsafe; Lock/Unlock must be managed by caller

type MempoolMessage 

type MempoolMessage interface{}

MempoolMessage is a message sent or received by the MempoolReactor.

type MempoolOption added in v0.22.0 

type MempoolOption func(*Mempool)

MempoolOption sets an optional parameter on the Mempool.

func WithMetrics added in v0.22.0 

func WithMetrics(metrics *Metrics) MempoolOption

WithMetrics sets the metrics.

func WithPostCheck added in v0.25.0 

func WithPostCheck(f PostCheckFunc) MempoolOption

WithPostCheck sets a filter for the mempool to reject a tx if f(tx) returns false. This is ran after CheckTx.

func WithPreCheck added in v0.25.0 

func WithPreCheck(f PreCheckFunc) MempoolOption

WithPreCheck sets a filter for the mempool to reject a tx if f(tx) returns false. This is ran before CheckTx.

type MempoolReactor 

type MempoolReactor struct {
	p2p.BaseReactor

	Mempool *Mempool
	// contains filtered or unexported fields
}

MempoolReactor handles mempool tx broadcasting amongst peers. It maintains a map from peer ID to counter, to prevent gossiping txs to the peers you received it from.

func NewMempoolReactor 

func NewMempoolReactor(config *cfg.MempoolConfig, mempool *Mempool) *MempoolReactor

NewMempoolReactor returns a new MempoolReactor with the given config and mempool.

func (*MempoolReactor) AddPeer 

func (memR *MempoolReactor) AddPeer(peer p2p.Peer)

AddPeer implements Reactor. It starts a broadcast routine ensuring all txs are forwarded to the given peer.

func (*MempoolReactor) GetChannels 

func (memR *MempoolReactor) GetChannels() []*p2p.ChannelDescriptor

GetChannels implements Reactor. It returns the list of channels for this reactor.

func (*MempoolReactor) OnStart added in v0.21.0 

func (memR *MempoolReactor) OnStart() error

OnStart implements p2p.BaseReactor.

func (*MempoolReactor) Receive 

func (memR *MempoolReactor) Receive(chID byte, src p2p.Peer, msgBytes []byte)

Receive implements Reactor. It adds any received transactions to the mempool.

func (*MempoolReactor) RemovePeer 

func (memR *MempoolReactor) RemovePeer(peer p2p.Peer, reason interface{})

RemovePeer implements Reactor.

func (*MempoolReactor) SetLogger added in v0.10.4 

func (memR *MempoolReactor) SetLogger(l log.Logger)

SetLogger sets the Logger on the reactor and the underlying Mempool.

type Metrics added in v0.22.0 

type Metrics struct {
	// Size of the mempool.
	Size metrics.Gauge
	// Histogram of transaction sizes, in bytes.
	TxSizeBytes metrics.Histogram
	// Number of failed transactions.
	FailedTxs metrics.Counter
	// Number of times transactions are rechecked in the mempool.
	RecheckTimes metrics.Counter
}

Metrics contains metrics exposed by this package. see MetricsProvider for descriptions.

func NopMetrics added in v0.22.0 

func NopMetrics() *Metrics

NopMetrics returns no-op Metrics.

func PrometheusMetrics added in v0.22.0 

func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics

PrometheusMetrics returns Metrics build using Prometheus client library. Optionally, labels can be provided along with their values ("foo", "fooValue").

type PeerState 

type PeerState interface {
	GetHeight() int64
}

PeerState describes the state of a peer.

type PostCheckFunc added in v0.25.0 

type PostCheckFunc func(types.Tx, *abci.ResponseCheckTx) error

PostCheckFunc is an optional filter executed after CheckTx and rejects transaction if false is returned. An example would be to ensure a transaction doesn't require more gas than available for the block.

func PostCheckMaxGas added in v0.25.0 

func PostCheckMaxGas(maxGas int64) PostCheckFunc

PostCheckMaxGas checks that the wanted gas is smaller or equal to the passed maxGas. Returns nil if maxGas is -1.

type PreCheckFunc added in v0.25.0 

type PreCheckFunc func(types.Tx) error

PreCheckFunc is an optional filter executed before CheckTx and rejects transaction if false is returned. An example would be to ensure that a transaction doesn't exceeded the block size.

func PreCheckAminoMaxBytes added in v0.25.0 

func PreCheckAminoMaxBytes(maxBytes int64) PreCheckFunc

PreCheckAminoMaxBytes checks that the size of the transaction plus the amino overhead is smaller or equal to the expected maxBytes.

type TxInfo 

type TxInfo struct {
	// We don't use p2p.ID here because it's too big. The gain is to store max 2
	// bytes with each tx to identify the sender rather than 20 bytes.
	PeerID uint16
}

TxInfo are parameters that get passed when attempting to add a tx to the mempool.

type TxMessage 

type TxMessage struct {
	Tx types.Tx
}

TxMessage is a MempoolMessage containing a transaction.

func (*TxMessage) String 

func (m *TxMessage) String() string

String returns a string representation of the TxMessage.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.