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(sk: &Xpriv) -> Self

👎Deprecating in a future version:

use from_xpriv() instead

Constructs a new extended public key from an extended private key.

pub fn from_xpriv(xpriv: &Xpriv) -> Self

Constructs a new extended public key from an extended private key.

pub fn to_pub(self) -> FullPublicKey

👎Deprecating in a future version:

use to_public_key() instead

Constructs a new ECDSA compressed public key matching internal public key representation.

pub fn to_public_key(self) -> FullPublicKey

Constructs a new ECDSA compressed public key matching internal public key representation.

pub fn to_x_only_pub(self) -> XOnlyPublicKey

👎Deprecating in a future version:

use to_x_only_public_key() instead

Constructs a new BIP-0340 x-only public key for BIP-0340 signatures and Taproot use matching the internal public key representation.

pub fn to_x_only_public_key(self) -> XOnlyPublicKey

Constructs a new BIP-0340 x-only public key for BIP-0340 signatures and Taproot use matching the internal public key representation.

pub fn derive_pub<P: AsRef<[ChildNumber]>>( &self, path: P, ) -> Result<Self, DerivationError>

👎Deprecating in a future version:

use derive_xpub() instead

Attempts to derive an extended public key from a path.

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

Errors

See derive_xpub.

pub fn derive_xpub<P: AsRef<[ChildNumber]>>( &self, path: P, ) -> Result<Self, DerivationError>

Attempts to derive an extended public key from a path.

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

Errors

Returns an error if any of the ChildNumbers are hardened.

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

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

Errors

Returns an error if the given ChildNumber is hardened.

pub fn ckd_pub(&self, i: ChildNumber) -> Result<Self, DerivationError>

Public->Public child key derivation

Errors

Returns an error if the given ChildNumber is hardened, or if next key exceeds the maximum derivation depth.

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

Decoding extended public key from binary data according to BIP-0032

Errors

• ParseError::UnknownVersion if the decoded network value is not main or testnet.
• ParseError::Secp256k1 if the public key bytes are not a valid secp public key.
• ParseError::WrongExtendedKeyLength if the data is not the correct length.
• ParseError::NonZeroParentFingerprintForMasterKey if the depth is 0 and the master key fingerprint is non-zero.
• ParseError::NonZeroChildNumberForMasterKey if the depth is 0 and the child number is non-zero.

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

Extended public key binary encoding according to BIP-0032

pub fn identifier(&self) -> XKeyIdentifier

Returns the HASH160 of the public key component of the xpub

pub fn fingerprint(&self) -> Fingerprint

Returns the first four bytes of the identifier

Trait Implementations

impl<'a> Arbitrary<'a> for Xpub

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Xpub

fn clone(&self) -> Xpub

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Xpub

impl Debug for Xpub

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Xpub, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Xpub

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

Formats the value using the given formatter.

impl Eq for Xpub

impl From<&Xpub> for XKeyIdentifier

fn from(key: &Xpub) -> Self

Converts to this type from the input type.

impl From<Xpub> for XKeyIdentifier

fn from(key: Xpub) -> Self

Converts to this type from the input type.

impl FromStr for Xpub

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(inp: &str) -> Result<Self, ParseError>

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

impl Hash for Xpub

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 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::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Xpub