#include <pubkey.h>

Inheritance diagram for XOnlyPubKey:

Collaboration diagram for XOnlyPubKey:

Public Member Functions
	XOnlyPubKey ()=default
	Construct an empty x-only pubkey.
	XOnlyPubKey (const XOnlyPubKey &)=default
XOnlyPubKey &	operator= (const XOnlyPubKey &)=default
bool	IsFullyValid () const
	Determine if this pubkey is fully valid.
bool	IsNull () const
	Test whether this is the 0 key (the result of default construction).
constexpr	XOnlyPubKey (std::span< const unsigned char > bytes)
	Construct an x-only pubkey from exactly 32 bytes.
	XOnlyPubKey (const CPubKey &pubkey)
	Construct an x-only pubkey from a normal pubkey.
bool	VerifySchnorr (const uint256 &msg, std::span< const unsigned char > sigbytes) const
	Verify a Schnorr signature against this public key.
uint256	ComputeTapTweakHash (const uint256 *merkle_root) const
	Compute the Taproot tweak as specified in BIP341, with *this as internal key:
bool	CheckTapTweak (const XOnlyPubKey &internal, const uint256 &merkle_root, bool parity) const
	Verify that this is a Taproot tweaked output point, against a specified internal key, Merkle root, and parity.
std::optional< std::pair< XOnlyPubKey, bool > >	CreateTapTweak (const uint256 *merkle_root) const
	Construct a Taproot tweaked output point with this point as internal key.
std::vector< CKeyID >	GetKeyIDs () const
	Returns a list of CKeyIDs for the CPubKeys that could have been used to create this XOnlyPubKey.
std::vector< CPubKey >	GetCPubKeys () const
	Returns this XOnlyPubKey with 0x02 and 0x03 prefixes.
CPubKey	GetEvenCorrespondingCPubKey () const
const unsigned char &	operator[] (int pos) const
const unsigned char *	data () const
const unsigned char *	begin () const
const unsigned char *	end () const
unsigned char *	data ()
unsigned char *	begin ()
unsigned char *	end ()
bool	operator== (const XOnlyPubKey &other) const
bool	operator< (const XOnlyPubKey &other) const
	SERIALIZE_METHODS (XOnlyPubKey, obj)
	Implement serialization without length prefixes since it is a fixed length.

Static Public Member Functions
static constexpr size_t	size ()

Static Public Attributes
static const XOnlyPubKey	NUMS_H
	Nothing Up My Sleeve point H Used as an internal key for provably disabling the key path spend see BIP341 for more details.

Private Attributes
uint256	m_keydata

Detailed Description

Definition at line 226 of file pubkey.h.

Constructor & Destructor Documentation

◆ XOnlyPubKey() [1/4]

XOnlyPubKey::XOnlyPubKey ( )

default

Construct an empty x-only pubkey.

Here is the caller graph for this function:

◆ XOnlyPubKey() [2/4]

XOnlyPubKey::XOnlyPubKey ( const XOnlyPubKey & )

default

Here is the call graph for this function:

◆ XOnlyPubKey() [3/4]

XOnlyPubKey::XOnlyPubKey ( std::span< const unsigned char > bytes )

inlineexplicitconstexpr

Construct an x-only pubkey from exactly 32 bytes.

Definition at line 253 of file pubkey.h.

◆ XOnlyPubKey() [4/4]

XOnlyPubKey::XOnlyPubKey ( const CPubKey & pubkey )

inlineexplicit

Construct an x-only pubkey from a normal pubkey.

Definition at line 256 of file pubkey.h.

Here is the call graph for this function:

Member Function Documentation

◆ begin() [1/2]

unsigned char * XOnlyPubKey::begin ( )

inline

Definition at line 298 of file pubkey.h.

◆ begin() [2/2]

const unsigned char * XOnlyPubKey::begin ( ) const

inline

Definition at line 295 of file pubkey.h.

Here is the caller graph for this function:

◆ CheckTapTweak()

bool XOnlyPubKey::CheckTapTweak	(	const XOnlyPubKey &	internal,
		const uint256 &	merkle_root,
		bool	parity ) const

Verify that this is a Taproot tweaked output point, against a specified internal key, Merkle root, and parity.

Definition at line 257 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeTapTweakHash()

uint256 XOnlyPubKey::ComputeTapTweakHash ( const uint256 * merkle_root ) const

Compute the Taproot tweak as specified in BIP341, with *this as internal key:

if merkle_root == nullptr: H_TapTweak(xonly_pubkey)
otherwise: H_TapTweak(xonly_pubkey || *merkle_root)

Note that the behavior of this function with merkle_root != nullptr is consensus critical.

Definition at line 246 of file pubkey.cpp.

Here is the caller graph for this function:

◆ CreateTapTweak()

std::optional< std::pair< XOnlyPubKey, bool > > XOnlyPubKey::CreateTapTweak ( const uint256 * merkle_root ) const

Construct a Taproot tweaked output point with this point as internal key.

Definition at line 265 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data() [1/2]

