Bitcoin Core 29.99.0
P2P Digital Currency
mempool.cpp
Go to the documentation of this file.
1// Copyright (c) 2010 Satoshi Nakamoto
2// Copyright (c) 2009-2022 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>
12#include <core_io.h>
14#include <net_processing.h>
16#include <node/types.h>
17#include <policy/rbf.h>
18#include <policy/settings.h>
20#include <rpc/server.h>
21#include <rpc/server_util.h>
22#include <rpc/util.h>
23#include <txmempool.h>
24#include <univalue.h>
25#include <util/fs.h>
26#include <util/moneystr.h>
27#include <util/strencodings.h>
28#include <util/time.h>
29#include <util/vector.h>
30
31#include <utility>
32
34
40using util::ToString;
41
43{
44 return RPCHelpMan{
45 "sendrawtransaction",
46 "Submit a raw transaction (serialized, hex-encoded) to local node and network.\n"
47 "\nThe transaction will be sent unconditionally to all peers, so using sendrawtransaction\n"
48 "for manual rebroadcast may degrade privacy by leaking the transaction's origin, as\n"
49 "nodes will normally not rebroadcast non-wallet transactions already in their mempool.\n"
50 "\nA specific exception, RPC_TRANSACTION_ALREADY_IN_UTXO_SET, may throw if the transaction cannot be added to the mempool.\n"
51 "\nRelated RPCs: createrawtransaction, signrawtransactionwithkey\n",
52 {
53 {"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex string of the raw transaction"},
55 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
56 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
58 "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"
59 "If burning funds through unspendable outputs is desired, increase this value.\n"
60 "This check is based on heuristics and does not guarantee spendability of outputs.\n"},
61 },
63 RPCResult::Type::STR_HEX, "", "The transaction hash in hex"
64 },
66 "\nCreate a transaction\n"
67 + HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
68 "Sign the transaction, and get back the hex\n"
69 + HelpExampleCli("signrawtransactionwithwallet", "\"myhex\"") +
70 "\nSend the transaction (signed hex)\n"
71 + HelpExampleCli("sendrawtransaction", "\"signedhex\"") +
72 "\nAs a JSON-RPC call\n"
73 + HelpExampleRpc("sendrawtransaction", "\"signedhex\"")
74 },
75 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
76 {
77 const CAmount max_burn_amount = request.params[2].isNull() ? 0 : AmountFromValue(request.params[2]);
78
80 if (!DecodeHexTx(mtx, request.params[0].get_str())) {
81 throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed. Make sure the tx has at least one input.");
82 }
83
84 for (const auto& out : mtx.vout) {
85 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
86 throw JSONRPCTransactionError(TransactionError::MAX_BURN_EXCEEDED);
87 }
88 }
89
90 CTransactionRef tx(MakeTransactionRef(std::move(mtx)));
91
92 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
93
94 int64_t virtual_size = GetVirtualTransactionSize(*tx);
95 CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
96
97 std::string err_string;
99 NodeContext& node = EnsureAnyNodeContext(request.context);
100 const TransactionError err = BroadcastTransaction(node, tx, err_string, max_raw_tx_fee, /*relay=*/true, /*wait_callback=*/true);
101 if (TransactionError::OK != err) {
102 throw JSONRPCTransactionError(err, err_string);
103 }
104
105 return tx->GetHash().GetHex();
106 },
107 };
108}
109
111{
112 return RPCHelpMan{
113 "testmempoolaccept",
114 "Returns result of mempool acceptance tests indicating if raw transaction(s) (serialized, hex-encoded) would be accepted by mempool.\n"
115 "\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"
116 "\nIf one transaction fails, other transactions may not be fully validated (the 'allowed' key will be blank).\n"
117 "\nThe maximum number of transactions allowed is " + ToString(MAX_PACKAGE_COUNT) + ".\n"
118 "\nThis checks if transactions violate the consensus or policy rules.\n"
119 "\nSee sendrawtransaction call.\n",
120 {
121 {"rawtxs", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of hex strings of raw transactions.",
122 {
124 },
125 },
127 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
128 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
129 },
130 RPCResult{
131 RPCResult::Type::ARR, "", "The result of the mempool acceptance test for each raw transaction in the input array.\n"
132 "Returns results for each transaction in the same order they were passed in.\n"
133 "Transactions that cannot be fully validated due to failures in other transactions will not contain an 'allowed' result.\n",
134 {
135 {RPCResult::Type::OBJ, "", "",
136 {
137 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
138 {RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
139 {RPCResult::Type::STR, "package-error", /*optional=*/true, "Package validation error, if any (only possible if rawtxs had more than 1 transaction)."},
140 {RPCResult::Type::BOOL, "allowed", /*optional=*/true, "Whether this tx would be accepted to the mempool and pass client-specified maxfeerate. "
141 "If not present, the tx was not fully validated due to a failure in another tx in the list."},
142 {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)"},
143 {RPCResult::Type::OBJ, "fees", /*optional=*/true, "Transaction fees (only present if 'allowed' is true)",
144 {
145 {RPCResult::Type::STR_AMOUNT, "base", "transaction fee in " + CURRENCY_UNIT},
146 {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."},
147 {RPCResult::Type::ARR, "effective-includes", /*optional=*/false, "transactions whose fees and vsizes are included in effective-feerate.",
148 {RPCResult{RPCResult::Type::STR_HEX, "", "transaction wtxid in hex"},
149 }},
150 }},
151 {RPCResult::Type::STR, "reject-reason", /*optional=*/true, "Rejection reason (only present when 'allowed' is false)"},
152 {RPCResult::Type::STR, "reject-details", /*optional=*/true, "Rejection details (only present when 'allowed' is false and rejection details exist)"},
153 }},
154 }
155 },
157 "\nCreate a transaction\n"
158 + HelpExampleCli("createrawtransaction", "\"[{\\\"txid\\\" : \\\"mytxid\\\",\\\"vout\\\":0}]\" \"{\\\"myaddress\\\":0.01}\"") +
159 "Sign the transaction, and get back the hex\n"
160 + HelpExampleCli("signrawtransactionwithwallet", "\"myhex\"") +
161 "\nTest acceptance of the transaction (signed hex)\n"
162 + HelpExampleCli("testmempoolaccept", R"('["signedhex"]')") +
163 "\nAs a JSON-RPC call\n"
164 + HelpExampleRpc("testmempoolaccept", "[\"signedhex\"]")
165 },
166 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
167 {
168 const UniValue raw_transactions = request.params[0].get_array();
169 if (raw_transactions.size() < 1 || raw_transactions.size() > MAX_PACKAGE_COUNT) {
171 "Array must contain between 1 and " + ToString(MAX_PACKAGE_COUNT) + " transactions.");
172 }
173
174 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
175
176 std::vector<CTransactionRef> txns;
177 txns.reserve(raw_transactions.size());
178 for (const auto& rawtx : raw_transactions.getValues()) {
180 if (!DecodeHexTx(mtx, rawtx.get_str())) {
182 "TX decode failed: " + rawtx.get_str() + " Make sure the tx has at least one input.");
183 }
184 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
185 }
186
187 NodeContext& node = EnsureAnyNodeContext(request.context);
188 CTxMemPool& mempool = EnsureMemPool(node);
190 Chainstate& chainstate = chainman.ActiveChainstate();
191 const PackageMempoolAcceptResult package_result = [&] {
193 if (txns.size() > 1) return ProcessNewPackage(chainstate, mempool, txns, /*test_accept=*/true, /*client_maxfeerate=*/{});
194 return PackageMempoolAcceptResult(txns[0]->GetWitnessHash(),
195 chainman.ProcessTransaction(txns[0], /*test_accept=*/true));
196 }();
197
198 UniValue rpc_result(UniValue::VARR);
199 // We will check transaction fees while we iterate through txns in order. If any transaction fee
200 // exceeds maxfeerate, we will leave the rest of the validation results blank, because it
201 // doesn't make sense to return a validation result for a transaction if its ancestor(s) would
202 // not be submitted.
203 bool exit_early{false};
204 for (const auto& tx : txns) {
205 UniValue result_inner(UniValue::VOBJ);
206 result_inner.pushKV("txid", tx->GetHash().GetHex());
207 result_inner.pushKV("wtxid", tx->GetWitnessHash().GetHex());
209 result_inner.pushKV("package-error", package_result.m_state.ToString());
210 }
211 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
212 if (exit_early || it == package_result.m_tx_results.end()) {
213 // Validation unfinished. Just return the txid and wtxid.
214 rpc_result.push_back(std::move(result_inner));
215 continue;
216 }
217 const auto& tx_result = it->second;
218 // Package testmempoolaccept doesn't allow transactions to already be in the mempool.
220 if (tx_result.m_result_type == MempoolAcceptResult::ResultType::VALID) {
221 const CAmount fee = tx_result.m_base_fees.value();
222 // Check that fee does not exceed maximum fee
223 const int64_t virtual_size = tx_result.m_vsize.value();
224 const CAmount max_raw_tx_fee = max_raw_tx_fee_rate.GetFee(virtual_size);
225 if (max_raw_tx_fee && fee > max_raw_tx_fee) {
226 result_inner.pushKV("allowed", false);
227 result_inner.pushKV("reject-reason", "max-fee-exceeded");
228 exit_early = true;
229 } else {
230 // Only return the fee and vsize if the transaction would pass ATMP.
231 // These can be used to calculate the feerate.
232 result_inner.pushKV("allowed", true);
233 result_inner.pushKV("vsize", virtual_size);
235 fees.pushKV("base", ValueFromAmount(fee));
236 fees.pushKV("effective-feerate", ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
237 UniValue effective_includes_res(UniValue::VARR);
238 for (const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
239 effective_includes_res.push_back(wtxid.ToString());
240 }
241 fees.pushKV("effective-includes", std::move(effective_includes_res));
242 result_inner.pushKV("fees", std::move(fees));
243 }
244 } else {
245 result_inner.pushKV("allowed", false);
246 const TxValidationState state = tx_result.m_state;
248 result_inner.pushKV("reject-reason", "missing-inputs");
249 } else {
250 result_inner.pushKV("reject-reason", state.GetRejectReason());
251 result_inner.pushKV("reject-details", state.ToString());
252 }
253 }
254 rpc_result.push_back(std::move(result_inner));
255 }
256 return rpc_result;
257 },
258 };
259}
260
261static std::vector<RPCResult> MempoolEntryDescription()
262{
263 return {
264 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."},
265 RPCResult{RPCResult::Type::NUM, "weight", "transaction weight as defined in BIP 141."},
266 RPCResult{RPCResult::Type::NUM_TIME, "time", "local time transaction entered pool in seconds since 1 Jan 1970 GMT"},
267 RPCResult{RPCResult::Type::NUM, "height", "block height when transaction entered pool"},
268 RPCResult{RPCResult::Type::NUM, "descendantcount", "number of in-mempool descendant transactions (including this one)"},
269 RPCResult{RPCResult::Type::NUM, "descendantsize", "virtual transaction size of in-mempool descendants (including this one)"},
270 RPCResult{RPCResult::Type::NUM, "ancestorcount", "number of in-mempool ancestor transactions (including this one)"},
271 RPCResult{RPCResult::Type::NUM, "ancestorsize", "virtual transaction size of in-mempool ancestors (including this one)"},
272 RPCResult{RPCResult::Type::STR_HEX, "wtxid", "hash of serialized transaction, including witness data"},
274 {
275 RPCResult{RPCResult::Type::STR_AMOUNT, "base", "transaction fee, denominated in " + CURRENCY_UNIT},
276 RPCResult{RPCResult::Type::STR_AMOUNT, "modified", "transaction fee with fee deltas used for mining priority, denominated in " + CURRENCY_UNIT},
277 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},
278 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},
279 }},
280 RPCResult{RPCResult::Type::ARR, "depends", "unconfirmed transactions used as inputs for this transaction",
281 {RPCResult{RPCResult::Type::STR_HEX, "transactionid", "parent transaction id"}}},
282 RPCResult{RPCResult::Type::ARR, "spentby", "unconfirmed transactions spending outputs from this transaction",
283 {RPCResult{RPCResult::Type::STR_HEX, "transactionid", "child transaction id"}}},
284 RPCResult{RPCResult::Type::BOOL, "bip125-replaceable", "Whether this transaction signals BIP125 replaceability or has an unconfirmed ancestor signaling BIP125 replaceability. (DEPRECATED)\n"},
285 RPCResult{RPCResult::Type::BOOL, "unbroadcast", "Whether this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)"},
286 };
287}
288
289static void entryToJSON(const CTxMemPool& pool, UniValue& info, const CTxMemPoolEntry& e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
290{
291 AssertLockHeld(pool.cs);
292
293 info.pushKV("vsize", (int)e.GetTxSize());
294 info.pushKV("weight", (int)e.GetTxWeight());
295 info.pushKV("time", count_seconds(e.GetTime()));
296 info.pushKV("height", (int)e.GetHeight());
297 info.pushKV("descendantcount", e.GetCountWithDescendants());
298 info.pushKV("descendantsize", e.GetSizeWithDescendants());
299 info.pushKV("ancestorcount", e.GetCountWithAncestors());
300 info.pushKV("ancestorsize", e.GetSizeWithAncestors());
301 info.pushKV("wtxid", e.GetTx().GetWitnessHash().ToString());
302
304 fees.pushKV("base", ValueFromAmount(e.GetFee()));
305 fees.pushKV("modified", ValueFromAmount(e.GetModifiedFee()));
306 fees.pushKV("ancestor", ValueFromAmount(e.GetModFeesWithAncestors()));
307 fees.pushKV("descendant", ValueFromAmount(e.GetModFeesWithDescendants()));
308 info.pushKV("fees", std::move(fees));
309
310 const CTransaction& tx = e.GetTx();
311 std::set<std::string> setDepends;
312 for (const CTxIn& txin : tx.vin)
313 {
314 if (pool.exists(txin.prevout.hash))
315 setDepends.insert(txin.prevout.hash.ToString());
316 }
317
318 UniValue depends(UniValue::VARR);
319 for (const std::string& dep : setDepends)
320 {
321 depends.push_back(dep);
322 }
323
324 info.pushKV("depends", std::move(depends));
325
327 for (const CTxMemPoolEntry& child : e.GetMemPoolChildrenConst()) {
328 spent.push_back(child.GetTx().GetHash().ToString());
329 }
330
331 info.pushKV("spentby", std::move(spent));
332
333 // Add opt-in RBF status
334 bool rbfStatus = false;
335 RBFTransactionState rbfState = IsRBFOptIn(tx, pool);
336 if (rbfState == RBFTransactionState::UNKNOWN) {
337 throw JSONRPCError(RPC_MISC_ERROR, "Transaction is not in mempool");
338 } else if (rbfState == RBFTransactionState::REPLACEABLE_BIP125) {
339 rbfStatus = true;
340 }
341
342 info.pushKV("bip125-replaceable", rbfStatus);
343 info.pushKV("unbroadcast", pool.IsUnbroadcastTx(tx.GetHash()));
344}
345
346UniValue MempoolToJSON(const CTxMemPool& pool, bool verbose, bool include_mempool_sequence)
347{
348 if (verbose) {
349 if (include_mempool_sequence) {
350 throw JSONRPCError(RPC_INVALID_PARAMETER, "Verbose results cannot contain mempool sequence values.");
351 }
352 LOCK(pool.cs);
354 for (const CTxMemPoolEntry& e : pool.entryAll()) {
356 entryToJSON(pool, info, e);
357 // Mempool has unique entries so there is no advantage in using
358 // UniValue::pushKV, which checks if the key already exists in O(N).
359 // UniValue::pushKVEnd is used instead which currently is O(1).
360 o.pushKVEnd(e.GetTx().GetHash().ToString(), std::move(info));
361 }
362 return o;
363 } else {
365 uint64_t mempool_sequence;
366 {
367 LOCK(pool.cs);
368 for (const CTxMemPoolEntry& e : pool.entryAll()) {
369 a.push_back(e.GetTx().GetHash().ToString());
370 }
371 mempool_sequence = pool.GetSequence();
372 }
373 if (!include_mempool_sequence) {
374 return a;
375 } else {
377 o.pushKV("txids", std::move(a));
378 o.pushKV("mempool_sequence", mempool_sequence);
379 return o;
380 }
381 }
382}
383
385{
386 return RPCHelpMan{
387 "getrawmempool",
388 "Returns all transaction ids in memory pool as a json array of string transaction ids.\n"
389 "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n",
390 {
391 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
392 {"mempool_sequence", RPCArg::Type::BOOL, RPCArg::Default{false}, "If verbose=false, returns a json object with transaction list and mempool sequence number attached."},
393 },
394 {
395 RPCResult{"for verbose = false",
396 RPCResult::Type::ARR, "", "",
397 {
398 {RPCResult::Type::STR_HEX, "", "The transaction id"},
399 }},
400 RPCResult{"for verbose = true",
402 {
403 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
404 }},
405 RPCResult{"for verbose = false and mempool_sequence = true",
406 RPCResult::Type::OBJ, "", "",
407 {
408 {RPCResult::Type::ARR, "txids", "",
409 {
410 {RPCResult::Type::STR_HEX, "", "The transaction id"},
411 }},
412 {RPCResult::Type::NUM, "mempool_sequence", "The mempool sequence value."},
413 }},
414 },
416 HelpExampleCli("getrawmempool", "true")
417 + HelpExampleRpc("getrawmempool", "true")
418 },
419 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
420{
421 bool fVerbose = false;
422 if (!request.params[0].isNull())
423 fVerbose = request.params[0].get_bool();
424
425 bool include_mempool_sequence = false;
426 if (!request.params[1].isNull()) {
427 include_mempool_sequence = request.params[1].get_bool();
428 }
429
430 return MempoolToJSON(EnsureAnyMemPool(request.context), fVerbose, include_mempool_sequence);
431},
432 };
433}
434
436{
437 return RPCHelpMan{
438 "getmempoolancestors",
439 "If txid is in the mempool, returns all in-mempool ancestors.\n",
440 {
441 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
442 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
443 },
444 {
445 RPCResult{"for verbose = false",
446 RPCResult::Type::ARR, "", "",
447 {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool ancestor transaction"}}},
448 RPCResult{"for verbose = true",
450 {
451 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
452 }},
453 },
455 HelpExampleCli("getmempoolancestors", "\"mytxid\"")
456 + HelpExampleRpc("getmempoolancestors", "\"mytxid\"")
457 },
458 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
459{
460 bool fVerbose = false;
461 if (!request.params[1].isNull())
462 fVerbose = request.params[1].get_bool();
463
464 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
465
466 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
467 LOCK(mempool.cs);
468
469 const auto entry{mempool.GetEntry(txid)};
470 if (entry == nullptr) {
471 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
472 }
473
474 auto ancestors{mempool.AssumeCalculateMemPoolAncestors(self.m_name, *entry, CTxMemPool::Limits::NoLimits(), /*fSearchForParents=*/false)};
475
476 if (!fVerbose) {
478 for (CTxMemPool::txiter ancestorIt : ancestors) {
479 o.push_back(ancestorIt->GetTx().GetHash().ToString());
480 }
481 return o;
482 } else {
484 for (CTxMemPool::txiter ancestorIt : ancestors) {
485 const CTxMemPoolEntry &e = *ancestorIt;
487 entryToJSON(mempool, info, e);
488 o.pushKV(e.GetTx().GetHash().ToString(), std::move(info));
489 }
490 return o;
491 }
492},
493 };
494}
495
497{
498 return RPCHelpMan{
499 "getmempooldescendants",
500 "If txid is in the mempool, returns all in-mempool descendants.\n",
501 {
502 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
503 {"verbose", RPCArg::Type::BOOL, RPCArg::Default{false}, "True for a json object, false for array of transaction ids"},
504 },
505 {
506 RPCResult{"for verbose = false",
507 RPCResult::Type::ARR, "", "",
508 {{RPCResult::Type::STR_HEX, "", "The transaction id of an in-mempool descendant transaction"}}},
509 RPCResult{"for verbose = true",
511 {
512 {RPCResult::Type::OBJ, "transactionid", "", MempoolEntryDescription()},
513 }},
514 },
516 HelpExampleCli("getmempooldescendants", "\"mytxid\"")
517 + HelpExampleRpc("getmempooldescendants", "\"mytxid\"")
518 },
519 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
520{
521 bool fVerbose = false;
522 if (!request.params[1].isNull())
523 fVerbose = request.params[1].get_bool();
524
525 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
526
527 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
528 LOCK(mempool.cs);
529
530 const auto it{mempool.GetIter(txid)};
531 if (!it) {
532 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
533 }
534
535 CTxMemPool::setEntries setDescendants;
536 mempool.CalculateDescendants(*it, setDescendants);
537 // CTxMemPool::CalculateDescendants will include the given tx
538 setDescendants.erase(*it);
539
540 if (!fVerbose) {
542 for (CTxMemPool::txiter descendantIt : setDescendants) {
543 o.push_back(descendantIt->GetTx().GetHash().ToString());
544 }
545
546 return o;
547 } else {
549 for (CTxMemPool::txiter descendantIt : setDescendants) {
550 const CTxMemPoolEntry &e = *descendantIt;
552 entryToJSON(mempool, info, e);
553 o.pushKV(e.GetTx().GetHash().ToString(), std::move(info));
554 }
555 return o;
556 }
557},
558 };
559}
560
562{
563 return RPCHelpMan{
564 "getmempoolentry",
565 "Returns mempool data for given transaction\n",
566 {
567 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id (must be in mempool)"},
568 },
569 RPCResult{
572 HelpExampleCli("getmempoolentry", "\"mytxid\"")
573 + HelpExampleRpc("getmempoolentry", "\"mytxid\"")
574 },
575 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
576{
577 auto txid{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
578
579 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
580 LOCK(mempool.cs);
581
582 const auto entry{mempool.GetEntry(txid)};
583 if (entry == nullptr) {
584 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction not in mempool");
585 }
586
588 entryToJSON(mempool, info, *entry);
589 return info;
590},
591 };
592}
593
595{
596 return RPCHelpMan{"gettxspendingprevout",
597 "Scans the mempool to find transactions spending any of the given outputs",
598 {
599 {"outputs", RPCArg::Type::ARR, RPCArg::Optional::NO, "The transaction outputs that we want to check, and within each, the txid (string) vout (numeric).",
600 {
602 {
603 {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
604 {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
605 },
606 },
607 },
608 },
609 },
610 RPCResult{
611 RPCResult::Type::ARR, "", "",
612 {
613 {RPCResult::Type::OBJ, "", "",
614 {
615 {RPCResult::Type::STR_HEX, "txid", "the transaction id of the checked output"},
616 {RPCResult::Type::NUM, "vout", "the vout value of the checked output"},
617 {RPCResult::Type::STR_HEX, "spendingtxid", /*optional=*/true, "the transaction id of the mempool transaction spending this output (omitted if unspent)"},
618 }},
619 }
620 },
622 HelpExampleCli("gettxspendingprevout", "\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
623 + HelpExampleRpc("gettxspendingprevout", "\"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":3}]\"")
624 },
625 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
626 {
627 const UniValue& output_params = request.params[0].get_array();
628 if (output_params.empty()) {
629 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, outputs are missing");
630 }
631
632 std::vector<COutPoint> prevouts;
633 prevouts.reserve(output_params.size());
634
635 for (unsigned int idx = 0; idx < output_params.size(); idx++) {
636 const UniValue& o = output_params[idx].get_obj();
637
639 {
640 {"txid", UniValueType(UniValue::VSTR)},
641 {"vout", UniValueType(UniValue::VNUM)},
642 }, /*fAllowNull=*/false, /*fStrict=*/true);
643
644 const Txid txid = Txid::FromUint256(ParseHashO(o, "txid"));
645 const int nOutput{o.find_value("vout").getInt<int>()};
646 if (nOutput < 0) {
647 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout cannot be negative");
648 }
649
650 prevouts.emplace_back(txid, nOutput);
651 }
652
653 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
654 LOCK(mempool.cs);
655
656 UniValue result{UniValue::VARR};
657
658 for (const COutPoint& prevout : prevouts) {
660 o.pushKV("txid", prevout.hash.ToString());
661 o.pushKV("vout", (uint64_t)prevout.n);
662
663 const CTransaction* spendingTx = mempool.GetConflictTx(prevout);
664 if (spendingTx != nullptr) {
665 o.pushKV("spendingtxid", spendingTx->GetHash().ToString());
666 }
667
668 result.push_back(std::move(o));
669 }
670
671 return result;
672 },
673 };
674}
675
677{
678 // Make sure this call is atomic in the pool.
679 LOCK(pool.cs);
681 ret.pushKV("loaded", pool.GetLoadTried());
682 ret.pushKV("size", (int64_t)pool.size());
683 ret.pushKV("bytes", (int64_t)pool.GetTotalTxSize());
684 ret.pushKV("usage", (int64_t)pool.DynamicMemoryUsage());
685 ret.pushKV("total_fee", ValueFromAmount(pool.GetTotalFee()));
686 ret.pushKV("maxmempool", pool.m_opts.max_size_bytes);
687 ret.pushKV("mempoolminfee", ValueFromAmount(std::max(pool.GetMinFee(), pool.m_opts.min_relay_feerate).GetFeePerK()));
688 ret.pushKV("minrelaytxfee", ValueFromAmount(pool.m_opts.min_relay_feerate.GetFeePerK()));
689 ret.pushKV("incrementalrelayfee", ValueFromAmount(pool.m_opts.incremental_relay_feerate.GetFeePerK()));
690 ret.pushKV("unbroadcastcount", uint64_t{pool.GetUnbroadcastTxs().size()});
691 ret.pushKV("fullrbf", true);
692 ret.pushKV("permitbaremultisig", pool.m_opts.permit_bare_multisig);
693 ret.pushKV("maxdatacarriersize", pool.m_opts.max_datacarrier_bytes.value_or(0));
694 return ret;
695}
696
698{
699 return RPCHelpMan{"getmempoolinfo",
700 "Returns details on the active state of the TX memory pool.",
701 {},
702 RPCResult{
703 RPCResult::Type::OBJ, "", "",
704 {
705 {RPCResult::Type::BOOL, "loaded", "True if the initial load attempt of the persisted mempool finished"},
706 {RPCResult::Type::NUM, "size", "Current tx count"},
707 {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"},
708 {RPCResult::Type::NUM, "usage", "Total memory usage for the mempool"},
709 {RPCResult::Type::STR_AMOUNT, "total_fee", "Total fees for the mempool in " + CURRENCY_UNIT + ", ignoring modified fees through prioritisetransaction"},
710 {RPCResult::Type::NUM, "maxmempool", "Maximum memory usage for the mempool"},
711 {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"},
712 {RPCResult::Type::STR_AMOUNT, "minrelaytxfee", "Current minimum relay fee for transactions"},
713 {RPCResult::Type::NUM, "incrementalrelayfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},
714 {RPCResult::Type::NUM, "unbroadcastcount", "Current number of transactions that haven't passed initial broadcast yet"},
715 {RPCResult::Type::BOOL, "fullrbf", "True if the mempool accepts RBF without replaceability signaling inspection (DEPRECATED)"},
716 {RPCResult::Type::BOOL, "permitbaremultisig", "True if the mempool accepts transactions with bare multisig outputs"},
717 {RPCResult::Type::NUM, "maxdatacarriersize", "Maximum number of bytes that can be used by OP_RETURN outputs in the mempool"},
718 }},
720 HelpExampleCli("getmempoolinfo", "")
721 + HelpExampleRpc("getmempoolinfo", "")
722 },
723 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
724{
725 return MempoolInfoToJSON(EnsureAnyMemPool(request.context));
726},
727 };
728}
729
731{
732 return RPCHelpMan{
733 "importmempool",
734 "Import a mempool.dat file and attempt to add its contents to the mempool.\n"
735 "Warning: Importing untrusted files is dangerous, especially if metadata from the file is taken over.",
736 {
737 {"filepath", RPCArg::Type::STR, RPCArg::Optional::NO, "The mempool file"},
738 {"options",
741 "",
742 {
743 {"use_current_time", RPCArg::Type::BOOL, RPCArg::Default{true},
744 "Whether to use the current system time or use the entry time metadata from the mempool file.\n"
745 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
746 {"apply_fee_delta_priority", RPCArg::Type::BOOL, RPCArg::Default{false},
747 "Whether to apply the fee delta metadata from the mempool file.\n"
748 "It will be added to any existing fee deltas.\n"
749 "The fee delta can be set by the prioritisetransaction RPC.\n"
750 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior.\n"
751 "Only set this bool if you understand what it does."},
752 {"apply_unbroadcast_set", RPCArg::Type::BOOL, RPCArg::Default{false},
753 "Whether to apply the unbroadcast set metadata from the mempool file.\n"
754 "Warning: Importing untrusted metadata may lead to unexpected issues and undesirable behavior."},
755 },
756 RPCArgOptions{.oneline_description = "options"}},
757 },
758 RPCResult{RPCResult::Type::OBJ, "", "", std::vector<RPCResult>{}},
759 RPCExamples{HelpExampleCli("importmempool", "/path/to/mempool.dat") + HelpExampleRpc("importmempool", "/path/to/mempool.dat")},
760 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
761 const NodeContext& node{EnsureAnyNodeContext(request.context)};
762
763 CTxMemPool& mempool{EnsureMemPool(node)};
765 Chainstate& chainstate = chainman.ActiveChainstate();
766
767 if (chainman.IsInitialBlockDownload()) {
768 throw JSONRPCError(RPC_CLIENT_IN_INITIAL_DOWNLOAD, "Can only import the mempool after the block download and sync is done.");
769 }
770
771 const fs::path load_path{fs::u8path(request.params[0].get_str())};
772 const UniValue& use_current_time{request.params[1]["use_current_time"]};
773 const UniValue& apply_fee_delta{request.params[1]["apply_fee_delta_priority"]};
774 const UniValue& apply_unbroadcast{request.params[1]["apply_unbroadcast_set"]};
776 .use_current_time = use_current_time.isNull() ? true : use_current_time.get_bool(),
777 .apply_fee_delta_priority = apply_fee_delta.isNull() ? false : apply_fee_delta.get_bool(),
778 .apply_unbroadcast_set = apply_unbroadcast.isNull() ? false : apply_unbroadcast.get_bool(),
779 };
780
781 if (!node::LoadMempool(mempool, load_path, chainstate, std::move(opts))) {
782 throw JSONRPCError(RPC_MISC_ERROR, "Unable to import mempool file, see debug.log for details.");
783 }
784
786 return ret;
787 },
788 };
789}
790
792{
793 return RPCHelpMan{
794 "savemempool",
795 "Dumps the mempool to disk. It will fail until the previous dump is fully loaded.\n",
796 {},
797 RPCResult{
798 RPCResult::Type::OBJ, "", "",
799 {
800 {RPCResult::Type::STR, "filename", "the directory and file where the mempool was saved"},
801 }},
803 HelpExampleCli("savemempool", "")
804 + HelpExampleRpc("savemempool", "")
805 },
806 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
807{
808 const ArgsManager& args{EnsureAnyArgsman(request.context)};
809 const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
810
811 if (!mempool.GetLoadTried()) {
812 throw JSONRPCError(RPC_MISC_ERROR, "The mempool was not loaded yet");
813 }
814
815 const fs::path& dump_path = MempoolPath(args);
816
817 if (!DumpMempool(mempool, dump_path)) {
818 throw JSONRPCError(RPC_MISC_ERROR, "Unable to dump mempool to disk");
819 }
820
822 ret.pushKV("filename", dump_path.utf8string());
823
824 return ret;
825},
826 };
827}
828
829static std::vector<RPCResult> OrphanDescription()
830{
831 return {
832 RPCResult{RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
833 RPCResult{RPCResult::Type::STR_HEX, "wtxid", "The transaction witness hash in hex"},
834 RPCResult{RPCResult::Type::NUM, "bytes", "The serialized transaction size in bytes"},
835 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."},
836 RPCResult{RPCResult::Type::NUM, "weight", "The transaction weight as defined in BIP 141."},
838 {
839 RPCResult{RPCResult::Type::NUM, "peer_id", "Peer ID"},
840 }},
841 };
842}
843
845{
847 o.pushKV("txid", orphan.tx->GetHash().ToString());
848 o.pushKV("wtxid", orphan.tx->GetWitnessHash().ToString());
849 o.pushKV("bytes", orphan.tx->GetTotalSize());
850 o.pushKV("vsize", GetVirtualTransactionSize(*orphan.tx));
851 o.pushKV("weight", GetTransactionWeight(*orphan.tx));
853 for (const auto fromPeer: orphan.announcers) {
854 from.push_back(fromPeer);
855 }
856 o.pushKV("from", from);
857 return o;
858}
859
861{
862 return RPCHelpMan{
863 "getorphantxs",
864 "Shows transactions in the tx orphanage.\n"
865 "\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
866 {
867 {"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",
869 },
870 {
871 RPCResult{"for verbose = 0",
872 RPCResult::Type::ARR, "", "",
873 {
874 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
875 }},
876 RPCResult{"for verbose = 1",
877 RPCResult::Type::ARR, "", "",
878 {
880 }},
881 RPCResult{"for verbose = 2",
882 RPCResult::Type::ARR, "", "",
883 {
884 {RPCResult::Type::OBJ, "", "",
885 Cat<std::vector<RPCResult>>(
887 {{RPCResult::Type::STR_HEX, "hex", "The serialized, hex-encoded transaction data"}}
888 )
889 },
890 }},
891 },
893 HelpExampleCli("getorphantxs", "2")
894 + HelpExampleRpc("getorphantxs", "2")
895 },
896 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
897 {
898 const NodeContext& node = EnsureAnyNodeContext(request.context);
899 PeerManager& peerman = EnsurePeerman(node);
900 std::vector<node::TxOrphanage::OrphanInfo> orphanage = peerman.GetOrphanTransactions();
901
902 int verbosity{ParseVerbosity(request.params[0], /*default_verbosity=*/0, /*allow_bool*/false)};
903
905
906 if (verbosity == 0) {
907 for (auto const& orphan : orphanage) {
908 ret.push_back(orphan.tx->GetHash().ToString());
909 }
910 } else if (verbosity == 1) {
911 for (auto const& orphan : orphanage) {
912 ret.push_back(OrphanToJSON(orphan));
913 }
914 } else if (verbosity == 2) {
915 for (auto const& orphan : orphanage) {
916 UniValue o{OrphanToJSON(orphan)};
917 o.pushKV("hex", EncodeHexTx(*orphan.tx));
918 ret.push_back(o);
919 }
920 } else {
921 throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid verbosity value " + ToString(verbosity));
922 }
923
924 return ret;
925 },
926 };
927}
928
930{
931 return RPCHelpMan{"submitpackage",
932 "Submit a package of raw transactions (serialized, hex-encoded) to local node.\n"
933 "The package will be validated according to consensus and mempool policy rules. If any transaction passes, it will be accepted to mempool.\n"
934 "This RPC is experimental and the interface may be unstable. Refer to doc/policy/packages.md for documentation on package policies.\n"
935 "Warning: successful submission does not mean the transactions will propagate throughout the network.\n"
936 ,
937 {
938 {"package", RPCArg::Type::ARR, RPCArg::Optional::NO, "An array of raw transactions.\n"
939 "The package must solely consist of a child transaction and all of its unconfirmed parents, if any. None of the parents may depend on each other.\n"
940 "The package must be topologically sorted, with the child being the last element in the array.",
941 {
943 },
944 },
946 "Reject transactions whose fee rate is higher than the specified value, expressed in " + CURRENCY_UNIT +
947 "/kvB.\nFee rates larger than 1BTC/kvB are rejected.\nSet to 0 to accept any fee rate."},
949 "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"
950 "If burning funds through unspendable outputs is desired, increase this value.\n"
951 "This check is based on heuristics and does not guarantee spendability of outputs.\n"
952 },
953 },
954 RPCResult{
955 RPCResult::Type::OBJ, "", "",
956 {
957 {RPCResult::Type::STR, "package_msg", "The transaction package result message. \"success\" indicates all transactions were accepted into or are already in the mempool."},
958 {RPCResult::Type::OBJ_DYN, "tx-results", "transaction results keyed by wtxid",
959 {
960 {RPCResult::Type::OBJ, "wtxid", "transaction wtxid", {
961 {RPCResult::Type::STR_HEX, "txid", "The transaction hash in hex"},
962 {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."},
963 {RPCResult::Type::NUM, "vsize", /*optional=*/true, "Sigops-adjusted virtual transaction size."},
964 {RPCResult::Type::OBJ, "fees", /*optional=*/true, "Transaction fees", {
965 {RPCResult::Type::STR_AMOUNT, "base", "transaction fee in " + CURRENCY_UNIT},
966 {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."},
967 {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.",
968 {{RPCResult::Type::STR_HEX, "", "transaction wtxid in hex"},
969 }},
970 }},
971 {RPCResult::Type::STR, "error", /*optional=*/true, "The transaction error string, if it was rejected by the mempool"},
972 }}
973 }},
974 {RPCResult::Type::ARR, "replaced-transactions", /*optional=*/true, "List of txids of replaced transactions",
975 {
976 {RPCResult::Type::STR_HEX, "", "The transaction id"},
977 }},
978 },
979 },
981 HelpExampleRpc("submitpackage", R"(["raw-parent-tx-1", "raw-parent-tx-2", "raw-child-tx"])") +
982 HelpExampleCli("submitpackage", R"('["raw-tx-without-unconfirmed-parents"]')")
983 },
984 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
985 {
986 const UniValue raw_transactions = request.params[0].get_array();
987 if (raw_transactions.empty() || raw_transactions.size() > MAX_PACKAGE_COUNT) {
989 "Array must contain between 1 and " + ToString(MAX_PACKAGE_COUNT) + " transactions.");
990 }
991
992 // Fee check needs to be run with chainstate and package context
993 const CFeeRate max_raw_tx_fee_rate{ParseFeeRate(self.Arg<UniValue>("maxfeerate"))};
994 std::optional<CFeeRate> client_maxfeerate{max_raw_tx_fee_rate};
995 // 0-value is special; it's mapped to no sanity check
996 if (max_raw_tx_fee_rate == CFeeRate(0)) {
997 client_maxfeerate = std::nullopt;
998 }
999
1000 // Burn sanity check is run with no context
1001 const CAmount max_burn_amount = request.params[2].isNull() ? 0 : AmountFromValue(request.params[2]);
1002
1003 std::vector<CTransactionRef> txns;
1004 txns.reserve(raw_transactions.size());
1005 for (const auto& rawtx : raw_transactions.getValues()) {
1007 if (!DecodeHexTx(mtx, rawtx.get_str())) {
1009 "TX decode failed: " + rawtx.get_str() + " Make sure the tx has at least one input.");
1010 }
1011
1012 for (const auto& out : mtx.vout) {
1013 if((out.scriptPubKey.IsUnspendable() || !out.scriptPubKey.HasValidOps()) && out.nValue > max_burn_amount) {
1014 throw JSONRPCTransactionError(TransactionError::MAX_BURN_EXCEEDED);
1015 }
1016 }
1017
1018 txns.emplace_back(MakeTransactionRef(std::move(mtx)));
1019 }
1020 CHECK_NONFATAL(!txns.empty());
1021 if (txns.size() > 1 && !IsChildWithParentsTree(txns)) {
1022 throw JSONRPCTransactionError(TransactionError::INVALID_PACKAGE, "package topology disallowed. not child-with-parents or parents depend on each other.");
1023 }
1024
1025 NodeContext& node = EnsureAnyNodeContext(request.context);
1026 CTxMemPool& mempool = EnsureMemPool(node);
1028 const auto package_result = WITH_LOCK(::cs_main, return ProcessNewPackage(chainstate, mempool, txns, /*test_accept=*/ false, client_maxfeerate));
1029
1030 std::string package_msg = "success";
1031
1032 // First catch package-wide errors, continue if we can
1033 switch(package_result.m_state.GetResult()) {
1035 {
1036 // Belt-and-suspenders check; everything should be successful here
1037 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size());
1038 for (const auto& tx : txns) {
1039 CHECK_NONFATAL(mempool.exists(tx->GetHash()));
1040 }
1041 break;
1042 }
1044 {
1045 // This only happens with internal bug; user should stop and report
1046 throw JSONRPCTransactionError(TransactionError::MEMPOOL_ERROR,
1047 package_result.m_state.GetRejectReason());
1048 }
1051 {
1052 // Package-wide error we want to return, but we also want to return individual responses
1053 package_msg = package_result.m_state.ToString();
1054 CHECK_NONFATAL(package_result.m_tx_results.size() == txns.size() ||
1055 package_result.m_tx_results.empty());
1056 break;
1057 }
1058 }
1059
1060 size_t num_broadcast{0};
1061 for (const auto& tx : txns) {
1062 // We don't want to re-submit the txn for validation in BroadcastTransaction
1063 if (!mempool.exists(tx->GetHash())) {
1064 continue;
1065 }
1066
1067 // We do not expect an error here; we are only broadcasting things already/still in mempool
1068 std::string err_string;
1069 const auto err = BroadcastTransaction(node, tx, err_string, /*max_tx_fee=*/0, /*relay=*/true, /*wait_callback=*/true);
1070 if (err != TransactionError::OK) {
1071 throw JSONRPCTransactionError(err,
1072 strprintf("transaction broadcast failed: %s (%d transactions were broadcast successfully)",
1073 err_string, num_broadcast));
1074 }
1075 num_broadcast++;
1076 }
1077
1078 UniValue rpc_result{UniValue::VOBJ};
1079 rpc_result.pushKV("package_msg", package_msg);
1080 UniValue tx_result_map{UniValue::VOBJ};
1081 std::set<Txid> replaced_txids;
1082 for (const auto& tx : txns) {
1083 UniValue result_inner{UniValue::VOBJ};
1084 result_inner.pushKV("txid", tx->GetHash().GetHex());
1085 auto it = package_result.m_tx_results.find(tx->GetWitnessHash());
1086 if (it == package_result.m_tx_results.end()) {
1087 // No results, report error and continue
1088 result_inner.pushKV("error", "unevaluated");
1089 continue;
1090 }
1091 const auto& tx_result = it->second;
1092 switch(it->second.m_result_type) {
1094 result_inner.pushKV("other-wtxid", it->second.m_other_wtxid.value().GetHex());
1095 break;
1097 result_inner.pushKV("error", it->second.m_state.ToString());
1098 break;
1101 result_inner.pushKV("vsize", int64_t{it->second.m_vsize.value()});
1103 fees.pushKV("base", ValueFromAmount(it->second.m_base_fees.value()));
1104 if (tx_result.m_result_type == MempoolAcceptResult::ResultType::VALID) {
1105 // Effective feerate is not provided for MEMPOOL_ENTRY transactions even
1106 // though modified fees is known, because it is unknown whether package
1107 // feerate was used when it was originally submitted.
1108 fees.pushKV("effective-feerate", ValueFromAmount(tx_result.m_effective_feerate.value().GetFeePerK()));
1109 UniValue effective_includes_res(UniValue::VARR);
1110 for (const auto& wtxid : tx_result.m_wtxids_fee_calculations.value()) {
1111 effective_includes_res.push_back(wtxid.ToString());
1112 }
1113 fees.pushKV("effective-includes", std::move(effective_includes_res));
1114 }
1115 result_inner.pushKV("fees", std::move(fees));
1116 for (const auto& ptx : it->second.m_replaced_transactions) {
1117 replaced_txids.insert(ptx->GetHash());
1118 }
1119 break;
1120 }
1121 tx_result_map.pushKV(tx->GetWitnessHash().GetHex(), std::move(result_inner));
1122 }
1123 rpc_result.pushKV("tx-results", std::move(tx_result_map));
1124 UniValue replaced_list(UniValue::VARR);
1125 for (const auto& txid : replaced_txids) replaced_list.push_back(txid.ToString());
1126 rpc_result.pushKV("replaced-transactions", std::move(replaced_list));
1127 return rpc_result;
1128 },
1129 };
1130}
1131
1133{
1134 static const CRPCCommand commands[]{
1135 {"rawtransactions", &sendrawtransaction},
1136 {"rawtransactions", &testmempoolaccept},
1137 {"blockchain", &getmempoolancestors},
1138 {"blockchain", &getmempooldescendants},
1139 {"blockchain", &getmempoolentry},
1140 {"blockchain", &gettxspendingprevout},
1141 {"blockchain", &getmempoolinfo},
1142 {"blockchain", &getrawmempool},
1143 {"blockchain", &importmempool},
1144 {"blockchain", &savemempool},
1145 {"hidden", &getorphantxs},
1146 {"rawtransactions", &submitpackage},
1147 };
1148 for (const auto& c : commands) {
1149 t.appendCommand(c.name, &c);
1150 }
1151}
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
int ret
static CAmount AmountFromValue(const UniValue &value)
Definition: bitcoin-tx.cpp:554
ArgsManager & args
Definition: bitcoind.cpp:277
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:102
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:35
CAmount GetFeePerK() const
Return the fee in satoshis for a vsize of 1000 vbytes.
Definition: feerate.h:63
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:296
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:343
const std::vector< CTxIn > vin
Definition: transaction.h:306
An input of a transaction.
Definition: transaction.h:67
COutPoint prevout
Definition: transaction.h:69
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
Definition: mempool_entry.h:66
const CTransaction & GetTx() const
const Children & GetMemPoolChildrenConst() const
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:281
setEntries AssumeCalculateMemPoolAncestors(std::string_view calling_fn_name, const CTxMemPoolEntry &entry, const Limits &limits, bool fSearchForParents=true) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Same as CalculateMemPoolAncestors, but always returns a (non-optional) setEntries.
Definition: txmempool.cpp:275
std::optional< txiter > GetIter(const Txid &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Returns an iterator to the given hash, if found.
Definition: txmempool.cpp:962
bool GetLoadTried() const
Definition: txmempool.cpp:1218
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
Definition: txmempool.h:367
CFeeRate GetMinFee(size_t sizelimit) const
Definition: txmempool.cpp:1108
size_t DynamicMemoryUsage() const
Definition: txmempool.cpp:1045
const Options m_opts
Definition: txmempool.h:421
bool exists(const Txid &txid) const
Definition: txmempool.h:630
std::set< txiter, CompareIteratorByHash > setEntries
Definition: txmempool.h:373
uint64_t GetSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:699
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
Definition: txmempool.h:370
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:956
std::set< Txid > GetUnbroadcastTxs() const
Returns transactions in unbroadcast set.
Definition: txmempool.h:681
void CalculateDescendants(txiter it, setEntries &setDescendants) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Populate setDescendants with all in-mempool descendants of hash.
Definition: txmempool.cpp:572
unsigned long size() const
Definition: txmempool.h:612
std::vector< CTxMemPoolEntryRef > entryAll() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:846
CAmount GetTotalFee() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:624
uint64_t GetTotalTxSize() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.h:618
const CTxMemPoolEntry * GetEntry(const Txid &txid) const LIFETIMEBOUND EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:872
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:531
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:898
SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(Chainstate ActiveChainstate)() const
Once the background validation chainstate has reached the height which is the base of the UTXO snapsh...
Definition: validation.h:1122
MempoolAcceptResult ProcessTransaction(const CTransactionRef &tx, bool test_accept=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the memory pool.
bool IsInitialBlockDownload() const
Check whether we are doing an initial block download (synchronizing from disk or network)
virtual std::vector< node::TxOrphanage::OrphanInfo > GetOrphanTransactions()=0
const std::string m_name
Definition: util.h:496
auto Arg(std::string_view key) const
Helper to get a required or default-valued request argument.
Definition: util.h:444
void push_back(UniValue val)
Definition: univalue.cpp:104
const UniValue & find_value(std::string_view key) const
Definition: univalue.cpp:233
@ VOBJ
Definition: univalue.h:24
@ VSTR
Definition: univalue.h:24
@ VARR
Definition: univalue.h:24
@ VNUM
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:118
Int getInt() const
Definition: univalue.h:140
const UniValue & get_array() const
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
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)
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_write.cpp:143
UniValue ValueFromAmount(const CAmount amount)
Definition: core_write.cpp:26
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness=false, bool try_witness=true)
Definition: core_read.cpp:196
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:18
static path u8path(const std::string &utf8_str)
Definition: fs.h:75
uint64_t fee
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
Definition: moneystr.cpp:19
Definition: messages.h:20
static const CAmount DEFAULT_MAX_BURN_AMOUNT
Maximum burn value for sendrawtransaction, submitpackage, and testmempoolaccept RPC calls.
Definition: transaction.h:33
TransactionError
Definition: types.h:24
TransactionError BroadcastTransaction(NodeContext &node, const CTransactionRef tx, std::string &err_string, const CAmount &max_tx_fee, bool relay, bool wait_callback)
Submit a transaction to the mempool and (optionally) relay it to all P2P peers.
Definition: transaction.cpp:34
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:27
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:245
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:376
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:424
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:423
UniValue JSONRPCError(int code, const std::string &message)
Definition: request.cpp:70
static UniValue OrphanToJSON(const node::TxOrphanage::OrphanInfo &orphan)
Definition: mempool.cpp:844
static RPCHelpMan getmempoolinfo()
Definition: mempool.cpp:697
static RPCHelpMan sendrawtransaction()
Definition: mempool.cpp:42
static std::vector< RPCResult > OrphanDescription()
Definition: mempool.cpp:829
static void entryToJSON(const CTxMemPool &pool, UniValue &info, const CTxMemPoolEntry &e) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
Definition: mempool.cpp:289
static RPCHelpMan importmempool()
Definition: mempool.cpp:730
void RegisterMempoolRPCCommands(CRPCTable &t)
Definition: mempool.cpp:1132
static RPCHelpMan getrawmempool()
Definition: mempool.cpp:384
static RPCHelpMan getmempoolentry()
Definition: mempool.cpp:561
UniValue MempoolInfoToJSON(const CTxMemPool &pool)
Mempool information to JSON.
Definition: mempool.cpp:676
static RPCHelpMan gettxspendingprevout()
Definition: mempool.cpp:594
static std::vector< RPCResult > MempoolEntryDescription()
Definition: mempool.cpp:261
static RPCHelpMan submitpackage()
Definition: mempool.cpp:929
static RPCHelpMan getorphantxs()
Definition: mempool.cpp:860
UniValue MempoolToJSON(const CTxMemPool &pool, bool verbose, bool include_mempool_sequence)
Mempool to JSON.
Definition: mempool.cpp:346
static RPCHelpMan testmempoolaccept()
Definition: mempool.cpp:110
static RPCHelpMan getmempooldescendants()
Definition: mempool.cpp:496
static RPCHelpMan getmempoolancestors()
Definition: mempool.cpp:435
static RPCHelpMan savemempool()
Definition: mempool.cpp:791
@ 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:186
UniValue JSONRPCTransactionError(TransactionError terr, const std::string &err_string)
Definition: util.cpp:411
CFeeRate ParseFeeRate(const UniValue &json)
Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB).
Definition: util.cpp:113
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
Definition: util.cpp:204
int ParseVerbosity(const UniValue &arg, int default_verbosity, bool allow_bool)
Parses verbosity from provided UniValue.
Definition: util.cpp:86
uint256 ParseHashO(const UniValue &o, std::string_view strKey)
Definition: util.cpp:129
void RPCTypeCheckObj(const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull, bool fStrict)
Definition: util.cpp:59
uint256 ParseHashV(const UniValue &v, std::string_view name)
Utilities: convert hex-encoded Values (throws error if not hex).
Definition: util.cpp:120
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:378
std::vector< CTxOut > vout
Definition: transaction.h:380
@ DIFFERENT_WITNESS
‍Valid, transaction was already in the mempool.
@ INVALID
‍Fully validated, valid.
Validation result for package mempool acceptance.
Definition: validation.h:232
PackageValidationState m_state
Definition: validation.h:233
std::map< Wtxid, MempoolAcceptResult > m_tx_results
Map from wtxid to finished MempoolAcceptResults.
Definition: validation.h:240
@ STR_HEX
Special type that is a STR with only hex chars.
@ AMOUNT
Special type representing a floating point amount (can be either NUM or STR)
@ OBJ_NAMED_PARAMS
Special type that behaves almost exactly like OBJ, defining an options object with a list of pre-defi...
@ 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
static constexpr MemPoolLimits NoLimits()
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:56
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:142
#define LOCK(cs)
Definition: sync.h:259
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:290
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:51
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition: time.h:82
PackageMempoolAcceptResult ProcessNewPackage(Chainstate &active_chainstate, CTxMemPool &pool, const Package &package, bool test_accept, const std::optional< CFeeRate > &client_maxfeerate)
Validate (and maybe submit) a package to the mempool.
AssertLockHeld(pool.cs)