rpcwallet.cpp File Reference

#include <amount.h>
#include <core_io.h>
#include <interfaces/chain.h>
#include <key_io.h>
#include <node/context.h>
#include <outputtype.h>
#include <policy/feerate.h>
#include <policy/fees.h>
#include <policy/rbf.h>
#include <rpc/rawtransaction_util.h>
#include <rpc/server.h>
#include <rpc/util.h>
#include <script/descriptor.h>
#include <script/sign.h>
#include <util/bip32.h>
#include <util/fees.h>
#include <util/moneystr.h>
#include <util/string.h>
#include <util/system.h>
#include <util/url.h>
#include <util/validation.h>
#include <wallet/coincontrol.h>
#include <wallet/feebumper.h>
#include <wallet/psbtwallet.h>
#include <wallet/rpcwallet.h>
#include <wallet/wallet.h>
#include <wallet/walletdb.h>
#include <wallet/walletutil.h>
#include <stdint.h>
#include <univalue.h>

Include dependency graph for rpcwallet.cpp:

Go to the source code of this file.

Classes
struct	tallyitem
class	DescribeWalletAddressVisitor

Functions
static bool	GetAvoidReuseFlag (CWallet *const pwallet, const UniValue &param)
static bool	ParseIncludeWatchonly (const UniValue &include_watchonly, const CWallet &pwallet)
	Used by RPC commands that have an include_watchonly parameter. More...
bool	HaveKey (const SigningProvider &wallet, const CKey &key)
	Checks if a CKey is in the given CWallet compressed or otherwise. More...
bool	GetWalletNameFromJSONRPCRequest (const JSONRPCRequest &request, std::string &wallet_name)
std::shared_ptr< CWallet >	GetWalletForJSONRPCRequest (const JSONRPCRequest &request)
	Figures out what wallet, if any, to use for a JSONRPCRequest. More...
std::string	HelpRequiringPassphrase (const CWallet *pwallet)
bool	EnsureWalletIsAvailable (const CWallet *pwallet, bool avoidException)
void	EnsureWalletIsUnlocked (const CWallet *pwallet)
LegacyScriptPubKeyMan &	EnsureLegacyScriptPubKeyMan (CWallet &wallet, bool also_create)
static void	WalletTxToJSON (interfaces::Chain &chain, interfaces::Chain::Lock &locked_chain, const CWalletTx &wtx, UniValue &entry)
static std::string	LabelFromValue (const UniValue &value)
static UniValue	getnewaddress (const JSONRPCRequest &request)
static UniValue	getrawchangeaddress (const JSONRPCRequest &request)
static UniValue	setlabel (const JSONRPCRequest &request)
static CTransactionRef	SendMoney (interfaces::Chain::Lock &locked_chain, CWallet *const pwallet, const CTxDestination &address, CAmount nValue, bool fSubtractFeeFromAmount, const CCoinControl &coin_control, mapValue_t mapValue)
static UniValue	sendtoaddress (const JSONRPCRequest &request)
static UniValue	listaddressgroupings (const JSONRPCRequest &request)
static UniValue	signmessage (const JSONRPCRequest &request)
static UniValue	getreceivedbyaddress (const JSONRPCRequest &request)
static UniValue	getreceivedbylabel (const JSONRPCRequest &request)
static UniValue	getbalance (const JSONRPCRequest &request)
static UniValue	getunconfirmedbalance (const JSONRPCRequest &request)
static UniValue	sendmany (const JSONRPCRequest &request)
static UniValue	addmultisigaddress (const JSONRPCRequest &request)
static UniValue	ListReceived (interfaces::Chain::Lock &locked_chain, CWallet *const pwallet, const UniValue &params, bool by_label) EXCLUSIVE_LOCKS_REQUIRED(pwallet -> cs_wallet)
static UniValue	listreceivedbyaddress (const JSONRPCRequest &request)
static UniValue	listreceivedbylabel (const JSONRPCRequest &request)
static void	MaybePushAddress (UniValue &entry, const CTxDestination &dest)
static void	ListTransactions (interfaces::Chain::Lock &locked_chain, CWallet *const pwallet, const CWalletTx &wtx, int nMinDepth, bool fLong, UniValue &ret, const isminefilter &filter_ismine, const std::string *filter_label) EXCLUSIVE_LOCKS_REQUIRED(pwallet -> cs_wallet)
	List transactions based on the given criteria. More...
