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