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