static const std::string	TransactionDescriptionString ()
UniValue	listtransactions (const JSONRPCRequest &request)
static UniValue	listsinceblock (const JSONRPCRequest &request)
static UniValue	gettransaction (const JSONRPCRequest &request)
static UniValue	abandontransaction (const JSONRPCRequest &request)
static UniValue	backupwallet (const JSONRPCRequest &request)
static UniValue	keypoolrefill (const JSONRPCRequest &request)
static UniValue	walletpassphrase (const JSONRPCRequest &request)
static UniValue	walletpassphrasechange (const JSONRPCRequest &request)
static UniValue	walletlock (const JSONRPCRequest &request)
static UniValue	encryptwallet (const JSONRPCRequest &request)
static UniValue	lockunspent (const JSONRPCRequest &request)
static UniValue	listlockunspent (const JSONRPCRequest &request)
static UniValue	settxfee (const JSONRPCRequest &request)
static UniValue	getbalances (const JSONRPCRequest &request)
static UniValue	getwalletinfo (const JSONRPCRequest &request)
static UniValue	listwalletdir (const JSONRPCRequest &request)
static UniValue	listwallets (const JSONRPCRequest &request)
static UniValue	loadwallet (const JSONRPCRequest &request)
static UniValue	setwalletflag (const JSONRPCRequest &request)
static UniValue	createwallet (const JSONRPCRequest &request)
static UniValue	unloadwallet (const JSONRPCRequest &request)
static UniValue	listunspent (const JSONRPCRequest &request)
void	FundTransaction (CWallet *const pwallet, CMutableTransaction &tx, CAmount &fee_out, int &change_position, UniValue options)
static UniValue	fundrawtransaction (const JSONRPCRequest &request)
UniValue	signrawtransactionwithwallet (const JSONRPCRequest &request)
static UniValue	bumpfee (const JSONRPCRequest &request)
UniValue	rescanblockchain (const JSONRPCRequest &request)
static UniValue	DescribeWalletAddress (CWallet *pwallet, const CTxDestination &dest)
static UniValue	AddressBookDataToJSON (const CAddressBookData &data, const bool verbose)
	Convert CAddressBookData to JSON record. More...
UniValue	getaddressinfo (const JSONRPCRequest &request)
static UniValue	getaddressesbylabel (const JSONRPCRequest &request)
static UniValue	listlabels (const JSONRPCRequest &request)
UniValue	sethdseed (const JSONRPCRequest &request)
UniValue	walletprocesspsbt (const JSONRPCRequest &request)
UniValue	walletcreatefundedpsbt (const JSONRPCRequest &request)
UniValue	abortrescan (const JSONRPCRequest &request)
UniValue	dumpprivkey (const JSONRPCRequest &request)
UniValue	importprivkey (const JSONRPCRequest &request)
UniValue	importaddress (const JSONRPCRequest &request)
UniValue	importpubkey (const JSONRPCRequest &request)
UniValue	dumpwallet (const JSONRPCRequest &request)
UniValue	importwallet (const JSONRPCRequest &request)
UniValue	importprunedfunds (const JSONRPCRequest &request)
UniValue	removeprunedfunds (const JSONRPCRequest &request)
UniValue	importmulti (const JSONRPCRequest &request)
void	RegisterWalletRPCCommands (interfaces::Chain &chain, std::vector< std::unique_ptr< interfaces::Handler >> &handlers)

