Struct Xpub

pub struct Xpub {
    pub network: NetworkKind,
    pub depth: u8,
    pub parent_fingerprint: Fingerprint,
    pub child_number: ChildNumber,
    pub public_key: PublicKey,
    pub chain_code: ChainCode,
}

Extended public key

Fields

network: NetworkKind

The network kind this key is to be used on

depth: u8

How many derivations this key is from the master (which is 0)

parent_fingerprint: Fingerprint

Fingerprint of the parent key

child_number: ChildNumber

Child number of the key used to derive from parent (0 for master)

public_key: PublicKey

Public key

chain_code: ChainCode

Chain code

Implementations

impl Xpub

pub fn from_priv<C>(secp: &Secp256k1<C>, sk: &Xpriv) -> Xpub

where C: Signing,

Derives a public key from a private key

pub fn to_pub(self) -> CompressedPublicKey

Constructs ECDSA compressed public key matching internal public key representation.

pub fn to_x_only_pub(self) -> XOnlyPublicKey

Constructs BIP340 x-only public key for BIP-340 signatures and Taproot use matching the internal public key representation.

pub fn derive_pub<C, P>( &self, secp: &Secp256k1<C>, path: &P, ) -> Result<Xpub, Error>

where C: Verification, P: AsRef<[ChildNumber]>,

Attempts to derive an extended public key from a path.

The path argument can be any type implementing AsRef<ChildNumber>, such as DerivationPath, for instance.

pub fn ckd_pub_tweak( &self, i: ChildNumber, ) -> Result<(SecretKey, ChainCode), Error>

Compute the scalar tweak added to this key to get a child key

pub fn ckd_pub<C>( &self, secp: &Secp256k1<C>, i: ChildNumber, ) -> Result<Xpub, Error>

where C: Verification,

Public->Public child key derivation

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

Decoding extended public key from binary data according to BIP 32

pub fn encode(&self) -> [u8; 78]

Extended public key binary encoding according to BIP 32

pub fn identifier(&self) -> XKeyIdentifier

Returns the HASH160 of the chaincode

pub fn fingerprint(&self) -> Fingerprint

Returns the first four bytes of the identifier

Trait Implementations

impl Clone for Xpub

fn clone(&self) -> Xpub

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Xpub

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Xpub

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Xpub

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

Formats the value using the given formatter.

impl From<&Xpub> for XKeyIdentifier

fn from(key: &Xpub) -> XKeyIdentifier

Converts to this type from the input type.

impl From<Xpub> for XKeyIdentifier

fn from(key: Xpub) -> XKeyIdentifier

Converts to this type from the input type.

impl FromStr for Xpub

type Err = Error

The associated error which can be returned from parsing.

fn from_str(inp: &str) -> Result<Xpub, Error>

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

impl Hash for Xpub

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 InnerXKey for Xpub

fn xkey_fingerprint<C>(&self, _secp: &Secp256k1<C>) -> Fingerprint

where C: Signing,

Returns the fingerprint of the key

fn can_derive_hardened() -> bool

Returns whether hardened steps can be derived on the key

impl Ord for Xpub

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

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Xpub

impl Eq for Xpub

impl StructuralPartialEq for Xpub