Make repo into a single crate

Author: ValuedMammal

.github/workflows/cont_integration.yml

@@ -54,7 +54,7 @@ jobs:
         env:
           MATRIX_RUST_VERSION: ${{ matrix.rust.version }}
         run: |
-          cargo build --workspace ${{ matrix.features }}
+          cargo build --workspace --all-targets ${{ matrix.features }}
           cargo test --workspace ${{ matrix.features }}
 
   check-no-std:
@@ -73,8 +73,7 @@ jobs:
           # target: "thumbv6m-none-eabi"
       - name: Rust Cache
         uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0
-      - name: Check bdk wallet
-        working-directory: ./wallet
+      - name: Check no-std
         # TODO "--target thumbv6m-none-eabi" should work but currently does not
         run: cargo check --no-default-features --features miniscript/no-std,bdk_chain/hashbrown
 
@@ -101,8 +100,7 @@ jobs:
             targets: "wasm32-unknown-unknown"
       - name: Rust Cache
         uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0
-      - name: Check bdk wallet
-        working-directory: ./wallet
+      - name: Check WASM
         run: cargo check --target wasm32-unknown-unknown --no-default-features --features miniscript/no-std,bdk_chain/hashbrown
 
   fmt:
@@ -140,21 +138,3 @@ jobs:
       - name: Clippy
         run: cargo clippy --all-features --all-targets -- -D warnings
 
-  build-examples:
-    needs: prepare
-    name: Build & Test Examples
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-      - name: Install Rust toolchain
-        uses: dtolnay/rust-toolchain@v1
-        with:
-          toolchain: ${{ needs.prepare.outputs.rust_version }}
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0
-      - name: Build + Test Examples
-        working-directory: examples
-        run: cargo test --workspace --all-targets --all-features

.gitignore

@@ -8,3 +8,4 @@ Cargo.lock
 # Example persisted files.
 *.db
 *.sqlite*
+examples/test_data

wallet/CHANGELOG.md renamed to CHANGELOG.md

@@ -1,13 +1,76 @@
-[workspace]
-resolver = "2"
-members = [
-    "wallet",
-]
-exclude = ["examples"]
-
-[workspace.package]
+[package]
+name = "bdk_wallet"
+homepage = "https://bitcoindevkit.org"
+version = "3.0.0-alpha.0"
+repository = "https://github.com/bitcoindevkit/bdk_wallet"
+documentation = "https://docs.rs/bdk_wallet"
+description = "A modern, lightweight, descriptor-based wallet library"
+keywords = ["bitcoin", "wallet", "descriptor", "psbt"]
+readme = "README.md"
+license = "MIT OR Apache-2.0"
 authors = ["Bitcoin Dev Kit Developers"]
+edition = "2021"
+rust-version = "1.85.0"
 
-[workspace.lints.clippy]
-print_stdout = "deny"
-print_stderr = "deny"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[dependencies]
+bdk_chain = { version = "0.23.1", features = ["miniscript", "serde"], default-features = false }
+bitcoin = { version = "0.32.6", features = ["serde", "base64"], default-features = false }
+miniscript = { version = "12.3.1", features = ["serde"], default-features = false }
+rand_core = { version = "0.6.0" }
+serde_json = { version = "1" }
+serde = { version = "1", features = ["derive"] }
+
+# Optional dependencies
+anyhow = { version = "1.0.98", optional = true }
+bdk_file_store = { version = "0.21.1", optional = true }
+bip39 = { version = "2.0", optional = true }
+tempfile = { version = "3.20.0", optional = true }
+
+[features]
+default = ["std"]
+std = ["bitcoin/std", "bitcoin/rand-std", "miniscript/std", "bdk_chain/std"]
+compiler = ["miniscript/compiler"]
+all-keys = ["keys-bip39"]
+keys-bip39 = ["bip39"]
+rusqlite = ["bdk_chain/rusqlite"]
+file_store = ["bdk_file_store"]
+test-utils = ["std", "anyhow", "tempfile"]
+
+[dev-dependencies]
+anyhow = "1"
+assert_matches = "1.5.0"
+bdk_bitcoind_rpc = { version = "0.21.0" }
+bdk_electrum = { version = "0.23.1" }
+bdk_esplora = { version = "0.22.1", features = ["async-https", "blocking-https", "tokio"] }
+bdk_wallet = { path = ".", features = ["rusqlite", "file_store", "test-utils"] }
+clap = { version = "4.5.17", features = ["derive", "env"] }
+ctrlc = "3.4.6"
+rand = "0.8"
+tempfile = "3"
+tokio = { version = "1.38.1", features = ["rt", "rt-multi-thread", "macros"] }
+
+[[example]]
+name = "mnemonic_to_descriptors"
+path = "examples/mnemonic_to_descriptors.rs"
+required-features = ["all-keys"]
+
+[[example]]
+name = "miniscriptc"
+path = "examples/compiler.rs"
+required-features = ["compiler"]
+
+[[example]]
+name = "electrum"
+
+[[example]]
+name = "esplora_async"
+
+[[example]]
+name = "esplora_blocking"
+
+[[example]]
+name = "bitcoind_rpc"

