Struct sapio_bitcoin::util::bip32::ExtendedPubKey

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

Extended public key

Fields

network: Network

The network 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 ExtendedPubKey

pub fn from_private<C: Signing>(
    secp: &Secp256k1<C>,
    sk: &ExtendedPrivKey
) -> ExtendedPubKey

Derives a public key from a private key

pub fn derive_pub<C: Verification, P: AsRef<[ChildNumber]>>(
    &self,
    secp: &Secp256k1<C>,
    path: &P
) -> Result<ExtendedPubKey, Error>

Attempts to derive an extended public key from a path.

The path argument can be both of type DerivationPath or Vec<ChildNumber>.

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

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

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

Public->Public child key derivation

pub fn decode(data: &[u8]) -> Result<ExtendedPubKey, 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) -> XpubIdentifier

Returns the HASH160 of the chaincode

pub fn fingerprint(&self) -> Fingerprint

Returns the first four bytes of the identifier

Trait Implementations

impl Clone for ExtendedPubKey

fn clone(&self) -> ExtendedPubKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ExtendedPubKey

impl Debug for ExtendedPubKey

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

Formats the value using the given formatter.

impl Display for ExtendedPubKey

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

Formats the value using the given formatter.

impl Eq for ExtendedPubKey

impl FromStr for ExtendedPubKey

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for ExtendedPubKey

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ExtendedPubKey

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ExtendedPubKey> for ExtendedPubKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ExtendedPubKey> for ExtendedPubKey

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for ExtendedPubKey

impl StructuralPartialEq for ExtendedPubKey