#include <consensus/amount.h>
#include <node/transaction.h>
#include <outputtype.h>
#include <protocol.h>
#include <rpc/request.h>
#include <script/script.h>
#include <script/sign.h>
#include <script/standard.h>
#include <uint256.h>
#include <univalue.h>
#include <util/check.h>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <initializer_list>
#include <map>
#include <optional>
#include <string>
#include <type_traits>
#include <utility>
#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	RPCArgOptions

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	RPCTypeCheckObj (const UniValue &o, const std::map< std::string, UniValueType > &typesExpected, bool fAllowNull=false, bool fStrict=false)
	Check for expected keys/value types in an Object. More...

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< uint8_t >	ParseHexV (const UniValue &v, std::string strName)

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

Amount	AmountFromValue (const UniValue &value)

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 CChainParams &chainparams, 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)

std::string	GetAllOutputTypes ()

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
static constexpr bool	DEFAULT_RPC_DOC_CHECK {false}

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
	Example CashAddr address used in multiple RPCExamples. More...

Typedef Documentation

◆ RPCArgList

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

Definition at line 85 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 133 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 236 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddrToPubKey()

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

Definition at line 208 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AmountFromValue()

Amount AmountFromValue ( const UniValue & value )

Definition at line 58 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DescribeAddress()

UniValue DescribeAddress ( const CTxDestination & dest )

Definition at line 304 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 1362 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAllOutputTypes()

std::string GetAllOutputTypes ( )

Definition at line 308 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 1409 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 153 of file util.cpp.

◆ HelpExampleCliNamed()

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

Definition at line 158 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 170 of file util.cpp.

◆ HelpExampleRpcNamed()

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

Definition at line 179 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 194 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 336 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 1345 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 93 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 76 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHexO()

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

Definition at line 111 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHexV()

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

Definition at line 97 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 317 of file util.cpp.

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`
	)

Check for expected keys/value types in an Object.

Definition at line 29 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ DEFAULT_RPC_DOC_CHECK

constexpr bool DEFAULT_RPC_DOC_CHECK {false}

staticconstexpr

Definition at line 44 of file util.h.

◆ EXAMPLE_ADDRESS

const std::string EXAMPLE_ADDRESS

extern

Example CashAddr address used in multiple RPCExamples.

Definition at line 26 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 25 of file util.cpp.

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ RPCArgList

Enumeration Type Documentation

◆ OuterType

Function Documentation

◆ AddAndGetMultisigDestination()

◆ AddrToPubKey()

◆ AmountFromValue()

◆ DescribeAddress()

◆ EvalDescriptorStringOrObject()

◆ GetAllOutputTypes()

◆ GetServicesNames()

◆ HelpExampleCli()

◆ HelpExampleCliNamed()

◆ HelpExampleRpc()

◆ HelpExampleRpcNamed()

◆ HexToPubKey()

◆ JSONRPCTransactionError()

◆ ParseDescriptorRange()

◆ ParseHashO()

◆ ParseHashV()

◆ ParseHexO()

◆ ParseHexV()

◆ RPCErrorFromTransactionError()

◆ RPCTypeCheckObj()

Variable Documentation

◆ DEFAULT_RPC_DOC_CHECK

◆ EXAMPLE_ADDRESS

◆ UNIX_EPOCH_TIME