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