client.cpp

Go to the documentation of this file.

// Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#include <rpc/client.h>
 
#include <common/args.h>
#include <tinyformat.h>
 
#include <cstdint>
#include <set>
#include <string>
#include <string_view>
 
class CRPCConvertParam {
public:
    std::string methodName; 
    int paramIdx;           
    std::string paramName;  
};
 
static const CRPCConvertParam vRPCConvertParams[] = {
    {"setmocktime", 0, "timestamp"},
    {"mockscheduler", 0, "delta_time"},
    {"utxoupdatepsbt", 1, "descriptors"},
    {"generatetoaddress", 0, "nblocks"},
    {"generatetoaddress", 2, "maxtries"},
    {"generatetodescriptor", 0, "num_blocks"},
    {"generatetodescriptor", 2, "maxtries"},
    {"generateblock", 1, "transactions"},
    {"getnetworkhashps", 0, "nblocks"},
    {"getnetworkhashps", 1, "height"},
    {"sendtoaddress", 1, "amount"},
    {"sendtoaddress", 4, "subtractfeefromamount"},
    {"sendtoaddress", 5, "avoid_reuse"},
    {"settxfee", 0, "amount"},
    {"sethdseed", 0, "newkeypool"},
    {"getreceivedbyaddress", 1, "minconf"},
    {"getreceivedbylabel", 1, "minconf"},
    {"listreceivedbyaddress", 0, "minconf"},
    {"listreceivedbyaddress", 1, "include_empty"},
    {"listreceivedbyaddress", 2, "include_watchonly"},
    {"listreceivedbylabel", 0, "minconf"},
    {"listreceivedbylabel", 1, "include_empty"},
    {"listreceivedbylabel", 2, "include_watchonly"},
    {"getbalance", 1, "minconf"},
    {"getbalance", 2, "include_watchonly"},
    {"getbalance", 3, "avoid_reuse"},
    {"getblockfrompeer", 1, "peer_id"},
    {"getblockhash", 0, "height"},
    {"waitforblockheight", 0, "height"},
    {"waitforblockheight", 1, "timeout"},
    {"waitforblock", 1, "timeout"},
    {"waitfornewblock", 0, "timeout"},
    {"listtransactions", 1, "count"},
    {"listtransactions", 2, "skip"},
    {"listtransactions", 3, "include_watchonly"},
    {"walletpassphrase", 1, "timeout"},
    {"getblocktemplate", 0, "template_request"},
    {"listsinceblock", 1, "target_confirmations"},
    {"listsinceblock", 2, "include_watchonly"},
    {"listsinceblock", 3, "include_removed"},
    {"sendmany", 1, "amounts"},
    {"sendmany", 2, "minconf"},
    {"sendmany", 4, "subtractfeefrom"},
    {"deriveaddresses", 1, "range"},
    {"scantxoutset", 1, "scanobjects"},
    {"addmultisigaddress", 0, "nrequired"},
    {"addmultisigaddress", 1, "keys"},
    {"createmultisig", 0, "nrequired"},
    {"createmultisig", 1, "keys"},
    {"listunspent", 0, "minconf"},
    {"listunspent", 1, "maxconf"},
    {"listunspent", 2, "addresses"},
    {"listunspent", 3, "include_unsafe"},
    {"listunspent", 4, "query_options"},
    {"listunspent", 4, "minimumAmount"},
    {"listunspent", 4, "maximumAmount"},
    {"listunspent", 4, "maximumCount"},
    {"listunspent", 4, "minimumSumAmount"},
    {"getblock", 1, "verbosity"},
    {"getblock", 1, "verbose"},
    {"getblockheader", 1, "verbose"},
    {"getchaintxstats", 0, "nblocks"},
    {"gettransaction", 1, "include_watchonly"},
    {"gettransaction", 2, "verbose"},
    {"getrawtransaction", 1, "verbose"},
    {"createrawtransaction", 0, "inputs"},
    {"createrawtransaction", 1, "outputs"},
    {"createrawtransaction", 2, "locktime"},
    {"signrawtransactionwithkey", 1, "privkeys"},
    {"signrawtransactionwithkey", 2, "prevtxs"},
    {"signrawtransactionwithwallet", 1, "prevtxs"},
    {"sendrawtransaction", 1, "maxfeerate"},
    {"submitpackage", 0, "package"},
    {"testmempoolaccept", 0, "rawtxs"},
    {"testmempoolaccept", 1, "maxfeerate"},
    {"combinerawtransaction", 0, "txs"},
    {"fundrawtransaction", 1, "options"},
    {"fundrawtransaction", 1, "add_inputs"},
    {"fundrawtransaction", 1, "include_unsafe"},
    {"fundrawtransaction", 1, "changePosition"},
    {"fundrawtransaction", 1, "includeWatching"},
    {"fundrawtransaction", 1, "lockUnspents"},
    {"fundrawtransaction", 1, "feeRate"},
    {"fundrawtransaction", 1, "subtractFeeFromOutputs"},
    {"walletcreatefundedpsbt", 0, "inputs"},
    {"walletcreatefundedpsbt", 1, "outputs"},
    {"walletcreatefundedpsbt", 2, "locktime"},
    {"walletcreatefundedpsbt", 3, "options"},
    {"walletcreatefundedpsbt", 3, "add_inputs"},
    {"walletcreatefundedpsbt", 3, "include_unsafe"},
    {"walletcreatefundedpsbt", 3, "changePosition"},
    {"walletcreatefundedpsbt", 3, "includeWatching"},
    {"walletcreatefundedpsbt", 3, "lockUnspents"},
    {"walletcreatefundedpsbt", 3, "feeRate"},
    {"walletcreatefundedpsbt", 3, "subtractFeeFromOutputs"},
    {"walletcreatefundedpsbt", 4, "bip32derivs"},
    {"walletprocesspsbt", 1, "sign"},
    {"walletprocesspsbt", 3, "bip32derivs"},
    {"createpsbt", 0, "inputs"},
    {"createpsbt", 1, "outputs"},
    {"createpsbt", 2, "locktime"},
    {"combinepsbt", 0, "txs"},
    {"joinpsbts", 0, "txs"},
    {"finalizepsbt", 1, "extract"},
    {"converttopsbt", 1, "permitsigdata"},
    {"gettxout", 1, "n"},
    {"gettxout", 2, "include_mempool"},
    {"gettxoutproof", 0, "txids"},
    {"gettxoutsetinfo", 1, "hash_or_height"},
    {"gettxoutsetinfo", 2, "use_index"},
    {"dumptxoutset", 2, "options"},
    {"dumptxoutset", 2, "rollback"},
    {"lockunspent", 0, "unlock"},
    {"lockunspent", 1, "transactions"},
    {"send", 0, "outputs"},
    {"send", 1, "options"},
    {"send", 1, "add_inputs"},
    {"send", 1, "include_unsafe"},
    {"send", 1, "add_to_wallet"},
    {"send", 1, "change_position"},
    {"send", 1, "fee_rate"},
    {"send", 1, "include_watching"},
    {"send", 1, "inputs"},
    {"send", 1, "locktime"},
    {"send", 1, "lock_unspents"},
    {"send", 1, "psbt"},
    {"send", 1, "subtract_fee_from_outputs"},
    {"importprivkey", 2, "rescan"},
    {"importaddress", 2, "rescan"},
    {"importaddress", 3, "p2sh"},
    {"importpubkey", 2, "rescan"},
    {"importmempool", 1, "options"},
    {"importmempool", 1, "apply_fee_delta_priority"},
    {"importmempool", 1, "use_current_time"},
    {"importmempool", 1, "apply_unbroadcast_set"},
    {"importmulti", 0, "requests"},
    {"importmulti", 1, "options"},
    {"importmulti", 1, "rescan"},
    {"importdescriptors", 0, "requests"},
    {"verifychain", 0, "checklevel"},
    {"verifychain", 1, "nblocks"},
    {"getblockstats", 0, "hash_or_height"},
    {"getblockstats", 1, "stats"},
    {"pruneblockchain", 0, "height"},
    {"keypoolrefill", 0, "newsize"},
    {"getrawmempool", 0, "verbose"},
    {"getrawmempool", 1, "mempool_sequence"},
    {"prioritisetransaction", 1, "dummy"},
    {"prioritisetransaction", 2, "fee_delta"},
    {"setban", 2, "bantime"},
    {"setban", 3, "absolute"},
    {"setnetworkactive", 0, "state"},
    {"setwalletflag", 1, "value"},
    {"getmempoolancestors", 1, "verbose"},
    {"getmempooldescendants", 1, "verbose"},
    {"disconnectnode", 1, "nodeid"},
    {"logging", 0, "include"},
    {"logging", 1, "exclude"},
    {"upgradewallet", 0, "version"},
    // Echo with conversion (For testing only)
    {"echojson", 0, "arg0"},
    {"echojson", 1, "arg1"},
    {"echojson", 2, "arg2"},
    {"echojson", 3, "arg3"},
    {"echojson", 4, "arg4"},
    {"echojson", 5, "arg5"},
    {"echojson", 6, "arg6"},
    {"echojson", 7, "arg7"},
    {"echojson", 8, "arg8"},
    {"echojson", 9, "arg9"},
    {"rescanblockchain", 0, "start_height"},
    {"rescanblockchain", 1, "stop_height"},
    {"createwallet", 1, "disable_private_keys"},
    {"createwallet", 2, "blank"},
    {"createwallet", 4, "avoid_reuse"},
    {"createwallet", 5, "descriptors"},
    {"createwallet", 6, "load_on_startup"},
    {"restorewallet", 2, "load_on_startup"},
    {"loadwallet", 1, "load_on_startup"},
    {"unloadwallet", 1, "load_on_startup"},
    {"getnodeaddresses", 0, "count"},
    {"addpeeraddress", 1, "port"},
    {"addpeeraddress", 2, "tried"},
    {"sendmsgtopeer", 0, "peer_id"},
    {"stop", 0, "wait"},
    {"createwallettransaction", 1, "amount"},
    // Avalanche
    {"addavalanchenode", 0, "nodeid"},
    {"buildavalancheproof", 0, "sequence"},
    {"buildavalancheproof", 1, "expiration"},
    {"buildavalancheproof", 3, "stakes"},
    {"getavailabilityscore", 0, "nodeid"},
    {"getremoteproofs", 0, "nodeid"},
    {"getstakingreward", 1, "recompute"},
    {"setstakingreward", 2, "append"},
    {"setflakyproof", 1, "flaky"},
    {"getfinaltransactions", 0, "verbose"},
};
 
