Struct CompressedPublicKey

pub struct CompressedPublicKey(pub PublicKey);

An always-compressed Bitcoin ECDSA public key

Tuple Fields

0: PublicKey

Implementations

impl CompressedPublicKey

pub fn pubkey_hash(&self) -> PubkeyHash

Returns bitcoin 160-bit hash of the public key

pub fn wpubkey_hash(&self) -> WPubkeyHash

Returns bitcoin 160-bit hash of the public key for witness program

pub fn p2wpkh_script_code(&self) -> ScriptBuf

Returns the script code used to spend a P2WPKH input.

pub fn write_into<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Write the public key into a writer

pub fn read_from<R>(reader: &mut R) -> Result<CompressedPublicKey, Error>

where R: Read + ?Sized,

Read the public key from a reader

This internally reads the first byte before reading the rest, so use of a BufReader is recommended.

pub fn to_bytes(&self) -> [u8; 33]

Serializes the public key.

As the type name suggests, the key is serialzied in compressed format.

Note that this can be used as a sort key to get BIP67-compliant sorting. That’s why this type doesn’t have the to_sort_key method - it would duplicate this one.

pub fn from_slice(data: &[u8]) -> Result<CompressedPublicKey, Error>

Deserialize a public key from a slice

pub fn from_private_key<C>( secp: &Secp256k1<C>, sk: &PrivateKey, ) -> Result<CompressedPublicKey, UncompressedPublicKeyError>

where C: Signing,

Computes the public key as supposed to be used with this secret

pub fn verify<C>( &self, secp: &Secp256k1<C>, msg: &Message, sig: &Signature, ) -> Result<(), Error>

where C: Verification,

Checks that sig is a valid ECDSA signature for msg using this public key.

Trait Implementations

impl Clone for CompressedPublicKey

fn clone(&self) -> CompressedPublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressedPublicKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompressedPublicKey

fn deserialize<D>( d: D, ) -> Result<CompressedPublicKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CompressedPublicKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&CompressedPublicKey> for PubkeyHash

fn from(key: &CompressedPublicKey) -> PubkeyHash

Converts to this type from the input type.

impl From<&CompressedPublicKey> for WPubkeyHash

fn from(key: &CompressedPublicKey) -> WPubkeyHash

Converts to this type from the input type.

impl From<CompressedPublicKey> for PubkeyHash

fn from(key: CompressedPublicKey) -> PubkeyHash

Converts to this type from the input type.

impl From<CompressedPublicKey> for PublicKey

fn from(value: CompressedPublicKey) -> PublicKey

Converts to this type from the input type.

impl From<CompressedPublicKey> for WPubkeyHash

fn from(key: CompressedPublicKey) -> WPubkeyHash

Converts to this type from the input type.

impl From<CompressedPublicKey> for XOnlyPublicKey

fn from(pk: CompressedPublicKey) -> XOnlyPublicKey

Converts to this type from the input type.

impl FromStr for CompressedPublicKey

type Err = ParseCompressedPublicKeyError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<CompressedPublicKey, <CompressedPublicKey as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for CompressedPublicKey

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

where __H: Hasher,

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 Ord for CompressedPublicKey

fn cmp(&self, other: &CompressedPublicKey) -> 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 CompressedPublicKey

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

Tests for self and other values to be equal, and is used by ==.

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 CompressedPublicKey

fn partial_cmp(&self, other: &CompressedPublicKey) -> 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 Serialize for CompressedPublicKey

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PublicKey> for CompressedPublicKey

type Error = UncompressedPublicKeyError

The type returned in the event of a conversion error.

fn try_from( value: PublicKey, ) -> Result<CompressedPublicKey, <CompressedPublicKey as TryFrom<PublicKey>>::Error>

Performs the conversion.

impl Copy for CompressedPublicKey

impl Eq for CompressedPublicKey

impl StructuralPartialEq for CompressedPublicKey