#include <node/coinstats.h>
#include <node/transaction.h>
#include <outputtype.h>
#include <protocol.h>
#include <pubkey.h>
#include <rpc/request.h>
#include <script/script.h>
#include <script/sign.h>
#include <script/standard.h>
#include <univalue.h>
#include <util/check.h>
#include <string>
#include <variant>
#include <vector>

Include dependency graph for util.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	UniValueType
	Wrapper for UniValue::VType, which includes typeAny: Used to denote don't care type. More...

struct	RPCArg

struct	RPCResult

struct	RPCResults

struct	RPCExamples

class	RPCHelpMan

Typedefs
using	RPCArgList = std::vector< std::pair< std::string, UniValue > >

Enumerations
enum class	OuterType { ARR , OBJ , NONE }
	Serializing JSON objects depends on the outer type. More...

Functions
void	RPCTypeCheck (const UniValue &params, const std::list< UniValueType > &typesExpected, bool fAllowNull=false)
	Type-check arguments; throws JSONRPCError if wrong type given. More...

void	RPCTypeCheckArgument (const UniValue &value, const UniValueType &typeExpected)
	Type-check one argument; throws JSONRPCError if wrong type given. More...

void	RPCTypeCheckObj (const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull=false, bool fStrict=false)

uint256	ParseHashV (const UniValue &v, std::string strName)
	Utilities: convert hex-encoded Values (throws error if not hex). More...

uint256	ParseHashO (const UniValue &o, std::string strKey)

std::vector< unsigned char >	ParseHexV (const UniValue &v, std::string strName)

std::vector< unsigned char >	ParseHexO (const UniValue &o, std::string strKey)

CAmount	AmountFromValue (const UniValue &value, int decimals=8)
	Validate and return a CAmount from a UniValue number or string. More...

std::string	HelpExampleCli (const std::string &methodname, const std::string &args)

std::string	HelpExampleCliNamed (const std::string &methodname, const RPCArgList &args)

std::string	HelpExampleRpc (const std::string &methodname, const std::string &args)

std::string	HelpExampleRpcNamed (const std::string &methodname, const RPCArgList &args)

CPubKey	HexToPubKey (const std::string &hex_in)

CPubKey	AddrToPubKey (const FillableSigningProvider &keystore, const std::string &addr_in)

CTxDestination	AddAndGetMultisigDestination (const int required, const std::vector< CPubKey > &pubkeys, OutputType type, FillableSigningProvider &keystore, CScript &script_out)

UniValue	DescribeAddress (const CTxDestination &dest)

unsigned int	ParseConfirmTarget (const UniValue &value, unsigned int max_target)
	Parse a confirm target option and raise an RPC error if it is invalid. More...

RPCErrorCode	RPCErrorFromTransactionError (TransactionError terr)

UniValue	JSONRPCTransactionError (TransactionError terr, const std::string &err_string="")

std::pair< int64_t, int64_t >	ParseDescriptorRange (const UniValue &value)
	Parse a JSON range specified as int64, or [int64, int64]. More...

std::vector< CScript >	EvalDescriptorStringOrObject (const UniValue &scanobject, FlatSigningProvider &provider)
	Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range of 1000. More...

UniValue	GetServicesNames (ServiceFlags services)
	Returns, given services flags, a list of humanly readable (known) network services. More...

Variables
const std::string	UNIX_EPOCH_TIME
	String used to describe UNIX epoch time in documentation, factored out to a constant for consistency. More...

const std::string	EXAMPLE_ADDRESS [2]
	Example bech32 addresses for the RPCExamples help documentation. More...

Typedef Documentation

◆ RPCArgList

using RPCArgList = std::vector<std::pair<std::string, UniValue> >

Definition at line 89 of file util.h.

Enumeration Type Documentation

◆ OuterType

enum class OuterType

strong

Serializing JSON objects depends on the outer type.

Only arrays and dictionaries can be nested in json. The top-level outer type is "NONE".

Enumerator
ARR
OBJ
NONE

Definition at line 120 of file util.h.

Function Documentation

◆ AddAndGetMultisigDestination()

CTxDestination AddAndGetMultisigDestination	(	const int	required,
		const std::vector< CPubKey > &	pubkeys,
		OutputType	type,
		FillableSigningProvider &	keystore,
		CScript &	script_out
	)

Definition at line 226 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddrToPubKey()

CPubKey AddrToPubKey	(	const FillableSigningProvider &	keystore,
		const std::string &	addr_in
	)

Definition at line 205 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AmountFromValue()

CAmount AmountFromValue	(	const UniValue &	value,
		int	decimals = `8`
	)

Validate and return a CAmount from a UniValue number or string.

Parameters

[in]	value	UniValue number or string to parse.
[in]	decimals	Number of significant digits (default: 8).

Returns: a CAmount if the various checks pass.

Definition at line 78 of file util.cpp.

Here is the call graph for this function:

◆ DescribeAddress()

UniValue DescribeAddress ( const CTxDestination & dest )

