Struct PubKey

pub struct PubKey { /* private fields */ }

| An encapsulated public key. | | Opaque data structure that holds a parsed | and valid public key. | | The exact representation of data inside | is implementation defined and not guaranteed | to be portable between different platforms | or versions. It is however guaranteed | to be 64 bytes in size, and can be safely | copied/moved. | | If you need to convert to a format suitable | for storage or transmission, use ec_pubkey_serialize | and ec_pubkey_parse. To compare keys, | use ec_pubkey_cmp. |

Implementations

impl PubKey

pub fn get_len(ch_header: u8) -> u32

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

pub fn invalidate(&mut self)

| Set this key data to be invalid |

pub fn valid_size(vch: &Vec<u8>) -> bool

pub fn set<T>(&mut self, pbegin: T, pend: T)

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

pub fn new_with_iter<T>(pbegin: T, pend: T) -> Self

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

pub fn new(slice: &[u8]) -> Self

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

pub fn size(&self) -> u32

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

pub fn data(&self) -> *const u8

pub fn begin(&self) -> *const u8

pub fn end(&self) -> *const u8

pub fn serialize<Stream>(&self, s: &mut Stream)

| Implement serialization, as if this | was a byte vector. |

pub fn unserialize<Stream>(&mut self, s: &mut Stream)

pub fn getid(&self) -> KeyID

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

pub fn get_hash(&self) -> u256

| Get the 256-bit hash of this public key. |

pub fn is_valid(&self) -> bool

| Check syntactic correctness. | | When setting a pubkey (Set()) or deserializing | fails (its header bytes don’t match | the length of the data), the size is set | to 0. Thus, by checking size, one can | observe whether Set() or deserialization | has failed. | | This does not check for more than that. | In particular, it does not verify that | the coordinates correspond to a point | on the curve (see IsFullyValid() for | that instead). | | ———– | @note | | this is consensus critical as | | CheckECDSASignature() calls it! |

pub fn is_compressed(&self) -> bool

| Check whether this is a compressed public | key. |

pub fn check_lows(&mut self, vch_sig: &Vec<u8>) -> bool

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

pub fn verify(&self, hash: &u256, vch_sig: &Vec<u8>) -> bool

| Verify a DER signature (~72 bytes). | | If this public key is not fully valid, | the return value will be false. |

pub fn recover_compact(&mut self, hash: &u256, vch_sig: &Vec<u8>) -> bool

| Recover a public key from a compact signature. |

pub fn is_fully_valid(&self) -> bool

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

pub fn decompress(&mut self) -> bool

| Turn this public key into an uncompressed | public key. |

pub fn derive( &self, pubkey_child: &mut PubKey, cc_child: &mut ChainCode, n_child: u32, cc: &ChainCode, ) -> bool

| Derive BIP32 child pubkey. |

Trait Implementations

impl Clone for PubKey

fn clone(&self) -> PubKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PubKey

fn default() -> Self

| Construct an invalid public key. |

impl From<&[u8]> for PubKey

fn from(vch: &[u8]) -> Self

| Construct a public key from a byte vector. |

impl From<&PubKey> for XOnlyPubKey

fn from(pubkey: &PubKey) -> Self

| Construct an x-only pubkey from a normal | pubkey. |

impl Hash for PubKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<u32> for PubKey

type Output = u8

The returned type after indexing.

fn index(&self, pos: u32) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for PubKey

fn cmp(&self, other: &PubKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PubKey

fn eq(&self, other: &PubKey) -> bool

Comparator implementation.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PubKey

fn partial_cmp(&self, other: &PubKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PubKey