Struct Bip32KeyProvider 

pub struct Bip32KeyProvider { /* private fields */ }

A BIP32 hierarchical deterministic key provider

This provider derives keypairs from a master extended private key using BIP32 derivation paths. It maintains an index counter for generating new receiving addresses.

Example

fn example() -> Result<(), Box<dyn std::error::Error>> {
// Create from a master key with a base path (e.g., m/84'/0'/0'/0)
let master_key = Xpriv::from_str("xprv...")?;
let base_path = DerivationPath::from_str("m/84'/0'/0'/0")?;

// This will derive keys at m/84'/0'/0'/0/0, m/84'/0'/0'/0/1, etc.
let provider = Bip32KeyProvider::new(master_key, base_path);

// Get the next receiving keypair (increments index)
let kp1 = provider.get_next_keypair(KeypairIndex::New)?; // m/84'/0'/0'/0/0
let kp2 = provider.get_next_keypair(KeypairIndex::New)?; // m/84'/0'/0'/0/1

// Or derive a specific keypair by path
let custom_path = vec![84 + 0x8000_0000, 0x8000_0000, 0x8000_0000, 0, 5];
let kp = provider.get_keypair_for_path(&custom_path)?;

Implementations

impl Bip32KeyProvider

pub fn new(master_key: Xpriv, base_path: DerivationPath) -> Self

Create a new BIP32 key provider

Arguments

• master_key - The master extended private key (xpriv)
• base_path - The base derivation path (e.g., m/84’/0’/0’/0). The provider will append index numbers to this path.

pub fn new_with_index( master_key: Xpriv, base_path: DerivationPath, start_index: u32, ) -> Self

Create a new BIP32 key provider starting from a specific index

Arguments

• master_key - The master extended private key (xpriv)
• base_path - The base derivation path
• start_index - The starting index for key derivation

Trait Implementations

impl KeyProvider for Bip32KeyProvider

fn get_next_keypair( &self, keypair_index: KeypairIndex, ) -> Result<Keypair, Error>

Get a keypair for receiving funds

fn get_keypair_for_path(&self, path: &[u32]) -> Result<Keypair, Error>

Get a keypair for a specific BIP32 derivation path

fn get_keypair_for_pk(&self, pk: &XOnlyPublicKey) -> Result<Keypair, Error>

Get a keypair for a specific public key

fn get_cached_pks(&self) -> Result<Vec<XOnlyPublicKey>, Error>

Get all public keys that this provider currently knows about

fn supports_discovery(&self) -> bool

Returns true if this provider supports key discovery

fn get_derivation_index_for_pk(&self, pk: &XOnlyPublicKey) -> Option<u32>

Get the derivation index for a cached public key.

fn derive_at_discovery_index( &self, index: u32, ) -> Result<Option<Keypair>, Error>

Derive a keypair at a specific index without caching

fn cache_discovered_keypair(&self, index: u32, kp: Keypair) -> Result<(), Error>

Cache a discovered keypair at the given index

fn mark_as_used(&self, pk: &XOnlyPublicKey) -> Result<(), Error>