package
1.9.6
Repository: https://github.com/decred/dcrd.git
Documentation: pkg.go.dev

# README

mempool

Build Status ISC License Doc

Package mempool provides a policy-enforced pool of unmined Decred transactions.

A key responsibility of the Decred network is mining transactions – regular transactions and stake transactions – into blocks. In order to facilitate this, the mining process relies on having a readily-available source of transactions to include in a block that is being solved.

At a high level, this package satisfies that requirement by providing an in-memory pool of fully validated transactions that can also optionally be further filtered based upon a configurable policy.

The Policy configuration options has flags that control whether or not "standard" transactions and old votes are accepted into the mempool. In essence, a "standard" transaction is one that satisfies a fairly strict set of requirements that are largely intended to help provide fair use of the system to all users. It is important to note that what is considered to be a "standard" transaction changes over time as policy and consensus rules evolve. For some insight, at the time of this writing, an example of some of the criteria that are required for a transaction to be considered standard are that it is of the most-recently supported version, finalized, does not exceed a specific size, and only consists of specific script forms.

Since this package does not deal with other Decred specifics such as network communication and transaction relay, it returns a list of transactions that were accepted which gives the caller a high level of flexibility in how they want to proceed. Typically, this will involve things such as relaying the transactions to other peers on the network and notifying the mining process that new transactions are available.

Feature Overview

The following is a quick overview of the major features. It is not intended to be an exhaustive list.

  • Maintain a pool of fully validated transactions
    • Reject non-fully-spent duplicate transactions
    • Reject coinbase transactions
    • Reject double spends (both from the chain and other transactions in pool)
    • Reject invalid transactions according to the network consensus rules
    • Full script execution and validation with signature cache support
    • Individual transaction query support
  • Stake transaction support (ticket purchases, votes and revocations)
    • Option to accept or reject old votes
  • Orphan transaction support (transactions that spend from unknown outputs)
    • Configurable limits (see transaction acceptance policy)
    • Automatic addition of orphan transactions that are no longer orphans as new transactions are added to the pool
    • Individual orphan transaction query support
  • Configurable transaction acceptance policy
    • Option to accept or reject standard transactions
    • Option to accept or reject transactions based on priority calculations
    • Minimum fee threshold
    • Max signature operations per transaction
    • Max orphan transaction size
    • Max number of orphan transactions allowed
  • Additional metadata tracking for each transaction
    • Timestamp when the transaction was added to the pool
    • Most recent block height when the transaction was added to the pool
    • The fee the transaction pays
    • The starting priority for the transaction
  • Manual control of transaction removal
    • Recursive removal of all dependent transactions

License

Package mempool is licensed under the copyfree ISC License.

# Functions

New returns a new memory pool for validating and storing standalone transactions until they are mined into a block.
UseLogger uses a specified Logger to output package logging info.

# Constants

BaseStandardVerifyFlags defines the script flags that should be used when executing transaction scripts to enforce additional checks which are required for the script to be considered standard regardless of the state of any agenda votes.
DefaultMinRelayTxFee is the minimum fee in atoms that is required for a transaction to be treated as free for relay and mining purposes.
ErrAlreadyExists indicates a transaction already exists on the main chain and is not fully spent.
ErrAlreadyVoted indicates a ticket already voted.
ErrCoinbase indicates a transaction is a standalone coinbase transaction.
ErrDuplicate indicates a transaction already exists in the mempool.
ErrDuplicateRevocation indicates a revocation already exists in the mempool.
ErrDustOutput indicates a transaction has one or more dust outputs.
ErrExpired indicates a transaction will be expired as of the next block.
ErrFeeTooHigh indicates a transaction pays fees above the maximum allowed by the active policy.
ErrInsufficientFee indicates a transaction cannot does not pay the minimum fee required by the active policy.
ErrInvalid indicates a mempool transaction is invalid per consensus.
ErrMempoolDoubleSpend indicates a transaction that attempts to spend coins already spent by other transactions in the pool.
ErrNonStandard indicates a non-standard transaction.
ErrOldVote indicates a ticket votes on a block height lower than the minimum allowed by the mempool.
ErrOrphan indicates a transaction is an orphan.
ErrOrphanPolicyViolation indicates that an orphan block violates the prevailing orphan policy.
ErrSeqLockUnmet indicates a transaction sequence locks are not active.
ErrTooManyTSpends indicates the number of treasury spend hashes exceeds the maximum allowed.
ErrTooManyVotes indicates the number of vote double spends exceeds the maximum allowed.
ErrTreasurybase indicates a transaction is a standalone treasurybase transaction.
ErrTSpendInvalidExpiry indicates a treasury spend expiry is invalid.
ErrTSpendMinedOnAncestor indicates a referenced treasury spend was already mined on an ancestor block.
MaxStandardTxSize is the maximum size allowed for transactions that are considered standard and will therefore be relayed and considered for mining.
MempoolMaxConcurrentTSpends is the maximum number of TSpends that are allowed in the mempool.

# Structs

Config is a descriptor containing the memory pool configuration.
Policy houses the policy (configuration parameters) which is used to control the mempool.
RuleError identifies a rule violation.
TxDesc is a descriptor containing a transaction in the mempool along with additional metadata.
TxPool is used as a source of transactions that need to be mined into blocks and relayed to other peers.
VerboseTxDesc is a descriptor containing a transaction in the mempool along with additional more expensive to calculate metadata.

# Type aliases

ErrorKind identifies a kind of error.
Tag represents an identifier to use for tagging orphan transactions.