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 return {
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, "bip125-replaceable", "Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n"},
459 RPCResult{RPCResult::Type::BOOL, "unbroadcast", "Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
460 };
461}
462
463void AppendChunkInfo(UniValue& all_chunks, FeePerWeight chunk_feerate, std::vector<const CTxMemPoolEntry *> chunk_txs)
464{
466 chunk.pushKV("chunkfee", ValueFromAmount(chunk_feerate.fee));
467 chunk.pushKV("chunkweight", chunk_feerate.size);
468 UniValue chunk_txids(UniValue::VARR);
469 for (const auto& chunk_tx : chunk_txs) {
470 chunk_txids.push_back(chunk_tx->GetTx().GetHash().ToString());
471 }
472 chunk.pushKV("txs", std::move(chunk_txids));
473 all_chunks.push_back(std::move(chunk));
474}
475
476static void clusterToJSON(const CTxMemPool& pool, UniValue& info, std::vector<const CTxMemPoolEntry *> cluster) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
477{
478 AssertLockHeld(pool.cs);
479 int total_weight{0};
480 for (const auto& tx : cluster) {
481 total_weight += tx->GetAdjustedWeight();
482 }
483 info.pushKV("clusterweight", total_weight);
484 info.pushKV("txcount", cluster.size());
485
486 // Output the cluster by chunk. This isn't handed to us by the mempool, but
487 // we can calculate it by looking at the chunk feerates of each transaction
488 // in the cluster.
489 FeePerWeight current_chunk_feerate = pool.GetMainChunkFeerate(*cluster[0]);
490 std::vector<const CTxMemPoolEntry *> current_chunk;
491 current_chunk.reserve(cluster.size());
492
493 UniValue all_chunks(UniValue::VARR);
494 for (const auto& tx : cluster) {
495 if (current_chunk_feerate.size == 0) {
496 // We've iterated all the transactions in the previous chunk; so
497 // append it to the output.
498 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
499 current_chunk.clear();
500 current_chunk_feerate = pool.GetMainChunkFeerate(*tx);
501 }
502 current_chunk.push_back(tx);
503 current_chunk_feerate.size -= tx->GetAdjustedWeight();
504 }
505 AppendChunkInfo(all_chunks, pool.GetMainChunkFeerate(*current_chunk[0]), current_chunk);
506 current_chunk.clear();
507 info.pushKV("chunks", std::move(all_chunks));
508}
509
510static void entryToJSON(const CTxMemPool& pool, UniValue& info, const CTxMemPoolEntry& e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
511{
512 AssertLockHeld(pool.cs);
513
514 auto [ancestor_count, ancestor_size, ancestor_fees] = pool.CalculateAncestorData(e);
515 auto [descendant_count, descendant_size, descendant_fees] = pool.CalculateDescendantData(e);
516
517 info.pushKV("vsize", e.GetTxSize());
518 info.pushKV("weight", e.GetTxWeight());
519 info.pushKV("time", count_seconds(e.GetTime()));
520 info.pushKV("height", e.GetHeight());
521 info.pushKV("descendantcount", descendant_count);
522 info.pushKV("descendantsize", descendant_size);
523 info.pushKV("ancestorcount", ancestor_count);
524 info.pushKV("ancestorsize", ancestor_size);
525 info.pushKV("wtxid", e.GetTx().GetWitnessHash().ToString());
526 auto feerate = pool.GetMainChunkFeerate(e);
527 info.pushKV("chunkweight", feerate.size);
528
530 fees.pushKV("base", ValueFromAmount(e.GetFee()));
531 fees.pushKV("modified", ValueFromAmount(e.GetModifiedFee()));
532 fees.pushKV("ancestor", ValueFromAmount(ancestor_fees));
533 fees.pushKV("descendant", ValueFromAmount(descendant_fees));
534 fees.pushKV("chunk", ValueFromAmount(feerate.fee));
535 info.pushKV("fees", std::move(fees));
536
537 const CTransaction& tx = e.GetTx();
538 std::set<std::string> setDepends;
539 for (const CTxIn& txin : tx.vin)
540 {
541 if (pool.exists(txin.prevout.hash))
542 setDepends.insert(txin.prevout.hash.ToString());
543 }
544
545 UniValue depends(UniValue::VARR);
546 for (const std::string& dep : setDepends)
547 {
548 depends.push_back(dep);
549 }
550
551 info.pushKV("depends", std::move(depends));
552
554 for (const CTxMemPoolEntry& child : pool.GetChildren(e)) {
555 spent.push_back(child.GetTx().GetHash().ToString());
556 }
557
558 info.pushKV("spentby", std::move(spent));
559
560 // Add opt-in RBF status
561 bool rbfStatus = false;
562 RBFTransactionState rbfState = IsRBFOptIn(tx, pool);
563 if (rbfState == RBFTransactionState::UNKNOWN) {
564 throw JSONRPCError(RPC_MISC_ERROR, "Transaction is not in mempool");
565 } else if (rbfState == RBFTransactionState::REPLACEABLE_BIP125) {
566 rbfStatus = true;
567 }
568
569 info.pushKV("bip125-replaceable", rbfStatus);
570 info.pushKV("unbroadcast", pool.IsUnbroadcastTx(tx.GetHash()));
571}
572
573UniValue MempoolToJSON(const CTxMemPool& pool, bool verbose, bool include_mempool_sequence)
574{
575 if (verbose) {
576 if (include_mempool_sequence) {
577 throw JSONRPCError(RPC_INVALID_PARAMETER, "Verbose results cannot contain mempool sequence values.");
578 }
579 LOCK(pool.cs);
581 for (const CTxMemPoolEntry& e : pool.entryAll()) {
583 entryToJSON(pool, info, e);
584 // Mempool has unique entries so there is no advantage in using
585 // UniValue::pushKV, which checks if the key already exists in O(N).
586 // UniValue::pushKVEnd is used instead which currently is O(1).
587 o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
588 }
589 return o;
590 } else {
592 uint64_t mempool_sequence;
593 {
594 LOCK(pool.cs);
595 for (const CTxMemPoolEntry& e : pool.entryAll()) {
596 a.push_back(e.GetTx().GetHash().ToString());
597 }
598 mempool_sequence = pool.GetSequence();
599 }
600 if (!include_mempool_sequence) {
601 return a;
602 } else {
604 o.pushKV("txids", std::move(a));
605 o.pushKV("mempool_sequence", mempool_sequence);
606 return o;
607 }
608 }
609}
610
612{
613 return RPCMethod{"getmempoolfeeratediagram",
614 "Returns the feerate diagram for the whole mempool.",
615 {},
616 {
617 RPCResult{"mempool chunks",
618 RPCResult::Type::ARR, "", "",
619 {
620 {
621 RPCResult::Type::OBJ, "", "",
622 {
623 {RPCResult::Type::NUM, "weight", "cumulative sigops-adjusted weight"},
624 {RPCResult::Type::NUM, "fee", "cumulative fee"}
625 }
626 }
627 }
628 }
629 },
631 HelpExampleCli("getmempoolfeeratediagram", "")
632 + HelpExampleRpc("getmempoolfeeratediagram", "")
633 },
634 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
635 {
636 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
637 LOCK(mempool.cs);
638
639 UniValue result(UniValue::VARR);
640
641 auto diagram = mempool.GetFeerateDiagram();
642
643 for (auto f : diagram) {
645 o.pushKV("weight", f.size);
646 o.pushKV("fee", ValueFromAmount(f.fee));
647 result.push_back(o);
648 }
649 return result;
650 }
651 };
652}
653
655{
656 return RPCMethod{
657 "getrawmempool",
658 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
659 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
660 {
661 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
662 {"mempool_sequence", RPCArg::Type::BOOL, RPCArg::Default{false}, "If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
663 },
664 {
665 RPCResult{"for verbose = false",
666 RPCResult::Type::ARR, "", "",
667 {
668 {RPCResult::Type::STR_HEX, "", "The transaction id"},
669 }},
670 RPCResult{"for verbose = true",
672 {
673 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
674 }},
675 RPCResult{"for verbose = false and mempool_sequence = true",
676 RPCResult::Type::OBJ, "", "",
677 {
678 {RPCResult::Type::ARR, "txids", "",
679 {
680 {RPCResult::Type::STR_HEX, "", "The transaction id"},
681 }},
682 {RPCResult::Type::NUM, "mempool_sequence", "The mempool sequence value."},
683 }},
684 },
686 HelpExampleCli("getrawmempool", "true")
687 + HelpExampleRpc("getrawmempool", "true")
688 },
689 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
690{
691 bool fVerbose = false;
692 if (!request.params[0].isNull())
693 fVerbose = request.params[0].get_bool();
694
695 bool include_mempool_sequence = false;
696 if (!request.params[1].isNull()) {
697 include_mempool_sequence = request.params[1].get_bool();
698 }
699
700 return MempoolToJSON(EnsureAnyMemPool(request.context), fVerbose, include_mempool_sequence);
701},
702 };
703}
704
706{
707 return RPCMethod{
708 "getmempoolancestors",
709 "If txid is in the mempool, returns all in-mempool ancestors.\n",
710 {
711 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
712 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
713 },
714 {
715 RPCResult{"for verbose = false",
716 RPCResult::Type::ARR, "", "",
717 {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool ancestor transaction"}}},
718 RPCResult{"for verbose = true",
720 {
721 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
722 }},
723 },
725 HelpExampleCli("getmempoolancestors", "\"mytxid\"")
726 + HelpExampleRpc("getmempoolancestors", "\"mytxid\"")
727 },
728 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
729{
730 bool fVerbose = false;
731 if (!request.params[1].isNull())
732 fVerbose = request.params[1].get_bool();
733
734 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
735
736 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
737 LOCK(mempool.cs);
738
739 const auto entry{mempool.GetEntry(txid)};
740 if (entry == nullptr) {
741 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
742 }
743
744 auto ancestors{mempool.CalculateMemPoolAncestors(*entry)};
745
746 if (!fVerbose) {
748 for (CTxMemPool::txiter ancestorIt : ancestors) {
749 o.push_back(ancestorIt->GetTx().GetHash().ToString());
750 }
751 return o;
752 } else {
754 for (CTxMemPool::txiter ancestorIt : ancestors) {
755 const CTxMemPoolEntry &e = *ancestorIt;
757 entryToJSON(mempool, info, e);
758 o.pushKV(e.GetTx().GetHash().ToString(), std::move(info));
759 }
760 return o;
761 }
762},
763 };
764}
765
767{
768 return RPCMethod{
769 "getmempooldescendants",
770 "If txid is in the mempool, returns all in-mempool descendants.\n",
771 {
772 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
773 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
774 },
775 {
776 RPCResult{"for verbose = false",
777 RPCResult::Type::ARR, "", "",
778 {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool descendant transaction"}}},
779 RPCResult{"for verbose = true",
781 {
782 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
783 }},
784 },
786 HelpExampleCli("getmempooldescendants", "\"mytxid\"")
787 + HelpExampleRpc("getmempooldescendants", "\"mytxid\"")
788 },
789 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
790{
791 bool fVerbose = false;
792 if (!request.params[1].isNull())
793 fVerbose = request.params[1].get_bool();
794
795 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
796
797 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
798 LOCK(mempool.cs);
799
800 const auto it{mempool.GetIter(txid)};
801 if (!it) {
802 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
803 }
804
805 CTxMemPool::setEntries setDescendants;
806 mempool.CalculateDescendants(*it, setDescendants);
807 // CTxMemPool::CalculateDescendants will include the given tx
808 setDescendants.erase(*it);
809
810 if (!fVerbose) {
812 for (CTxMemPool::txiter descendantIt : setDescendants) {
813 o.push_back(descendantIt->GetTx().GetHash().ToString());
814 }
815
816 return o;
817 } else {
819 for (CTxMemPool::txiter descendantIt : setDescendants) {
820 const CTxMemPoolEntry &e = *descendantIt;
822 entryToJSON(mempool, info, e);
823 o.pushKV(e.GetTx().GetHash().ToString(), std::move(info));
824 }
825 return o;
826 }
827},
828 };
829}
830
832{
833 return RPCMethod{"getmempoolcluster",
834 "Returns mempool data for given cluster\n",
835 {
836 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The txid of a transaction in the cluster"},
837 },
838 RPCResult{
841 HelpExampleCli("getmempoolcluster", "txid")
842 + HelpExampleRpc("getmempoolcluster", "txid")
843 },
844 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
845{
846 uint256 hash = ParseHashV(request.params[0], "txid");
847
848 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
849 LOCK(mempool.cs);
850
851 auto txid = Txid::FromUint256(hash);
852 const auto entry{mempool.GetEntry(txid)};
853 if (entry == nullptr) {
854 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
855 }
856
857 auto cluster = mempool.GetCluster(txid);
858
860 clusterToJSON(mempool, info, cluster);
861 return info;
862},
863 };
864}
865
867{
868 return RPCMethod{
869 "getmempoolentry",
870 "Returns mempool data for given transaction\n",
871 {
872 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
873 },
874 RPCResult{
877 HelpExampleCli("getmempoolentry", "\"mytxid\"")
878 + HelpExampleRpc("getmempoolentry", "\"mytxid\"")
879 },
880 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
881{
882 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
883
884 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
885 LOCK(mempool.cs);
886
887 const auto entry{mempool.GetEntry(txid)};
888 if (entry == nullptr) {
889 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
890 }
891
893 entryToJSON(mempool, info, *entry);
894 return info;
895},
896 };
897}
898
900{
901 return RPCMethod{"gettxspendingprevout",
902 "Scans the mempool (and the txospenderindex, if available) to find transactions spending any of the given outputs",
903 {
904 {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The transaction outputs that we want to check, and within each, the txid (string) vout (numeric).",
905 {
907 {
908 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
909 {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
910 },
911 },
912 },
913 },
915 {
916 {"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)."},
917 {"return_spending_tx", RPCArg::Type::BOOL, RPCArg::DefaultHint{"false"}, "If true, return the full spending tx."},
918 },
919 },
920 },
921 RPCResult{
922 RPCResult::Type::ARR, "", "",
923 {
924 {RPCResult::Type::OBJ, "", "",
925 {
926 {RPCResult::Type::STR_HEX, "txid", "the transaction id of the checked output"},
927 {RPCResult::Type::NUM, "vout", "the vout value of the checked output"},
928 {RPCResult::Type::STR_HEX, "spendingtxid", /*optional=*/true, "the transaction id of the mempool transaction spending this output (omitted if unspent)"},
929 {RPCResult::Type::STR_HEX, "spendingtx", /*optional=*/true, "the transaction spending this output (only if return_spending_tx is set, omitted if unspent)"},
930 {RPCResult::Type::STR_HEX, "blockhash", /*optional=*/true, "the hash of the spending block (omitted if unspent or the spending tx is not confirmed)"},
931 }},
932 }
933 },
935 HelpExampleCli("gettxspendingprevout", "\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
936 + HelpExampleRpc("gettxspendingprevout", "\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
937 + HelpExampleCliNamed("gettxspendingprevout", {{"outputs", "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":3}]"}, {"return_spending_tx", true}})
938 },
939 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
940 {
941 const UniValue& output_params = request.params[0].get_array();
942 if (output_params.empty()) {
943 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, outputs are missing");
944 }
945 const UniValue options{request.params[1].isNull() ? UniValue::VOBJ : request.params[1]};
946 RPCTypeCheckObj(options,
947 {
948 {"mempool_only", UniValueType(UniValue::VBOOL)},
949 {"return_spending_tx", UniValueType(UniValue::VBOOL)},
950 }, /*fAllowNull=*/true, /*fStrict=*/true);
951
952 const bool mempool_only{options.exists("mempool_only") ? options["mempool_only"].get_bool() : !g_txospenderindex};
953 const bool return_spending_tx{options.exists("return_spending_tx") ? options["return_spending_tx"].get_bool() : false};
954
955 // Worklist of outpoints to resolve
956 struct Entry {
957 COutPoint outpoint;
958 const UniValue* raw;
959 };
960 std::vector<Entry> prevouts_to_process;
961 prevouts_to_process.reserve(output_params.size());
962 for (unsigned int idx = 0; idx < output_params.size(); idx++) {
963 const UniValue& o = output_params[idx].get_obj();
964
966 {
967 {"txid", UniValueType(UniValue::VSTR)},
968 {"vout", UniValueType(UniValue::VNUM)},
969 }, /*fAllowNull=*/false, /*fStrict=*/true);
970
971 const Txid txid = Txid::FromUint256(ParseHashO(o, "txid"));
972 const int nOutput{o.find_value("vout").getInt<int>()};
973 if (nOutput < 0) {
974 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout cannot be negative");
975 }
976 prevouts_to_process.emplace_back(COutPoint{txid, static_cast<uint32_t>(nOutput)}, &o);
977 }
978
979 auto make_output = [return_spending_tx](const Entry& prevout, const CTransaction* spending_tx = nullptr) {
980 UniValue o{*prevout.raw};
981 if (spending_tx) {
982 o.pushKV("spendingtxid", spending_tx->GetHash().ToString());
983 if (return_spending_tx) {
984 o.pushKV("spendingtx", EncodeHexTx(*spending_tx));
985 }
986 }
987 return o;
988 };
989
990 UniValue result{UniValue::VARR};
991
992 // Search the mempool first
993 {
994 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
995 LOCK(mempool.cs);
996
997 // Make the result if the spending tx appears in the mempool or this is a mempool_only request
998 for (auto it = prevouts_to_process.begin(); it != prevouts_to_process.end(); ) {
999 const CTransaction* spending_tx{mempool.GetConflictTx(it->outpoint)};
1000
1001 // If the outpoint is not spent in the mempool and this is not a mempool-only
1002 // request, we cannot answer it yet.
1003 if (!spending_tx && !mempool_only) {
1004 ++it;
1005 continue;
1006 }
1007
1008 result.push_back(make_output(*it, spending_tx));
1009 it = prevouts_to_process.erase(it);
1010 }
1011 }
1012
1013 // Return early if all requests have been handled by the mempool search
1014 if (prevouts_to_process.empty()) {
1015 return result;
1016 }
1017
1018 // At this point the request was not limited to the mempool and some outpoints remain
1019 // unresolved. We now rely on the index to determine whether they were spent or not.
1020 if (!g_txospenderindex || !g_txospenderindex->BlockUntilSyncedToCurrentChain()) {
1021 throw JSONRPCError(RPC_MISC_ERROR, "Mempool lacks a relevant spend, and txospenderindex is unavailable.");
1022 }
1023
1024 for (const auto& prevout : prevouts_to_process) {
1025 const auto spender{g_txospenderindex->FindSpender(prevout.outpoint)};
1026 if (!spender) {
1027 throw JSONRPCError(RPC_MISC_ERROR, spender.error());
1028 }
1029
1030 if (const auto& spender_opt{spender.value()}) {
1031 UniValue o{make_output(prevout, spender_opt->tx.get())};
1032 o.pushKV("blockhash", spender_opt->block_hash.GetHex());
1033 result.push_back(std::move(o));
1034 } else {
1035 // Only return the input outpoint itself, which indicates it is unspent.
1036 result.push_back(make_output(prevout));
1037 }
1038 }
1039
1040 return result;
1041 },
1042 };
1043}
1044
1046{
1047 // Make sure this call is atomic in the pool.
1048 LOCK(pool.cs);
1050 ret.pushKV("loaded", pool.GetLoadTried());
1051 ret.pushKV("size", pool.size());
1052 ret.pushKV("bytes", pool.GetTotalTxSize());
1053 ret.pushKV("usage", pool.DynamicMemoryUsage());
1054 ret.pushKV("total_fee", ValueFromAmount(pool.GetTotalFee()));
1055 ret.pushKV("maxmempool", pool.m_opts.max_size_bytes);
1056 ret.pushKV("mempoolminfee", ValueFromAmount(std::max(pool.GetMinFee(), pool.m_opts.min_relay_feerate).GetFeePerK()));
1057 ret.pushKV("minrelaytxfee", ValueFromAmount(pool.m_opts.min_relay_feerate.GetFeePerK()));
1058 ret.pushKV("incrementalrelayfee", ValueFromAmount(pool.m_opts.incremental_relay_feerate.GetFeePerK()));
1059 ret.pushKV("unbroadcastcount", pool.GetUnbroadcastTxs().size());
1060 ret.pushKV("fullrbf", true);
1061 ret.pushKV("permitbaremultisig", pool.m_opts.permit_bare_multisig);
1062 ret.pushKV("maxdatacarriersize", pool.m_opts.max_datacarrier_bytes.value_or(0));
1063 ret.pushKV("limitclustercount", pool.m_opts.limits.cluster_count);
1064 ret.pushKV("limitclustersize", pool.m_opts.limits.cluster_size_vbytes);
1065 ret.pushKV("optimal", pool.m_txgraph->DoWork(0)); // 0 work is a quick check for known optimality
1066 return ret;
1067}
1068
1070{
1071 return RPCMethod{"getmempoolinfo",
1072 "Returns details on the active state of the TX memory pool.",
1073 {},
1074 RPCResult{
1075 RPCResult::Type::OBJ, "", "",
1076 {
1077 {RPCResult::Type::BOOL, "loaded", "True if the initial load attempt of the persisted mempool finished"},
1078 {RPCResult::Type::NUM, "size", "Current tx count"},
1079 {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"},
1080 {RPCResult::Type::NUM, "usage", "Total memory usage for the mempool"},
1081 {RPCResult::Type::STR_AMOUNT, "total_fee", "Total fees for the mempool in " + CURRENCY_UNIT + ", ignoring modified fees through prioritisetransaction"},
1082 {RPCResult::Type::NUM, "maxmempool", "Maximum memory usage for the mempool"},
1083 {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"},
1084 {RPCResult::Type::STR_AMOUNT, "minrelaytxfee", "Current minimum relay fee for transactions"},
1085 {RPCResult::Type::NUM, "incrementalrelayfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},
1086 {RPCResult::Type::NUM, "unbroadcastcount", "Current number of transactions that haven't passed initial broadcast yet"},
1087 {RPCResult::Type::BOOL, "fullrbf", "True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)"},
1088 {RPCResult::Type::BOOL, "permitbaremultisig", "True if the mempool accepts transactions with bare multisig outputs"},
1089 {RPCResult::Type::NUM, "maxdatacarriersize", "Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
1090 {RPCResult::Type::NUM, "limitclustercount", "Maximum number of transactions that can be in a cluster (configured by -limitclustercount)"},
1091 {RPCResult::Type::NUM, "limitclustersize", "Maximum size of a cluster in virtual bytes (configured by -limitclustersize)"},
1092 {RPCResult::Type::BOOL, "optimal", "If the mempool is in a known-optimal transaction ordering"},
1093 }},
1095 HelpExampleCli("getmempoolinfo", "")
1096 + HelpExampleRpc("getmempoolinfo", "")
1097 },
1098 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1099{
1100 return MempoolInfoToJSON(EnsureAnyMemPool(request.context));
1101},
1102 };
1103}
1104
1106{
1107 return RPCMethod{
1108 "importmempool",
1109 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
1110 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
1111 {
1112 {"filepath", RPCArg::Type::STR, RPCArg::Optional::NO, "The mempool file"},
1113 {"options",
1116 "",
1117 {
1118 {"use_current_time", RPCArg::Type::BOOL, RPCArg::Default{true},
1119 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
1120 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1121 {"apply_fee_delta_priority", RPCArg::Type::BOOL, RPCArg::Default{false},
1122 "Whether to apply the fee delta metadata from the mempool file.\n"
1123 "It will be added to any existing fee deltas.\n"
1124 "The fee delta can be set by the prioritisetransaction RPC.\n"
1125 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
1126 "Only set this bool if you understand what it does."},
1127 {"apply_unbroadcast_set", RPCArg::Type::BOOL, RPCArg::Default{false},
1128 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
1129 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
1130 },
1131 RPCArgOptions{.oneline_description = "options"}},
1132 },
1133 RPCResult{RPCResult::Type::OBJ, "", "", std::vector<RPCResult>{}},
1134 RPCExamples{HelpExampleCli("importmempool", "/path/to/mempool.dat") + HelpExampleRpc("importmempool", "/path/to/mempool.dat")},
1135 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
1136 const NodeContext& node{EnsureAnyNodeContext(request.context)};
1137
1138 CTxMemPool& mempool{EnsureMemPool(node)};
1140 Chainstate& chainstate = chainman.ActiveChainstate();
1141
1142 if (chainman.IsInitialBlockDownload()) {
1143 throw JSONRPCError(RPC_CLIENT_IN_INITIAL_DOWNLOAD, "Can only import the mempool after the block download and sync is done.");
1144 }
1145
1146 const fs::path load_path{fs::u8path(self.Arg<std::string_view>("filepath"))};
1147 const UniValue& use_current_time{request.params[1]["use_current_time"]};
1148 const UniValue& apply_fee_delta{request.params[1]["apply_fee_delta_priority"]};
1149 const UniValue& apply_unbroadcast{request.params[1]["apply_unbroadcast_set"]};
1151 .use_current_time = use_current_time.isNull() ? true : use_current_time.get_bool(),
1152 .apply_fee_delta_priority = apply_fee_delta.isNull() ? false : apply_fee_delta.get_bool(),
1153 .apply_unbroadcast_set = apply_unbroadcast.isNull() ? false : apply_unbroadcast.get_bool(),
1154 };
1155
1156 if (!node::LoadMempool(mempool, load_path, chainstate, std::move(opts))) {
1157 throw JSONRPCError(RPC_MISC_ERROR, "Unable to import mempool file, see debug log for details.");
1158 }
1159
1161 return ret;
1162 },
1163 };
1164}
1165
1167{
1168 return RPCMethod{
1169 "savemempool",
1170 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
1171 {},
1172 RPCResult{
1173 RPCResult::Type::OBJ, "", "",
1174 {
1175 {RPCResult::Type::STR, "filename", "the directory and file where the mempool was saved"},
1176 }},
1178 HelpExampleCli("savemempool", "")
1179 + HelpExampleRpc("savemempool", "")
1180 },
1181 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1182{
1183 const ArgsManager& args{EnsureAnyArgsman(request.context)};
1184 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
1185
1186 if (!mempool.GetLoadTried()) {
1187 throw JSONRPCError(RPC_MISC_ERROR, "The mempool was not loaded yet");
1188 }
1189
1190 const fs::path& dump_path = MempoolPath(args);
1191
1192 if (!DumpMempool(mempool, dump_path)) {
1193 throw JSONRPCError(RPC_MISC_ERROR, "Unable to dump mempool to disk");
1194 }
1195
1197 ret.pushKV("filename", dump_path.utf8string());
1198
1199 return ret;
1200},
1201 };
1202}
1203
1204static std::vector<RPCResult> OrphanDescription()
1205{
1206 return {
1207 RPCResult{RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
1208 RPCResult{RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
1209 RPCResult{RPCResult::Type::NUM, "bytes", "The serialized transaction size in bytes"},
1210 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."},
1211 RPCResult{RPCResult::Type::NUM, "weight", "The transaction weight as defined in BIP 141."},
1212 RPCResult{RPCResult::Type::ARR, "from", "",
1213 {
1214 RPCResult{RPCResult::Type::NUM, "peer_id", "Peer ID"},
1215 }},
1216 };
1217}
1218
1220{
1222 o.pushKV("txid", orphan.tx->GetHash().ToString());
1223 o.pushKV("wtxid", orphan.tx->GetWitnessHash().ToString());
1224 o.pushKV("bytes", orphan.tx->ComputeTotalSize());
1225 o.pushKV("vsize", GetVirtualTransactionSize(*orphan.tx));
1226 o.pushKV("weight", GetTransactionWeight(*orphan.tx));
1228 for (const auto fromPeer: orphan.announcers) {
1229 from.push_back(fromPeer);
1230 }
1231 o.pushKV("from", from);
1232 return o;
1233}
1234
1236{
1237 return RPCMethod{
1238 "getorphantxs",
1239 "Shows transactions in the tx orphanage.\n"
1240 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
1241 {
1242 {"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",
1244 },
1245 {
1246 RPCResult{"for verbose = 0",
1247 RPCResult::Type::ARR, "", "",
1248 {
1249 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
1250 }},
1251 RPCResult{"for verbose = 1",
1252 RPCResult::Type::ARR, "", "",
1253 {
1255 }},
1256 RPCResult{"for verbose = 2",
1257 RPCResult::Type::ARR, "", "",
1258 {
1259 {RPCResult::Type::OBJ, "", "",
1260 Cat<std::vector<RPCResult>>(
1262 {{RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded transaction data"}}
1263 )
1264 },
1265 }},
1266 },
1268 HelpExampleCli("getorphantxs", "2")
1269 + HelpExampleRpc("getorphantxs", "2")
1270 },
1271 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1272 {
1273 const NodeContext& node = EnsureAnyNodeContext(request.context);
1274 PeerManager& peerman = EnsurePeerman(node);
1275 std::vector<node::TxOrphanage::OrphanInfo> orphanage = peerman.GetOrphanTransactions();
1276
1277 int verbosity{ParseVerbosity(request.params[0], /*default_verbosity=*/0, /*allow_bool=*/false)};
1278
1280
1281 if (verbosity == 0) {
1282 for (auto const& orphan : orphanage) {
1283 ret.push_back(orphan.tx->GetHash().ToString());
1284 }
1285 } else if (verbosity == 1) {
1286 for (auto const& orphan : orphanage) {
1287 ret.push_back(OrphanToJSON(orphan));
1288 }
1289 } else if (verbosity == 2) {
1290 for (auto const& orphan : orphanage) {
1291 UniValue o{OrphanToJSON(orphan)};
1292 o.pushKV("hex", EncodeHexTx(*orphan.tx));
1293 ret.push_back(o);
1294 }
1295 } else {
1296 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid verbosity value " + ToString(verbosity));
1297 }
1298
1299 return ret;
1300 },
1301 };
1302}
1303
1305{
1306 return RPCMethod{"submitpackage",
1307 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
1308 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
1309 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
1310 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
1311 ,
1312 {
1313 {"package", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of raw transactions.\n"
1314 "The package must consist of a transaction with (some, all, or none of) its unconfirmed parents. A single transaction is permitted.\n"
1315 "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"
1316 "The package must be topologically sorted, with the child being the last element in the array if there are multiple elements.",
1317 {
1319 },
1320 },
1322 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
1323 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
1325 "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"
1326 "If burning funds through unspendable outputs is desired, increase this value.\n"
1327 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
1328 },
1329 },
1330 RPCResult{
1331 RPCResult::Type::OBJ, "", "",
1332 {
1333 {RPCResult::Type::STR, "package_msg", "The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
1334 {RPCResult::Type::OBJ_DYN, "tx-results", "The transaction results keyed by wtxid. An entry is returned for every submitted wtxid.",
1335 {
1336 {RPCResult::Type::OBJ, "wtxid", "transaction wtxid", {
1337 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
1338 {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."},
1339 {RPCResult::Type::NUM, "vsize", /*optional=*/true, "Sigops-adjusted virtual transaction size."},
1340 {RPCResult::Type::OBJ, "fees", /*optional=*/true, "Transaction fees", {
1341 {RPCResult::Type::STR_AMOUNT, "base", "transaction fee in " + CURRENCY_UNIT},
1342 {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."},
1343 {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.",
1344 {{RPCResult::Type::STR_HEX, "", "transaction wtxid in hex"},
1345 }},
1346 }},
1347 {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."},
1348 }}
1349 }},
1350 {RPCResult::Type::ARR, "replaced-transactions", /*optional=*/true, "List of txids of replaced transactions",
1351 {
1352 {RPCResult::Type::STR_HEX, "", "The transaction id"},
1353 }},
1354 },
1355 },
1357 HelpExampleRpc("submitpackage", R"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
1358 HelpExampleCli("submitpackage", R"('["raw-tx-without-unconfirmed-parents"]')")
1359 },
1360 [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1361 {
1362 const UniValue raw_transactions = request.params[0].get_array();
1363 if (raw_transactions.empty() || raw_transactions.size() > MAX_PACKAGE_COUNT) {
1365 "Array must contain between 1 and " + ToString(MAX_PACKAGE_COUNT) + " transactions.");
1366 }
1367
1368 // Fee check needs to be run with chainstate and package context
1369 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
1370 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
1371 // 0-value is special; it's mapped to no sanity check
1372 if (max_raw_tx_fee_rate == CFeeRate(0)) {
1373 client_maxfeerate = std::nullopt;
1374 }
1375
1376 // Burn sanity check is run with no context
1377 const CAmount max_burn_amount = request.params[2].isNull() ? 0 : AmountFromValue(request.params[2]);
1378
1379 std::vector<CTransactionRef> txns;
1380 txns.reserve(raw_transactions.size());
1381 for (const auto& rawtx : raw_transactions.getValues()) {
1383 if (!DecodeHexTx(mtx, rawtx.get_str())) {
1385 "TX decode failed: " + rawtx.get_str() + " Make sure the tx has at least one input.");
1386 }
1387
1388 for (const auto& out : mtx.vout) {
1389 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
1390 throw JSONRPCTransactionError(TransactionError::MAX_BURN_EXCEEDED);
1391 }
1392 }
1393
1394 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
1395 }
1396 CHECK_NONFATAL(!txns.empty());
1397 if (txns.size() > 1 && !IsChildWithParentsTree(txns)) {
1398 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE, "package topology disallowed. not child-with-parents or parents depend on each other.");
1399 }
1400
1401 NodeContext& node = EnsureAnyNodeContext(request.context);
1402 CTxMemPool& mempool = EnsureMemPool(node);
1404 const auto package_result = WITH_LOCK(::cs_main, return ProcessNewPackage(chainstate, mempool, txns, /*test_accept=*/ false, client_maxfeerate));
1405
1406 std::string package_msg = "success";
1407
1408 // First catch package-wide errors, continue if we can
1409 switch(package_result.m_state.GetResult()) {
1411 {
1412 // Belt-and-suspenders check; everything should be successful here
1413 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1414 for (const auto& tx : txns) {
1415 CHECK_NONFATAL(mempool.exists(tx->GetHash()));
1416 }
1417 break;
1418 }
1420 {
1421 // This only happens with internal bug; user should stop and report
1422 throw JSONRPCTransactionError(TransactionError::MEMPOOL_ERROR,
1423 package_result.m_state.GetRejectReason());
1424 }
1427 {
1428 // Package-wide error we want to return, but we also want to return individual responses
1429 package_msg = package_result.m_state.ToString();
1430 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1431 package_result.m_tx_results.empty());
1432 break;
1433 }
1434 }
1435
1436 size_t num_broadcast{0};
1437 for (const auto& tx : txns) {
1438 // We don't want to re-submit the txn for validation in BroadcastTransaction
1439 if (!mempool.exists(tx->GetHash())) {
1440 continue;
1441 }
1442
1443 // We do not expect an error here; we are only broadcasting things already/still in mempool
1444 std::string err_string;
1445 const auto err = BroadcastTransaction(node,
1446 tx,
1447 err_string,
1448 /*max_tx_fee=*/0,
1450 /*wait_callback=*/true);
1451 if (err != TransactionError::OK) {
1452 throw JSONRPCTransactionError(err,
1453 strprintf("transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1454 err_string, num_broadcast));
1455 }
1456 num_broadcast++;
1457 }
1458
1459 UniValue rpc_result{UniValue::VOBJ};
1460 rpc_result.pushKV("package_msg", package_msg);
1461 UniValue tx_result_map{UniValue::VOBJ};
1462 std::set<Txid> replaced_txids;
1463 for (const auto& tx : txns) {
1464 UniValue result_inner{UniValue::VOBJ};
1465 result_inner.pushKV("txid", tx->GetHash().GetHex());
1466 const auto wtxid_hex = tx->GetWitnessHash().GetHex();
1467 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1468 if (it == package_result.m_tx_results.end()) {
1469 // No per-tx result for this wtxid
1470 // Current invariant: per-tx results are all-or-none (every member or empty on package abort).
1471 // If any exist yet this one is missing, it's an unexpected partial map.
1472 CHECK_NONFATAL(package_result.m_tx_results.empty());
1473 result_inner.pushKV("error", "package-not-validated");
1474 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1475 continue;
1476 }
1477 const auto& tx_result = it->second;
1478 switch(it->second.m_result_type) {
1480 result_inner.pushKV("other-wtxid", it->second.m_other_wtxid.value().GetHex());
1481 break;
1483 result_inner.pushKV("error", it->second.m_state.ToString());
1484 break;
1487 result_inner.pushKV("vsize", it->second.m_vsize.value());
1489 fees.pushKV("base", ValueFromAmount(it->second.m_base_fees.value()));
1490 if (tx_result.m_result_type == MempoolAcceptResult::ResultType::VALID) {
1491 // Effective feerate is not provided for MEMPOOL_ENTRY transactions even
1492 // though modified fees is known, because it is unknown whether package
1493 // feerate was used when it was originally submitted.
1494 fees.pushKV("effective-feerate", ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1495 UniValue effective_includes_res(UniValue::VARR);
1496 for (const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1497 effective_includes_res.push_back(wtxid.ToString());
1498 }
1499 fees.pushKV("effective-includes", std::move(effective_includes_res));
1500 }
1501 result_inner.pushKV("fees", std::move(fees));
1502 for (const auto& ptx : it->second.m_replaced_transactions) {
1503 replaced_txids.insert(ptx->GetHash());
1504 }
1505 break;
1506 }
1507 tx_result_map.pushKV(wtxid_hex, std::move(result_inner));
1508 }
1509 rpc_result.pushKV("tx-results", std::move(tx_result_map));
1510 UniValue replaced_list(UniValue::VARR);
1511 for (const auto& txid : replaced_txids) replaced_list.push_back(txid.ToString());
1512 rpc_result.pushKV("replaced-transactions", std::move(replaced_list));
1513 return rpc_result;
1514 },
1515 };
1516}
1517
1519{
1520 static const CRPCCommand commands[]{
1521 {"rawtransactions", &sendrawtransaction},
1522 {"rawtransactions", &getprivatebroadcastinfo},
1523 {"rawtransactions", &abortprivatebroadcast},
1524 {"rawtransactions", &testmempoolaccept},
1525 {"blockchain", &getmempoolancestors},
1526 {"blockchain", &getmempooldescendants},
1527 {"blockchain", &getmempoolentry},
1528 {"blockchain", &getmempoolcluster},
1529 {"blockchain", &gettxspendingprevout},
1530 {"blockchain", &getmempoolinfo},
1531 {"hidden", &getmempoolfeeratediagram},
1532 {"blockchain", &getrawmempool},
1533 {"blockchain", &importmempool},
1534 {"blockchain", &savemempool},
1535 {"hidden", &getorphantxs},
1536 {"rawtransactions", &submitpackage},
1537 };
1538 for (const auto& c : commands) {
1539 t.appendCommand(c.name, &c);
1540 }
1541}
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:400
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:303
std::vector< FeePerWeight > GetFeerateDiagram() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:1082
bool exists(const Txid &txid) const
Definition: txmempool.h:503
std::set< txiter, CompareIteratorByHash > setEntries
Definition: txmempool.h:268
uint64_t GetSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:574
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
Definition: txmempool.h:265
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:556
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:485
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:497
uint64_t GetTotalTxSize() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:491
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:1166
static UniValue OrphanToJSON(const node::TxOrphanage::OrphanInfo &orphan)
Definition: mempool.cpp:1219
static std::vector< RPCResult > ClusterDescription()
Definition: mempool.cpp:415
static std::vector< RPCResult > OrphanDescription()
Definition: mempool.cpp:1204
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:510
static RPCMethod importmempool()
Definition: mempool.cpp:1105
static RPCMethod submitpackage()
Definition: mempool.cpp:1304
void RegisterMempoolRPCCommands(CRPCTable &t)
Definition: mempool.cpp:1518
static void clusterToJSON(const CTxMemPool &pool, UniValue &info, std::vector< const CTxMemPoolEntry * > cluster) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
Definition: mempool.cpp:476
UniValue MempoolInfoToJSON(const CTxMemPool &pool)
Mempool information to JSON.
Definition: mempool.cpp:1045
static RPCMethod getmempoolcluster()
Definition: mempool.cpp:831
static RPCMethod getmempoolentry()
Definition: mempool.cpp:866
static std::vector< RPCResult > MempoolEntryDescription()
Definition: mempool.cpp:433
static RPCMethod getprivatebroadcastinfo()
Definition: mempool.cpp:142
static RPCMethod getmempoolancestors()
Definition: mempool.cpp:705
void AppendChunkInfo(UniValue &all_chunks, FeePerWeight chunk_feerate, std::vector< const CTxMemPoolEntry * > chunk_txs)
Definition: mempool.cpp:463
static RPCMethod getorphantxs()
Definition: mempool.cpp:1235
UniValue MempoolToJSON(const CTxMemPool &pool, bool verbose, bool include_mempool_sequence)
Mempool to JSON.
Definition: mempool.cpp:573
static RPCMethod getmempooldescendants()
Definition: mempool.cpp:766
static RPCMethod gettxspendingprevout()
Definition: mempool.cpp:899
static RPCMethod getrawmempool()
Definition: mempool.cpp:654
static RPCMethod abortprivatebroadcast()
Definition: mempool.cpp:209
static RPCMethod getmempoolfeeratediagram()
Definition: mempool.cpp:611
static RPCMethod getmempoolinfo()
Definition: mempool.cpp:1069
@ 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
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:108
int32_t size
Definition: feefrac.h:109
Tagged wrapper around FeeFrac to avoid unit confusion.
Definition: feefrac.h:240
@ 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:96
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)