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