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