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