standard.h File Reference

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

Go to the source code of this file.

Classes
class	CScriptID
class	CNoDestination
struct	PKHash
struct	ScriptHash
struct	WitnessV0ScriptHash
struct	WitnessV0KeyHash
struct	WitnessUnknown
	CTxDestination subtype to encode any future Witness version. More...

Typedefs
typedef boost::variant< CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessUnknown >	CTxDestination

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)
const char *	GetTxnOutputType (txnouttype t)
txnouttype	Solver (const CScript &scriptPubKey, std::vector< std::vector< unsigned char >> &vSolutionsRet)
bool	ExtractDestination (const CScript &scriptPubKey, CTxDestination &addressRet)
bool	ExtractDestinations (const CScript &scriptPubKey, txnouttype &typeRet, std::vector< CTxDestination > &addressRet, int &nRequiredRet)
CScript	GetScriptForDestination (const CTxDestination &dest)
CScript	GetScriptForRawPubKey (const CPubKey &pubkey)
CScript	GetScriptForMultisig (int nRequired, const std::vector< CPubKey > &keys)
CScript	GetScriptForWitness (const CScript &redeemscript)

Variables
static const bool	DEFAULT_ACCEPT_DATACARRIER = true
static const unsigned int	MAX_OP_RETURN_RELAY = 83
bool	fAcceptDatacarrier
unsigned	nMaxDatacarrierBytes
static const unsigned int	MANDATORY_SCRIPT_VERIFY_FLAGS = SCRIPT_VERIFY_P2SH

Typedef Documentation

CTxDestination

typedef boost::variant<CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessUnknown> CTxDestination

A txout script template with a specific destination. It is either:

• CNoDestination: no destination set
• PKHash: TX_PUBKEYHASH destination (P2PKH)
• ScriptHash: 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

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.

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.

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.

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.

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.

GetScriptForMultisig()

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

Generate a multisig script.

GetScriptForRawPubKey()

CScript GetScriptForRawPubKey

(

const CPubKey &

pubkey

)

Generate a P2PK script for the given pubkey.

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.

GetTxnOutputType()

const char* GetTxnOutputType

(

txnouttype

t

)

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

IsValidDestination()

bool IsValidDestination

(

const CTxDestination &

dest

)

Check whether a CTxDestination is a CNoDestination.

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.

Variable Documentation

DEFAULT_ACCEPT_DATACARRIER

const bool DEFAULT_ACCEPT_DATACARRIER = true

static

fAcceptDatacarrier

bool fAcceptDatacarrier

A data carrying output is an unspendable output containing data. The script type is designated as TX_NULL_DATA.

MANDATORY_SCRIPT_VERIFY_FLAGS

const unsigned int MANDATORY_SCRIPT_VERIFY_FLAGS = SCRIPT_VERIFY_P2SH

static

Mandatory script verification flags that all new blocks must comply with for them to be valid. (but old blocks may not comply with) Currently just P2SH, but in the future other flags may be added, such as a soft-fork to enforce strict DER encoding.

Failing one of these tests may trigger a DoS ban - see CheckInputs() for details.

MAX_OP_RETURN_RELAY

const unsigned int MAX_OP_RETURN_RELAY = 83

static

Default setting for nMaxDatacarrierBytes. 80 bytes of data, +1 for OP_RETURN, +2 for the pushdata opcodes.

nMaxDatacarrierBytes

unsigned nMaxDatacarrierBytes

Maximum size of TX_NULL_DATA scripts that this node considers standard.