Bitcoin
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
CPubKey Class Reference

#include <pubkey.h>

Public Member Functions

 CPubKey ()
 Construct an invalid public key. More...
 
template<typename T >
void Set (const T pbegin, const T pend)
 Initialize a public key using begin/end iterators to byte data. More...
 
template<typename T >
 CPubKey (const T pbegin, const T pend)
 Construct a public key using begin/end iterators to byte data. More...
 
 CPubKey (const std::vector< unsigned char > &_vch)
 Construct a public key from a byte vector. More...
 
unsigned int size () const
 Simple read-only vector-like interface to the pubkey data. More...
 
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. More...
 
template<typename Stream >
void Unserialize (Stream &s)
 
CKeyID GetID () const
 Get the KeyID of this public key (hash of its serialization) More...
 
uint256 GetHash () const
 Get the 256-bit hash of this public key. More...
 
bool IsValid () const
 
bool IsFullyValid () const
 fully validate whether this is a valid public key (more expensive than IsValid()) More...
 
bool IsCompressed () const
 Check whether this is a compressed public key. More...
 
bool Verify (const uint256 &hash, const std::vector< unsigned char > &vchSig) const
 
bool RecoverCompact (const uint256 &hash, const std::vector< unsigned char > &vchSig)
 Recover a public key from a compact signature. More...
 
bool Decompress ()
 Turn this public key into an uncompressed public key. More...
 
bool Derive (CPubKey &pubkeyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode &cc) const
 Derive BIP32 child pubkey. More...
 

Static Public Member Functions

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

Static Public Attributes

static constexpr unsigned int PUBLIC_KEY_SIZE = 65
 
static constexpr unsigned int COMPRESSED_PUBLIC_KEY_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. More...
 

Static Private Member Functions

unsigned static int GetLen (unsigned char chHeader)
 Compute the length of a pubkey with a given first byte. More...
 

Private Attributes

unsigned char vch [PUBLIC_KEY_SIZE]
 

Friends

bool operator== (const CPubKey &a, const CPubKey &b)
 Comparator implementation. More...
 
bool operator!= (const CPubKey &a, const CPubKey &b)
 
bool operator< (const CPubKey &a, const CPubKey &b)
 

Detailed Description

An encapsulated public key.

Constructor & Destructor Documentation

◆ CPubKey() [1/3]

CPubKey::CPubKey ( )
inline

Construct an invalid public key.

◆ 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.

◆ CPubKey() [3/3]

CPubKey::CPubKey ( const std::vector< unsigned char > &  _vch)
inlineexplicit

Construct a public key from a byte vector.

Member Function Documentation

◆ begin()

const unsigned char* CPubKey::begin ( ) const
inline

◆ CheckLowS()

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

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

◆ data()

const unsigned char* CPubKey::data ( ) const
inline

◆ Decompress()

bool CPubKey::Decompress ( )

Turn this public key into an uncompressed public key.

◆ Derive()

bool CPubKey::Derive ( CPubKey pubkeyChild,
ChainCode ccChild,
unsigned int  nChild,
const ChainCode cc 
) const

Derive BIP32 child pubkey.

◆ end()

const unsigned char* CPubKey::end ( ) const
inline

◆ GetHash()

uint256 CPubKey::GetHash ( ) const
inline

Get the 256-bit hash of this public key.

◆ GetID()

CKeyID CPubKey::GetID ( ) const
inline

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

◆ GetLen()

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

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

◆ Invalidate()

void CPubKey::Invalidate ( )
inlineprivate

Set this key data to be invalid.

◆ IsCompressed()

bool CPubKey::IsCompressed ( ) const
inline

Check whether this is a compressed public key.

◆ IsFullyValid()

bool CPubKey::IsFullyValid ( ) const

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

◆ IsValid()

bool CPubKey::IsValid ( ) const
inline

◆ operator[]()

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

◆ RecoverCompact()

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

Recover a public key from a compact signature.

◆ Serialize()

template<typename Stream >
void CPubKey::Serialize ( Stream &  s) const
inline

Implement serialization, as if this was a byte vector.

◆ 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.

◆ size()

unsigned int CPubKey::size ( ) const
inline

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

◆ Unserialize()

template<typename Stream >
void CPubKey::Unserialize ( Stream &  s)
inline

◆ ValidSize()

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

◆ 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.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const CPubKey a,
const CPubKey b 
)
friend

◆ operator<

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

◆ operator==

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

Comparator implementation.

Member Data Documentation

◆ COMPACT_SIGNATURE_SIZE

constexpr unsigned int CPubKey::COMPACT_SIGNATURE_SIZE = 65
static

◆ COMPRESSED_PUBLIC_KEY_SIZE

constexpr unsigned int CPubKey::COMPRESSED_PUBLIC_KEY_SIZE = 33
static

◆ PUBLIC_KEY_SIZE

constexpr unsigned int CPubKey::PUBLIC_KEY_SIZE = 65
static

secp256k1:

◆ SIGNATURE_SIZE

constexpr unsigned int CPubKey::SIGNATURE_SIZE = 72
static

◆ vch

unsigned char CPubKey::vch[PUBLIC_KEY_SIZE]
private

see www.keylength.com script supports up to 75 for single byte pushJust store the serialized data. Its length can very cheaply be computed from the first byte.


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