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