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