Cargo.toml

@@ -1,20 +1,18 @@
-# The Bitcoin Dev Kit Wallet
-
 <div align="center">
-  <h1>BDK Wallet</h1>
+  <h1>BDK</h1>
 
-  <img src="./static/bdk.png" width="220" />
+  <img src="https://raw.githubusercontent.com/bitcoindevkit/bdk/master/static/bdk.png" width="220" />
 
   <p>
     <strong>A modern, lightweight, descriptor-based wallet library written in Rust!</strong>
   </p>
 
   <p>
     <a href="https://crates.io/crates/bdk_wallet"><img alt="Crate Info" src="https://img.shields.io/crates/v/bdk_wallet.svg"/></a>
-    <a href="https://github.com/bitcoindevkit/bdk_wallet/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
-    <a href="https://github.com/bitcoindevkit/bdk_wallet/actions?query=workflow%3ACI"><img alt="CI Status" src="https://github.com/bitcoindevkit/bdk_wallet/workflows/CI/badge.svg"></a>
-    <a href="https://coveralls.io/github/bitcoindevkit/bdk_wallet?branch=master"><img src="https://coveralls.io/repos/github/bitcoindevkit/bdk_wallet/badge.svg?branch=master"/></a>
-    <a href="https://docs.rs/bdk_wallet"><img alt="Wallet API Docs" src="https://img.shields.io/badge/docs.rs-bdk_wallet-green"/></a>
+    <a href="https://github.com/bitcoindevkit/bdk/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
+    <a href="https://github.com/bitcoindevkit/bdk/actions?query=workflow%3ACI"><img alt="CI Status" src="https://github.com/bitcoindevkit/bdk/workflows/CI/badge.svg"></a>
+    <a href="https://coveralls.io/github/bitcoindevkit/bdk?branch=master"><img src="https://coveralls.io/repos/github/bitcoindevkit/bdk/badge.svg?branch=master"/></a>
+    <a href="https://docs.rs/bdk_wallet"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-bdk_wallet-green"/></a>
     <a href="https://blog.rust-lang.org/2025/02/20/Rust-1.85.0/"><img alt="Rustc Version 1.85.0+" src="https://img.shields.io/badge/rustc-1.85.0%2B-lightgrey.svg"/></a>
     <a href="https://discord.gg/d7NkDKm"><img alt="Chat on Discord" src="https://img.shields.io/discord/753336465005608961?logo=discord"></a>
   </p>
@@ -29,25 +27,88 @@
 ## About
 
 The `bdk_wallet` project provides a high level descriptor based wallet API for building Bitcoin applications.
-It is built upon the excellent [`rust-bitcoin`] and [`rust-miniscript`] crates.
 
 ## Architecture
 
-There is currently only one published crate in this repository:
+[`bdk_wallet`] contains the central high level [`Wallet`] type that is built from the other low-level components.
 
-- [`wallet`](./wallet): Contains the central high level `Wallet` type that is built from the low-level mechanisms provided by the other components.
+Core BDK crates that `bdk_wallet` depends on are found in the [`bdk`] repository. This works by
+leveraging the functionality in [`rust-bitcoin`] and [`rust-miniscript`].
 
-Crates that `bdk_wallet` depends on are found in the [`bdk`] repository.
+# BDK Wallet
 
-Fully working examples of how to use these components are in `/examples`:
+The `bdk_wallet` provides the [`Wallet`] type which is a simple, high-level
+interface built from the low-level components of [`bdk_chain`]. `Wallet` is a good starting point
+for many simple applications as well as a good demonstration of how to use the other mechanisms to
+construct a wallet. It has two keychains (external and internal) that are defined by
+[miniscript descriptors][`rust-miniscript`] and uses them to generate addresses. When you give it
+chain data it also uses the descriptors to find transaction outputs owned by them. From there, you
+can create and sign transactions.
 
