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