Variables
static const std::string	WALLET_ENDPOINT_BASE = "/wallet/"
static const CRPCCommand	commands []
interfaces::Chain *	g_rpc_chain = nullptr
	Pointer to chain interface that needs to be declared as a global to be accessible loadwallet and createwallet methods. More...

Function Documentation

abandontransaction()

static UniValue abandontransaction ( const JSONRPCRequest &  request )

static

Definition at line 1754 of file rpcwallet.cpp.

Here is the call graph for this function:

abortrescan()

UniValue abortrescan

(

const JSONRPCRequest &

request

)

Definition at line 194 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

addmultisigaddress()

static UniValue addmultisigaddress ( const JSONRPCRequest &  request )

static

Definition at line 948 of file rpcwallet.cpp.

Here is the call graph for this function:

AddressBookDataToJSON()

static UniValue AddressBookDataToJSON ( const CAddressBookData &  data, const bool  verbose  )

static

Convert CAddressBookData to JSON record.

Definition at line 3708 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

backupwallet()

static UniValue backupwallet ( const JSONRPCRequest &  request )

static

Definition at line 1799 of file rpcwallet.cpp.

Here is the call graph for this function:

bumpfee()

static UniValue bumpfee ( const JSONRPCRequest &  request )

static

Definition at line 3317 of file rpcwallet.cpp.

Here is the call graph for this function:

createwallet()

static UniValue createwallet ( const JSONRPCRequest &  request )

static

Definition at line 2676 of file rpcwallet.cpp.

Here is the call graph for this function:

DescribeWalletAddress()

static UniValue DescribeWalletAddress ( CWallet *  pwallet, const CTxDestination &  dest  )

static

Definition at line 3693 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

dumpprivkey()

UniValue dumpprivkey

(

const JSONRPCRequest &

request

)

Definition at line 676 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

dumpwallet()

UniValue dumpwallet

(

const JSONRPCRequest &

request

)

Definition at line 724 of file rpcdump.cpp.

Here is the caller graph for this function:

encryptwallet()

static UniValue encryptwallet ( const JSONRPCRequest &  request )

static

Definition at line 2060 of file rpcwallet.cpp.

Here is the call graph for this function:

EnsureLegacyScriptPubKeyMan()

LegacyScriptPubKeyMan& EnsureLegacyScriptPubKeyMan	(	CWallet &	wallet,
		bool	also_create
	)

Definition at line 128 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureWalletIsAvailable()

bool EnsureWalletIsAvailable	(	const CWallet *	pwallet,
		bool	avoidException
	)

Definition at line 108 of file rpcwallet.cpp.

Here is the call graph for this function:

EnsureWalletIsUnlocked()

void EnsureWalletIsUnlocked

(

const CWallet *

pwallet

)

Definition at line 120 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

fundrawtransaction()

static UniValue fundrawtransaction ( const JSONRPCRequest &  request )

static

Definition at line 3117 of file rpcwallet.cpp.

Here is the call graph for this function:

FundTransaction()

void FundTransaction	(	CWallet *const	pwallet,
		CMutableTransaction &	tx,
		CAmount &	fee_out,
		int &	change_position,
		UniValue	options
	)

Definition at line 2999 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getaddressesbylabel()

static UniValue getaddressesbylabel ( const JSONRPCRequest &  request )

static

Definition at line 3858 of file rpcwallet.cpp.

Here is the call graph for this function:

getaddressinfo()

UniValue getaddressinfo

(

const JSONRPCRequest &

request

)

Definition at line 3718 of file rpcwallet.cpp.

Here is the call graph for this function:

GetAvoidReuseFlag()

static bool GetAvoidReuseFlag ( CWallet *const  pwallet, const UniValue &  param  )

inlinestatic

Definition at line 42 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getbalance()

static UniValue getbalance ( const JSONRPCRequest &  request )

static

Definition at line 728 of file rpcwallet.cpp.

Here is the call graph for this function:

