util.h File Reference

#include <addresstype.h>
#include <consensus/amount.h>
#include <node/transaction.h>
#include <outputtype.h>
#include <pubkey.h>
#include <rpc/protocol.h>
#include <rpc/request.h>
#include <script/script.h>
#include <script/sign.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 <string_view>
#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:

Go to the source code of 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
std::string	GetAllOutputTypes ()
	Gets all existing output types formatted for RPC help sections. 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_view name)
	Utilities: convert hex-encoded Values (throws error if not hex). More...
uint256	ParseHashO (const UniValue &o, std::string_view strKey)
std::vector< unsigned char >	ParseHexV (const UniValue &v, std::string_view name)
std::vector< unsigned char >	ParseHexO (const UniValue &o, std::string_view strKey)
CAmount	AmountFromValue (const UniValue &value, int decimals=8)
	Validate and return a CAmount from a UniValue number or string. More...
CFeeRate	ParseFeeRate (const UniValue &json)
	Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB). 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)
int	ParseSighashString (const UniValue &sighash)
	Parse a sighash string representation and raise an RPC error if it is invalid. More...
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, const bool expand_priv=false)
	Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range of 1000. More...
void	PushWarnings (const UniValue &warnings, UniValue &obj)
	Push warning messages to an RPC "warnings" field as a JSON array of strings. More...
void	PushWarnings (const std::vector< bilingual_str > &warnings, UniValue &obj)

Variables
static constexpr bool	DEFAULT_RPC_DOC_CHECK
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 112 of file util.h.

Enumeration Type Documentation

OuterType

enum 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 143 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 225 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 204 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 70 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 329 of file util.cpp.

Here is the caller graph for this function:

EvalDescriptorStringOrObject()

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

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

Definition at line 1285 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetAllOutputTypes()

std::string GetAllOutputTypes

(

)

Gets all existing output types formatted for RPC help sections.

Returns

Comma separated string representing output type names.

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

HelpExampleCliNamed()

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

Definition at line 160 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 173 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 191 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 380 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 351 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 1269 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ParseFeeRate()

CFeeRate ParseFeeRate

(

const UniValue &

json

)

Parse a json number or string, denoting BTC/kvB, into a CFeeRate (sat/kvB).

Reject negative values or rates larger than 1BTC/kvB.

Definition at line 82 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_view	strKey
	)

Definition at line 98 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_view	name
	)

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

Definition at line 89 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_view	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<unsigned char> ParseHexV	(	const UniValue &	v,
		std::string_view	name
	)

Definition at line 102 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ParseSighashString()

int ParseSighashString

(

const UniValue &

sighash

)

Parse a sighash string representation and raise an RPC error if it is invalid.

Parse a sighash string representation and raise an RPC error if it is invalid.

Precondition

The sighash argument should be string or null.

Definition at line 339 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

PushWarnings() [1/2]

void PushWarnings	(	const std::vector< bilingual_str > &	warnings,
		UniValue &	obj
	)

Definition at line 1343 of file util.cpp.

Here is the call graph for this function:

PushWarnings() [2/2]

void PushWarnings	(	const UniValue &	warnings,
		UniValue &	obj
	)

Push warning messages to an RPC "warnings" field as a JSON array of strings.

Parameters

[in]	warnings	Warning messages to push.
[out]	obj	UniValue object to push the warnings array object to.

Definition at line 1337 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 361 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
	)

Definition at line 43 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

staticconstexpr

Initial value:

{
 
 
 
    false
 
}

Definition at line 41 of file util.h.

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 31 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 30 of file util.cpp.