10#include <chainparams.h>
47 "Submit a raw transaction (serialized, hex-encoded) to local node and network.\n"
48 "\nThe transaction will be sent unconditionally to all peers, so using sendrawtransaction\n"
49 "for manual rebroadcast may degrade privacy by leaking the transaction's origin, as\n"
50 "nodes will normally not rebroadcast non-wallet transactions already in their mempool.\n"
51 "\nA specific exception, RPC_TRANSACTION_ALREADY_IN_UTXO_SET, may throw if the transaction cannot be added to the mempool.\n"
52 "\nRelated RPCs: createrawtransaction, signrawtransactionwithkey\n",
56 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
57 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
59 "Reject transactions with provably unspendable outputs (e.g. 'datacarrier' outputs that use the OP_RETURN opcode) greater than the specified value, expressed in " +
CURRENCY_UNIT +
".\n"
60 "If burning funds through unspendable outputs is desired, increase this value.\n"
61 "This check is based on heuristics and does not guarantee spendability of outputs.\n"},
67 "\nCreate a transaction\n"
68 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
69 "Sign the transaction, and get back the hex\n"
71 "\nSend the transaction (signed hex)\n"
73 "\nAs a JSON-RPC call\n"
81 if (!
DecodeHexTx(mtx, request.params[0].get_str())) {
85 for (
const auto&
out : mtx.
vout) {
86 if((
out.scriptPubKey.IsUnspendable() || !
out.scriptPubKey.HasValidOps()) &&
out.nValue > max_burn_amount) {
96 CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
98 std::string err_string;
107 if (TransactionError::OK != err) {
111 return tx->GetHash().GetHex();
120 "Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.\n"
121 "\nIf multiple transactions are passed in, parents must come before children and package policies apply: the transactions cannot conflict with any mempool transactions or each other.\n"
122 "\nIf one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank).\n"
124 "\nThis checks if transactions violate the consensus or policy rules.\n"
125 "\nSee sendrawtransaction call.\n",
133 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
134 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
137 RPCResult::Type::ARR,
"",
"The result of the mempool acceptance test for each raw transaction in the input array.\n"
138 "Returns results for each transaction in the same order they were passed in.\n"
139 "Transactions that cannot be fully validated due to failures in other transactions will not contain an 'allowed' result.\n",
145 {
RPCResult::Type::STR,
"package-error",
true,
"Package validation error, if any (only possible if rawtxs had more than 1 transaction)."},
146 {
RPCResult::Type::BOOL,
"allowed",
true,
"Whether this tx would be accepted to the mempool and pass client-specified maxfeerate. "
147 "If not present, the tx was not fully validated due to a failure in another tx in the list."},
148 {
RPCResult::Type::NUM,
"vsize",
true,
"Virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted (only present when 'allowed' is true)"},
152 {
RPCResult::Type::STR_AMOUNT,
"effective-feerate",
false,
"the effective feerate in " +
CURRENCY_UNIT +
" per KvB. May differ from the base feerate if, for example, there are modified fees from prioritisetransaction or a package feerate was used."},
153 {
RPCResult::Type::ARR,
"effective-includes",
false,
"transactions whose fees and vsizes are included in effective-feerate.",
157 {
RPCResult::Type::STR,
"reject-reason",
true,
"Rejection reason (only present when 'allowed' is false)"},
158 {
RPCResult::Type::STR,
"reject-details",
true,
"Rejection details (only present when 'allowed' is false and rejection details exist)"},
163 "\nCreate a transaction\n"
164 +
HelpExampleCli(
"createrawtransaction",
"\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
165 "Sign the transaction, and get back the hex\n"
167 "\nTest acceptance of the transaction (signed hex)\n"
169 "\nAs a JSON-RPC call\n"
182 std::vector<CTransactionRef> txns;
183 txns.reserve(raw_transactions.
size());
184 for (
const auto& rawtx : raw_transactions.
getValues()) {
188 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
199 if (txns.size() > 1)
return ProcessNewPackage(chainstate, mempool, txns,
true, {});
209 bool exit_early{
false};
210 for (
const auto& tx : txns) {
212 result_inner.
pushKV(
"txid", tx->GetHash().GetHex());
213 result_inner.
pushKV(
"wtxid", tx->GetWitnessHash().GetHex());
217 auto it = package_result.
m_tx_results.find(tx->GetWitnessHash());
218 if (exit_early || it == package_result.
m_tx_results.end()) {
220 rpc_result.
push_back(std::move(result_inner));
223 const auto& tx_result = it->second;
227 const CAmount fee = tx_result.m_base_fees.value();
229 const int64_t virtual_size = tx_result.m_vsize.value();
230 const CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
231 if (max_raw_tx_fee &&
fee > max_raw_tx_fee) {
232 result_inner.
pushKV(
"allowed",
false);
233 result_inner.
pushKV(
"reject-reason",
"max-fee-exceeded");
238 result_inner.
pushKV(
"allowed",
true);
239 result_inner.
pushKV(
"vsize", virtual_size);
242 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
244 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
245 effective_includes_res.
push_back(wtxid.ToString());
247 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
248 result_inner.
pushKV(
"fees", std::move(fees));
251 result_inner.
pushKV(
"allowed",
false);
254 result_inner.
pushKV(
"reject-reason",
"missing-inputs");
260 rpc_result.
push_back(std::move(result_inner));
288 RPCResult{
RPCResult::Type::NUM,
"vsize",
"virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
296 RPCResult{
RPCResult::Type::NUM,
"chunkweight",
"sigops-adjusted weight (as defined in BIP 141 and modified by '-bytespersigop') of this transaction's chunk"},
310 RPCResult{
RPCResult::Type::BOOL,
"bip125-replaceable",
"Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n"},
311 RPCResult{
RPCResult::Type::BOOL,
"unbroadcast",
"Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
319 chunk.
pushKV(
"chunkweight", chunk_feerate.
size);
321 for (
const auto& chunk_tx : chunk_txs) {
322 chunk_txids.
push_back(chunk_tx->GetTx().GetHash().ToString());
324 chunk.
pushKV(
"txs", std::move(chunk_txids));
332 for (
const auto& tx : cluster) {
333 total_weight += tx->GetAdjustedWeight();
335 info.pushKV(
"clusterweight", total_weight);
336 info.pushKV(
"txcount", (
int)cluster.size());
341 FeePerWeight current_chunk_feerate = pool.GetMainChunkFeerate(*cluster[0]);
342 std::vector<const CTxMemPoolEntry *> current_chunk;
343 current_chunk.reserve(cluster.size());
346 for (
const auto& tx : cluster) {
347 if (current_chunk_feerate.
size == 0) {
350 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
351 current_chunk.clear();
352 current_chunk_feerate = pool.GetMainChunkFeerate(*tx);
354 current_chunk.push_back(tx);
355 current_chunk_feerate.
size -= tx->GetAdjustedWeight();
357 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
358 current_chunk.clear();
359 info.pushKV(
"chunks", std::move(all_chunks));
366 auto [ancestor_count, ancestor_size, ancestor_fees] = pool.CalculateAncestorData(e);
367 auto [descendant_count, descendant_size, descendant_fees] = pool.CalculateDescendantData(e);
369 info.pushKV(
"vsize", (
int)e.GetTxSize());
370 info.pushKV(
"weight", (
int)e.GetTxWeight());
372 info.pushKV(
"height", (
int)e.GetHeight());
373 info.pushKV(
"descendantcount", descendant_count);
374 info.pushKV(
"descendantsize", descendant_size);
375 info.pushKV(
"ancestorcount", ancestor_count);
376 info.pushKV(
"ancestorsize", ancestor_size);
377 info.pushKV(
"wtxid", e.GetTx().GetWitnessHash().ToString());
378 auto feerate = pool.GetMainChunkFeerate(e);
379 info.pushKV(
"chunkweight", feerate.size);
387 info.pushKV(
"fees", std::move(fees));
390 std::set<std::string> setDepends;
398 for (
const std::string& dep : setDepends)
403 info.pushKV(
"depends", std::move(depends));
407 spent.
push_back(child.GetTx().GetHash().ToString());
410 info.pushKV(
"spentby", std::move(spent));
413 bool rbfStatus =
false;
421 info.pushKV(
"bip125-replaceable", rbfStatus);
422 info.pushKV(
"unbroadcast", pool.IsUnbroadcastTx(tx.
GetHash()));
428 if (include_mempool_sequence) {
439 o.
pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
444 uint64_t mempool_sequence;
448 a.
push_back(e.GetTx().GetHash().ToString());
452 if (!include_mempool_sequence) {
456 o.
pushKV(
"txids", std::move(a));
457 o.
pushKV(
"mempool_sequence", mempool_sequence);
466 "Returns the feerate diagram for the whole mempool.",
495 for (
auto f : diagram) {
497 o.
pushKV(
"weight", f.size);
510 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
511 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
514 {
"mempool_sequence",
RPCArg::Type::BOOL,
RPCArg::Default{
false},
"If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
527 RPCResult{
"for verbose = false and mempool_sequence = true",
543 bool fVerbose =
false;
544 if (!request.params[0].isNull())
545 fVerbose = request.params[0].
get_bool();
547 bool include_mempool_sequence =
false;
548 if (!request.params[1].isNull()) {
549 include_mempool_sequence = request.params[1].get_bool();
560 "getmempoolancestors",
561 "If txid is in the mempool, returns all in-mempool ancestors.\n",
582 bool fVerbose =
false;
583 if (!request.params[1].isNull())
584 fVerbose = request.params[1].
get_bool();
591 const auto entry{mempool.
GetEntry(txid)};
592 if (entry ==
nullptr) {
601 o.
push_back(ancestorIt->GetTx().GetHash().ToString());
621 "getmempooldescendants",
622 "If txid is in the mempool, returns all in-mempool descendants.\n",
643 bool fVerbose =
false;
644 if (!request.params[1].isNull())
645 fVerbose = request.params[1].
get_bool();
652 const auto it{mempool.
GetIter(txid)};
660 setDescendants.erase(*it);
665 o.
push_back(descendantIt->GetTx().GetHash().ToString());
686 "Returns mempool data for given cluster\n",
704 const auto entry{mempool.
GetEntry(txid)};
705 if (entry ==
nullptr) {
722 "Returns mempool data for given transaction\n",
739 const auto entry{mempool.
GetEntry(txid)};
740 if (entry ==
nullptr) {
754 "Scans the mempool to find transactions spending any of the given outputs",
774 {
RPCResult::Type::STR_HEX,
"spendingtxid",
true,
"the transaction id of the mempool transaction spending this output (omitted if unspent)"},
779 HelpExampleCli(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
780 +
HelpExampleRpc(
"gettxspendingprevout",
"\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
785 if (output_params.
empty()) {
789 std::vector<COutPoint> prevouts;
790 prevouts.reserve(output_params.
size());
792 for (
unsigned int idx = 0; idx < output_params.
size(); idx++) {
807 prevouts.emplace_back(txid, nOutput);
815 for (
const COutPoint& prevout : prevouts) {
817 o.
pushKV(
"txid", prevout.hash.ToString());
818 o.
pushKV(
"vout", (uint64_t)prevout.n);
821 if (spendingTx !=
nullptr) {
825 result.push_back(std::move(o));
839 ret.pushKV(
"size", (int64_t)pool.
size());
848 ret.pushKV(
"fullrbf",
true);
859 "Returns details on the active state of the TX memory pool.",
864 {
RPCResult::Type::BOOL,
"loaded",
"True if the initial load attempt of the persisted mempool finished"},
866 {
RPCResult::Type::NUM,
"bytes",
"Sum of all virtual transaction sizes as defined in BIP 141. Differs from actual serialized size because witness data is discounted"},
873 {
RPCResult::Type::NUM,
"unbroadcastcount",
"Current number of transactions that haven't passed initial broadcast yet"},
874 {
RPCResult::Type::BOOL,
"fullrbf",
"True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)"},
875 {
RPCResult::Type::BOOL,
"permitbaremultisig",
"True if the mempool accepts transactions with bare multisig outputs"},
876 {
RPCResult::Type::NUM,
"maxdatacarriersize",
"Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
877 {
RPCResult::Type::NUM,
"limitclustercount",
"Maximum number of transactions that can be in a cluster (configured by -limitclustercount)"},
878 {
RPCResult::Type::NUM,
"limitclustersize",
"Maximum size of a cluster in virtual bytes (configured by -limitclustersize)"},
895 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
896 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
905 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
906 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
908 "Whether to apply the fee delta metadata from the mempool file.\n"
909 "It will be added to any existing fee deltas.\n"
910 "The fee delta can be set by the prioritisetransaction RPC.\n"
911 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
912 "Only set this bool if you understand what it does."},
914 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
915 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
932 const fs::path load_path{
fs::u8path(self.
Arg<std::string_view>(
"filepath"))};
933 const UniValue& use_current_time{request.params[1][
"use_current_time"]};
934 const UniValue& apply_fee_delta{request.params[1][
"apply_fee_delta_priority"]};
935 const UniValue& apply_unbroadcast{request.params[1][
"apply_unbroadcast_set"]};
937 .
use_current_time = use_current_time.isNull() ? true : use_current_time.get_bool(),
938 .apply_fee_delta_priority = apply_fee_delta.isNull() ? false : apply_fee_delta.get_bool(),
939 .apply_unbroadcast_set = apply_unbroadcast.isNull() ? false : apply_unbroadcast.get_bool(),
956 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
983 ret.pushKV(
"filename", dump_path.utf8string());
996 RPCResult{
RPCResult::Type::NUM,
"vsize",
"The virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
1008 o.
pushKV(
"txid", orphan.
tx->GetHash().ToString());
1009 o.
pushKV(
"wtxid", orphan.
tx->GetWitnessHash().ToString());
1010 o.
pushKV(
"bytes", orphan.
tx->GetTotalSize());
1014 for (
const auto fromPeer: orphan.
announcers) {
1025 "Shows transactions in the tx orphanage.\n"
1026 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
1028 {
"verbosity",
RPCArg::Type::NUM,
RPCArg::Default{0},
"0 for an array of txids (may contain duplicates), 1 for an array of objects with tx details, and 2 for details from (1) and tx hex",
1046 Cat<std::vector<RPCResult>>(
1067 if (verbosity == 0) {
1068 for (
auto const& orphan : orphanage) {
1069 ret.push_back(orphan.tx->GetHash().ToString());
1071 }
else if (verbosity == 1) {
1072 for (
auto const& orphan : orphanage) {
1075 }
else if (verbosity == 2) {
1076 for (
auto const& orphan : orphanage) {
1093 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
1094 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
1095 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
1096 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
1100 "The package must consist of a transaction with (some, all, or none of) its unconfirmed parents. A single transaction is permitted.\n"
1101 "None of the parents may depend on each other. Parents that are already in mempool do not need to be present in the package.\n"
1102 "The package must be topologically sorted, with the child being the last element in the array if there are multiple elements.",
1108 "Reject transactions whose fee rate is higher than the specified value, expressed in " +
CURRENCY_UNIT +
1109 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
1111 "Reject transactions with provably unspendable outputs (e.g. 'datacarrier' outputs that use the OP_RETURN opcode) greater than the specified value, expressed in " +
CURRENCY_UNIT +
".\n"
1112 "If burning funds through unspendable outputs is desired, increase this value.\n"
1113 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
1119 {
RPCResult::Type::STR,
"package_msg",
"The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
1120 {
RPCResult::Type::OBJ_DYN,
"tx-results",
"The transaction results keyed by wtxid. An entry is returned for every submitted wtxid.",
1124 {
RPCResult::Type::STR_HEX,
"other-wtxid",
true,
"The wtxid of a different transaction with the same txid but different witness found in the mempool. This means the submitted transaction was ignored."},
1128 {
RPCResult::Type::STR_AMOUNT,
"effective-feerate",
true,
"if the transaction was not already in the mempool, the effective feerate in " +
CURRENCY_UNIT +
" per KvB. For example, the package feerate and/or feerate with modified fees from prioritisetransaction."},
1129 {
RPCResult::Type::ARR,
"effective-includes",
true,
"if effective-feerate is provided, the wtxids of the transactions whose fees and vsizes are included in effective-feerate.",
1133 {
RPCResult::Type::STR,
"error",
true,
"Error string if rejected from mempool, or \"package-not-validated\" when the package aborts before any per-tx processing."},
1136 {
RPCResult::Type::ARR,
"replaced-transactions",
true,
"List of txids of replaced transactions",
1143 HelpExampleRpc(
"submitpackage", R
"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
1144 HelpExampleCli("submitpackage", R
"('["raw-tx-without-unconfirmed-parents"]')")
1156 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
1158 if (max_raw_tx_fee_rate ==
CFeeRate(0)) {
1159 client_maxfeerate = std::nullopt;
1165 std::vector<CTransactionRef> txns;
1166 txns.reserve(raw_transactions.
size());
1167 for (
const auto& rawtx : raw_transactions.
getValues()) {
1171 "TX decode failed: " + rawtx.get_str() +
" Make sure the tx has at least one input.");
1174 for (
const auto&
out : mtx.
vout) {
1175 if((
out.scriptPubKey.IsUnspendable() || !
out.scriptPubKey.HasValidOps()) &&
out.nValue > max_burn_amount) {
1184 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE,
"package topology disallowed. not child-with-parents or parents depend on each other.");
1192 std::string package_msg =
"success";
1195 switch(package_result.m_state.GetResult()) {
1199 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1200 for (
const auto& tx : txns) {
1209 package_result.m_state.GetRejectReason());
1215 package_msg = package_result.m_state.ToString();
1216 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1217 package_result.m_tx_results.empty());
1222 size_t num_broadcast{0};
1223 for (
const auto& tx : txns) {
1225 if (!mempool.
exists(tx->GetHash())) {
1230 std::string err_string;
1237 if (err != TransactionError::OK) {
1239 strprintf(
"transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1240 err_string, num_broadcast));
1246 rpc_result.pushKV(
"package_msg", package_msg);
1248 std::set<Txid> replaced_txids;
1249 for (
const auto& tx : txns) {
1251 result_inner.pushKV(
"txid", tx->GetHash().GetHex());
1252 const auto wtxid_hex = tx->GetWitnessHash().GetHex();
1253 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1254 if (it == package_result.m_tx_results.end()) {
1259 result_inner.pushKV(
"error",
"package-not-validated");
1260 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1263 const auto& tx_result = it->second;
1264 switch(it->second.m_result_type) {
1266 result_inner.pushKV(
"other-wtxid", it->second.m_other_wtxid.value().GetHex());
1269 result_inner.pushKV(
"error", it->second.m_state.ToString());
1273 result_inner.pushKV(
"vsize", int64_t{it->second.m_vsize.value()});
1280 fees.
pushKV(
"effective-feerate",
ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1282 for (
const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1283 effective_includes_res.
push_back(wtxid.ToString());
1285 fees.
pushKV(
"effective-includes", std::move(effective_includes_res));
1287 result_inner.pushKV(
"fees", std::move(fees));
1288 for (
const auto& ptx : it->second.m_replaced_transactions) {
1289 replaced_txids.insert(ptx->GetHash());
1293 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1295 rpc_result.pushKV(
"tx-results", std::move(tx_result_map));
1297 for (
const auto& txid : replaced_txids) replaced_list.
push_back(txid.ToString());
1298 rpc_result.pushKV(
"replaced-transactions", std::move(replaced_list));
1322 for (
const auto& c : commands) {
1323 t.appendCommand(c.name, &c);
int64_t CAmount
Amount in satoshis (Can be negative)
static CAmount AmountFromValue(const UniValue &value)
#define CHECK_NONFATAL(condition)
Identity function.
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 vbytes.
An outpoint - a combination of a transaction hash and an index n into its vout.
The basic transaction that is broadcasted on the network and contained in blocks.
const Txid & GetHash() const LIFETIMEBOUND
const std::vector< CTxIn > vin
An input of a transaction.
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
const CTransaction & GetTx() const
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
std::vector< const CTxMemPoolEntry * > GetCluster(Txid txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
std::optional< txiter > GetIter(const Txid &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Returns an iterator to the given hash, if found.
bool GetLoadTried() const
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
CFeeRate GetMinFee(size_t sizelimit) const
size_t DynamicMemoryUsage() const
std::vector< FeePerWeight > GetFeerateDiagram() const EXCLUSIVE_LOCKS_REQUIRED(cs)
bool exists(const Txid &txid) const
std::set< txiter, CompareIteratorByHash > setEntries
uint64_t GetSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
const CTransaction * GetConflictTx(const COutPoint &prevout) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Get the transaction in the pool that spends the same prevout.
std::set< Txid > GetUnbroadcastTxs() const
Returns transactions in unbroadcast set.
void CalculateDescendants(txiter it, setEntries &setDescendants) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Populate setDescendants with all in-mempool descendants of given transaction.
unsigned long size() const
setEntries CalculateMemPoolAncestors(const CTxMemPoolEntry &entry) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Calculate all in-mempool ancestors of entry (not including the tx itself)
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
CAmount GetTotalFee() const EXCLUSIVE_LOCKS_REQUIRED(cs)
uint64_t GetTotalTxSize() const EXCLUSIVE_LOCKS_REQUIRED(cs)
const CTxMemPoolEntry * GetEntry(const Txid &txid) const LIFETIMEBOUND EXCLUSIVE_LOCKS_REQUIRED(cs)
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(Chainstate ActiveChainstate)() const
Once the background validation chainstate has reached the height which is the base of the UTXO snapsh...
MempoolAcceptResult ProcessTransaction(const CTransactionRef &tx, bool test_accept=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the memory pool.
bool IsInitialBlockDownload() const
Check whether we are doing an initial block download (synchronizing from disk or network)
virtual std::vector< node::TxOrphanage::OrphanInfo > GetOrphanTransactions()=0
auto Arg(std::string_view key) const
Helper to get a required or default-valued request argument.
void push_back(UniValue val)
const UniValue & find_value(std::string_view key) const
const UniValue & get_obj() const
const std::vector< UniValue > & getValues() const
void pushKVEnd(std::string key, UniValue val)
const UniValue & get_array() const
void pushKV(std::string key, UniValue val)
std::string GetRejectReason() const
std::string ToString() const
std::string ToString() const
static transaction_identifier FromUint256(const uint256 &id)
static int32_t GetTransactionWeight(const CTransaction &tx)
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
std::string EncodeHexTx(const CTransaction &tx)
UniValue ValueFromAmount(const CAmount amount)
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness=false, bool try_witness=true)
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
const std::string CURRENCY_UNIT
static path u8path(std::string_view utf8_str)
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
static const CAmount DEFAULT_MAX_BURN_AMOUNT
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls.
@ MEMPOOL_AND_BROADCAST_TO_ALL
Add the transaction to the mempool and broadcast to all peers for which tx relay is enabled.
fs::path MempoolPath(const ArgsManager &argsman)
static const CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE
Maximum fee rate for sendrawtransaction and testmempoolaccept RPC calls.
TransactionError BroadcastTransaction(NodeContext &node, const CTransactionRef tx, std::string &err_string, const CAmount &max_tx_fee, TxBroadcast broadcast_method, bool wait_callback)
Submit a transaction to the mempool and (optionally) relay it to all P2P peers.
bool LoadMempool(CTxMemPool &pool, const fs::path &load_path, Chainstate &active_chainstate, ImportMempoolOptions &&opts)
Import the file and attempt to add its contents to the mempool.
bool DumpMempool(const CTxMemPool &pool, const fs::path &dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
std::string ToString(const T &t)
Locale-independent version of std::to_string.
is a home for public enum and struct type definitions that are used internally by node code,...
bool IsChildWithParentsTree(const Package &package)
Context-free check that a package IsChildWithParents() and none of the parents depend on each other (...
static constexpr uint32_t MAX_PACKAGE_COUNT
Default maximum number of transactions in a package.
@ PCKG_POLICY
The package itself is invalid (e.g. too many transactions).
@ PCKG_RESULT_UNSET
Initial value. The package has not yet been rejected.
@ PCKG_MEMPOOL_ERROR
Mempool logic error.
@ PCKG_TX
At least one tx is invalid.
RBFTransactionState IsRBFOptIn(const CTransaction &tx, const CTxMemPool &pool)
Determine whether an unconfirmed transaction is signaling opt-in to RBF according to BIP 125 This inv...
RBFTransactionState
The rbf state of unconfirmed transactions.
@ UNKNOWN
Unconfirmed tx that does not signal rbf and is not in the mempool.
@ REPLACEABLE_BIP125
Either this tx or a mempool ancestor signals rbf.
int64_t GetVirtualTransactionSize(int64_t nWeight, int64_t nSigOpCost, unsigned int bytes_per_sigop)
Compute the virtual transaction size (weight reinterpreted as bytes).
static CTransactionRef MakeTransactionRef(Tx &&txIn)
std::shared_ptr< const CTransaction > CTransactionRef
UniValue JSONRPCError(int code, const std::string &message)
static UniValue OrphanToJSON(const node::TxOrphanage::OrphanInfo &orphan)
static std::vector< RPCResult > ClusterDescription()
static RPCHelpMan getmempoolinfo()
static RPCHelpMan sendrawtransaction()
static std::vector< RPCResult > OrphanDescription()
static void entryToJSON(const CTxMemPool &pool, UniValue &info, const CTxMemPoolEntry &e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
static RPCHelpMan importmempool()
void RegisterMempoolRPCCommands(CRPCTable &t)
static RPCHelpMan getrawmempool()
static RPCHelpMan getmempoolentry()
static void clusterToJSON(const CTxMemPool &pool, UniValue &info, std::vector< const CTxMemPoolEntry * > cluster) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
UniValue MempoolInfoToJSON(const CTxMemPool &pool)
Mempool information to JSON.
static RPCHelpMan getmempoolcluster()
static RPCHelpMan getmempoolfeeratediagram()
static RPCHelpMan gettxspendingprevout()
static std::vector< RPCResult > MempoolEntryDescription()
static RPCHelpMan submitpackage()
static RPCHelpMan getorphantxs()
void AppendChunkInfo(UniValue &all_chunks, FeePerWeight chunk_feerate, std::vector< const CTxMemPoolEntry * > chunk_txs)
UniValue MempoolToJSON(const CTxMemPool &pool, bool verbose, bool include_mempool_sequence)
Mempool to JSON.
static RPCHelpMan testmempoolaccept()
static RPCHelpMan getmempooldescendants()
static RPCHelpMan getmempoolancestors()
static RPCHelpMan savemempool()
@ RPC_MISC_ERROR
General application defined errors.
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
@ RPC_CLIENT_IN_INITIAL_DOWNLOAD
Still downloading initial blocks.
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
UniValue JSONRPCTransactionError(TransactionError terr, const std::string &err_string)
CFeeRate ParseFeeRate(const UniValue &json)
Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB).
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
uint256 ParseHashO(const UniValue &o, std::string_view strKey)
void RPCTypeCheckObj(const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull, bool fStrict)
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
NodeContext & EnsureAnyNodeContext(const std::any &context)
CTxMemPool & EnsureMemPool(const NodeContext &node)
PeerManager & EnsurePeerman(const NodeContext &node)
ChainstateManager & EnsureChainman(const NodeContext &node)
CTxMemPool & EnsureAnyMemPool(const std::any &context)
ArgsManager & EnsureAnyArgsman(const std::any &context)
A mutable version of CTransaction.
std::vector< CTxOut > vout
Tagged wrapper around FeeFrac to avoid unit confusion.
@ DIFFERENT_WITNESS
Valid, transaction was already in the mempool.
@ INVALID
Fully validated, valid.
Validation result for package mempool acceptance.
PackageValidationState m_state
std::map< Wtxid, MempoolAcceptResult > m_tx_results
Map from wtxid to finished MempoolAcceptResults.
@ STR_HEX
Special type that is a STR with only hex chars.
@ AMOUNT
Special type representing a floating point amount (can be either NUM or STR)
@ OBJ_NAMED_PARAMS
Special type that behaves almost exactly like OBJ, defining an options object with a list of pre-defi...
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
@ NUM_TIME
Special numeric to denote unix epoch time.
@ OBJ_DYN
Special dictionary with keys that are not literals.
@ STR_HEX
Special string with only hex chars.
@ STR_AMOUNT
Special string to represent a floating point amount.
Wrapper for UniValue::VType, which includes typeAny: Used to denote don't care type.
unsigned cluster_count
The maximum number of transactions in a cluster.
int64_t cluster_size_vbytes
The maximum allowed size in virtual bytes of a cluster.
std::optional< unsigned > max_datacarrier_bytes
A data carrying output is an unspendable output containing data.
CFeeRate incremental_relay_feerate
bool permit_bare_multisig
CFeeRate min_relay_feerate
A fee rate smaller than this is considered zero fee (for relaying, mining and transaction creation)
NodeContext struct containing references to chain state and connection state.
Allows providing orphan information externally.
std::set< NodeId > announcers
Peers added with AddTx or AddAnnouncer.
#define AssertLockNotHeld(cs)
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
#define EXCLUSIVE_LOCKS_REQUIRED(...)
constexpr int64_t count_seconds(std::chrono::seconds t)
PackageMempoolAcceptResult ProcessNewPackage(Chainstate &active_chainstate, CTxMemPool &pool, const Package &package, bool test_accept, const std::optional< CFeeRate > &client_maxfeerate)
Validate (and maybe submit) a package to the mempool.