getbalances()

static UniValue getbalances ( const JSONRPCRequest &  request )

static

Definition at line 2343 of file rpcwallet.cpp.

Here is the call graph for this function:

getnewaddress()

static UniValue getnewaddress ( const JSONRPCRequest &  request )

static

Definition at line 190 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getrawchangeaddress()

static UniValue getrawchangeaddress ( const JSONRPCRequest &  request )

static

Definition at line 243 of file rpcwallet.cpp.

Here is the call graph for this function:

getreceivedbyaddress()

static UniValue getreceivedbyaddress ( const JSONRPCRequest &  request )

static

Definition at line 590 of file rpcwallet.cpp.

Here is the call graph for this function:

getreceivedbylabel()

static UniValue getreceivedbylabel ( const JSONRPCRequest &  request )

static

Definition at line 660 of file rpcwallet.cpp.

Here is the call graph for this function:

gettransaction()

static UniValue gettransaction ( const JSONRPCRequest &  request )

static

Definition at line 1646 of file rpcwallet.cpp.

Here is the call graph for this function:

getunconfirmedbalance()

static UniValue getunconfirmedbalance ( const JSONRPCRequest &  request )

static

Definition at line 786 of file rpcwallet.cpp.

Here is the call graph for this function:

GetWalletForJSONRPCRequest()

std::shared_ptr<CWallet> GetWalletForJSONRPCRequest

(

const JSONRPCRequest &

request

)

Figures out what wallet, if any, to use for a JSONRPCRequest.

Parameters

[in]

request

JSONRPCRequest that wishes to access a wallet

Returns

nullptr if no wallet should be used, or a pointer to the CWallet

Definition at line 88 of file rpcwallet.cpp.

Here is the call graph for this function:

getwalletinfo()

static UniValue getwalletinfo ( const JSONRPCRequest &  request )

static

Definition at line 2409 of file rpcwallet.cpp.

Here is the call graph for this function:

GetWalletNameFromJSONRPCRequest()

bool GetWalletNameFromJSONRPCRequest	(	const JSONRPCRequest &	request,
		std::string &	wallet_name
	)

Definition at line 78 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

HaveKey()

bool HaveKey	(	const SigningProvider &	wallet,
		const CKey &	key
	)

Checks if a CKey is in the given CWallet compressed or otherwise.

Definition at line 71 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

HelpRequiringPassphrase()

std::string HelpRequiringPassphrase

(

const CWallet *

pwallet

)

Definition at line 101 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

importaddress()

UniValue importaddress

(

const JSONRPCRequest &

request

)

Definition at line 222 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

importmulti()

UniValue importmulti

(

const JSONRPCRequest &

request

)

Definition at line 1264 of file rpcdump.cpp.

Here is the caller graph for this function:

importprivkey()

UniValue importprivkey

(

const JSONRPCRequest &

request

)

Definition at line 90 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

importprunedfunds()

UniValue importprunedfunds

(

const JSONRPCRequest &

request

)

Definition at line 326 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

importpubkey()

UniValue importpubkey

(

const JSONRPCRequest &

request

)

Definition at line 427 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

importwallet()

UniValue importwallet

(

const JSONRPCRequest &

request

)

Definition at line 516 of file rpcdump.cpp.

Here is the caller graph for this function:

keypoolrefill()

static UniValue keypoolrefill ( const JSONRPCRequest &  request )

static

Definition at line 1836 of file rpcwallet.cpp.

Here is the call graph for this function:

LabelFromValue()

static std::string LabelFromValue ( const UniValue &  value )

static

Definition at line 182 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

listaddressgroupings()

static UniValue listaddressgroupings ( const JSONRPCRequest &  request )

static

Definition at line 457 of file rpcwallet.cpp.

Here is the call graph for this function:

listlabels()

static UniValue listlabels ( const JSONRPCRequest &  request )

static

Definition at line 3915 of file rpcwallet.cpp.

