mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-02-11 11:16:09 -05:00
2079b80854
This new function takes the populated sets of direct and all conflicts computed in the current mempool, assuming the replacements are a single chunk, and computes a diagram check. The diagram check only works against cluster sizes of 2 or less, and fails if it encounters a different topology. Co-authored-by: Suhas Daftuar <sdaftuar@chaincode.com>
135 lines
6.8 KiB
C++
135 lines
6.8 KiB
C++
// Copyright (c) 2016-2022 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_RBF_H
|
|
#define BITCOIN_POLICY_RBF_H
|
|
|
|
#include <consensus/amount.h>
|
|
#include <primitives/transaction.h>
|
|
#include <threadsafety.h>
|
|
#include <txmempool.h>
|
|
#include <util/feefrac.h>
|
|
|
|
#include <compare>
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
#include <optional>
|
|
#include <set>
|
|
#include <string>
|
|
|
|
class CFeeRate;
|
|
class uint256;
|
|
|
|
/** Maximum number of transactions that can be replaced by RBF (Rule #5). This includes all
|
|
* mempool conflicts and their descendants. */
|
|
static constexpr uint32_t MAX_REPLACEMENT_CANDIDATES{100};
|
|
|
|
/** The rbf state of unconfirmed transactions */
|
|
enum class RBFTransactionState {
|
|
/** Unconfirmed tx that does not signal rbf and is not in the mempool */
|
|
UNKNOWN,
|
|
/** Either this tx or a mempool ancestor signals rbf */
|
|
REPLACEABLE_BIP125,
|
|
/** Neither this tx nor a mempool ancestor signals rbf */
|
|
FINAL,
|
|
};
|
|
|
|
enum class DiagramCheckError {
|
|
/** Unable to calculate due to topology or other reason */
|
|
UNCALCULABLE,
|
|
/** New diagram wasn't strictly superior */
|
|
FAILURE,
|
|
};
|
|
|
|
/**
|
|
* Determine whether an unconfirmed transaction is signaling opt-in to RBF
|
|
* according to BIP 125
|
|
* This involves checking sequence numbers of the transaction, as well
|
|
* as the sequence numbers of all in-mempool ancestors.
|
|
*
|
|
* @param tx The unconfirmed transaction
|
|
* @param pool The mempool, which may contain the tx
|
|
*
|
|
* @return The rbf state
|
|
*/
|
|
RBFTransactionState IsRBFOptIn(const CTransaction& tx, const CTxMemPool& pool) EXCLUSIVE_LOCKS_REQUIRED(pool.cs);
|
|
RBFTransactionState IsRBFOptInEmptyMempool(const CTransaction& tx);
|
|
|
|
/** Get all descendants of iters_conflicting. Checks that there are no more than
|
|
* MAX_REPLACEMENT_CANDIDATES potential entries. May overestimate if the entries in
|
|
* iters_conflicting have overlapping descendants.
|
|
* @param[in] iters_conflicting The set of iterators to mempool entries.
|
|
* @param[out] all_conflicts Populated with all the mempool entries that would be replaced,
|
|
* which includes iters_conflicting and all entries' descendants.
|
|
* Not cleared at the start; any existing mempool entries will
|
|
* remain in the set.
|
|
* @returns an error message if MAX_REPLACEMENT_CANDIDATES may be exceeded, otherwise a std::nullopt.
|
|
*/
|
|
std::optional<std::string> GetEntriesForConflicts(const CTransaction& tx, CTxMemPool& pool,
|
|
const CTxMemPool::setEntries& iters_conflicting,
|
|
CTxMemPool::setEntries& all_conflicts)
|
|
EXCLUSIVE_LOCKS_REQUIRED(pool.cs);
|
|
|
|
/** The replacement transaction may only include an unconfirmed input if that input was included in
|
|
* one of the original transactions.
|
|
* @returns error message if tx spends unconfirmed inputs not also spent by iters_conflicting,
|
|
* otherwise std::nullopt. */
|
|
std::optional<std::string> HasNoNewUnconfirmed(const CTransaction& tx, const CTxMemPool& pool,
|
|
const CTxMemPool::setEntries& iters_conflicting)
|
|
EXCLUSIVE_LOCKS_REQUIRED(pool.cs);
|
|
|
|
/** Check the intersection between two sets of transactions (a set of mempool entries and a set of
|
|
* txids) to make sure they are disjoint.
|
|
* @param[in] ancestors Set of mempool entries corresponding to ancestors of the
|
|
* replacement transactions.
|
|
* @param[in] direct_conflicts Set of txids corresponding to the mempool conflicts
|
|
* (candidates to be replaced).
|
|
* @param[in] txid Transaction ID, included in the error message if violation occurs.
|
|
* @returns error message if the sets intersect, std::nullopt if they are disjoint.
|
|
*/
|
|
std::optional<std::string> EntriesAndTxidsDisjoint(const CTxMemPool::setEntries& ancestors,
|
|
const std::set<Txid>& direct_conflicts,
|
|
const uint256& txid);
|
|
|
|
/** Check that the feerate of the replacement transaction(s) is higher than the feerate of each
|
|
* of the transactions in iters_conflicting.
|
|
* @param[in] iters_conflicting The set of mempool entries.
|
|
* @returns error message if fees insufficient, otherwise std::nullopt.
|
|
*/
|
|
std::optional<std::string> PaysMoreThanConflicts(const CTxMemPool::setEntries& iters_conflicting,
|
|
CFeeRate replacement_feerate, const uint256& txid);
|
|
|
|
/** The replacement transaction must pay more fees than the original transactions. The additional
|
|
* fees must pay for the replacement's bandwidth at or above the incremental relay feerate.
|
|
* @param[in] original_fees Total modified fees of original transaction(s).
|
|
* @param[in] replacement_fees Total modified fees of replacement transaction(s).
|
|
* @param[in] replacement_vsize Total virtual size of replacement transaction(s).
|
|
* @param[in] relay_fee The node's minimum feerate for transaction relay.
|
|
* @param[in] txid Transaction ID, included in the error message if violation occurs.
|
|
* @returns error string if fees are insufficient, otherwise std::nullopt.
|
|
*/
|
|
std::optional<std::string> PaysForRBF(CAmount original_fees,
|
|
CAmount replacement_fees,
|
|
size_t replacement_vsize,
|
|
CFeeRate relay_fee,
|
|
const uint256& txid);
|
|
|
|
/**
|
|
* The replacement transaction must improve the feerate diagram of the mempool.
|
|
* @param[in] pool The mempool.
|
|
* @param[in] direct_conflicts Set of in-mempool txids corresponding to the direct conflicts i.e.
|
|
* input double-spends with the proposed transaction
|
|
* @param[in] all_conflicts Set of mempool entries corresponding to all transactions to be evicted
|
|
* @param[in] replacement_fees Fees of proposed replacement package
|
|
* @param[in] replacement_vsize Size of proposed replacement package
|
|
* @returns error type and string if mempool diagram doesn't improve, otherwise std::nullopt.
|
|
*/
|
|
std::optional<std::pair<DiagramCheckError, std::string>> ImprovesFeerateDiagram(CTxMemPool& pool,
|
|
const CTxMemPool::setEntries& direct_conflicts,
|
|
const CTxMemPool::setEntries& all_conflicts,
|
|
CAmount replacement_fees,
|
|
int64_t replacement_vsize)
|
|
EXCLUSIVE_LOCKS_REQUIRED(pool.cs);
|
|
|
|
#endif // BITCOIN_POLICY_RBF_H
|