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