Coverage Report

Created: 2026-04-29 19:21

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