Bitcoin Core 32.99.0
P2P Digital Currency
mempool.cpp
Go to the documentation of this file.
1// Copyright (c) 2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <rpc/mempool.h>
7#include <rpc/register.h> // IWYU pragma: associated
8
9#include <common/args.h>
10#include <consensus/amount.h>
12#include <core_io.h>
14#include <net.h>
15#include <net_processing.h>
16#include <netaddress.h>
17#include <netbase.h>
20#include <node/transaction.h>
21#include <node/txorphanage.h>
22#include <node/types.h>
23#include <policy/feerate.h>
24#include <policy/packages.h>
25#include <policy/policy.h>
26#include <policy/rbf.h>
28#include <rpc/protocol.h>
29#include <rpc/request.h>
30#include <rpc/server.h>
31#include <rpc/server_util.h>
32#include <rpc/util.h>
33#include <script/script.h>
34#include <sync.h>
35#include <tinyformat.h>
36#include <txgraph.h>
37#include <txmempool.h>
38#include <uint256.h>
39#include <univalue.h>
40#include <util/check.h>
41#include <util/expected.h>
42#include <util/feefrac.h>
43#include <util/fs.h>
44#include <util/moneystr.h>
45#include <util/string.h>
46#include <util/time.h>
47#include <util/vector.h>
48#include <validation.h>
49
50#include <algorithm>
51#include <cstddef>
52#include <cstdint>
53#include <functional>
54#include <list>
55#include <map>
56#include <memory>
57#include <optional>
58#include <ranges>
59#include <set>
60#include <string>
61#include <string_view>
62#include <tuple>
63#include <utility>
64#include <vector>
65
66namespace node {
67struct NodeContext;
68} // namespace node
69
71
77using util::ToString;
78
80{
81 return RPCMethod{
82 "sendrawtransaction",
83 "Submit a raw transaction (serialized, hex-encoded) to the network.\n"
84
85 "\nIf -privatebroadcast is disabled, then the transaction will be put into the\n"
86 "local mempool of the node and will be sent unconditionally to all currently\n"
87 "connected peers, so using sendrawtransaction for manual rebroadcast will degrade\n"
88 "privacy by leaking the transaction's origin, as nodes will normally not\n"
89 "rebroadcast non-wallet transactions already in their mempool.\n"
90
91 "\nIf -privatebroadcast is enabled, then the transaction will be sent only via\n"
92 "dedicated, short-lived connections to Tor or I2P peers or IPv4/IPv6 peers\n"
93 "via the Tor network. This conceals the transaction's origin. The transaction\n"
94 "will only enter the local mempool when it is received back from the network.\n"
95 "The private broadcast queue is bounded: when it is full, this RPC fails and\n"
96 "the transaction is not scheduled, until an existing one completes or is\n"
97 "aborted. Use getprivatebroadcastinfo to inspect the queue and abortprivatebroadcast to abort.\n"
98
99 "\nA specific exception, RPC_TRANSACTION_ALREADY_IN_UTXO_SET, may throw if the transaction cannot be added to the mempool.\n"
100
101 "\nRelated RPCs: createrawtransaction, signrawtransactionwithkey\n",
102 {
103 {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex string of the raw transaction"},
105 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
106 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
108 "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"
109 "If burning funds through unspendable outputs is desired, increase this value.\n"
110 "This check is based on heuristics and does not guarantee spendability of outputs.\n"},
111 },
112 RPCResult{
113 RPCResult::Type::STR_HEX, "", "The transaction hash in hex"
114 },
116 "\nCreate a transaction\n"
117 + HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
118 "Sign the transaction, and get back the hex\n"
119 + HelpExampleCli("signrawtransactionwithwallet", "\"myhex\"") +
120 "\nSend the transaction (signed hex)\n"
121 + HelpExampleCli("sendrawtransaction", "\"signedhex\"") +
122 "\nAs a JSON-RPC call\n"
123 + HelpExampleRpc("sendrawtransaction", "\"signedhex\"")
124 },
125 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
126 {
127 const CAmount max_burn_amount = request.params[2].isNull() ? 0 : AmountFromValue(request.params[2]);
128
130 if (!DecodeHexTx(mtx, request.params[0].get_str())) {
131 throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed. Make sure the tx has at least one input.");
132 }
133
134 for (const auto& out : mtx.vout) {
135 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
136 throw JSONRPCTransactionError(TransactionError::MAX_BURN_EXCEEDED);
137 }
138 }
139
140 CTransactionRef tx(MakeTransactionRef(std::move(mtx)));
141
142 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
143
144 int64_t virtual_size = GetVirtualTransactionSize(*tx);
145 CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
146
147 std::string err_string;
149 NodeContext& node = EnsureAnyNodeContext(request.context);
150 const bool private_broadcast_enabled{gArgs.GetBoolArg("-privatebroadcast", DEFAULT_PRIVATE_BROADCAST)};
151 if (private_broadcast_enabled &&
155 "-privatebroadcast is enabled, but none of the Tor or I2P networks is "
156 "reachable. Maybe the location of the Tor proxy couldn't be retrieved "
157 "from the Tor daemon at startup. Check whether the Tor daemon is running "
158 "and that -torcontrol, -torpassword and -i2psam are configured properly.");
159 }
160 const auto method = private_broadcast_enabled ? node::TxBroadcast::NO_MEMPOOL_PRIVATE_BROADCAST
163 tx,
164 err_string,
165 max_raw_tx_fee,
166 method,
167 /*wait_callback=*/true);
168 if (TransactionError::OK != err) {
169 throw JSONRPCTransactionError(err, err_string);
170 }
171
172 return tx->GetHash().GetHex();
173 },
174 };
175}
176
178{
179 return RPCMethod{
180 "getprivatebroadcastinfo",
181 "Returns information about transactions tracked for private broadcast.\n"
182 "Transactions that have reached the send-attempt limit remain in the result with attempts_remaining=0.\n"
183 "This method is only available when running with -privatebroadcast enabled.\n",
184 {},
185 RPCResult{
186 RPCResult::Type::OBJ, "", "",
187 {
188 {RPCResult::Type::ARR, "transactions", "",
189 {
190 {RPCResult::Type::OBJ, "", "",
191 {
192 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
193 {RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
194 {RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded transaction data"},
195 {RPCResult::Type::NUM_TIME, "time_added", "The time this transaction was added to the private broadcast queue (seconds since epoch)"},
196 {RPCResult::Type::NUM, "attempts_remaining", "The number of additional private broadcast send attempts allowed for this transaction"},
197 {RPCResult::Type::ARR, "peers", "Per-peer send and acknowledgment information for this transaction",
198 {
199 {RPCResult::Type::OBJ, "", "",
200 {
201 {RPCResult::Type::STR, "address", "The address of the peer to which the transaction was sent"},
202 {RPCResult::Type::NUM_TIME, "sent", "The time this transaction was picked for sending to this peer via private broadcast (seconds since epoch)"},
203 {RPCResult::Type::NUM_TIME, "received", /*optional=*/true, "The time this peer acknowledged reception of the transaction (seconds since epoch)"},
204 }},
205 }},
206 }},
207 }},
208 }},
210 HelpExampleCli("getprivatebroadcastinfo", "")
211 + HelpExampleRpc("getprivatebroadcastinfo", "")
212 },
213 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
214 {
215 const NodeContext& node{EnsureAnyNodeContext(request.context)};
216 const PeerManager& peerman{EnsurePeerman(node)};
217 if (!peerman.GetInfo().private_broadcast) {
218 throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Private broadcast is not enabled. Ensure you're running Bitcoin Core with -privatebroadcast=1.");
219 }
220
221 const auto txs{peerman.GetPrivateBroadcastInfo()};
222
223 UniValue transactions(UniValue::VARR);
224 for (const auto& tx_info : txs) {
226 o.pushKV("txid", tx_info.tx->GetHash().ToString());
227 o.pushKV("wtxid", tx_info.tx->GetWitnessHash().ToString());
228 o.pushKV("hex", EncodeHexTx(*tx_info.tx));
229 o.pushKV("time_added", TicksSinceEpoch<std::chrono::seconds>(tx_info.time_added));
230 o.pushKV("attempts_remaining", tx_info.attempts_remaining);
232 for (const auto& peer : tx_info.peers) {
234 p.pushKV("address", peer.address.ToStringAddrPort());
235 p.pushKV("sent", TicksSinceEpoch<std::chrono::seconds>(peer.sent));
236 if (peer.received.has_value()) {
237 p.pushKV("received", TicksSinceEpoch<std::chrono::seconds>(*peer.received));
238 }
239 peers.push_back(std::move(p));
240 }
241 o.pushKV("peers", std::move(peers));
242 transactions.push_back(std::move(o));
243 }
244
246 ret.pushKV("transactions", std::move(transactions));
247 return ret;
248 },
249 };
250}
251
253{
254 return RPCMethod{
255 "abortprivatebroadcast",
256 "Abort private broadcast attempts for a transaction currently being privately broadcast.\n"
257 "The transaction will be removed from the private broadcast queue.\n"
258 "This method is only available when running with -privatebroadcast enabled.\n",
259 {
260 {"id", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A transaction identifier to abort. It will be matched against both txid and wtxid for all transactions in the private broadcast queue.\n"
261 "If the provided id matches a txid that corresponds to multiple transactions with different wtxids, multiple transactions will be removed and returned."},
262 },
263 RPCResult{
264 RPCResult::Type::OBJ, "", "",
265 {
266 {RPCResult::Type::ARR, "removed_transactions", "Transactions removed from the private broadcast queue",
267 {
268 {RPCResult::Type::OBJ, "", "",
269 {
270 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
271 {RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
272 {RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded transaction data"},
273 }},
274 }},
275 }
276 },
278 HelpExampleCli("abortprivatebroadcast", "\"id\"")
279 + HelpExampleRpc("abortprivatebroadcast", "\"id\"")
280 },
281 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
282 {
283
284 const NodeContext& node{EnsureAnyNodeContext(request.context)};
285 PeerManager& peerman{EnsurePeerman(node)};
286 if (!peerman.GetInfo().private_broadcast) {
287 throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Private broadcast is not enabled. Ensure you're running Bitcoin Core with -privatebroadcast=1.");
288 }
289
290 const uint256 id{ParseHashV(self.Arg<UniValue>("id"), "id")};
291
292 const auto removed_txs{peerman.AbortPrivateBroadcast(id)};
293 if (removed_txs.empty()) {
294 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in private broadcast queue. Check getprivatebroadcastinfo.");
295 }
296
297 UniValue removed_transactions(UniValue::VARR);
298 for (const auto& tx : removed_txs) {
300 o.pushKV("txid", tx->GetHash().ToString());
301 o.pushKV("wtxid", tx->GetWitnessHash().ToString());
302 o.pushKV("hex", EncodeHexTx(*tx));
303 removed_transactions.push_back(std::move(o));
304 }
306 ret.pushKV("removed_transactions", std::move(removed_transactions));
307 return ret;
308 },
309 };
310}
311
313{
314 return RPCMethod{
315 "testmempoolaccept",
316 "Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.\n"
317 "\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"
318 "\nIf one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank).\n"
319 "\nThe maximum number of transactions allowed is " + ToString(MAX_PACKAGE_COUNT) + ".\n"
320 "\nThis checks if transactions violate the consensus or policy rules.\n"
321 "\nSee sendrawtransaction call.\n",
322 {
323 {"rawtxs", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of hex strings of raw transactions.",
324 {
326 },
327 },
329 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
330 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
331 },
332 RPCResult{
333 RPCResult::Type::ARR, "", "The result of the mempool acceptance test for each raw transaction in the input array.\n"
334 "Returns results for each transaction in the same order they were passed in.\n"
335 "Transactions that cannot be fully validated due to failures in other transactions will not contain an 'allowed' result.\n",
336 {
337 {RPCResult::Type::OBJ, "", "",
338 {
339 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
340 {RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
341 {RPCResult::Type::STR, "package-error", /*optional=*/true, "Package validation error, if any (only possible if rawtxs had more than 1 transaction)."},
342 {RPCResult::Type::BOOL, "allowed", /*optional=*/true, "Whether this tx would be accepted to the mempool and pass client-specified maxfeerate. "
343 "If not present, the tx was not fully validated due to a failure in another tx in the list."},
344 {RPCResult::Type::NUM, "vsize_adjusted", /*optional=*/true, "Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141 (only present when 'allowed' is true)."},
345 {RPCResult::Type::NUM, "vsize", /*optional=*/true, "(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
346 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
347 {RPCResult::Type::NUM, "vsize_bip141", /*optional=*/true, "Virtual transaction size as defined in BIP 141.\n"
348 "This is different from actual serialized size for witness transactions as witness data is discounted (only present when 'allowed' is true)."},
349 {RPCResult::Type::OBJ, "fees", /*optional=*/true, "Transaction fees (only present if 'allowed' is true)",
350 {
351 {RPCResult::Type::STR_AMOUNT, "base", "transaction fee in " + CURRENCY_UNIT},
352 {RPCResult::Type::STR_AMOUNT, "effective-feerate", /*optional=*/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."},
353 {RPCResult::Type::ARR, "effective-includes", /*optional=*/false, "transactions whose fees and vsizes are included in effective-feerate.",
354 {RPCResult{RPCResult::Type::STR_HEX, "", "transaction wtxid in hex"},
355 }},
356 }},
357 {RPCResult::Type::STR, "reject-reason", /*optional=*/true, "Rejection reason (only present when 'allowed' is false)"},
358 {RPCResult::Type::STR, "reject-details", /*optional=*/true, "Rejection details (only present when 'allowed' is false and rejection details exist)"},
359 }},
360 }
361 },
363 "\nCreate a transaction\n"
364 + HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
365 "Sign the transaction, and get back the hex\n"
366 + HelpExampleCli("signrawtransactionwithwallet", "\"myhex\"") +
367 "\nTest acceptance of the transaction (signed hex)\n"
368 + HelpExampleCli("testmempoolaccept", R"('["signedhex"]')") +
369 "\nAs a JSON-RPC call\n"
370 + HelpExampleRpc("testmempoolaccept", "[\"signedhex\"]")
371 },
372 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
373 {
374 const UniValue raw_transactions = request.params[0].get_array();
375 if (raw_transactions.size() < 1 || raw_transactions.size() > MAX_PACKAGE_COUNT) {
377 "Array must contain between 1 and " + ToString(MAX_PACKAGE_COUNT) + " transactions.");
378 }
379
380 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
381
382 std::vector<CTransactionRef> txns;
383 txns.reserve(raw_transactions.size());
384 for (const auto& rawtx : raw_transactions.getValues()) {
386 if (!DecodeHexTx(mtx, rawtx.get_str())) {
388 "TX decode failed: " + rawtx.get_str() + " Make sure the tx has at least one input.");
389 }
390 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
391 }
392
393 NodeContext& node = EnsureAnyNodeContext(request.context);
394 CTxMemPool& mempool = EnsureMemPool(node);
396 Chainstate& chainstate = chainman.ActiveChainstate();
397 const PackageMempoolAcceptResult package_result = [&] {
399 if (txns.size() > 1) return ProcessNewPackage(chainstate, mempool, txns, /*test_accept=*/true, /*client_maxfeerate=*/{});
400 return PackageMempoolAcceptResult(txns[0]->GetWitnessHash(),
401 chainman.ProcessTransaction(txns[0], /*test_accept=*/true));
402 }();
403
404 UniValue rpc_result(UniValue::VARR);
405 // We will check transaction fees while we iterate through txns in order. If any transaction fee
406 // exceeds maxfeerate, we will leave the rest of the validation results blank, because it
407 // doesn't make sense to return a validation result for a transaction if its ancestor(s) would
408 // not be submitted.
409 bool exit_early{false};
410 for (const auto& tx : txns) {
411 UniValue result_inner(UniValue::VOBJ);
412 result_inner.pushKV("txid", tx->GetHash().GetHex());
413 result_inner.pushKV("wtxid", tx->GetWitnessHash().GetHex());
415 result_inner.pushKV("package-error", package_result.m_state.ToString());
416 }
417 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
418 if (exit_early || it == package_result.m_tx_results.end()) {
419 // Validation unfinished. Just return the txid and wtxid.
420 rpc_result.push_back(std::move(result_inner));
421 continue;
422 }
423 const auto& tx_result = it->second;
424 // Package testmempoolaccept doesn't allow transactions to already be in the mempool.
426 if (tx_result.m_result_type == MempoolAcceptResult::ResultType::VALID) {
427 const CAmount fee = tx_result.m_base_fees.value();
428 // Check that fee does not exceed maximum fee
429 const int64_t virtual_size = tx_result.m_vsize.value();
430 const CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
431 if (max_raw_tx_fee && fee > max_raw_tx_fee) {
432 result_inner.pushKV("allowed", false);
433 result_inner.pushKV("reject-reason", "max-fee-exceeded");
434 exit_early = true;
435 } else {
436 // Only return the fee and vsize if the transaction would pass ATMP.
437 // These can be used to calculate the feerate.
438 result_inner.pushKV("allowed", true);
439 result_inner.pushKV("vsize_adjusted", virtual_size);
440 result_inner.pushKV("vsize", virtual_size);
441 result_inner.pushKV("vsize_bip141", GetVirtualTransactionSize(*tx));
443 fees.pushKV("base", ValueFromAmount(fee));
444 fees.pushKV("effective-feerate", ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
445 UniValue effective_includes_res(UniValue::VARR);
446 for (const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
447 effective_includes_res.push_back(wtxid.ToString());
448 }
449 fees.pushKV("effective-includes", std::move(effective_includes_res));
450 result_inner.pushKV("fees", std::move(fees));
451 }
452 } else {
453 result_inner.pushKV("allowed", false);
454 const TxValidationState state = tx_result.m_state;
456 result_inner.pushKV("reject-reason", "missing-inputs");
457 } else {
458 result_inner.pushKV("reject-reason", state.GetRejectReason());
459 result_inner.pushKV("reject-details", state.ToString());
460 }
461 }
462 rpc_result.push_back(std::move(result_inner));
463 }
464 return rpc_result;
465 },
466 };
467}
468
469static std::vector<RPCResult> ClusterDescription()
470{
471 return {
472 RPCResult{RPCResult::Type::NUM, "clusterweight", "total sigops-adjusted weight (as defined in BIP 141 and modified by '-bytespersigop')"},
473 RPCResult{RPCResult::Type::NUM, "txcount", "number of transactions"},
474 RPCResult{RPCResult::Type::ARR, "chunks", "chunks in this cluster (in mining order)",
475 {RPCResult{RPCResult::Type::OBJ, "chunk", "",
476 {
477 RPCResult{RPCResult::Type::STR_AMOUNT, "chunkfee", "fees of the transactions in this chunk"},
478 RPCResult{RPCResult::Type::NUM, "chunkweight", "sigops-adjusted weight of all transactions in this chunk"},
479 RPCResult{RPCResult::Type::ARR, "txs", "transactions in this chunk in mining order",
480 {RPCResult{RPCResult::Type::STR_HEX, "txid", "transaction id"}}},
481 }
482 }}
483 }
484 };
485}
486
487static std::vector<RPCResult> MempoolEntryDescription()
488{
489 std::vector<RPCResult> list = {
490 {RPCResult::Type::NUM, "vsize", "(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
491 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
492 {RPCResult::Type::NUM, "vsize_bip141", "Virtual transaction size as defined in BIP 141.\n"
493 "This is different from actual serialized size for witness transactions as witness data is discounted."},
494 {RPCResult::Type::NUM, "vsize_adjusted", "Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141."},
495 RPCResult{RPCResult::Type::NUM, "weight", "transaction weight as defined in BIP 141."},
496 RPCResult{RPCResult::Type::NUM_TIME, "time", "local time transaction entered pool in seconds since 1 Jan 1970 GMT"},
497 RPCResult{RPCResult::Type::NUM, "height", "block height when transaction entered pool"},
498 RPCResult{RPCResult::Type::NUM, "descendantcount", "number of in-mempool descendant transactions (including this one)"},
499 RPCResult{RPCResult::Type::NUM, "descendantsize", "virtual transaction size of in-mempool descendants (including this one)"},
500 RPCResult{RPCResult::Type::NUM, "ancestorcount", "number of in-mempool ancestor transactions (including this one)"},
501 RPCResult{RPCResult::Type::NUM, "ancestorsize", "virtual transaction size of in-mempool ancestors (including this one)"},
502 RPCResult{RPCResult::Type::NUM, "chunkweight", "sigops-adjusted weight (as defined in BIP 141 and modified by '-bytespersigop') of this transaction's chunk"},
503 RPCResult{RPCResult::Type::STR_HEX, "wtxid", "hash of serialized transaction, including witness data"},
505 {
506 RPCResult{RPCResult::Type::STR_AMOUNT, "base", "transaction fee, denominated in " + CURRENCY_UNIT},
507 RPCResult{RPCResult::Type::STR_AMOUNT, "modified", "transaction fee with fee deltas used for mining priority, denominated in " + CURRENCY_UNIT},
508 RPCResult{RPCResult::Type::STR_AMOUNT, "ancestor", "transaction fees of in-mempool ancestors (including this one) with fee deltas used for mining priority, denominated in " + CURRENCY_UNIT},
509 RPCResult{RPCResult::Type::STR_AMOUNT, "descendant", "transaction fees of in-mempool descendants (including this one) with fee deltas used for mining priority, denominated in " + CURRENCY_UNIT},
510 RPCResult{RPCResult::Type::STR_AMOUNT, "chunk", "transaction fees of chunk, denominated in " + CURRENCY_UNIT},
511 }},
512 RPCResult{RPCResult::Type::ARR, "depends", "unconfirmed transactions used as inputs for this transaction",
513 {RPCResult{RPCResult::Type::STR_HEX, "transactionid", "parent transaction id"}}},
514 RPCResult{RPCResult::Type::ARR, "spentby", "unconfirmed transactions spending outputs from this transaction",
515 {RPCResult{RPCResult::Type::STR_HEX, "transactionid", "child transaction id"}}},
516 RPCResult{RPCResult::Type::BOOL, "unbroadcast", "Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
517 };
518 if (IsDeprecatedRPCEnabled("bip125")) {
519 list.emplace_back(RPCResult::Type::BOOL, "bip125-replaceable", "Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n");
520 }
521 return list;
522}
523
524void AppendChunkInfo(UniValue& all_chunks, FeePerWeight chunk_feerate, std::vector<const CTxMemPoolEntry *> chunk_txs)
525{
527 chunk.pushKV("chunkfee", ValueFromAmount(chunk_feerate.fee));
528 chunk.pushKV("chunkweight", chunk_feerate.size);
529 UniValue chunk_txids(UniValue::VARR);
530 for (const auto& chunk_tx : chunk_txs) {
531 chunk_txids.push_back(chunk_tx->GetTx().GetHash().ToString());
532 }
533 chunk.pushKV("txs", std::move(chunk_txids));
534 all_chunks.push_back(std::move(chunk));
535}
536
537static void clusterToJSON(const CTxMemPool& pool, UniValue& info, std::vector<const CTxMemPoolEntry *> cluster) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
538{
539 AssertLockHeld(pool.cs);
540 int total_weight{0};
541 for (const auto& tx : cluster) {
542 total_weight += tx->GetAdjustedWeight();
543 }
544 info.pushKV("clusterweight", total_weight);
545 info.pushKV("txcount", cluster.size());
546
547 // Output the cluster by chunk. This isn't handed to us by the mempool, but
548 // we can calculate it by looking at the chunk feerates of each transaction
549 // in the cluster.
550 FeePerWeight current_chunk_feerate = pool.GetMainChunkFeerate(*cluster[0]);
551 std::vector<const CTxMemPoolEntry *> current_chunk;
552 current_chunk.reserve(cluster.size());
553
554 UniValue all_chunks(UniValue::VARR);
555 for (const auto& tx : cluster) {
556 if (current_chunk_feerate.size == 0) {
557 // We've iterated all the transactions in the previous chunk; so
558 // append it to the output.
559 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
560 current_chunk.clear();
561 current_chunk_feerate = pool.GetMainChunkFeerate(*tx);
562 }
563 current_chunk.push_back(tx);
564 current_chunk_feerate.size -= tx->GetAdjustedWeight();
565 }
566 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
567 current_chunk.clear();
568 info.pushKV("chunks", std::move(all_chunks));
569}
570
571static void entryToJSON(const CTxMemPool& pool, UniValue& info, const CTxMemPoolEntry& e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
572{
573 AssertLockHeld(pool.cs);
574
575 auto [ancestor_count, ancestor_size, ancestor_fees] = pool.CalculateAncestorData(e);
576 auto [descendant_count, descendant_size, descendant_fees] = pool.CalculateDescendantData(e);
577
578 info.pushKV("vsize_adjusted", e.GetTxSize());
579 info.pushKV("vsize", e.GetTxSize());
580 info.pushKV("vsize_bip141", GetVirtualTransactionSize(e.GetTx()));
581 info.pushKV("weight", e.GetTxWeight());
582 info.pushKV("time", count_seconds(e.GetTime()));
583 info.pushKV("height", e.GetHeight());
584 info.pushKV("descendantcount", descendant_count);
585 info.pushKV("descendantsize", descendant_size);
586 info.pushKV("ancestorcount", ancestor_count);
587 info.pushKV("ancestorsize", ancestor_size);
588 info.pushKV("wtxid", e.GetTx().GetWitnessHash().ToString());
589 auto feerate = pool.GetMainChunkFeerate(e);
590 info.pushKV("chunkweight", feerate.size);
591
593 fees.pushKV("base", ValueFromAmount(e.GetFee()));
594 fees.pushKV("modified", ValueFromAmount(e.GetModifiedFee()));
595 fees.pushKV("ancestor", ValueFromAmount(ancestor_fees));
596 fees.pushKV("descendant", ValueFromAmount(descendant_fees));
597 fees.pushKV("chunk", ValueFromAmount(feerate.fee));
598 info.pushKV("fees", std::move(fees));
599
600 const CTransaction& tx = e.GetTx();
601 std::set<std::string> setDepends;
602 for (const CTxIn& txin : tx.vin)
603 {
604 if (pool.exists(txin.prevout.hash))
605 setDepends.insert(txin.prevout.hash.ToString());
606 }
607
608 UniValue depends(UniValue::VARR);
609 for (const std::string& dep : setDepends)
610 {
611 depends.push_back(dep);
612 }
613
614 info.pushKV("depends", std::move(depends));
615
617 for (const CTxMemPoolEntry& child : pool.GetChildren(e)) {
618 spent.push_back(child.GetTx().GetHash().ToString());
619 }
620
621 info.pushKV("spentby", std::move(spent));
622 info.pushKV("unbroadcast", pool.IsUnbroadcastTx(tx.GetHash()));
623
624 // Add opt-in RBF status
625 if (IsDeprecatedRPCEnabled("bip125")) {
626 bool rbfStatus = false;
627 RBFTransactionState rbfState = IsRBFOptIn(tx, pool);
628 if (rbfState == RBFTransactionState::UNKNOWN) {
629 throw JSONRPCError(RPC_MISC_ERROR, "Transaction is not in mempool");
630 } else if (rbfState == RBFTransactionState::REPLACEABLE_BIP125) {
631 rbfStatus = true;
632 }
633 info.pushKV("bip125-replaceable", rbfStatus);
634 }
635}
636
637UniValue MempoolToJSON(const CTxMemPool& pool, bool verbose, bool include_mempool_sequence)
638{
639 if (verbose) {
640 if (include_mempool_sequence) {
641 throw JSONRPCError(RPC_INVALID_PARAMETER, "Verbose results cannot contain mempool sequence values.");
642 }
643 LOCK(pool.cs);
645 for (const CTxMemPoolEntry& e : pool.entryAll()) {
647 entryToJSON(pool, info, e);
648 // Mempool has unique entries so there is no advantage in using
649 // UniValue::pushKV, which checks if the key already exists in O(N).
650 // UniValue::pushKVEnd is used instead which currently is O(1).
651 o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
652 }
653 return o;
654 } else {
656 uint64_t mempool_sequence;
657 {
658 LOCK(pool.cs);
659 for (const CTxMemPoolEntry& e : pool.entryAll()) {
660 a.push_back(e.GetTx().GetHash().ToString());
661 }
662 mempool_sequence = pool.GetSequence();
663 }
664 if (!include_mempool_sequence) {
665 return a;
666 } else {
668 o.pushKV("txids", std::move(a));
669 o.pushKV("mempool_sequence", mempool_sequence);
670 return o;
671 }
672 }
673}
674
676{
677 return RPCMethod{"getmempoolfeeratediagram",
678 "Returns the feerate diagram for the whole mempool.",
679 {},
680 {
681 RPCResult{"mempool chunks",
682 RPCResult::Type::ARR, "", "",
683 {
684 {
685 RPCResult::Type::OBJ, "", "",
686 {
687 {RPCResult::Type::NUM, "weight", "cumulative sigops-adjusted weight"},
688 {RPCResult::Type::STR_AMOUNT, "fee", "cumulative fee"}
689 }
690 }
691 }
692 }
693 },
695 HelpExampleCli("getmempoolfeeratediagram", "")
696 + HelpExampleRpc("getmempoolfeeratediagram", "")
697 },
698 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
699 {
700 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
701 LOCK(mempool.cs);
702
703 UniValue result(UniValue::VARR);
704
705 auto diagram = mempool.GetFeerateDiagram();
706
707 for (auto f : diagram) {
709 o.pushKV("weight", f.size);
710 o.pushKV("fee", ValueFromAmount(f.fee));
711 result.push_back(o);
712 }
713 return result;
714 }
715 };
716}
717
719{
720 return RPCMethod{
721 "getrawmempool",
722 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
723 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
724 {
725 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
726 {"mempool_sequence", RPCArg::Type::BOOL, RPCArg::Default{false}, "If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
727 },
728 {
729 RPCResult{"for verbose = false",
730 RPCResult::Type::ARR, "", "",
731 {
732 {RPCResult::Type::STR_HEX, "", "The transaction id"},
733 }},
734 RPCResult{"for verbose = true",
736 {
737 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
738 }},
739 RPCResult{"for verbose = false and mempool_sequence = true",
740 RPCResult::Type::OBJ, "", "",
741 {
742 {RPCResult::Type::ARR, "txids", "",
743 {
744 {RPCResult::Type::STR_HEX, "", "The transaction id"},
745 }},
746 {RPCResult::Type::NUM, "mempool_sequence", "The mempool sequence value."},
747 }},
748 },
750 HelpExampleCli("getrawmempool", "true")
751 + HelpExampleRpc("getrawmempool", "true")
752 },
753 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
754{
755 bool fVerbose = false;
756 if (!request.params[0].isNull())
757 fVerbose = request.params[0].get_bool();
758
759 bool include_mempool_sequence = false;
760 if (!request.params[1].isNull()) {
761 include_mempool_sequence = request.params[1].get_bool();
762 }
763
764 return MempoolToJSON(EnsureAnyMemPool(request.context), fVerbose, include_mempool_sequence);
765},
766 };
767}
768
770{
771 return RPCMethod{
772 "getmempoolancestors",
773 "If txid is in the mempool, returns all in-mempool ancestors.\n",
774 {
775 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
776 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
777 },
778 {
779 RPCResult{"for verbose = false",
780 RPCResult::Type::ARR, "", "",
781 {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool ancestor transaction"}}},
782 RPCResult{"for verbose = true",
784 {
785 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
786 }},
787 },
789 HelpExampleCli("getmempoolancestors", "\"mytxid\"")
790 + HelpExampleRpc("getmempoolancestors", "\"mytxid\"")
791 },
792 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
793{
794 bool fVerbose = false;
795 if (!request.params[1].isNull())
796 fVerbose = request.params[1].get_bool();
797
798 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
799
800 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
801 LOCK(mempool.cs);
802
803 const auto entry{mempool.GetEntry(txid)};
804 if (entry == nullptr) {
805 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
806 }
807
808 auto ancestors{mempool.CalculateMemPoolAncestors(*entry)};
809
810 if (!fVerbose) {
812 for (CTxMemPool::txiter ancestorIt : ancestors) {
813 o.push_back(ancestorIt->GetTx().GetHash().ToString());
814 }
815 return o;
816 } else {
818 for (CTxMemPool::txiter ancestorIt : ancestors) {
819 const CTxMemPoolEntry &e = *ancestorIt;
821 entryToJSON(mempool, info, e);
822 o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
823 }
824 return o;
825 }
826},
827 };
828}
829
831{
832 return RPCMethod{
833 "getmempooldescendants",
834 "If txid is in the mempool, returns all in-mempool descendants.\n",
835 {
836 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
837 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
838 },
839 {
840 RPCResult{"for verbose = false",
841 RPCResult::Type::ARR, "", "",
842 {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool descendant transaction"}}},
843 RPCResult{"for verbose = true",
845 {
846 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
847 }},
848 },
850 HelpExampleCli("getmempooldescendants", "\"mytxid\"")
851 + HelpExampleRpc("getmempooldescendants", "\"mytxid\"")
852 },
853 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
854{
855 bool fVerbose = false;
856 if (!request.params[1].isNull())
857 fVerbose = request.params[1].get_bool();
858
859 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
860
861 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
862 LOCK(mempool.cs);
863
864 const auto it{mempool.GetIter(txid)};
865 if (!it) {
866 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
867 }
868
869 CTxMemPool::setEntries setDescendants;
870 mempool.CalculateDescendants(*it, setDescendants);
871 // CTxMemPool::CalculateDescendants will include the given tx
872 setDescendants.erase(*it);
873
874 if (!fVerbose) {
876 for (CTxMemPool::txiter descendantIt : setDescendants) {
877 o.push_back(descendantIt->GetTx().GetHash().ToString());
878 }
879
880 return o;
881 } else {
883 for (CTxMemPool::txiter descendantIt : setDescendants) {
884 const CTxMemPoolEntry &e = *descendantIt;
886 entryToJSON(mempool, info, e);
887 o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
888 }
889 return o;
890 }
891},
892 };
893}
894
896{
897 return RPCMethod{"getmempoolcluster",
898 "Returns mempool data for given cluster\n",
899 {
900 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The txid of a transaction in the cluster"},
901 },
902 RPCResult{
905 HelpExampleCli("getmempoolcluster", "txid")
906 + HelpExampleRpc("getmempoolcluster", R"("txid")")
907 },
908 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
909{
910 uint256 hash = ParseHashV(request.params[0], "txid");
911
912 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
913 LOCK(mempool.cs);
914
915 auto txid = Txid::FromUint256(hash);
916 const auto entry{mempool.GetEntry(txid)};
917 if (entry == nullptr) {
918 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
919 }
920
921 auto cluster = mempool.GetCluster(txid);
922
924 clusterToJSON(mempool, info, cluster);
925 return info;
926},
927 };
928}
929
931{
932 return RPCMethod{
933 "getmempoolentry",
934 "Returns mempool data for given transaction\n",
935 {
936 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
937 },
938 RPCResult{
941 HelpExampleCli("getmempoolentry", "\"mytxid\"")
942 + HelpExampleRpc("getmempoolentry", "\"mytxid\"")
943 },
944 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
945{
946 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
947
948 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
949 LOCK(mempool.cs);
950
951 const auto entry{mempool.GetEntry(txid)};
952 if (entry == nullptr) {
953 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
954 }
955
957 entryToJSON(mempool, info, *entry);
958 return info;
959},
960 };
961}
962
964{
965 return RPCMethod{"gettxspendingprevout",
966 "Scans the mempool (and the txospenderindex, if available) to find transactions spending any of the given outputs",
967 {
968 {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The transaction outputs that we want to check, and within each, the txid (string) vout (numeric).",
969 {
971 {
972 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
973 {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
974 },
975 },
976 },
977 },
979 {
980 {"mempool_only", RPCArg::Type::BOOL, RPCArg::DefaultHint{"true if txospenderindex unavailable, otherwise false"}, "If false and mempool lacks a relevant spend, use txospenderindex (throws an exception if not available)."},
981 {"return_spending_tx", RPCArg::Type::BOOL, RPCArg::DefaultHint{"false"}, "If true, return the full spending tx."},
982 },
983 },
984 },
985 RPCResult{
986 RPCResult::Type::ARR, "", "",
987 {
988 {RPCResult::Type::OBJ, "", "",
989 {
990 {RPCResult::Type::STR_HEX, "txid", "the transaction id of the checked output"},
991 {RPCResult::Type::NUM, "vout", "the vout value of the checked output"},
992 {RPCResult::Type::STR_HEX, "spendingtxid", /*optional=*/true, "the transaction id of the mempool transaction spending this output (omitted if unspent)"},
993 {RPCResult::Type::STR_HEX, "spendingtx", /*optional=*/true, "the transaction spending this output (only if return_spending_tx is set, omitted if unspent)"},
994 {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "the hash of the spending block (omitted if unspent or the spending tx is not confirmed)"},
995 }},
996 }
997 },
999 HelpExampleCli("gettxspendingprevout", "\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
1000 + HelpExampleRpc("gettxspendingprevout", "\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
1001 + HelpExampleCliNamed("gettxspendingprevout", {{"outputs", "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]"}, {"return_spending_tx", true}})
1002 },
1003 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1004 {
1005 const UniValue& output_params = request.params[0].get_array();
1006 if (output_params.empty()) {
1007 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, outputs are missing");
1008 }
1009 const UniValue options{request.params[1].isNull() ? UniValue::VOBJ : request.params[1]};
1010 RPCTypeCheckObj(options,
1011 {
1012 {"mempool_only", UniValueType(UniValue::VBOOL)},
1013 {"return_spending_tx", UniValueType(UniValue::VBOOL)},
1014 }, /*fAllowNull=*/true, /*fStrict=*/true);
1015
1016 const bool mempool_only{options.exists("mempool_only") ? options["mempool_only"].get_bool() : !g_txospenderindex};
1017 const bool return_spending_tx{options.exists("return_spending_tx") ? options["return_spending_tx"].get_bool() : false};
1018
1019 // Worklist of outpoints to resolve
1020 struct Entry {
1021 COutPoint outpoint;
1022 size_t request_index;
1023 };
1024 std::vector<Entry> prevouts_to_process;
1025 prevouts_to_process.reserve(output_params.size());
1026 for (const size_t idx : std::views::iota(size_t{0}, output_params.size())) {
1027 const UniValue& o = output_params[idx].get_obj();
1028
1030 {
1031 {"txid", UniValueType(UniValue::VSTR)},
1032 {"vout", UniValueType(UniValue::VNUM)},
1033 }, /*fAllowNull=*/false, /*fStrict=*/true);
1034
1035 const Txid txid = Txid::FromUint256(ParseHashO(o, "txid"));
1036 const int nOutput{o.find_value("vout").getInt<int>()};
1037 if (nOutput < 0) {
1038 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout cannot be negative");
1039 }
1040 prevouts_to_process.emplace_back(COutPoint{txid, static_cast<uint32_t>(nOutput)}, idx);
1041 }
1042
1043 auto make_output = [&output_params, return_spending_tx](const Entry& prevout, const CTransaction* spending_tx = nullptr) {
1044 UniValue o{output_params[prevout.request_index]};
1045 if (spending_tx) {
1046 o.pushKV("spendingtxid", spending_tx->GetHash().ToString());
1047 if (return_spending_tx) {
1048 o.pushKV("spendingtx", EncodeHexTx(*spending_tx));
1049 }
1050 }
1051 return o;
1052 };
1053
1054 std::vector<UniValue> results(output_params.size());
1055
1056 // Search the mempool first
1057 std::vector<Entry> unresolved;
1058 unresolved.reserve(prevouts_to_process.size());
1059 {
1060 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
1061 LOCK(mempool.cs);
1062
1063 // Make the result if the spending tx appears in the mempool or this is a mempool_only request
1064 for (const auto& prevout : prevouts_to_process) {
1065 const auto* spending_tx{mempool.GetConflictTx(prevout.outpoint)};
1066
1067 // If the outpoint is not spent in the mempool and this is not a mempool-only
1068 // request, we cannot answer it yet.
1069 if (!spending_tx && !mempool_only) {
1070 unresolved.push_back(prevout);
1071 } else {
1072 results[prevout.request_index] = make_output(prevout, spending_tx);
1073 }
1074 }
1075 }
1076
1077 // mempool_only requests resolve every outpoint above, so only other requests reach the index.
1078 if (!unresolved.empty() && (!g_txospenderindex || !g_txospenderindex->BlockUntilSyncedToCurrentChain())) {
1079 throw JSONRPCError(RPC_MISC_ERROR, "Mempool lacks a relevant spend, and txospenderindex is unavailable.");
1080 }
1081
1082 for (const auto& prevout : unresolved) {
1083 const auto spender{g_txospenderindex->FindSpender(prevout.outpoint)};
1084 if (!spender) {
1085 throw JSONRPCError(RPC_MISC_ERROR, spender.error());
1086 }
1087
1088 if (const auto& spender_opt{spender.value()}) {
1089 UniValue o{make_output(prevout, spender_opt->tx.get())};
1090 o.pushKV("blockhash", spender_opt->block_hash.GetHex());
1091 results[prevout.request_index] = std::move(o);
1092 } else {
1093 // Only return the input outpoint itself, which indicates it is unspent.
1094 results[prevout.request_index] = make_output(prevout);
1095 }
1096 }
1097
1098 UniValue result{UniValue::VARR};
1099 result.reserve(results.size());
1100 for (auto& output : results) result.push_back(std::move(output));
1101 return result;
1102 },
1103 };
1104}
1105
1107{
1108 // Make sure this call is atomic in the pool.
1109 LOCK(pool.cs);
1111 ret.pushKV("loaded", pool.GetLoadTried());
1112 ret.pushKV("size", pool.size());
1113 ret.pushKV("bytes", pool.GetTotalTxSize());
1114 ret.pushKV("usage", pool.DynamicMemoryUsage());
1115 ret.pushKV("total_fee", ValueFromAmount(pool.GetTotalFee()));
1116 ret.pushKV("maxmempool", pool.m_opts.max_size_bytes);
1117 ret.pushKV("mempoolminfee", ValueFromAmount(std::max(pool.GetMinFee(), pool.m_opts.min_relay_feerate).GetFeePerK()));
1118 ret.pushKV("minrelaytxfee", ValueFromAmount(pool.m_opts.min_relay_feerate.GetFeePerK()));
1119 ret.pushKV("incrementalrelayfee", ValueFromAmount(pool.m_opts.incremental_relay_feerate.GetFeePerK()));
1120 ret.pushKV("unbroadcastcount", pool.GetUnbroadcastTxs().size());
1121 ret.pushKV("permitbaremultisig", pool.m_opts.permit_bare_multisig);
1122 ret.pushKV("maxdatacarriersize", pool.m_opts.max_datacarrier_bytes.value_or(0));
1123 ret.pushKV("limitclustercount", pool.m_opts.limits.cluster_count);
1124 ret.pushKV("limitclustersize", pool.m_opts.limits.cluster_size_vbytes);
1125 ret.pushKV("optimal", pool.m_txgraph->DoWork(0)); // 0 work is a quick check for known optimality
1126 if (IsDeprecatedRPCEnabled("fullrbf")) {
1127 ret.pushKV("fullrbf", true);
1128 }
1129 return ret;
1130}
1131
1133{
1134 return RPCMethod{"getmempoolinfo",
1135 "Returns details on the active state of the TX memory pool.",
1136 {},
1137 RPCResult{
1138 RPCResult::Type::OBJ, "", "",
1139 [](){
1140 std::vector<RPCResult> list = {
1141 {RPCResult::Type::BOOL, "loaded", "True if the initial load attempt of the persisted mempool finished"},
1142 {RPCResult::Type::NUM, "size", "Current tx count"},
1143 {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"},
1144 {RPCResult::Type::NUM, "usage", "Total memory usage for the mempool"},
1145 {RPCResult::Type::STR_AMOUNT, "total_fee", "Total fees for the mempool in " + CURRENCY_UNIT + ", ignoring modified fees through prioritisetransaction"},
1146 {RPCResult::Type::NUM, "maxmempool", "Maximum memory usage for the mempool"},
1147 {RPCResult::Type::STR_AMOUNT, "mempoolminfee", "Minimum fee rate in " + CURRENCY_UNIT + "/kvB for tx to be accepted. Is the maximum of minrelaytxfee and minimum mempool fee"},
1148 {RPCResult::Type::STR_AMOUNT, "minrelaytxfee", "Current minimum relay fee for transactions"},
1149 {RPCResult::Type::STR_AMOUNT, "incrementalrelayfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},
1150 {RPCResult::Type::NUM, "unbroadcastcount", "Current number of transactions that haven't passed initial broadcast yet"},
1151 {RPCResult::Type::BOOL, "permitbaremultisig", "True if the mempool accepts transactions with bare multisig outputs"},
1152 {RPCResult::Type::NUM, "maxdatacarriersize", "Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
1153 {RPCResult::Type::NUM, "limitclustercount", "Maximum number of transactions that can be in a cluster (configured by -limitclustercount)"},
1154 {RPCResult::Type::NUM, "limitclustersize", "Maximum size of a cluster in virtual bytes (configured by -limitclustersize)"},
1155 {RPCResult::Type::BOOL, "optimal", "If the mempool is in a known-optimal transaction ordering"},
1156 };
1157 if (IsDeprecatedRPCEnabled("fullrbf")) {
1158 list.emplace_back(RPCResult::Type::BOOL, "fullrbf", "True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)");
1159 }
1160 return list;
1161 }()
1162 },
1164 HelpExampleCli("getmempoolinfo", "")
1165 + HelpExampleRpc("getmempoolinfo", "")
1166 },
1167 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1168{
1169 return MempoolInfoToJSON(EnsureAnyMemPool(request.context));
1170},
1171 };
1172}
1173
1175{
1176 return RPCMethod{
1177 "importmempool",
1178 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
1179 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
1180 {
1181 {"filepath", RPCArg::Type::STR, RPCArg::Optional::NO, "The mempool file"},
1182 {"options",
1185 "",
1186 {
1187 {"use_current_time", RPCArg::Type::BOOL, RPCArg::Default{true},
1188 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
1189 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1190 {"apply_fee_delta_priority", RPCArg::Type::BOOL, RPCArg::Default{false},
1191 "Whether to apply the fee delta metadata from the mempool file.\n"
1192 "It will be added to any existing fee deltas.\n"
1193 "The fee delta can be set by the prioritisetransaction RPC.\n"
1194 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
1195 "Only set this bool if you understand what it does."},
1196 {"apply_unbroadcast_set", RPCArg::Type::BOOL, RPCArg::Default{false},
1197 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
1198 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1199 },
1200 RPCArgOptions{.oneline_description = "options"}},
1201 },
1202 RPCResult{RPCResult::Type::OBJ, "", "", std::vector<RPCResult>{}},
1203 RPCExamples{HelpExampleCli("importmempool", "/path/to/mempool.dat") + HelpExampleRpc("importmempool", R"("/path/to/mempool.dat")")},
1204 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
1205 const NodeContext& node{EnsureAnyNodeContext(request.context)};
1206
1207 CTxMemPool& mempool{EnsureMemPool(node)};
1209 Chainstate& chainstate = chainman.ActiveChainstate();
1210
1211 if (chainman.IsInitialBlockDownload()) {
1212 throw JSONRPCError(RPC_CLIENT_IN_INITIAL_DOWNLOAD, "Can only import the mempool after the block download and sync is done.");
1213 }
1214
1215 const fs::path load_path{fs::u8path(self.Arg<std::string_view>("filepath"))};
1216 const UniValue& use_current_time{request.params[1]["use_current_time"]};
1217 const UniValue& apply_fee_delta{request.params[1]["apply_fee_delta_priority"]};
1218 const UniValue& apply_unbroadcast{request.params[1]["apply_unbroadcast_set"]};
1220 .use_current_time = use_current_time.isNull() ? true : use_current_time.get_bool(),
1221 .apply_fee_delta_priority = apply_fee_delta.isNull() ? false : apply_fee_delta.get_bool(),
1222 .apply_unbroadcast_set = apply_unbroadcast.isNull() ? false : apply_unbroadcast.get_bool(),
1223 };
1224
1225 if (!node::LoadMempool(mempool, load_path, chainstate, std::move(opts))) {
1226 throw JSONRPCError(RPC_MISC_ERROR, "Unable to import mempool file, see debug log for details.");
1227 }
1228
1230 return ret;
1231 },
1232 };
1233}
1234
1236{
1237 return RPCMethod{
1238 "savemempool",
1239 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
1240 {},
1241 RPCResult{
1242 RPCResult::Type::OBJ, "", "",
1243 {
1244 {RPCResult::Type::STR, "filename", "the directory and file where the mempool was saved"},
1245 }},
1247 HelpExampleCli("savemempool", "")
1248 + HelpExampleRpc("savemempool", "")
1249 },
1250 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1251{
1252 const ArgsManager& args{EnsureAnyArgsman(request.context)};
1253 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
1254
1255 if (!mempool.GetLoadTried()) {
1256 throw JSONRPCError(RPC_MISC_ERROR, "The mempool was not loaded yet");
1257 }
1258
1259 const fs::path& dump_path = MempoolPath(args);
1260
1261 if (!DumpMempool(mempool, dump_path)) {
1262 throw JSONRPCError(RPC_MISC_ERROR, "Unable to dump mempool to disk");
1263 }
1264
1266 ret.pushKV("filename", dump_path.utf8string());
1267
1268 return ret;
1269},
1270 };
1271}
1272
1273static std::vector<RPCResult> OrphanDescription()
1274{
1275 return {
1276 RPCResult{RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
1277 RPCResult{RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
1278 RPCResult{RPCResult::Type::NUM, "bytes", "The serialized transaction size in bytes"},
1279 RPCResult{RPCResult::Type::NUM, "vsize", "(DEPRECATED) use vsize_bip141 instead. The virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
1280 RPCResult{RPCResult::Type::NUM, "vsize_bip141", "The virtual transaction size as defined in BIP 141. This is different from actual serialized size for witness transactions as witness data is discounted."},
1281 RPCResult{RPCResult::Type::NUM, "weight", "The transaction weight as defined in BIP 141."},
1282 RPCResult{RPCResult::Type::ARR, "from", "",
1283 {
1284 RPCResult{RPCResult::Type::NUM, "peer_id", "Peer ID"},
1285 }},
1286 };
1287}
1288
1290{
1292 o.pushKV("txid", orphan.tx->GetHash().ToString());
1293 o.pushKV("wtxid", orphan.tx->GetWitnessHash().ToString());
1294 o.pushKV("bytes", orphan.tx->ComputeTotalSize());
1295 o.pushKV("vsize", GetVirtualTransactionSize(*orphan.tx));
1296 o.pushKV("vsize_bip141", GetVirtualTransactionSize(*orphan.tx));
1297 o.pushKV("weight", GetTransactionWeight(*orphan.tx));
1299 for (const auto fromPeer: orphan.announcers) {
1300 from.push_back(fromPeer);
1301 }
1302 o.pushKV("from", from);
1303 return o;
1304}
1305
1307{
1308 return RPCMethod{
1309 "getorphantxs",
1310 "Shows transactions in the tx orphanage.\n"
1311 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
1312 {
1313 {"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",
1315 },
1316 {
1317 RPCResult{"for verbose = 0",
1318 RPCResult::Type::ARR, "", "",
1319 {
1320 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
1321 }},
1322 RPCResult{"for verbose = 1",
1323 RPCResult::Type::ARR, "", "",
1324 {
1326 }},
1327 RPCResult{"for verbose = 2",
1328 RPCResult::Type::ARR, "", "",
1329 {
1330 {RPCResult::Type::OBJ, "", "",
1331 Cat<std::vector<RPCResult>>(
1333 {{RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded transaction data"}}
1334 )
1335 },
1336 }},
1337 },
1339 HelpExampleCli("getorphantxs", "2")
1340 + HelpExampleRpc("getorphantxs", "2")
1341 },
1342 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1343 {
1344 const NodeContext& node = EnsureAnyNodeContext(request.context);
1345 PeerManager& peerman = EnsurePeerman(node);
1346 std::vector<node::TxOrphanage::OrphanInfo> orphanage = peerman.GetOrphanTransactions();
1347
1348 int verbosity{ParseVerbosity(request.params[0], /*default_verbosity=*/0, /*allow_bool=*/false)};
1349
1351
1352 if (verbosity == 0) {
1353 for (auto const& orphan : orphanage) {
1354 ret.push_back(orphan.tx->GetHash().ToString());
1355 }
1356 } else if (verbosity == 1) {
1357 for (auto const& orphan : orphanage) {
1358 ret.push_back(OrphanToJSON(orphan));
1359 }
1360 } else if (verbosity == 2) {
1361 for (auto const& orphan : orphanage) {
1362 UniValue o{OrphanToJSON(orphan)};
1363 o.pushKV("hex", EncodeHexTx(*orphan.tx));
1364 ret.push_back(o);
1365 }
1366 } else {
1367 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid verbosity value " + ToString(verbosity));
1368 }
1369
1370 return ret;
1371 },
1372 };
1373}
1374
1376{
1377 return RPCMethod{"submitpackage",
1378 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
1379 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
1380 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
1381 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
1382 ,
1383 {
1384 {"package", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of raw transactions.\n"
1385 "The package must consist of a transaction with (some, all, or none of) its unconfirmed parents. A single transaction is permitted.\n"
1386 "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"
1387 "The package must be topologically sorted, with the child being the last element in the array if there are multiple elements.",
1388 {
1390 },
1391 },
1393 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
1394 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
1396 "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"
1397 "If burning funds through unspendable outputs is desired, increase this value.\n"
1398 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
1399 },
1400 },
1401 RPCResult{
1402 RPCResult::Type::OBJ, "", "",
1403 {
1404 {RPCResult::Type::STR, "package_msg", "The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
1405 {RPCResult::Type::OBJ_DYN, "tx-results", "The transaction results keyed by wtxid. An entry is returned for every submitted wtxid.",
1406 {
1407 {RPCResult::Type::OBJ, "wtxid", "transaction wtxid", {
1408 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
1409 {RPCResult::Type::STR_HEX, "other-wtxid", /*optional=*/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."},
1410 {RPCResult::Type::NUM, "vsize_adjusted", /*optional=*/true, "Maximum of sigop-adjusted size (-bytespersigop) and virtual transaction size as defined in BIP 141."},
1411 {RPCResult::Type::NUM, "vsize", /*optional=*/true, "(DEPRECATED) Was previously erroneously described as the BIP 141 vsize, but is actually sigops-adjusted vsize.\n"
1412 "Use vsize_bip141 to actually get that behavior or switch to the explicit vsize_adjusted for retained behavior."},
1413 {RPCResult::Type::NUM, "vsize_bip141", /*optional=*/true, "Virtual transaction size as defined in BIP 141."},
1414 {RPCResult::Type::OBJ, "fees", /*optional=*/true, "Transaction fees", {
1415 {RPCResult::Type::STR_AMOUNT, "base", "transaction fee in " + CURRENCY_UNIT},
1416 {RPCResult::Type::STR_AMOUNT, "effective-feerate", /*optional=*/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."},
1417 {RPCResult::Type::ARR, "effective-includes", /*optional=*/true, "if effective-feerate is provided, the wtxids of the transactions whose fees and vsizes are included in effective-feerate.",
1418 {{RPCResult::Type::STR_HEX, "", "transaction wtxid in hex"},
1419 }},
1420 }},
1421 {RPCResult::Type::STR, "error", /*optional=*/true, "Error string if rejected from mempool, or \"package-not-validated\" when the package aborts before any per-tx processing."},
1422 }}
1423 }},
1424 {RPCResult::Type::ARR, "replaced-transactions", /*optional=*/true, "List of txids of replaced transactions",
1425 {
1426 {RPCResult::Type::STR_HEX, "", "The transaction id"},
1427 }},
1428 },
1429 },
1431 HelpExampleRpc("submitpackage", R"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
1432 HelpExampleCli("submitpackage", R"('["raw-tx-without-unconfirmed-parents"]')")
1433 },
1434 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1435 {
1436 const UniValue raw_transactions = request.params[0].get_array();
1437 if (raw_transactions.empty() || raw_transactions.size() > MAX_PACKAGE_COUNT) {
1439 "Array must contain between 1 and " + ToString(MAX_PACKAGE_COUNT) + " transactions.");
1440 }
1441
1442 // Fee check needs to be run with chainstate and package context
1443 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
1444 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
1445 // 0-value is special; it's mapped to no sanity check
1446 if (max_raw_tx_fee_rate == CFeeRate(0)) {
1447 client_maxfeerate = std::nullopt;
1448 }
1449
1450 // Burn sanity check is run with no context
1451 const CAmount max_burn_amount = request.params[2].isNull() ? 0 : AmountFromValue(request.params[2]);
1452
1453 std::vector<CTransactionRef> txns;
1454 txns.reserve(raw_transactions.size());
1455 for (const auto& rawtx : raw_transactions.getValues()) {
1457 if (!DecodeHexTx(mtx, rawtx.get_str())) {
1459 "TX decode failed: " + rawtx.get_str() + " Make sure the tx has at least one input.");
1460 }
1461
1462 for (const auto& out : mtx.vout) {
1463 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
1464 throw JSONRPCTransactionError(TransactionError::MAX_BURN_EXCEEDED);
1465 }
1466 }
1467
1468 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
1469 }
1470 CHECK_NONFATAL(!txns.empty());
1471 if (txns.size() > 1 && !IsChildWithParentsTree(txns)) {
1472 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE, "package topology disallowed. not child-with-parents or parents depend on each other.");
1473 }
1474
1475 NodeContext& node = EnsureAnyNodeContext(request.context);
1476 CTxMemPool& mempool = EnsureMemPool(node);
1478 const auto package_result = WITH_LOCK(::cs_main, return ProcessNewPackage(chainstate, mempool, txns, /*test_accept=*/ false, client_maxfeerate));
1479
1480 std::string package_msg = "success";
1481
1482 // First catch package-wide errors, continue if we can
1483 switch(package_result.m_state.GetResult()) {
1485 {
1486 // Belt-and-suspenders check; everything should be successful here
1487 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1488 for (const auto& tx : txns) {
1489 CHECK_NONFATAL(mempool.exists(tx->GetHash()));
1490 }
1491 break;
1492 }
1494 {
1495 // This only happens with internal bug; user should stop and report
1496 throw JSONRPCTransactionError(TransactionError::MEMPOOL_ERROR,
1497 package_result.m_state.GetRejectReason());
1498 }
1501 {
1502 // Package-wide error we want to return, but we also want to return individual responses
1503 package_msg = package_result.m_state.ToString();
1504 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1505 package_result.m_tx_results.empty());
1506 break;
1507 }
1508 }
1509
1510 size_t num_broadcast{0};
1511 for (const auto& tx : txns) {
1512 // We don't want to re-submit the txn for validation in BroadcastTransaction
1513 if (!mempool.exists(tx->GetHash())) {
1514 continue;
1515 }
1516
1517 // We do not expect an error here; we are only broadcasting things already/still in mempool
1518 std::string err_string;
1519 const auto err = BroadcastTransaction(node,
1520 tx,
1521 err_string,
1522 /*max_tx_fee=*/0,
1524 /*wait_callback=*/true);
1525 if (err != TransactionError::OK) {
1526 throw JSONRPCTransactionError(err,
1527 strprintf("transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1528 err_string, num_broadcast));
1529 }
1530 num_broadcast++;
1531 }
1532
1533 UniValue rpc_result{UniValue::VOBJ};
1534 rpc_result.pushKV("package_msg", package_msg);
1535 UniValue tx_result_map{UniValue::VOBJ};
1536 std::set<Txid> replaced_txids;
1537 for (const auto& tx : txns) {
1538 UniValue result_inner{UniValue::VOBJ};
1539 result_inner.pushKV("txid", tx->GetHash().GetHex());
1540 const auto wtxid_hex = tx->GetWitnessHash().GetHex();
1541 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1542 if (it == package_result.m_tx_results.end()) {
1543 // No per-tx result for this wtxid
1544 // Current invariant: per-tx results are all-or-none (every member or empty on package abort).
1545 // If any exist yet this one is missing, it's an unexpected partial map.
1546 CHECK_NONFATAL(package_result.m_tx_results.empty());
1547 result_inner.pushKV("error", "package-not-validated");
1548 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1549 continue;
1550 }
1551 const auto& tx_result = it->second;
1552 switch(it->second.m_result_type) {
1554 result_inner.pushKV("other-wtxid", it->second.m_other_wtxid.value().GetHex());
1555 break;
1557 result_inner.pushKV("error", it->second.m_state.ToString());
1558 break;
1561 result_inner.pushKV("vsize_adjusted", it->second.m_vsize.value());
1562 result_inner.pushKV("vsize", it->second.m_vsize.value());
1563 result_inner.pushKV("vsize_bip141", GetVirtualTransactionSize(*tx));
1565 fees.pushKV("base", ValueFromAmount(it->second.m_base_fees.value()));
1566 if (tx_result.m_result_type == MempoolAcceptResult::ResultType::VALID) {
1567 // Effective feerate is not provided for MEMPOOL_ENTRY transactions even
1568 // though modified fees is known, because it is unknown whether package
1569 // feerate was used when it was originally submitted.
1570 fees.pushKV("effective-feerate", ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1571 UniValue effective_includes_res(UniValue::VARR);
1572 for (const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1573 effective_includes_res.push_back(wtxid.ToString());
1574 }
1575 fees.pushKV("effective-includes", std::move(effective_includes_res));
1576 }
1577 result_inner.pushKV("fees", std::move(fees));
1578 for (const auto& ptx : it->second.m_replaced_transactions) {
1579 replaced_txids.insert(ptx->GetHash());
1580 }
1581 break;
1582 }
1583 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1584 }
1585 rpc_result.pushKV("tx-results", std::move(tx_result_map));
1586 UniValue replaced_list(UniValue::VARR);
1587 for (const auto& txid : replaced_txids) replaced_list.push_back(txid.ToString());
1588 rpc_result.pushKV("replaced-transactions", std::move(replaced_list));
1589 return rpc_result;
1590 },
1591 };
1592}
1593
1595{
1596 static const CRPCCommand commands[]{
1597 {"rawtransactions", &sendrawtransaction},
1598 {"rawtransactions", &getprivatebroadcastinfo},
1599 {"rawtransactions", &abortprivatebroadcast},
1600 {"rawtransactions", &testmempoolaccept},
1601 {"blockchain", &getmempoolancestors},
1602 {"blockchain", &getmempooldescendants},
1603 {"blockchain", &getmempoolentry},
1604 {"blockchain", &getmempoolcluster},
1605 {"blockchain", &gettxspendingprevout},
1606 {"blockchain", &getmempoolinfo},
1607 {"hidden", &getmempoolfeeratediagram},
1608 {"blockchain", &getrawmempool},
1609 {"blockchain", &importmempool},
1610 {"blockchain", &savemempool},
1611 {"hidden", &getorphantxs},
1612 {"rawtransactions", &submitpackage},
1613 };
1614 for (const auto& c : commands) {
1615 t.appendCommand(c.name, &c);
1616 }
1617}
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
ArgsManager gArgs
Definition: args.cpp:38
int ret
static CAmount AmountFromValue(const UniValue &value)
Definition: bitcoin-tx.cpp:555
ArgsManager & args
Definition: bitcoind.cpp:280
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:112
bool GetBoolArg(const std::string &strArg, bool fDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return boolean argument or default value.
Definition: args.cpp:571
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:32
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 vbytes.
Definition: feerate.h:71
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:30
Txid hash
Definition: transaction.h:32
RPC command dispatcher.
Definition: server.h:89
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:287
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:334
const std::vector< CTxIn > vin
Definition: transaction.h:297
An input of a transaction.
Definition: transaction.h:63
COutPoint prevout
Definition: transaction.h:65
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
Definition: mempool_entry.h:66
const CTransaction & GetTx() const
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:187
std::vector< const CTxMemPoolEntry * > GetCluster(Txid txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:410
std::optional< txiter > GetIter(const Txid &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Returns an iterator to the given hash, if found.
Definition: txmempool.cpp:743
bool GetLoadTried() const
Definition: txmempool.cpp:1004
CFeeRate GetMinFee(size_t sizelimit) const
Definition: txmempool.cpp:877
size_t DynamicMemoryUsage() const
Definition: txmempool.cpp:826
const Options m_opts
Definition: txmempool.h:301
std::vector< FeePerWeight > GetFeerateDiagram() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:1130
bool exists(const Txid &txid) const
Definition: txmempool.h:513
std::set< txiter, CompareIteratorByHash > setEntries
Definition: txmempool.h:266
uint64_t GetSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:598
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
Definition: txmempool.h:263
const CTransaction * GetConflictTx(const COutPoint &prevout) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Get the transaction in the pool that spends the same prevout.
Definition: txmempool.cpp:737
std::set< Txid > GetUnbroadcastTxs() const
Returns transactions in unbroadcast set.
Definition: txmempool.h:580
void CalculateDescendants(txiter it, setEntries &setDescendants) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Populate setDescendants with all in-mempool descendants of given transaction.
Definition: txmempool.cpp:309
unsigned long size() const
Definition: txmempool.h:495
setEntries CalculateMemPoolAncestors(const CTxMemPoolEntry &entry) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Calculate all in-mempool ancestors of entry (not including the tx itself)
Definition: txmempool.cpp:130
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:627
CAmount GetTotalFee() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:507
uint64_t GetTotalTxSize() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:501
const CTxMemPoolEntry * GetEntry(const Txid &txid) const LIFETIMEBOUND EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:653
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:550
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition: validation.h:950
bool IsInitialBlockDownload() const noexcept
Check whether we are doing an initial block download (synchronizing from disk or network)
MempoolAcceptResult ProcessTransaction(const CTransactionRef &tx, bool test_accept=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the memory pool.
Chainstate & ActiveChainstate() const
Alternatives to CurrentChainstate() used by older code to query latest chainstate information without...
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.
Definition: util.h:470
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:134
void push_back(UniValue val)
Definition: univalue.cpp:103
const UniValue & find_value(std::string_view key) const
Definition: univalue.cpp:232
@ VOBJ
Definition: univalue.h:24
@ VSTR
Definition: univalue.h:24
@ VARR
Definition: univalue.h:24
@ VNUM
Definition: univalue.h:24
@ VBOOL
Definition: univalue.h:24
bool isNull() const
Definition: univalue.h:81
const UniValue & get_obj() const
size_t size() const
Definition: univalue.h:71
const std::vector< UniValue > & getValues() const
bool empty() const
Definition: univalue.h:69
void pushKVEnd(std::string key, UniValue val)
Definition: univalue.cpp:117
Int getInt() const
Definition: univalue.h:143
const UniValue & get_array() const
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:125
bool get_bool() const
std::string GetRejectReason() const
Definition: validation.h:116
Result GetResult() const
Definition: validation.h:115
std::string ToString() const
Definition: validation.h:118
std::string ToString() const
static transaction_identifier FromUint256(const uint256 &id)
256-bit opaque blob.
Definition: uint256.h:196
static int32_t GetTransactionWeight(const CTransaction &tx)
Definition: validation.h:139
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
std::string EncodeHexTx(const CTransaction &tx)
Definition: core_io.cpp:404
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness, bool try_witness)
Definition: core_io.cpp:225
UniValue ValueFromAmount(const CAmount amount)
Definition: core_io.cpp:283
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
const std::string CURRENCY_UNIT
Definition: feerate.h:19
static path u8path(std::string_view utf8_str)
Definition: fs.h:80
uint64_t fee
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
Definition: moneystr.cpp:19
Definition: messages.h:21
@ MEMPOOL_AND_BROADCAST_TO_ALL
Add the transaction to the mempool and broadcast to all peers for which tx relay is enabled.
@ NO_MEMPOOL_PRIVATE_BROADCAST
Omit the mempool and directly send the transaction via a few dedicated connections to peers on privac...
TransactionError
Definition: types.h:19
constexpr CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE
Maximum fee rate for sendrawtransaction and testmempoolaccept RPC calls.
Definition: transaction.h:28
fs::path MempoolPath(const ArgsManager &argsman)
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.
Definition: transaction.cpp:32
constexpr CAmount DEFAULT_MAX_BURN_AMOUNT
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls.
Definition: transaction.h:34
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.
Definition: string.h:250
constexpr bool DEFAULT_PRIVATE_BROADCAST
Default for -privatebroadcast.
Definition: net.h:91
@ NET_I2P
I2P.
Definition: netaddress.h:47
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:44
ReachableNets g_reachable_nets
Definition: netbase.cpp:43
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 (...
Definition: packages.cpp:136
constexpr uint32_t MAX_PACKAGE_COUNT
Default maximum number of transactions in a package.
Definition: packages.h:19
@ 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...
Definition: rbf.cpp:24
RBFTransactionState
The rbf state of unconfirmed transactions.
Definition: rbf.h:29
@ 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).
Definition: policy.cpp:395
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:418
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:417
UniValue JSONRPCError(int code, const std::string &message)
Definition: request.cpp:75
static RPCMethod savemempool()
Definition: mempool.cpp:1235
static UniValue OrphanToJSON(const node::TxOrphanage::OrphanInfo &orphan)
Definition: mempool.cpp:1289
static std::vector< RPCResult > ClusterDescription()
Definition: mempool.cpp:469
static std::vector< RPCResult > OrphanDescription()
Definition: mempool.cpp:1273
static RPCMethod testmempoolaccept()
Definition: mempool.cpp:312
static RPCMethod sendrawtransaction()
Definition: mempool.cpp:79
static void entryToJSON(const CTxMemPool &pool, UniValue &info, const CTxMemPoolEntry &e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
Definition: mempool.cpp:571
static RPCMethod importmempool()
Definition: mempool.cpp:1174
static RPCMethod submitpackage()
Definition: mempool.cpp:1375
void RegisterMempoolRPCCommands(CRPCTable &t)
Definition: mempool.cpp:1594
static void clusterToJSON(const CTxMemPool &pool, UniValue &info, std::vector< const CTxMemPoolEntry * > cluster) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
Definition: mempool.cpp:537
UniValue MempoolInfoToJSON(const CTxMemPool &pool)
Mempool information to JSON.
Definition: mempool.cpp:1106
static RPCMethod getmempoolcluster()
Definition: mempool.cpp:895
static RPCMethod getmempoolentry()
Definition: mempool.cpp:930
static std::vector< RPCResult > MempoolEntryDescription()
Definition: mempool.cpp:487
static RPCMethod getprivatebroadcastinfo()
Definition: mempool.cpp:177
static RPCMethod getmempoolancestors()
Definition: mempool.cpp:769
void AppendChunkInfo(UniValue &all_chunks, FeePerWeight chunk_feerate, std::vector< const CTxMemPoolEntry * > chunk_txs)
Definition: mempool.cpp:524
static RPCMethod getorphantxs()
Definition: mempool.cpp:1306
UniValue MempoolToJSON(const CTxMemPool &pool, bool verbose, bool include_mempool_sequence)
Mempool to JSON.
Definition: mempool.cpp:637
static RPCMethod getmempooldescendants()
Definition: mempool.cpp:830
static RPCMethod gettxspendingprevout()
Definition: mempool.cpp:963
static RPCMethod getrawmempool()
Definition: mempool.cpp:718
static RPCMethod abortprivatebroadcast()
Definition: mempool.cpp:252
static RPCMethod getmempoolfeeratediagram()
Definition: mempool.cpp:675
static RPCMethod getmempoolinfo()
Definition: mempool.cpp:1132
@ RPC_MISC_ERROR
General application defined errors.
Definition: protocol.h:65
@ RPC_METHOD_NOT_FOUND
Definition: protocol.h:57
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
Definition: protocol.h:69
@ RPC_CLIENT_IN_INITIAL_DOWNLOAD
Still downloading initial blocks.
Definition: protocol.h:85
@ RPC_DESERIALIZATION_ERROR
Error parsing or validating structure in raw format.
Definition: protocol.h:71
@ RPC_INVALID_ADDRESS_OR_KEY
Invalid address or key.
Definition: protocol.h:67
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
Definition: util.cpp:189
UniValue JSONRPCTransactionError(TransactionError terr, const std::string &err_string)
Definition: util.cpp:416
CFeeRate ParseFeeRate(const UniValue &json)
Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB).
Definition: util.cpp:116
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
Definition: util.cpp:207
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
Definition: util.cpp:89
uint256 ParseHashO(const UniValue &o, std::string_view strKey)
Definition: util.cpp:132
void RPCTypeCheckObj(const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull, bool fStrict)
Definition: util.cpp:62
std::string HelpExampleCliNamed(const std::string &methodname, const RPCArgList &args)
Definition: util.cpp:194
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
Definition: util.cpp:123
bool IsDeprecatedRPCEnabled(const std::string &method)
Definition: server.cpp:716
NodeContext & EnsureAnyNodeContext(const std::any &context)
Definition: server_util.cpp:28
CTxMemPool & EnsureMemPool(const NodeContext &node)
Definition: server_util.cpp:37
PeerManager & EnsurePeerman(const NodeContext &node)
ChainstateManager & EnsureChainman(const NodeContext &node)
Definition: server_util.cpp:77
CTxMemPool & EnsureAnyMemPool(const std::any &context)
Definition: server_util.cpp:45
ArgsManager & EnsureAnyArgsman(const std::any &context)
Definition: server_util.cpp:72
A mutable version of CTransaction.
Definition: transaction.h:372
std::vector< CTxOut > vout
Definition: transaction.h:374
int64_t fee
Definition: feefrac.h:88
int32_t size
Definition: feefrac.h:89
Tagged wrapper around FeeFrac to avoid unit confusion.
Definition: feefrac.h:191
@ DIFFERENT_WITNESS
‍Valid, transaction was already in the mempool.
@ INVALID
‍Fully validated, valid.
Validation result for package mempool acceptance.
Definition: validation.h:240
PackageValidationState m_state
Definition: validation.h:241
std::map< Wtxid, MempoolAcceptResult > m_tx_results
Map from wtxid to finished MempoolAcceptResults.
Definition: validation.h:248
@ 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...
std::string DefaultHint
Hint for default value.
Definition: util.h:220
@ OMITTED
Optional argument for which the default value is omitted from help text for one of two reasons:
@ NO
Required arg.
std::string oneline_description
Should be empty unless it is supposed to override the auto-generated summary line.
Definition: util.h:170
bool skip_type_check
Definition: util.h:169
@ 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.
Definition: util.h:79
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
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.
Definition: context.h:59
Allows providing orphan information externally.
Definition: txorphanage.h:44
std::set< NodeId > announcers
Peers added with AddTx or AddAnnouncer.
Definition: txorphanage.h:47
#define AssertLockNotHeld(cs)
Definition: sync.h:149
#define LOCK(cs)
Definition: sync.h:268
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:299
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
std::unique_ptr< TxoSpenderIndex > g_txospenderindex
The global txo spender index. May be null.
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition: time.h:97
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.
AssertLockHeld(pool.cs)