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