#include <script/interpreter.h>
#include <uint256.h>
#include <boost/variant.hpp>
#include <stdint.h>

Include dependency graph for standard.h:

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

Classes
class	CScriptID
	A reference to a CScript: the Hash360 of its serialization (see script.h) More...

class	CNoDestination

struct	WitnessV0ScriptHash

struct	WitnessV0KeyHash

struct	WitnessUnknown
	CTxDestination subtype to encode any future Witness version. More...

Typedefs
typedef boost::variant< CNoDestination, CKeyID, CScriptID, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessUnknown >	CTxDestination
	A txout script template with a specific destination. More...

Enumerations
enum	txnouttype { TX_NONSTANDARD, TX_PUBKEY, TX_PUBKEYHASH, TX_SCRIPTHASH, TX_MULTISIG, TX_NULL_DATA, TX_WITNESS_V0_SCRIPTHASH, TX_WITNESS_V0_KEYHASH, TX_WITNESS_UNKNOWN }

Functions
bool	IsValidDestination (const CTxDestination &dest)
	Check whether a CTxDestination is a CNoDestination. More...

const char *	GetTxnOutputType (txnouttype t)
	Get the name of a txnouttype as a C string, or nullptr if unknown. More...

txnouttype	Solver (const CScript &scriptPubKey, std::vector< std::vector< unsigned char >> &vSolutionsRet)
	Parse a scriptPubKey and identify script type for standard scripts. More...

bool	ExtractDestination (const CScript &scriptPubKey, CTxDestination &addressRet)
	Parse a standard scriptPubKey for the destination address. More...

bool	ExtractDestinations (const CScript &scriptPubKey, txnouttype &typeRet, std::vector< CTxDestination > &addressRet, int &nRequiredRet)
	Parse a standard scriptPubKey with one or more destination addresses. More...

CScript	GetScriptForDestination (const CTxDestination &dest)
	Generate a Bitcoin scriptPubKey for the given CTxDestination. More...

CScript	GetScriptForRawPubKey (const CPubKey &pubkey)
	Generate a P2PK script for the given pubkey. More...

CScript	GetScriptForMultisig (int nRequired, const std::vector< CPubKey > &keys)
	Generate a multisig script. More...

CScript	GetScriptForWitness (const CScript &redeemscript)
	Generate a pay-to-witness script for the given redeem script. More...

Variables
bool	fAcceptDatacarrier
	A data carrying output is an unspendable output containing data. More...

unsigned	nMaxDatacarrierBytes
	Maximum size of TX_NULL_DATA scripts that this node considers standard. More...

Typedef Documentation

◆ CTxDestination

typedef boost::variant<CNoDestination, CKeyID, CScriptID, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessUnknown> CTxDestination

A txout script template with a specific destination.

It is either:

CNoDestination: no destination set
CKeyID: TX_PUBKEYHASH destination (P2PKH)
CScriptID: TX_SCRIPTHASH destination (P2SH)
WitnessV0ScriptHash: TX_WITNESS_V0_SCRIPTHASH destination (P2WSH)
WitnessV0KeyHash: TX_WITNESS_V0_KEYHASH destination (P2WPKH)
WitnessUnknown: TX_WITNESS_UNKNOWN destination (P2W???) A CTxDestination is the internal data type encoded in a bitcoin address

Definition at line 123 of file standard.h.

Enumeration Type Documentation

◆ txnouttype

enum txnouttype

Enumerator
TX_NONSTANDARD
TX_PUBKEY
TX_PUBKEYHASH
TX_SCRIPTHASH
TX_MULTISIG
TX_NULL_DATA	unspendable OP_RETURN script that carries data
TX_WITNESS_V0_SCRIPTHASH
TX_WITNESS_V0_KEYHASH
TX_WITNESS_UNKNOWN	Only for Witness versions not already defined above.

Definition at line 56 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, P2SH, P2WPKH, and P2WSH scripts.

Definition at line 155 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,
		txnouttype &	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. Currently does not extract address from pay-to-witness scripts.

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 199 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 288 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 301 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 296 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScriptForWitness()

CScript GetScriptForWitness ( const CScript & redeemscript )

Generate a pay-to-witness script for the given redeem script.

If the redeem script is P2PK or P2PKH, this returns a P2WPKH script, otherwise it returns a P2WSH script.

TODO: replace calls to GetScriptForWitness with GetScriptForDestination using the various witness-specific CTxDestination subtypes.

Definition at line 312 of file standard.cpp.

Here is the call graph for this function:

◆ GetTxnOutputType()

const char* GetTxnOutputType ( txnouttype t )

Get the name of a txnouttype as a C string, or nullptr if unknown.

Definition at line 27 of file standard.cpp.

Here is the caller graph for this function:

◆ IsValidDestination()

bool IsValidDestination ( const CTxDestination & dest )

Check whether a CTxDestination is a CNoDestination.

Definition at line 324 of file standard.cpp.

Here is the caller graph for this function:

◆ Solver()

txnouttype Solver	(	const CScript &	scriptPubKey,
		std::vector< std::vector< unsigned char >> &	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. TX_NONSTANDARD represents a failed solve.

Definition at line 90 of file standard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ fAcceptDatacarrier

bool fAcceptDatacarrier

A data carrying output is an unspendable output containing data.

The script type is designated as TX_NULL_DATA.

Definition at line 17 of file standard.cpp.

◆ nMaxDatacarrierBytes

unsigned nMaxDatacarrierBytes

Maximum size of TX_NULL_DATA scripts that this node considers standard.

Definition at line 18 of file standard.cpp.

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ CTxDestination

Enumeration Type Documentation

◆ txnouttype

Function Documentation

◆ ExtractDestination()

◆ ExtractDestinations()

◆ GetScriptForDestination()

◆ GetScriptForMultisig()

◆ GetScriptForRawPubKey()

◆ GetScriptForWitness()

◆ GetTxnOutputType()

◆ IsValidDestination()

◆ Solver()

Variable Documentation

◆ fAcceptDatacarrier

◆ nMaxDatacarrierBytes