packages.h File Reference

#include <consensus/consensus.h>
#include <consensus/validation.h>
#include <policy/policy.h>
#include <primitives/transaction.h>
#include <util/hasher.h>
#include <cstdint>
#include <unordered_set>
#include <vector>

Include dependency graph for packages.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PackageValidationState

Typedefs
using	Package = std::vector< CTransactionRef >
	A package is an ordered list of transactions. More...

Enumerations
enum class	PackageValidationResult { PCKG_RESULT_UNSET = 0 , PCKG_POLICY , PCKG_TX , PCKG_MEMPOOL_ERROR }
	A "reason" why a package was invalid. More...

Functions
bool	IsTopoSortedPackage (const Package &txns)
	If any direct dependencies exist between transactions (i.e. More...
bool	IsConsistentPackage (const Package &txns)
	Checks that these transactions don't conflict, i.e., spend the same prevout. More...
bool	IsWellFormedPackage (const Package &txns, PackageValidationState &state, bool require_sorted)
	Context-free package policy checks: More...
bool	IsChildWithParents (const Package &package)
	Context-free check that a package is exactly one child and its parents; not all parents need to be present, but the package must not contain any transactions that are not the child's parents. More...
bool	IsChildWithParentsTree (const Package &package)
	Context-free check that a package IsChildWithParents() and none of the parents depend on each other (the package is a "tree"). More...
uint256	GetPackageHash (const std::vector< CTransactionRef > &transactions)
	Get the hash of these transactions' wtxids, concatenated in lexicographical order (treating the wtxids as little endian encoded uint256, smallest to largest). More...

Variables
static constexpr uint32_t	MAX_PACKAGE_COUNT {25}
	Default maximum number of transactions in a package. More...
static constexpr uint32_t	MAX_PACKAGE_WEIGHT = 404'000
	Default maximum total weight of transactions in a package in weight to allow for context-less checks. More...

Typedef Documentation

Package

using Package = std::vector<CTransactionRef>

A package is an ordered list of transactions.

The transactions cannot conflict with (spend the same inputs as) one another.

Definition at line 50 of file packages.h.

Enumeration Type Documentation

PackageValidationResult

enum class PackageValidationResult

strong

A "reason" why a package was invalid.

It may be that one or more of the included transactions is invalid or the package itself violates our rules. We don't distinguish between consensus and policy violations right now.

Enumerator
PCKG_RESULT_UNSET	Initial value. The package has not yet been rejected.
PCKG_POLICY	The package itself is invalid (e.g. too many transactions).
PCKG_TX	At least one tx is invalid.
PCKG_MEMPOOL_ERROR	Mempool logic error.

Definition at line 41 of file packages.h.

Function Documentation

GetPackageHash()

uint256 GetPackageHash

(

const std::vector< CTransactionRef > &

transactions

)

Get the hash of these transactions' wtxids, concatenated in lexicographical order (treating the wtxids as little endian encoded uint256, smallest to largest).

Definition at line 151 of file packages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsChildWithParents()

bool IsChildWithParents

(

const Package &

package

)

Context-free check that a package is exactly one child and its parents; not all parents need to be present, but the package must not contain any transactions that are not the child's parents.

It is expected to be sorted, which means the last transaction must be the child.

Definition at line 119 of file packages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsChildWithParentsTree()

bool IsChildWithParentsTree

(

const Package &

package

)

Context-free check that a package IsChildWithParents() and none of the parents depend on each other (the package is a "tree").

Definition at line 136 of file packages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsConsistentPackage()

bool IsConsistentPackage

(

const Package &

txns

)

Checks that these transactions don't conflict, i.e., spend the same prevout.

This includes checking that there are no duplicate transactions. Since these checks require looking at the inputs of a transaction, returns false immediately if any transactions have empty vin.

Does not check consistency of a transaction with oneself; does not check if a transaction spends the same prevout multiple times (see bad-txns-inputs-duplicate in CheckTransaction()).

Returns

true if there are no conflicts. False if any two transactions spend the same prevout.

Definition at line 52 of file packages.cpp.

Here is the caller graph for this function:

IsTopoSortedPackage()

bool IsTopoSortedPackage

(

const Package &

txns

)

If any direct dependencies exist between transactions (i.e.

a child spending the output of a parent), checks that all parents appear somewhere in the list before their respective children. No other ordering is enforced. This function cannot detect indirect dependencies (e.g. a transaction's grandparent if its parent is not present).

Returns

true if sorted. False if any tx spends the output of a tx that appears later in txns.

Definition at line 43 of file packages.cpp.

Here is the call graph for this function:

IsWellFormedPackage()

bool IsWellFormedPackage	(	const Package &	txns,
		PackageValidationState &	state,
		bool	require_sorted
	)

Context-free package policy checks:

1. The number of transactions cannot exceed MAX_PACKAGE_COUNT.
2. The total weight cannot exceed MAX_PACKAGE_WEIGHT.
3. If any dependencies exist between transactions, parents must appear before children.
4. Transactions cannot conflict, i.e., spend the same inputs.

Definition at line 79 of file packages.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MAX_PACKAGE_COUNT

constexpr uint32_t MAX_PACKAGE_COUNT {25}

staticconstexpr

Default maximum number of transactions in a package.

Definition at line 19 of file packages.h.

MAX_PACKAGE_WEIGHT

constexpr uint32_t MAX_PACKAGE_WEIGHT = 404'000

staticconstexpr

Default maximum total weight of transactions in a package in weight to allow for context-less checks.

This must allow a superset of sigops weighted vsize limited transactions to not disallow transactions we would have otherwise accepted individually.

Definition at line 24 of file packages.h.