Crate bdk_redb

This crate provides an alternative to the sqlite persistence backend for BDK using redb, a lightweight key-value store in Rust.

Example

Add this to your Cargo.toml :

[dependencies]
anyhow = "1.0.98"
bdk_redb = "0.1.1"
bdk_wallet = "2.0.0"
tempfile = "3.20.0"

Now:

    use bdk_wallet::bitcoin::Network;
    use bdk_wallet::{KeychainKind, Wallet};
    use std::sync::Arc;
    use tempfile::NamedTempFile;
     
    use anyhow::Result;
     
    // Warning: Descriptors below are on a test network and only serve as an example.
    // MAINNET funds sent to addresses controlled by these descriptors will be LOST!
    const EXTERNAL_DESCRIPTOR: &str = "tr(tprv8ZgxMBicQKsPdrjwWCyXqqJ4YqcyG4DmKtjjsRt29v1PtD3r3PuFJAjWytzcvSTKnZAGAkPSmnrdnuHWxCAwy3i1iPhrtKAfXRH7dVCNGp6/86'/1'/0'/0/*)#g9xn7wf9";
    const INTERNAL_DESCRIPTOR: &str = "tr(tprv8ZgxMBicQKsPdrjwWCyXqqJ4YqcyG4DmKtjjsRt29v1PtD3r3PuFJAjWytzcvSTKnZAGAkPSmnrdnuHWxCAwy3i1iPhrtKAfXRH7dVCNGp6/86'/1'/0'/1/*)#e3rjrmea";
     
    fn main() -> Result<()> {
        let network = Network::Signet;
        let file_path = NamedTempFile::new()?;
        let db = Arc::new(bdk_redb::redb::Database::create(file_path.path())?);
        let mut store = bdk_redb::Store::new(db, "wallet1".to_string())?;
     
        let wallet_opt = Wallet::load()
            .descriptor(KeychainKind::External, Some(EXTERNAL_DESCRIPTOR))
            .descriptor(KeychainKind::Internal, Some(INTERNAL_DESCRIPTOR))
            .extract_keys()
            .check_network(network)
            .load_wallet(&mut store)?;
     
        let mut wallet = match wallet_opt {
            Some(wallet) => {
                println!("Loaded existing wallet database.");
                wallet
            }
            None => {
                println!("Creating new wallet database.");
                Wallet::create(EXTERNAL_DESCRIPTOR, INTERNAL_DESCRIPTOR)
                    .network(network)
                    .create_wallet(&mut store)?
            }
        };
        // Reveal a new address from your external keychain
        let address = wallet.reveal_next_address(KeychainKind::External);
        wallet.persist(&mut store)?;
        // Only share new address with user after successfully persisting wallet
        println!("Wallet address[{}]: {}", address.index, address.address);
     
        Ok(())
    }

Also note that BDK uses structures called ChangeSets for persistence so while the documentation of each function links to the structures it is trying to eventually persist, the function actually uses the corresponding ChangeSets.

Re-exports

pub use redb;

Modules

anchor_trait

This module contains AnchorWithMetaData trait and implementations of the trait for some types.

error

This module contains the crate’s error type.

Structs

Store

Persists the bdk_chain and bdk_wallet structures in a redb database.