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