-- [`example_wallet_esplora_blocking`](examples/example_wallet_esplora_blocking): Uses the `Wallet` to sync and spend using the Esplora blocking interface.
-- [`example_wallet_esplora_async`](examples/example_wallet_esplora_async): Uses the `Wallet` to sync and spend using the Esplora asynchronous interface.
-- [`example_wallet_electrum`](examples/example_wallet_electrum): Uses the `Wallet` to sync and spend using Electrum.
+For details about the API of `Wallet` see the [module-level documentation][`Wallet`].
 
-[`bdk`]: https://github.com/bitcoindevkit/bdk
-[`rust-miniscript`]: https://github.com/rust-bitcoin/rust-miniscript
-[`rust-bitcoin`]: https://github.com/rust-bitcoin/rust-bitcoin
+## Blockchain data
+
+In order to get blockchain data for `Wallet` to consume, you should configure a client from
+an available chain source. Typically you make a request to the chain source and get a response
+that the `Wallet` can use to update its view of the chain.
+
+**Blockchain Data Sources**
+
+* [`bdk_esplora`]: Gets blockchain data from Esplora for updating BDK structures.
+* [`bdk_electrum`]: Gets blockchain data from Electrum for updating BDK structures.
+* [`bdk_bitcoind_rpc`]: Gets blockchain data from Bitcoin Core for updating BDK structures.
+
+**Examples**
+
+* [`examples/esplora_async`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/esplora_async)
+* [`examples/esplora_blocking`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/esplora_blocking)
+* [`examples/electrum`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/electrum)
+* [`examples/bitcoind_rpc`](https://github.com/bitcoindevkit/bdk_wallet/tree/master/examples/bitcoind_rpc)
+
+## Persistence
+
+To persist `Wallet` state use a data storage crate that reads and writes [`ChangeSet`].
+
+**Implementations**
+
+* [`bdk_file_store`]: Stores wallet changes in a simple flat file.
+
+**Example**
+
+```rust,no_run
+use bdk_wallet::{bitcoin::Network, KeychainKind, ChangeSet, Wallet};
+
+// Open or create a new file store for wallet data.
+let (mut db, _changeset) =
+    bdk_file_store::Store::<ChangeSet>::load_or_create(b"magic_bytes", "/tmp/my_wallet.db")
+        .expect("create store");
+
+// Create a wallet with initial wallet data read from the file store.
+let network = Network::Testnet;
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let wallet_opt = Wallet::load()
+    .descriptor(KeychainKind::External, Some(descriptor))
+    .descriptor(KeychainKind::Internal, Some(change_descriptor))
+    .extract_keys()
+    .check_network(network)
+    .load_wallet(&mut db)
+    .expect("wallet");
+let mut wallet = match wallet_opt {
+    Some(wallet) => wallet,
+    None => Wallet::create(descriptor, change_descriptor)
+        .network(network)
+        .create_wallet(&mut db)
+        .expect("wallet"),
+};
+
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+wallet.persist(&mut db).expect("persist");
+println!("Your new receive address is: {}", receive_address.address);
+```
 
 ## Minimum Supported Rust Version (MSRV)
 
@@ -61,18 +122,37 @@ This project has a [`justfile`](/justfile) for easy command running. You must ha
 
 To see a list of available recipes: `just -l`
 
-## License
+## Testing
+
+### Unit testing
+
+```bash
+just test
+```
+
+# License
 
 Licensed under either of
 
-* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
-* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
+* Apache License, Version 2.0, ([LICENSE-APACHE](../../LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
+* MIT license ([LICENSE-MIT](../../LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
 
 at your option.
 
-### Contribution
+# Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally
 submitted for inclusion in the work by you, as defined in the Apache-2.0
 license, shall be dual licensed as above, without any additional terms or
 conditions.
+
+[`Wallet`]: https://docs.rs/bdk_wallet/latest/bdk_wallet/wallet/struct.Wallet.html
+[`bdk`]: https://github.com/bitcoindevkit/bdk
+[`bdk_wallet`]: https://docs.rs/bdk_wallet/latest
+[`bdk_chain`]: https://docs.rs/bdk_chain/latest
+[`bdk_file_store`]: https://docs.rs/bdk_file_store/latest
+[`bdk_electrum`]: https://docs.rs/bdk_electrum/latest
+[`bdk_esplora`]: https://docs.rs/bdk_esplora/latest
+[`bdk_bitcoind_rpc`]: https://docs.rs/bdk_bitcoind_rpc/latest
+[`rust-bitcoin`]: https://docs.rs/miniscript/latest/bitcoin/index.html
+[`rust-miniscript`]: https://docs.rs/miniscript/latest/miniscript/index.html