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