An encapsulated public key. More...

#include <pubkey.h>

Public Member Functions
	CPubKey ()
	Construct an invalid public key.

template<typename T >
void	Set (const T pbegin, const T pend)
	Initialize a public key using begin/end iterators to byte data.

template<typename T >
	CPubKey (const T pbegin, const T pend)
	Construct a public key using begin/end iterators to byte data.

	CPubKey (std::span< const uint8_t > _vch)
	Construct a public key from a byte vector.

unsigned int	size () const
	Simple read-only vector-like interface to the pubkey data.

const unsigned char *	data () const

const unsigned char *	begin () const

const unsigned char *	end () const

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

template<typename Stream >
void	Serialize (Stream &s) const
	Implement serialization, as if this was a byte vector.

template<typename Stream >
void	Unserialize (Stream &s)

CKeyID	GetID () const
	Get the KeyID of this public key (hash of its serialization)

uint256	GetHash () const
	Get the 256-bit hash of this public key.

bool	IsValid () const

bool	IsValidNonHybrid () const noexcept
	Check if a public key is a syntactically valid compressed or uncompressed key.

bool	IsFullyValid () const
	fully validate whether this is a valid public key (more expensive than IsValid())

bool	IsCompressed () const
	Check whether this is a compressed public key.

bool	Verify (const uint256 &hash, const std::vector< unsigned char > &vchSig) const
	Verify a DER signature (~72 bytes).

bool	RecoverCompact (const uint256 &hash, const std::vector< unsigned char > &vchSig)
	Recover a public key from a compact signature.

bool	Decompress ()
	Turn this public key into an uncompressed public key.

bool	Derive (CPubKey &pubkeyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode &cc, uint256 *bip32_tweak_out=nullptr) const
	Derive BIP32 child pubkey.

Static Public Member Functions
static bool	ValidSize (const std::vector< unsigned char > &vch)

static bool	CheckLowS (const std::vector< unsigned char > &vchSig)
	Check whether a signature is normalized (lower-S).

Static Public Attributes
static constexpr unsigned int	SIZE = 65
	secp256k1:

static constexpr unsigned int	COMPRESSED_SIZE = 33

static constexpr unsigned int	SIGNATURE_SIZE = 72

static constexpr unsigned int	COMPACT_SIGNATURE_SIZE = 65

Private Member Functions
void	Invalidate ()
	Set this key data to be invalid.

Static Private Member Functions
unsigned static int	GetLen (unsigned char chHeader)
	Compute the length of a pubkey with a given first byte.

Private Attributes
unsigned char	vch [SIZE]
	see www.keylength.com script supports up to 75 for single byte push

Friends
bool	operator== (const CPubKey &a, const CPubKey &b)
	Comparator implementation.

bool	operator< (const CPubKey &a, const CPubKey &b)

bool	operator> (const CPubKey &a, const CPubKey &b)

Detailed Description

An encapsulated public key.

Definition at line 42 of file pubkey.h.

Constructor & Destructor Documentation

◆ CPubKey() [1/3]

CPubKey::CPubKey ( )

inline

Construct an invalid public key.

Definition at line 91 of file pubkey.h.

Here is the call graph for this function:

◆ CPubKey() [2/3]

template<typename T >

CPubKey::CPubKey	(	const T	pbegin,
		const T	pend
	)

inline

Construct a public key using begin/end iterators to byte data.

Definition at line 109 of file pubkey.h.

Here is the call graph for this function:

◆ CPubKey() [3/3]

CPubKey::CPubKey ( std::span< const uint8_t > _vch )

inlineexplicit

Construct a public key from a byte vector.

Definition at line 115 of file pubkey.h.

Here is the call graph for this function:

Member Function Documentation

◆ begin()

const unsigned char * CPubKey::begin ( ) const

inline

Definition at line 123 of file pubkey.h.

Here is the caller graph for this function:

◆ CheckLowS()

bool CPubKey::CheckLowS ( const std::vector< unsigned char > & vchSig )

static

Check whether a signature is normalized (lower-S).

Definition at line 393 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data()

const unsigned char * CPubKey::data ( ) const

inline

Definition at line 122 of file pubkey.h.

Here is the caller graph for this function:

◆ Decompress()

bool CPubKey::Decompress ( )

Turn this public key into an uncompressed public key.

Definition at line 327 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Derive()

bool CPubKey::Derive	(	CPubKey &	pubkeyChild,
		ChainCode &	ccChild,
		unsigned int	nChild,
		const ChainCode &	cc,
		uint256 *	bip32_tweak_out = `nullptr`
	)		const

Derive BIP32 child pubkey.

Definition at line 341 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end()

const unsigned char * CPubKey::end ( ) const

inline

Definition at line 124 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHash()

uint256 CPubKey::GetHash ( ) const

inline

Get the 256-bit hash of this public key.

Definition at line 175 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetID()

