WIP

Author: evanlinjin

examples/example_wallet_electrum/Cargo.toml

@@ -6,5 +6,5 @@ edition = "2021"
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["file_store"] }
 #bdk_electrum = { version = "0.21" }
-bdk_electrum = { git = "https://github.com/bitcoindevkit/bdk", rev = "b70758652d1c819c88d92765905d09e26b951ee2" }
+bdk_electrum = { git = "https://github.com/evanlinjin/bdk", branch = "superimposed_canonicalization" }
 anyhow = "1"

examples/example_wallet_electrum/src/main.rs

@@ -41,7 +41,7 @@ fn main() -> Result<(), anyhow::Error> {
     wallet.persist(&mut db)?;
     println!("Generated Address: {}", address);
 
-    let balance = wallet.balance();
+    let balance = wallet.balance(wallet.include_unbroadcasted());
     println!("Wallet balance before syncing: {}", balance.total());
 
     print!("Syncing...");
@@ -70,7 +70,7 @@ fn main() -> Result<(), anyhow::Error> {
     wallet.apply_update(update)?;
     wallet.persist(&mut db)?;
 
-    let balance = wallet.balance();
+    let balance = wallet.balance(wallet.include_unbroadcasted());
     println!("Wallet balance after syncing: {}", balance.total());
 
     if balance.total() < SEND_AMOUNT {
@@ -81,14 +81,17 @@ fn main() -> Result<(), anyhow::Error> {
         std::process::exit(0);
     }
 
-    let mut tx_builder = wallet.build_tx();
+    let canonicalization_params = wallet.include_unbroadcasted();
+    let mut tx_builder = wallet.build_tx(canonicalization_params);
     tx_builder.add_recipient(address.script_pubkey(), SEND_AMOUNT);
 
     let mut psbt = tx_builder.finish()?;
     let finalized = wallet.sign(&mut psbt, SignOptions::default())?;
     assert!(finalized);
 
     let tx = psbt.extract_tx()?;
+    wallet.insert_unbroadcasted(tx.clone());
+
     client.transaction_broadcast(&tx)?;
     println!("Tx broadcasted! Txid: {}", tx.compute_txid());
 

examples/example_wallet_esplora_async/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["rusqlite"] }
 #bdk_esplora = { version = "0.20", features = ["async-https", "tokio"] }
-bdk_esplora = { git = "https://github.com/bitcoindevkit/bdk", rev = "b70758652d1c819c88d92765905d09e26b951ee2", features = ["async-https", "tokio"] }
-bdk_testenv = { git = "https://github.com/bitcoindevkit/bdk", rev = "b70758652d1c819c88d92765905d09e26b951ee2" }
+bdk_esplora = { git = "https://github.com/evanlinjin/bdk", branch = "superimposed_canonicalization", features = ["async-https", "tokio"] }
+bdk_testenv = { git = "https://github.com/evanlinjin/bdk", branch = "superimposed_canonicalization" }
 tokio = { version = "1", features = ["rt", "rt-multi-thread", "macros"] }
 anyhow = "1"

examples/example_wallet_esplora_async/src/main.rs

@@ -154,8 +154,14 @@ async fn main() -> Result<(), anyhow::Error> {
     wallet.apply_update(resp)?;
     wallet.persist(&mut conn)?;
 
-    assert_eq!(wallet.balance().total(), Amount::ONE_BTC);
-    println!("Balance after send tx1: {}", wallet.balance().total());
+    assert_eq!(
+        wallet.balance(wallet.include_unbroadcasted()).total(),
+        Amount::ONE_BTC
+    );
+    println!(
+        "Balance after send tx1: {}",
+        wallet.balance(wallet.include_unbroadcasted()).total()
+    );
     // We should expect tx1 to occur in a future sync
     let exp_spk_txids = wallet
         .tx_graph()
@@ -189,8 +195,14 @@ async fn main() -> Result<(), anyhow::Error> {
     wallet.apply_update(resp)?;
     wallet.persist(&mut conn)?;
 
-    println!("Balance after send tx2: {}", wallet.balance().total());
-    assert_eq!(wallet.balance().total(), Amount::ZERO);
+    println!(
+        "Balance after send tx2: {}",
+        wallet.balance(wallet.include_unbroadcasted()).total()
+    );
+    assert_eq!(
+        wallet.balance(wallet.include_unbroadcasted()).total(),
+        Amount::ZERO
+    );
 
     // Load the persisted wallet
     {
@@ -201,13 +213,21 @@ async fn main() -> Result<(), anyhow::Error> {
         // tx1 is there, but is not canonical
         assert!(wallet.tx_graph().full_txs().any(|node| node.txid == txid1));
         assert!(wallet
-            .tx_graph()
-            .list_canonical_txs(wallet.local_chain(), wallet.local_chain().tip().block_id())
+            .transactions(wallet.include_unbroadcasted())
+            .next()
+            .is_none());
+        assert!(wallet
+            .list_unspent(wallet.include_unbroadcasted())
             .next()
             .is_none());
-        assert!(wallet.list_unspent().next().is_none());
-        assert_eq!(wallet.balance().total(), Amount::ZERO);
-        println!("Balance after load wallet: {}", wallet.balance().total());
+        assert_eq!(
+            wallet.balance(wallet.include_unbroadcasted()).total(),
+            Amount::ZERO
+        );
+        println!(
+            "Balance after load wallet: {}",
+            wallet.balance(wallet.include_unbroadcasted()).total()
+        );
     }
 
     Ok(())

examples/example_wallet_esplora_blocking/Cargo.toml

@@ -9,5 +9,5 @@ publish = false
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["file_store"] }
 #bdk_esplora = { version = "0.20", features = ["blocking"] }
-bdk_esplora = { git = "https://github.com/bitcoindevkit/bdk", rev = "b70758652d1c819c88d92765905d09e26b951ee2", features = ["blocking"] }
+bdk_esplora = { git = "https://github.com/evanlinjin/bdk", branch = "superimposed_canonicalization", features = ["blocking"] }
 anyhow = "1"

examples/example_wallet_esplora_blocking/src/main.rs

@@ -41,7 +41,7 @@ fn main() -> Result<(), anyhow::Error> {
         address.index, address.address
     );
 
-    let balance = wallet.balance();
+    let balance = wallet.balance(wallet.include_unbroadcasted());
     println!("Wallet balance before syncing: {}", balance.total());
 
     print!("Syncing...");
@@ -65,7 +65,7 @@ fn main() -> Result<(), anyhow::Error> {
     wallet.persist(&mut db)?;
     println!();
 
-    let balance = wallet.balance();
+    let balance = wallet.balance(wallet.include_unbroadcasted());
     println!("Wallet balance after syncing: {}", balance.total());
 
     if balance.total() < SEND_AMOUNT {
@@ -76,14 +76,17 @@ fn main() -> Result<(), anyhow::Error> {
         std::process::exit(0);
     }
 
-    let mut tx_builder = wallet.build_tx();
+    let params = wallet.include_unbroadcasted();
+    let mut tx_builder = wallet.build_tx(params);
     tx_builder.add_recipient(address.script_pubkey(), SEND_AMOUNT);
 
     let mut psbt = tx_builder.finish()?;
     let finalized = wallet.sign(&mut psbt, SignOptions::default())?;
     assert!(finalized);
 
     let tx = psbt.extract_tx()?;
+    wallet.insert_unbroadcasted(tx.clone());
+
     client.broadcast(&tx)?;
     println!("Tx broadcasted! Txid: {}", tx.compute_txid());
 

examples/example_wallet_rpc/Cargo.toml

@@ -8,7 +8,7 @@ edition = "2021"
 [dependencies]
 bdk_wallet = { path = "../../wallet", features = ["file_store"] }
 #bdk_bitcoind_rpc = { version = "0.18" }
-bdk_bitcoind_rpc = { git = "https://github.com/bitcoindevkit/bdk", rev = "b70758652d1c819c88d92765905d09e26b951ee2" }
+bdk_bitcoind_rpc = { git = "https://github.com/evanlinjin/bdk", branch = "superimposed_canonicalization" }
 
 anyhow = "1"
 clap = { version = "4.5.17", features = ["derive", "env"] }

examples/example_wallet_rpc/src/main.rs

@@ -110,7 +110,7 @@ fn main() -> anyhow::Result<()> {
         start_load_wallet.elapsed().as_secs_f32()
     );
 
-    let balance = wallet.balance();
+    let balance = wallet.balance(wallet.include_unbroadcasted());
     println!("Wallet balance before syncing: {}", balance.total());
 
     let wallet_tip = wallet.latest_checkpoint();
@@ -173,7 +173,7 @@ fn main() -> anyhow::Result<()> {
         }
     }
     let wallet_tip_end = wallet.latest_checkpoint();
-    let balance = wallet.balance();
+    let balance = wallet.balance(wallet.include_unbroadcasted());
     println!(
         "Synced {} blocks in {}s",
         blocks_received,
@@ -187,8 +187,8 @@ fn main() -> anyhow::Result<()> {
     println!("Wallet balance is {}", balance.total());
     println!(
         "Wallet has {} transactions and {} utxos",
-        wallet.transactions().count(),
-        wallet.list_unspent().count()
+        wallet.transactions(wallet.include_unbroadcasted()).count(),
+        wallet.list_unspent(wallet.include_unbroadcasted()).count()
     );
 
     Ok(())

wallet/Cargo.toml

@@ -28,14 +28,14 @@ serde_json = { version = "^1.0" }
 bip39 = { version = "2.0", optional = true }
 
 [dependencies.bdk_chain]
-git = "https://github.com/bitcoindevkit/bdk"
-rev = "b70758652d1c819c88d92765905d09e26b951ee2"
+git = "https://github.com/evanlinjin/bdk"
+branch = "superimposed_canonicalization"
 default-features = false
 features = ["miniscript", "serde"]
 
 [dependencies.bdk_file_store]
-git = "https://github.com/bitcoindevkit/bdk"
-rev = "b70758652d1c819c88d92765905d09e26b951ee2"
+git = "https://github.com/evanlinjin/bdk"
+branch = "superimposed_canonicalization"
 optional = true
 
 [features]
@@ -59,8 +59,8 @@ anyhow = "1"
 rand = "^0.8"
 
 [dev-dependencies.bdk_chain]
-git = "https://github.com/bitcoindevkit/bdk"
-rev = "b70758652d1c819c88d92765905d09e26b951ee2"
+git = "https://github.com/evanlinjin/bdk"
+branch = "superimposed_canonicalization"
 features = ["rusqlite"]
 
 [package.metadata.docs.rs]

wallet/src/wallet/changeset.rs

@@ -3,6 +3,8 @@ use bdk_chain::{
 };
 use miniscript::{Descriptor, DescriptorPublicKey};
 
+use super::unbroadcasted;
+
 type IndexedTxGraphChangeSet =
     indexed_tx_graph::ChangeSet<ConfirmationBlockTime, keychain_txout::ChangeSet>;
 
@@ -21,6 +23,8 @@ pub struct ChangeSet {
     pub tx_graph: tx_graph::ChangeSet<ConfirmationBlockTime>,
     /// Changes to [`KeychainTxOutIndex`](keychain_txout::KeychainTxOutIndex).
     pub indexer: keychain_txout::ChangeSet,
+    /// Changes to [`Unbroadcasted`](crate::unbroadcasted::Unbroadcasted).
+    pub unbroadcasted: unbroadcasted::ChangeSet,
 }
 
 impl Merge for ChangeSet {

wallet/src/wallet/coin_selection.rs

@@ -91,7 +91,10 @@
 //!     .require_network(Network::Testnet)
 //!     .unwrap();
 //! let psbt = {
-//!     let mut builder = wallet.build_tx().coin_selection(AlwaysSpendEverything);
+//!     let params = wallet.include_unbroadcasted();
+//!     let mut builder = wallet
+//!         .build_tx(params)
+//!         .coin_selection(AlwaysSpendEverything);
 //!     builder.add_recipient(to_address.script_pubkey(), Amount::from_sat(50_000));
 //!     builder.finish()?
 //! };

wallet/src/wallet/export.rs

@@ -128,12 +128,15 @@ impl FullyNodedExport {
         Self::is_compatible_with_core(&descriptor)?;
 
         let blockheight = if include_blockheight {
-            wallet.transactions().next().map_or(0, |canonical_tx| {
-                canonical_tx
-                    .chain_position
-                    .confirmation_height_upper_bound()
-                    .unwrap_or(0)
-            })
+            wallet
+                .transactions(wallet.include_unbroadcasted())
+                .next()
+                .map_or(0, |canonical_tx| {
+                    canonical_tx
+                        .chain_position
+                        .confirmation_height_upper_bound()
+                        .unwrap_or(0)
+                })
         } else {
             0
         };