static UniValue Parse(std::string_view raw) {
    UniValue parsed;
    if (!parsed.read(raw)) {
        throw std::runtime_error(tfm::format("Error parsing JSON: %s", raw));
    }
 
    return parsed;
}
 
class CRPCConvertTable {
private:
    std::set<std::pair<std::string, int>> members;
    std::set<std::pair<std::string, std::string>> membersByName;
 
public:
    CRPCConvertTable();
 
    UniValue ArgToUniValue(std::string_view arg_value,
                           const std::string &method, int param_idx) {
        return members.count({method, param_idx}) > 0 ? Parse(arg_value)
                                                      : arg_value;
    }
 
    UniValue ArgToUniValue(std::string_view arg_value,
                           const std::string &method,
                           const std::string &param_name) {
        return membersByName.count({method, param_name}) > 0 ? Parse(arg_value)
                                                             : arg_value;
    }
};
 
CRPCConvertTable::CRPCConvertTable() {
    for (const auto &cp : vRPCConvertParams) {
        members.emplace(cp.methodName, cp.paramIdx);
        membersByName.emplace(cp.methodName, cp.paramName);
    }
}
 
static CRPCConvertTable rpcCvtTable;
 
UniValue RPCConvertValues(const std::string &strMethod,
                          const std::vector<std::string> &strParams) {
    UniValue params(UniValue::VARR);
 
    for (unsigned int idx = 0; idx < strParams.size(); idx++) {
        std::string_view value{strParams[idx]};
        params.push_back(rpcCvtTable.ArgToUniValue(value, strMethod, idx));
    }
 
    return params;
}
 
UniValue RPCConvertNamedValues(const std::string &strMethod,
                               const std::vector<std::string> &strParams) {
    UniValue params(UniValue::VOBJ);
    UniValue positional_args{UniValue::VARR};
 
    for (std::string_view s : strParams) {
        size_t pos = s.find('=');
        if (pos == std::string::npos) {
            positional_args.push_back(rpcCvtTable.ArgToUniValue(
                s, strMethod, positional_args.size()));
            continue;
        }
 
        std::string name{s.substr(0, pos)};
        std::string_view value{s.substr(pos + 1)};
 
        // Intentionally overwrite earlier named values with later ones as a
        // convenience for scripts and command line users that want to merge
        // options.
        params.pushKV(name, rpcCvtTable.ArgToUniValue(value, strMethod, name));
    }
 
    if (!positional_args.empty()) {
        // Use pushKVEnd instead of pushKV to avoid overwriting an explicit
        // "args" value with an implicit one. Let the RPC server handle the
        // request as given.
        params.pushKVEnd("args", std::move(positional_args));
    }
 
    return params;
}