unsigned char * XOnlyPubKey::data ( )

inline

Definition at line 297 of file pubkey.h.

◆ data() [2/2]

const unsigned char * XOnlyPubKey::data ( ) const

inline

Definition at line 294 of file pubkey.h.

Here is the caller graph for this function:

◆ end() [1/2]

unsigned char * XOnlyPubKey::end ( )

inline

Definition at line 299 of file pubkey.h.

◆ end() [2/2]

const unsigned char * XOnlyPubKey::end ( ) const

inline

Definition at line 296 of file pubkey.h.

Here is the caller graph for this function:

◆ GetCPubKeys()

std::vector< CPubKey > XOnlyPubKey::GetCPubKeys ( ) const

Returns this XOnlyPubKey with 0x02 and 0x03 prefixes.

Definition at line 200 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEvenCorrespondingCPubKey()

CPubKey XOnlyPubKey::GetEvenCorrespondingCPubKey ( ) const

Definition at line 223 of file pubkey.cpp.

Here is the call graph for this function:

◆ GetKeyIDs()

std::vector< CKeyID > XOnlyPubKey::GetKeyIDs ( ) const

Returns a list of CKeyIDs for the CPubKeys that could have been used to create this XOnlyPubKey.

As the CKeyID is the Hash160(full pubkey), the produced CKeyIDs are for the versions of this XOnlyPubKey with 0x02 and 0x03 prefixes. This is needed for key lookups since keys are indexed by CKeyID.

Definition at line 214 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsFullyValid()

bool XOnlyPubKey::IsFullyValid ( ) const

Determine if this pubkey is fully valid.

This is true for approximately 50% of all possible 32-byte arrays. If false, VerifySchnorr, CheckTapTweak and CreateTapTweak will always fail.

Definition at line 230 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsNull()

bool XOnlyPubKey::IsNull ( ) const

inline

Test whether this is the 0 key (the result of default construction).

This implies !IsFullyValid().

Definition at line 250 of file pubkey.h.

Here is the caller graph for this function:

◆ operator<()

bool XOnlyPubKey::operator< ( const XOnlyPubKey & other ) const

inline

Definition at line 301 of file pubkey.h.

Here is the call graph for this function:

◆ operator=()

XOnlyPubKey & XOnlyPubKey::operator= ( const XOnlyPubKey & )

default

Here is the call graph for this function:

◆ operator==()

bool XOnlyPubKey::operator== ( const XOnlyPubKey & other ) const

inline

Definition at line 300 of file pubkey.h.

Here is the call graph for this function:

◆ operator[]()

const unsigned char & XOnlyPubKey::operator[] ( int pos ) const

inline

Definition at line 292 of file pubkey.h.

◆ SERIALIZE_METHODS()

XOnlyPubKey::SERIALIZE_METHODS	(	XOnlyPubKey	,
		obj	)

inline

Implement serialization without length prefixes since it is a fixed length.

Definition at line 304 of file pubkey.h.

Here is the call graph for this function:

◆ size()

constexpr size_t XOnlyPubKey::size ( )

inlinestaticconstexpr

Definition at line 293 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VerifySchnorr()

bool XOnlyPubKey::VerifySchnorr	(	const uint256 &	msg,
		std::span< const unsigned char >	sigbytes ) const

Verify a Schnorr signature against this public key.

sigbytes must be exactly 64 bytes.

Definition at line 236 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_keydata

uint256 XOnlyPubKey::m_keydata

private

Definition at line 229 of file pubkey.h.

◆ NUMS_H

XOnlyPubKey XOnlyPubKey::NUMS_H

staticconstexpr

Initial value:

{
    
    []() consteval { return XOnlyPubKey{"50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0"_hex_u8}; }(),
}

Nothing Up My Sleeve point H Used as an internal key for provably disabling the key path spend see BIP341 for more details.

Nothing Up My Sleeve (NUMS) point.

NUMS_H is a point with an unknown discrete logarithm, constructed by taking the sha256 of 'g' (uncompressed encoding), which happens to be a point on the curve.

For an example script for calculating H, refer to the unit tests in ./test/functional/test_framework/crypto/secp256k1.py

Definition at line 195 of file pubkey.h.

The documentation for this class was generated from the following files:

src/pubkey.h
src/pubkey.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XOnlyPubKey() [1/4]

◆ XOnlyPubKey() [2/4]

◆ XOnlyPubKey() [3/4]

◆ XOnlyPubKey() [4/4]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ CheckTapTweak()

◆ ComputeTapTweakHash()

◆ CreateTapTweak()

◆ data() [1/2]

◆ data() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ GetCPubKeys()

◆ GetEvenCorrespondingCPubKey()

◆ GetKeyIDs()

◆ IsFullyValid()

◆ IsNull()

◆ operator<()

◆ operator=()

◆ operator==()

◆ operator[]()

◆ SERIALIZE_METHODS()

◆ size()

◆ VerifySchnorr()

Member Data Documentation

◆ m_keydata

◆ NUMS_H