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