Here is the call graph for this function:

listlockunspent()

static UniValue listlockunspent ( const JSONRPCRequest &  request )

static

Definition at line 2248 of file rpcwallet.cpp.

Here is the call graph for this function:

ListReceived()

static UniValue ListReceived ( interfaces::Chain::Lock &  locked_chain, CWallet *const  pwallet, const UniValue &  params, bool  by_label  ) -> cs_wallet)

static

Definition at line 1043 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

listreceivedbyaddress()

static UniValue listreceivedbyaddress ( const JSONRPCRequest &  request )

static

Definition at line 1189 of file rpcwallet.cpp.

Here is the call graph for this function:

listreceivedbylabel()

static UniValue listreceivedbylabel ( const JSONRPCRequest &  request )

static

Definition at line 1240 of file rpcwallet.cpp.

Here is the call graph for this function:

listsinceblock()

static UniValue listsinceblock ( const JSONRPCRequest &  request )

static

Definition at line 1509 of file rpcwallet.cpp.

Here is the call graph for this function:

ListTransactions()

static void ListTransactions ( interfaces::Chain::Lock &  locked_chain, CWallet *const  pwallet, const CWalletTx &  wtx, int  nMinDepth, bool  fLong, UniValue &  ret, const isminefilter &  filter_ismine, const std::string *  filter_label  ) -> cs_wallet)

static

List transactions based on the given criteria.

Parameters

pwallet	The wallet.
wtx	The wallet transaction.
nMinDepth	The minimum confirmation depth.
fLong	Whether to include the JSON version of the transaction.
ret	The UniValue into which the result is stored.
filter_ismine	The "is mine" filter flags.
filter_label	Optional label string to filter incoming transactions.

Definition at line 1302 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

listtransactions()

UniValue listtransactions

(

const JSONRPCRequest &

request

)

Definition at line 1399 of file rpcwallet.cpp.

Here is the call graph for this function:

listunspent()

static UniValue listunspent ( const JSONRPCRequest &  request )

static

Definition at line 2784 of file rpcwallet.cpp.

Here is the call graph for this function:

listwalletdir()

static UniValue listwalletdir ( const JSONRPCRequest &  request )

static

Definition at line 2498 of file rpcwallet.cpp.

Here is the call graph for this function:

listwallets()

static UniValue listwallets ( const JSONRPCRequest &  request )

static

Definition at line 2531 of file rpcwallet.cpp.

Here is the call graph for this function:

loadwallet()

static UniValue loadwallet ( const JSONRPCRequest &  request )

static

Definition at line 2564 of file rpcwallet.cpp.

Here is the call graph for this function:

lockunspent()

static UniValue lockunspent ( const JSONRPCRequest &  request )

static

Definition at line 2121 of file rpcwallet.cpp.

Here is the call graph for this function:

MaybePushAddress()

static void MaybePushAddress ( UniValue &  entry, const CTxDestination &  dest  )

static

Definition at line 1284 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ParseIncludeWatchonly()

static bool ParseIncludeWatchonly ( const UniValue &  include_watchonly, const CWallet &  pwallet  )

static

Used by RPC commands that have an include_watchonly parameter.

We default to true for watchonly wallets if include_watchonly isn't explicitly set.

Definition at line 58 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterWalletRPCCommands()

void RegisterWalletRPCCommands	(	interfaces::Chain &	chain,
		std::vector< std::unique_ptr< interfaces::Handler >> &	handlers
	)

Definition at line 4312 of file rpcwallet.cpp.

Here is the call graph for this function:

removeprunedfunds()

UniValue removeprunedfunds

(

const JSONRPCRequest &

request

)

Definition at line 387 of file rpcdump.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

rescanblockchain()

UniValue rescanblockchain

(

const JSONRPCRequest &

request

)

Definition at line 3509 of file rpcwallet.cpp.

Here is the call graph for this function:

sendmany()

static UniValue sendmany ( const JSONRPCRequest &  request )

