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