packages.h

Go to the documentation of this file.

// Copyright (c) 2021-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_POLICY_PACKAGES_H
#define BITCOIN_POLICY_PACKAGES_H

#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>

static constexpr uint32_t MAX_PACKAGE_COUNT{25};
static constexpr uint32_t MAX_PACKAGE_WEIGHT = 404'000;
static_assert(MAX_PACKAGE_WEIGHT >= MAX_STANDARD_TX_WEIGHT);

// Packages are part of a single cluster, so ensure that the package limits are
// set within the mempool's cluster size limits.
static_assert(DEFAULT_CLUSTER_LIMIT >= MAX_PACKAGE_COUNT);
static_assert(MAX_PACKAGE_WEIGHT <= DEFAULT_CLUSTER_SIZE_LIMIT_KVB * WITNESS_SCALE_FACTOR * 1000);

enum class PackageValidationResult {
    PCKG_RESULT_UNSET = 0,        
    PCKG_POLICY,                  
    PCKG_TX,                      
    PCKG_MEMPOOL_ERROR,           
};

using Package = std::vector<CTransactionRef>;

class PackageValidationState : public ValidationState<PackageValidationResult> {};

bool IsTopoSortedPackage(const Package& txns);

bool IsConsistentPackage(const Package& txns);

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

bool IsChildWithParents(const Package& package);

bool IsChildWithParentsTree(const Package& package);

uint256 GetPackageHash(const std::vector<CTransactionRef>& transactions);

#endif // BITCOIN_POLICY_PACKAGES_H