static

Definition at line 813 of file rpcwallet.cpp.

Here is the call graph for this function:

SendMoney()

static CTransactionRef SendMoney ( interfaces::Chain::Lock &  locked_chain, CWallet *const  pwallet, const CTxDestination &  address, CAmount  nValue, bool  fSubtractFeeFromAmount, const CCoinControl &  coin_control, mapValue_t  mapValue  )

static

Definition at line 330 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

sendtoaddress()

static UniValue sendtoaddress ( const JSONRPCRequest &  request )

static

Definition at line 361 of file rpcwallet.cpp.

Here is the call graph for this function:

sethdseed()

UniValue sethdseed

(

const JSONRPCRequest &

request

)

Definition at line 3970 of file rpcwallet.cpp.

Here is the call graph for this function:

setlabel()

static UniValue setlabel ( const JSONRPCRequest &  request )

static

Definition at line 289 of file rpcwallet.cpp.

Here is the call graph for this function:

settxfee()

static UniValue settxfee ( const JSONRPCRequest &  request )

static

Definition at line 2303 of file rpcwallet.cpp.

Here is the call graph for this function:

setwalletflag()

static UniValue setwalletflag ( const JSONRPCRequest &  request )

static

Definition at line 2609 of file rpcwallet.cpp.

Here is the call graph for this function:

signmessage()

static UniValue signmessage ( const JSONRPCRequest &  request )

static

Definition at line 518 of file rpcwallet.cpp.

Here is the call graph for this function:

signrawtransactionwithwallet()

UniValue signrawtransactionwithwallet

(

const JSONRPCRequest &

request

)

Definition at line 3216 of file rpcwallet.cpp.

Here is the call graph for this function:

TransactionDescriptionString()

static const std::string TransactionDescriptionString ( )

static

Definition at line 1377 of file rpcwallet.cpp.

Here is the caller graph for this function:

unloadwallet()

static UniValue unloadwallet ( const JSONRPCRequest &  request )

static

Definition at line 2743 of file rpcwallet.cpp.

Here is the call graph for this function:

walletcreatefundedpsbt()

UniValue walletcreatefundedpsbt

(

const JSONRPCRequest &

request

)

Definition at line 4114 of file rpcwallet.cpp.

Here is the call graph for this function:

walletlock()

static UniValue walletlock ( const JSONRPCRequest &  request )

static

Definition at line 2019 of file rpcwallet.cpp.

Here is the call graph for this function:

walletpassphrase()

static UniValue walletpassphrase ( const JSONRPCRequest &  request )

static

Definition at line 1884 of file rpcwallet.cpp.

Here is the call graph for this function:

walletpassphrasechange()

static UniValue walletpassphrasechange ( const JSONRPCRequest &  request )

static

Definition at line 1968 of file rpcwallet.cpp.

Here is the call graph for this function:

walletprocesspsbt()

UniValue walletprocesspsbt

(

const JSONRPCRequest &

request

)

Definition at line 4048 of file rpcwallet.cpp.

Here is the call graph for this function:

WalletTxToJSON()

static void WalletTxToJSON ( interfaces::Chain &  chain, interfaces::Chain::Lock &  locked_chain, const CWalletTx &  wtx, UniValue &  entry  )

static

Definition at line 140 of file rpcwallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

commands

const CRPCCommand commands[]

static

Definition at line 4250 of file rpcwallet.cpp.

g_rpc_chain

interfaces::Chain* g_rpc_chain = nullptr

Pointer to chain interface that needs to be declared as a global to be accessible loadwallet and createwallet methods.

Due to limitations of the RPC framework, there's currently no direct way to pass in state to RPC methods without globals.

Definition at line 4318 of file rpcwallet.cpp.

WALLET_ENDPOINT_BASE

const std::string WALLET_ENDPOINT_BASE = "/wallet/"

static

Definition at line 40 of file rpcwallet.cpp.