Skip to content

refactor(wallet)!: Replace new_or_load() with load_with_descriptors() #1512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
notmandatory wants to merge 1 commit into from
Closed

refactor(wallet)!: Replace new_or_load() with load_with_descriptors() #1512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions crates/wallet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,11 @@ let mut db =
let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
let changeset = db.aggregate_changesets().expect("changeset loaded");
let mut wallet =
Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
.expect("create or load wallet");
let mut wallet = if let Some(changeset) = changeset {
Wallet::load(changeset).expect("loaded wallet")
} else {
Wallet::new(descriptor, change_descriptor, Network::Testnet).expect("created new wallet")
};

// Get a new address to receive bitcoin.
let receive_address = wallet.reveal_next_address(KeychainKind::External);
Expand Down
292 changes: 93 additions & 199 deletions crates/wallet/src/wallet/mod.rs
View file
Open in desktop

Large diffs are not rendered by default.

110 changes: 40 additions & 70 deletions crates/wallet/tests/wallet.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ fn load_recovers_wallet() -> anyhow::Result<()> {
let db = &mut recover(&file_path).expect("must recover db");
let changeset = read(db).expect("must recover wallet").expect("changeset");

let wallet = Wallet::load_from_changeset(changeset).expect("must recover wallet");
let wallet = Wallet::load(changeset).expect("must recover wallet");
assert_eq!(wallet.network(), Network::Testnet);
assert_eq!(
wallet.spk_index().keychains().collect::<Vec<_>>(),
Expand Down Expand Up @@ -182,78 +182,32 @@ fn load_recovers_wallet() -> anyhow::Result<()> {
}

#[test]
fn new_or_load() -> anyhow::Result<()> {
fn run<Db, NewOrRecover, Read, Write>(
fn new_and_load() -> anyhow::Result<()> {
fn run<Db, Recover, Read, Write>(
filename: &str,
new_or_load: NewOrRecover,
load: Recover,
read: Read,
write: Write,
) -> anyhow::Result<()>
where
NewOrRecover: Fn(&Path) -> anyhow::Result<Db>,
Recover: Fn(&Path) -> anyhow::Result<Db>,
Read: Fn(&mut Db) -> anyhow::Result<Option<ChangeSet>>,
Write: Fn(&mut Db, &ChangeSet) -> anyhow::Result<()>,
{
let temp_dir = tempfile::tempdir().expect("must create tempdir");
let file_path = temp_dir.path().join(filename);
let (desc, change_desc) = get_test_wpkh_with_change_desc();

// init wallet when non-existent
// init wallet
let wallet_keychains: BTreeMap<_, _> = {
let wallet = &mut Wallet::new_or_load(desc, change_desc, None, Network::Testnet)
.expect("must init wallet");
let mut db = new_or_load(&file_path).expect("must create db");
if let Some(changeset) = wallet.take_staged() {
write(&mut db, &changeset)?;
}
let wallet =
&mut Wallet::new(desc, change_desc, Network::Testnet).expect("must init wallet");
let changeset = wallet.take_staged().expect("must have changeset");
let db = &mut load(&file_path).expect("must open db");
write(db, &changeset)?;
wallet.keychains().map(|(k, v)| (*k, v.clone())).collect()
};

// wrong network
{
let mut db = new_or_load(&file_path).expect("must create db");
let changeset = read(&mut db)?;
let err = Wallet::new_or_load(desc, change_desc, changeset, Network::Bitcoin)
.expect_err("wrong network");
assert!(
matches!(
err,
bdk_wallet::wallet::NewOrLoadError::LoadedNetworkDoesNotMatch {
got: Some(Network::Testnet),
expected: Network::Bitcoin
}
),
"err: {}",
err,
);
}

// wrong genesis hash
{
let exp_blockhash = BlockHash::all_zeros();
let got_blockhash = bitcoin::constants::genesis_block(Network::Testnet).block_hash();

let db = &mut new_or_load(&file_path).expect("must open db");
let changeset = read(db)?;
let err = Wallet::new_or_load_with_genesis_hash(
desc,
change_desc,
changeset,
Network::Testnet,
exp_blockhash,
)
.expect_err("wrong genesis hash");
assert!(
matches!(
err,
bdk_wallet::wallet::NewOrLoadError::LoadedGenesisDoesNotMatch { got, expected }
if got == Some(got_blockhash) && expected == exp_blockhash
),
"err: {}",
err,
);
}

// wrong external descriptor
{
let (exp_descriptor, exp_change_desc) = get_test_tr_single_sig_xprv_with_change_desc();
Expand All @@ -262,15 +216,14 @@ fn new_or_load() -> anyhow::Result<()> {
.unwrap()
.0;

let db = &mut new_or_load(&file_path).expect("must open db");
let changeset = read(db)?;
let err =
Wallet::new_or_load(exp_descriptor, exp_change_desc, changeset, Network::Testnet)
.expect_err("wrong external descriptor");
let db = &mut load(&file_path).expect("must open db");
let changeset = read(db)?.expect("changeset must exist");
let err = Wallet::load_with_descriptors(exp_descriptor, exp_change_desc, changeset)
.expect_err("wrong external descriptor");
assert!(
matches!(
err,
bdk_wallet::wallet::NewOrLoadError::LoadedDescriptorDoesNotMatch { ref got, keychain }
bdk_wallet::wallet::LoadError::LoadedDescriptorDoesNotMatch { ref got, keychain }
if got == &Some(got_descriptor) && keychain == KeychainKind::External
),
"err: {}",
Expand All @@ -286,14 +239,14 @@ fn new_or_load() -> anyhow::Result<()> {
.unwrap()
.0;

let db = &mut new_or_load(&file_path).expect("must open db");
let changeset = read(db)?;
let err = Wallet::new_or_load(desc, exp_descriptor, changeset, Network::Testnet)
let db = &mut load(&file_path).expect("must open db");
let changeset = read(db)?.expect("changeset must exist");
let err = Wallet::load_with_descriptors(desc, exp_descriptor, changeset)
.expect_err("wrong internal descriptor");
assert!(
matches!(
err,
bdk_wallet::wallet::NewOrLoadError::LoadedDescriptorDoesNotMatch { ref got, keychain }
bdk_wallet::wallet::LoadError::LoadedDescriptorDoesNotMatch { ref got, keychain }
if got == &Some(got_descriptor) && keychain == KeychainKind::Internal
),
"err: {}",
Expand All @@ -303,16 +256,33 @@ fn new_or_load() -> anyhow::Result<()> {

// all parameters match
{
let db = &mut new_or_load(&file_path).expect("must open db");
let changeset = read(db)?;
let wallet = Wallet::new_or_load(desc, change_desc, changeset, Network::Testnet)
let db = &mut load(&file_path).expect("must open db");
let changeset = read(db)?.expect("changeset must exist");
let wallet = Wallet::load_with_descriptors(desc, change_desc, changeset)
.expect("must recover wallet");
assert_eq!(wallet.network(), Network::Testnet);
assert!(wallet
.keychains()
.map(|(k, v)| (*k, v.clone()))
.eq(wallet_keychains));
}

// signers added
{
let db = &mut load(&file_path).expect("must open db");
let changeset = read(db)?.expect("changeset must exist");
let wallet = Wallet::load_with_descriptors(desc, change_desc, changeset)
.expect("must recover wallet");
assert_eq!(
wallet.get_signers(KeychainKind::External).signers().len(),
1
);
assert_eq!(
wallet.get_signers(KeychainKind::Internal).signers().len(),
1
);
}

Ok(())
}

Expand Down
11 changes: 5 additions & 6 deletions example-crates/wallet_electrum/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,11 @@ fn main() -> Result<(), anyhow::Error> {
let changeset = db
.aggregate_changesets()
.map_err(|e| anyhow!("load changes error: {}", e))?;
let mut wallet = Wallet::new_or_load(
external_descriptor,
internal_descriptor,
changeset,
Network::Testnet,
)?;
let mut wallet = if let Some(changeset) = changeset {
Wallet::load_with_descriptors(external_descriptor, internal_descriptor, changeset)?
} else {
Wallet::new(external_descriptor, internal_descriptor, Network::Testnet)?
};

let address = wallet.next_unused_address(KeychainKind::External);
if let Some(changeset) = wallet.take_staged() {
Expand Down
11 changes: 5 additions & 6 deletions example-crates/wallet_esplora_async/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@ async fn main() -> Result<(), anyhow::Error> {
let internal_descriptor = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/1/*)";
let changeset = db.read()?;

let mut wallet = Wallet::new_or_load(
external_descriptor,
internal_descriptor,
changeset,
Network::Signet,
)?;
let mut wallet = if let Some(changeset) = changeset {
Wallet::load_with_descriptors(external_descriptor, internal_descriptor, changeset)?
} else {
Wallet::new(external_descriptor, internal_descriptor, Network::Testnet)?
Copy link
Copy Markdown
Collaborator

@ValuedMammal ValuedMammal Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency should we have Signet here?

Suggested change
Wallet::new(external_descriptor, internal_descriptor, Network::Testnet)?
Wallet::new(external_descriptor, internal_descriptor, Network::Signet)?

Copy link
Copy Markdown

@storopoli storopoli Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is addressed already in #1442.

};

let address = wallet.next_unused_address(KeychainKind::External);
if let Some(changeset) = wallet.take_staged() {
Expand Down
11 changes: 5 additions & 6 deletions example-crates/wallet_esplora_blocking/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,11 @@ fn main() -> Result<(), anyhow::Error> {
let internal_descriptor = "wpkh(tprv8ZgxMBicQKsPdy6LMhUtFHAgpocR8GC6QmwMSFpZs7h6Eziw3SpThFfczTDh5rW2krkqffa11UpX3XkeTTB2FvzZKWXqPY54Y6Rq4AQ5R8L/84'/1'/0'/1/*)";
let changeset = db.aggregate_changesets()?;

let mut wallet = Wallet::new_or_load(
external_descriptor,
internal_descriptor,
changeset,
Network::Testnet,
)?;
let mut wallet = if let Some(changeset) = changeset {
Wallet::load_with_descriptors(external_descriptor, internal_descriptor, changeset)?
} else {
Wallet::new(external_descriptor, internal_descriptor, Network::Testnet)?
};

let address = wallet.next_unused_address(KeychainKind::External);
if let Some(changeset) = wallet.take_staged() {
Expand Down
12 changes: 6 additions & 6 deletions example-crates/wallet_rpc/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ fn main() -> anyhow::Result<()> {
)?;
let changeset = db.aggregate_changesets()?;

let mut wallet = Wallet::new_or_load(
&args.descriptor,
&args.change_descriptor,
changeset,
args.network,
)?;
let mut wallet = if let Some(changeset) = changeset {
Wallet::load_with_descriptors(&args.descriptor, &args.change_descriptor, changeset)?
} else {
Wallet::new(&args.descriptor, &args.change_descriptor, Network::Testnet)?
Copy link
Copy Markdown
Collaborator

@ValuedMammal ValuedMammal Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Wallet::new(&args.descriptor, &args.change_descriptor, Network::Testnet)?
Wallet::new(&args.descriptor, &args.change_descriptor, args.network)?

Copy link
Copy Markdown

@storopoli storopoli Jul 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is addressed already in #1442.

};

println!(
"Loaded wallet in {}s",
start_load_wallet.elapsed().as_secs_f32()
Expand Down