CKeyID CPubKey::GetID ( ) const

inline

Get the KeyID of this public key (hash of its serialization)

Definition at line 169 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLen()

unsigned static int CPubKey::GetLen ( unsigned char chHeader )

inlinestaticprivate

Compute the length of a pubkey with a given first byte.

Definition at line 69 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Invalidate()

void CPubKey::Invalidate ( )

inlineprivate

Set this key data to be invalid.

Definition at line 79 of file pubkey.h.

Here is the caller graph for this function:

◆ IsCompressed()

bool CPubKey::IsCompressed ( ) const

inline

Check whether this is a compressed public key.

Definition at line 209 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsFullyValid()

bool CPubKey::IsFullyValid ( ) const

fully validate whether this is a valid public key (more expensive than IsValid())

Definition at line 320 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsValid()

bool CPubKey::IsValid ( ) const

inline

Definition at line 194 of file pubkey.h.

Here is the caller graph for this function:

◆ IsValidNonHybrid()

bool CPubKey::IsValidNonHybrid ( ) const

inlinenoexcept

Check if a public key is a syntactically valid compressed or uncompressed key.

Definition at line 200 of file pubkey.h.

Here is the call graph for this function:

◆ operator[]()

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

inline

Definition at line 125 of file pubkey.h.

◆ RecoverCompact()

bool CPubKey::RecoverCompact	(	const uint256 &	hash,
		const std::vector< unsigned char > &	vchSig
	)

Recover a public key from a compact signature.

Definition at line 300 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize()

template<typename Stream >

void CPubKey::Serialize ( Stream & s ) const

inline

Implement serialization, as if this was a byte vector.

Definition at line 146 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Set()

template<typename T >

void CPubKey::Set	(	const T	pbegin,
		const T	pend
	)

inline

Initialize a public key using begin/end iterators to byte data.

Definition at line 98 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

unsigned int CPubKey::size ( ) const

inline

Simple read-only vector-like interface to the pubkey data.

Definition at line 121 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Unserialize()

template<typename Stream >

void CPubKey::Unserialize ( Stream & s )

inline

Definition at line 153 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ValidSize()

static bool CPubKey::ValidSize ( const std::vector< unsigned char > & vch )

inlinestatic

Definition at line 86 of file pubkey.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Verify()

bool CPubKey::Verify	(	const uint256 &	hash,
		const std::vector< unsigned char > &	vchSig
	)		const

Verify a DER signature (~72 bytes).

If this public key is not fully valid, the return value will be false.

Definition at line 283 of file pubkey.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ operator<

bool operator<	(	const CPubKey &	a,
		const CPubKey &	b
	)

friend

Definition at line 133 of file pubkey.h.

◆ operator==

bool operator==	(	const CPubKey &	a,
		const CPubKey &	b
	)

friend

Comparator implementation.

Definition at line 128 of file pubkey.h.

◆ operator>

bool operator>	(	const CPubKey &	a,
		const CPubKey &	b
	)

friend

Definition at line 138 of file pubkey.h.

Member Data Documentation

◆ COMPACT_SIGNATURE_SIZE

constexpr unsigned int CPubKey::COMPACT_SIGNATURE_SIZE = 65

staticconstexpr

Definition at line 51 of file pubkey.h.

◆ COMPRESSED_SIZE

constexpr unsigned int CPubKey::COMPRESSED_SIZE = 33

staticconstexpr

Definition at line 49 of file pubkey.h.

◆ SIGNATURE_SIZE

constexpr unsigned int CPubKey::SIGNATURE_SIZE = 72

staticconstexpr

Definition at line 50 of file pubkey.h.

◆ SIZE

constexpr unsigned int CPubKey::SIZE = 65

staticconstexpr

secp256k1:

Definition at line 48 of file pubkey.h.

◆ vch

unsigned char CPubKey::vch[SIZE]

private

see www.keylength.com script supports up to 75 for single byte push

Just store the serialized data. Its length can very cheaply be computed from the first byte.

Definition at line 66 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 Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CPubKey() [1/3]

◆ CPubKey() [2/3]

◆ CPubKey() [3/3]

Member Function Documentation

◆ begin()

◆ CheckLowS()

◆ data()

◆ Decompress()

◆ Derive()

◆ end()

◆ GetHash()

◆ GetID()

◆ GetLen()

◆ Invalidate()

◆ IsCompressed()

◆ IsFullyValid()

◆ IsValid()

◆ IsValidNonHybrid()

◆ operator[]()

◆ RecoverCompact()

◆ Serialize()

◆ Set()

◆ size()

◆ Unserialize()

◆ ValidSize()

◆ Verify()

Friends And Related Symbol Documentation

◆ operator<

◆ operator==

◆ operator>

Member Data Documentation

◆ COMPACT_SIGNATURE_SIZE

◆ COMPRESSED_SIZE

◆ SIGNATURE_SIZE

◆ SIZE

◆ vch