standard.h File Reference

#include <pubkey.h>
#include <script/script_flags.h>
#include <uint256.h>
#include <util/hash_type.h>
#include <string>
#include <variant>

Include dependency graph for standard.h:

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

Go to the source code of this file.

Classes
class	CScriptID
	A reference to a CScript: the Hash160 of its serialization (see script.h) More...
class	CNoDestination
struct	PKHash
struct	ScriptHash

Typedefs
using	CTxDestination = std::variant< CNoDestination, PKHash, ScriptHash >
	A txout script template with a specific destination.

Enumerations
enum class	TxoutType {   NONSTANDARD , PUBKEY , PUBKEYHASH , SCRIPTHASH ,   MULTISIG , NULL_DATA }

Functions
CKeyID	ToKeyID (const PKHash &key_hash)
bool	IsValidDestination (const CTxDestination &dest)
	Check whether a CTxDestination is a CNoDestination.
std::string	GetTxnOutputType (TxoutType t)
	Get the name of a TxoutType as a string.
TxoutType	Solver (const CScript &scriptPubKey, std::vector< std::vector< uint8_t > > &vSolutionsRet)
	Parse a scriptPubKey and identify script type for standard scripts.
bool	ExtractDestination (const CScript &scriptPubKey, CTxDestination &addressRet)
	Parse a standard scriptPubKey for the destination address.
bool	ExtractDestinations (const CScript &scriptPubKey, TxoutType &typeRet, std::vector< CTxDestination > &addressRet, int &nRequiredRet)
	Parse a standard scriptPubKey with one or more destination addresses.
CScript	GetScriptForDestination (const CTxDestination &dest)
	Generate a Bitcoin scriptPubKey for the given CTxDestination.
CScript	GetScriptForRawPubKey (const CPubKey &pubkey)
	Generate a P2PK script for the given pubkey.
CScript	GetScriptForMultisig (int nRequired, const std::vector< CPubKey > &keys)
	Generate a multisig script.

Variables
static const bool	DEFAULT_ACCEPT_DATACARRIER = true
static const unsigned int	MAX_OP_RETURN_RELAY = 223
	Default setting for nMaxDatacarrierBytes.

Typedef Documentation

CTxDestination

using CTxDestination = std::variant<CNoDestination, PKHash, ScriptHash>

A txout script template with a specific destination.

It is either:

• CNoDestination: no destination set
• PKHash: TxoutType::PUBKEYHASH destination (P2PKH)
• ScriptHash: TxoutType::SCRIPTHASH destination (P2SH) A CTxDestination is the internal data type encoded in a bitcoin address

Definition at line 85 of file standard.h.

Enumeration Type Documentation

TxoutType

enum class TxoutType

strong

Enumerator
NONSTANDARD
PUBKEY
PUBKEYHASH
SCRIPTHASH
MULTISIG
NULL_DATA

Definition at line 38 of file standard.h.

Function Documentation

ExtractDestination()

bool ExtractDestination	(	const CScript &	scriptPubKey,
		CTxDestination &	addressRet
	)

Parse a standard scriptPubKey for the destination address.

Assigns result to the addressRet parameter and returns true if successful. For multisig scripts, instead use ExtractDestinations. Currently only works for P2PK, P2PKH, and P2SH scripts.

Definition at line 158 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ExtractDestinations()

bool ExtractDestinations	(	const CScript &	scriptPubKey,
		TxoutType &	typeRet,
		std::vector< CTxDestination > &	addressRet,
		int &	nRequiredRet
	)

Parse a standard scriptPubKey with one or more destination addresses.

For multisig scripts, this populates the addressRet vector with the pubkey IDs and nRequiredRet with the n required to spend. For other destinations, addressRet is populated with a single value and nRequiredRet is set to 1. Returns true if successful.

Note: this function confuses destinations (a subset of CScripts that are encodable as an address) with key identifiers (of keys involved in a CScript), and its use should be phased out.

Definition at line 184 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetScriptForDestination()

CScript GetScriptForDestination

(

const CTxDestination &

dest

)

Generate a Bitcoin scriptPubKey for the given CTxDestination.

Returns a P2PKH script for a CKeyID destination, a P2SH script for a CScriptID, and an empty script for CNoDestination.

Definition at line 240 of file standard.cpp.

Here is the caller graph for this function:

GetScriptForMultisig()

CScript GetScriptForMultisig	(	int	nRequired,
		const std::vector< CPubKey > &	keys
	)

Generate a multisig script.

Definition at line 249 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetScriptForRawPubKey()

CScript GetScriptForRawPubKey

(

const CPubKey &

pubkey

)

Generate a P2PK script for the given pubkey.

Definition at line 244 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetTxnOutputType()

std::string GetTxnOutputType

(

TxoutType

t

)

Get the name of a TxoutType as a string.

Definition at line 29 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsValidDestination()

bool IsValidDestination

(

const CTxDestination &

dest

)

Check whether a CTxDestination is a CNoDestination.

Definition at line 260 of file standard.cpp.

Here is the caller graph for this function:

Solver()

TxoutType Solver	(	const CScript &	scriptPubKey,
		std::vector< std::vector< uint8_t > > &	vSolutionsRet
	)

Parse a scriptPubKey and identify script type for standard scripts.

If successful, returns script type and parsed pubkeys or hashes, depending on the type. For example, for a P2SH script, vSolutionsRet will contain the script hash, for P2PKH it will contain the key hash, etc.

Parameters

[in]	scriptPubKey	Script to parse
[out]	vSolutionsRet	Vector of parsed pubkeys and hashes

Returns

The script type. TxoutType::NONSTANDARD represents a failed solve.

Definition at line 108 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ToKeyID()

CKeyID ToKeyID

(

const PKHash &

key_hash

)

Definition at line 25 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

DEFAULT_ACCEPT_DATACARRIER

const bool DEFAULT_ACCEPT_DATACARRIER = true

static

Definition at line 17 of file standard.h.

MAX_OP_RETURN_RELAY

const unsigned int MAX_OP_RETURN_RELAY = 223

static

Default setting for nMaxDatacarrierBytes.

220 bytes of data, +1 for OP_RETURN, +2 for the pushdata opcodes.

Definition at line 36 of file standard.h.