Test bdk crates with rust-bitcoin 1.0-rc

[notmandatory]

Describe the enhancement

Update and test bdk crates with rust-bitcoin 1.0 release candidate(s) and give feedback to that team.

See: rust-bitcoin/rust-bitcoin#5941

[Hamza1610]

@notmandatory I will like to be assigned to this task. my approach to this will be updating the Cargo.toml for the all the crates from:
[dependencies] bitcoin = { version = "0.32.0", default-features = false }
to:
[dependencies] bitcoin = { version = "1.0.0-rc.1", default-features = false }

then run cargo build to check for the failed test. I believe, the failed test should be accounted for the next PRs.
Given the list of crates to update:
bitcoind_rpc, chain, core, electrum, esplora, file_store, testenv

[Hamza1610]

Hey @notmandatory

I've looked into this issue(#2169) tested the master branch against the current rust-bitcoin master (0.33.0-beta) to see what breaks. Here's what I found.

Setup

I updated the bitcoin dependency in the following files to point at rust-bitcoin master:

• crates/bitcoind_rpc/Cargo.toml
• crates/core/Cargo.toml
• crates/testenv/Cargo.toml
• crates/chain/Cargo.toml

bitcoin = { git = "https://github.com/rust-bitcoin/rust-bitcoin", branch = "master", default-features = false }

First issue -- rand-std feature removed

The first thing that broke was in crates/testenv/Cargo.toml. The rand-std feature no longer exists in 0.33.0-beta. The available features are now:

arbitrary, base64, bitcoinconsensus, default, rand,
secp-global-context, secp-lowmemory, secp-recovery, serde, std

Fix was straightforward -- replaced bitcoin/rand-std with bitcoin/rand in the features section. Not a big deal but worth noting for anyone migrating.

Second issue -- Script and ScriptBuf are now generic

This one is more significant. After fixing the first issue, the build produced 18 errors all coming from crates/core/src/spk_client.rs. The root cause is that Script and ScriptBuf are now generic structs with a phantom type parameter T:

// rust-bitcoin master
pub struct ScriptBuf<T>(PhantomData<T>, Vec<u8>);
pub struct Script<T>(PhantomData<T>, [u8]);

Every place in masterbranch that usesScriptorScriptBufwithout a type parameter now fails to compile. This affects structs, function signatures, trait implementations, and type aliases throughoutspk_client.rs`. Here's a sample of the errors:

error[E0107]: missing generics for struct `ScriptBuf`
  --> crates/core/src/spk_client.rs:98:14
   |
98 |     pub spk: ScriptBuf,
   |              ^^^^^^^^^ expected 1 generic argument

18 errors in total just from this one file.

Third issue — BlockHash::all_zeros() removed

In crates/core/src/block_id.rs, BlockHash::all_zeros() no longer exists. The compiler suggests BlockHash::from_byte_array([0u8; 32]) as the replacement.

Fourth issue — block.time is now BlockTime not u32

In crates/core/src/checkpoint.rs, the time field on blocks changed from a raw u32 to a BlockTime newtype. Fix is adding .into() but worth flagging as a behavioural type change.

The bigger question

The ScriptBuf<T> change is not a mechanical find-and-replace migration. Since T is a phantom type used to distinguish script kinds at the type level, we need needs to decide what T should be in standard wallet contexts before the migration can proceed properly. Blindly adding <T> everywhere will just propagate a new generic parameter through the entire type system which is a significant refactor.

Screenshorts:

Would love some guidance from the rust-bitcoin team on what the intended migration path looks like for downstream crates using ScriptBuf in a general wallet context. Is there a concrete type alias we should be using, or is the expectation that downstream crates become generic over T as well?

Happy to keep digging and will update this comment as I find more. 🙏