Definition at line 325 of file util.cpp.

Here is the caller graph for this function:

◆ EvalDescriptorStringOrObject()

std::vector< CScript > EvalDescriptorStringOrObject	(	const UniValue &	scanobject,
		FlatSigningProvider &	provider
	)

Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range of 1000.

Definition at line 992 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetServicesNames()

UniValue GetServicesNames ( ServiceFlags services )

Returns, given services flags, a list of humanly readable (known) network services.

Definition at line 1030 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HelpExampleCli()

std::string HelpExampleCli	(	const std::string &	methodname,
		const std::string &	args
	)

Definition at line 156 of file util.cpp.

◆ HelpExampleCliNamed()

std::string HelpExampleCliNamed	(	const std::string &	methodname,
		const RPCArgList &	args
	)

Definition at line 161 of file util.cpp.

Here is the caller graph for this function:

◆ HelpExampleRpc()

std::string HelpExampleRpc	(	const std::string &	methodname,
		const std::string &	args
	)

Definition at line 174 of file util.cpp.

◆ HelpExampleRpcNamed()

std::string HelpExampleRpcNamed	(	const std::string &	methodname,
		const RPCArgList &	args
	)

Definition at line 180 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HexToPubKey()

CPubKey HexToPubKey ( const std::string & hex_in )

Definition at line 192 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ JSONRPCTransactionError()

UniValue JSONRPCTransactionError	(	TransactionError	terr,
		const std::string &	err_string = `""`
	)

Definition at line 359 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseConfirmTarget()

unsigned int ParseConfirmTarget	(	const UniValue &	value,
		unsigned int	max_target
	)

Parse a confirm target option and raise an RPC error if it is invalid.

Definition at line 330 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseDescriptorRange()

std::pair< int64_t, int64_t > ParseDescriptorRange ( const UniValue & value )

Parse a JSON range specified as int64, or [int64, int64].

Definition at line 976 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHashO()

uint256 ParseHashO	(	const UniValue &	o,
		std::string	strKey
	)

Definition at line 99 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHashV()

uint256 ParseHashV	(	const UniValue &	v,
		std::string	strName
	)

Utilities: convert hex-encoded Values (throws error if not hex).

Definition at line 90 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHexO()

std::vector< unsigned char > ParseHexO	(	const UniValue &	o,
		std::string	strKey
	)

Definition at line 112 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHexV()

std::vector< unsigned char > ParseHexV	(	const UniValue &	v,
		std::string	strName
	)

Definition at line 103 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RPCErrorFromTransactionError()

RPCErrorCode RPCErrorFromTransactionError ( TransactionError terr )

Definition at line 340 of file util.cpp.

Here is the caller graph for this function:

◆ RPCTypeCheck()

void RPCTypeCheck	(	const UniValue &	params,
		const std::list< UniValueType > &	typesExpected,
		bool	fAllowNull = `false`
	)

Type-check arguments; throws JSONRPCError if wrong type given.

Does not check that the right number of arguments are passed, just that any passed are the correct type.

Definition at line 24 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RPCTypeCheckArgument()

void RPCTypeCheckArgument	(	const UniValue &	value,
		const UniValueType &	typeExpected
	)

Type-check one argument; throws JSONRPCError if wrong type given.

Definition at line 41 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RPCTypeCheckObj()

void RPCTypeCheckObj	(	const UniValue &	o,
		const std::map< std::string, UniValueType > &	typesExpected,
		bool	fAllowNull = `false`,
		bool	fStrict = `false`
	)

Definition at line 48 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ EXAMPLE_ADDRESS

const std::string EXAMPLE_ADDRESS[2]

extern

Example bech32 addresses for the RPCExamples help documentation.

They are intentionally invalid to prevent accidental transactions by users.

Definition at line 22 of file util.cpp.

◆ UNIX_EPOCH_TIME

const std::string UNIX_EPOCH_TIME

extern

String used to describe UNIX epoch time in documentation, factored out to a constant for consistency.

Definition at line 21 of file util.cpp.

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ RPCArgList

Enumeration Type Documentation

◆ OuterType

Function Documentation

◆ AddAndGetMultisigDestination()

◆ AddrToPubKey()

◆ AmountFromValue()

◆ DescribeAddress()

◆ EvalDescriptorStringOrObject()

◆ GetServicesNames()

◆ HelpExampleCli()

◆ HelpExampleCliNamed()

◆ HelpExampleRpc()

◆ HelpExampleRpcNamed()

◆ HexToPubKey()

◆ JSONRPCTransactionError()

◆ ParseConfirmTarget()

◆ ParseDescriptorRange()

◆ ParseHashO()

◆ ParseHashV()

◆ ParseHexO()

◆ ParseHexV()

◆ RPCErrorFromTransactionError()

◆ RPCTypeCheck()

◆ RPCTypeCheckArgument()

◆ RPCTypeCheckObj()

Variable Documentation

◆ EXAMPLE_ADDRESS

◆ UNIX_EPOCH_TIME