Struct iop_keyvault::Bip32Node

pub struct Bip32Node<C: KeyDerivationCrypto + 'static> { /* private fields */ }

In BIP-0032 each extended private key has the same operations, independently from the actual path. This struct represents such an extended private key in a given subtree.

Implementations

impl<C: KeyDerivationCrypto + 'static> Bip32Node<C>

pub fn new(
    path: Path,
    xsk: <C as KeyDerivationCrypto>::ExtendedPrivateKey,
    subtree: &'static dyn Subtree<Suite = C>
) -> Self

Backdoor for advanced or fringe non-standard use-cases. Use [Bip32.master] instead for normal use-cases.

pub fn path(&self) -> &Path

Accessor for the BIP32 path of this node

pub fn xsk(&self) -> &<C as KeyDerivationCrypto>::ExtendedPrivateKey

Accessor for the extended private key of this node

pub fn subtree(&self) -> &'static dyn Subtree<Suite = C>

Accessor for the subtree of this node

pub fn neuter(&self) -> Bip32PublicNode<C>

Removes the ability to sign and derive hardened keys. The public node it returns is still able to provide normal derivation and signature verifications.

pub fn derive_normal(&self, idx: i32) -> Result<Bip32Node<C>>

Create a new node with normal (public) derivation with the given index.

pub fn derive_hardened(&self, idx: i32) -> Result<Bip32Node<C>>

Create a new node with hardened (private) derivation with the given index.

pub fn private_key(&self) -> C::PrivateKey

Creates the private key that belongs to this node for authenticating actions.

impl Bip32Node<Secp256k1>

pub fn from_xprv(
    path: Path,
    xprv: impl AsRef<str>,
    network: &'static dyn Network<Suite = Secp256k1>
) -> Result<Bip32Node<Secp256k1>>

Recreates the BIP32 node from its parts

pub fn to_xprv(
    &self,
    network: &'static dyn Network<Suite = Secp256k1>
) -> String

Returns the extended private key in the BIP32 readable format with the version bytes of the network.

pub fn to_wif(&self, network: &'static dyn Network<Suite = Secp256k1>) -> String

Returns the private key in the Wallet Import Format with the version byte of the network.

Trait Implementations

impl<C: Clone + KeyDerivationCrypto + 'static> Clone for Bip32Node<C>

fn clone(&self) -> Bip32Node<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: KeyDerivationCrypto + 'static> Debug for Bip32Node<C>

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

Formats the value using the given formatter.