Skip to content

Rescan the wallet_rescan_from_height block #1069

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

Open
tankyleo wants to merge 1 commit into
base: main
Choose a base branch
from
+64 −39
Open

Rescan the wallet_rescan_from_height block #1069

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
40 changes: 23 additions & 17 deletions src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,9 +427,9 @@ impl NodeBuilder {
/// ## Parameters:
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection.
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from on first
/// startup, before wallet state exists. Existing wallets are not rewound. The height must
/// be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from (inclusive) on
/// first startup, before wallet state exists. Existing wallets are not rewound. The height
/// must be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// checkpoints at the current tip.
#[cfg(feature = "chain-bitcoind")]
pub fn set_chain_source_bitcoind_rpc(
Expand All @@ -456,9 +456,9 @@ impl NodeBuilder {
/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from on first
/// startup, before wallet state exists. Existing wallets are not rewound. The height must
/// be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from (inclusive) on
/// first startup, before wallet state exists. Existing wallets are not rewound. The height
/// must be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// checkpoints at the current tip.
#[cfg(feature = "chain-bitcoind")]
pub fn set_chain_source_bitcoind_rest(
Expand Down Expand Up @@ -1075,9 +1075,9 @@ impl Builder {
/// ## Parameters:
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection.
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from on first
/// startup, before wallet state exists. Existing wallets are not rewound. The height must
/// be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from (inclusive) on
/// first startup, before wallet state exists. Existing wallets are not rewound. The height
/// must be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// checkpoints at the current tip.
pub fn set_chain_source_bitcoind_rpc(
&self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
Expand All @@ -1101,9 +1101,9 @@ impl Builder {
/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from on first
/// startup, before wallet state exists. Existing wallets are not rewound. The height must
/// be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// * `wallet_rescan_from_height` - Optional wallet birthday height to rescan from (inclusive) on
/// first startup, before wallet state exists. Existing wallets are not rewound. The height
/// must be at or below the current tip. Passing `Some(0)` rescans from genesis; passing `None`
/// checkpoints at the current tip.
pub fn set_chain_source_bitcoind_rest(
&self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
Expand Down Expand Up @@ -1771,8 +1771,9 @@ fn build_with_store_internal(
})?;

// Decide which block (if any) to insert as the initial BDK checkpoint. If the
// bitcoind config provides a wallet rescan height, resolve that block and use it as
// the checkpoint. Otherwise, use the current chain tip to avoid any rescan.
// bitcoind config provides a wallet rescan height, use the preceding block as the
// checkpoint so synchronization includes the requested height. Otherwise, use the
// current chain tip to avoid any rescan.
let checkpoint_block = match wallet_rescan_from_height {
None => chain_tip_opt,
#[cfg(feature = "chain-bitcoind")]
Expand All @@ -1788,6 +1789,10 @@ fn build_with_store_internal(
return Err(BuildError::WalletRescanHeightTooHigh);
}
}
// `synchronize_listeners` connects blocks strictly above each listener's
// checkpoint. The genesis block is already BDK's initial checkpoint, so
// saturating subtraction also handles a requested height of zero.
let checkpoint_height = height.saturating_sub(1);

let utxo_source = chain_source.as_utxo_source().ok_or_else(|| {
log_error!(
Expand All @@ -1799,16 +1804,17 @@ fn build_with_store_internal(
let hash_res = runtime.block_on(async {
lightning_block_sync::gossip::UtxoSource::get_block_hash_by_height(
&utxo_source,
height,
checkpoint_height,
)
.await
});
match hash_res {
Ok(hash) => Some(BlockLocator::new(hash, height)),
Ok(hash) => Some(BlockLocator::new(hash, checkpoint_height)),
Err(e) => {
log_error!(
logger,
"Failed to resolve block hash at height {} for wallet rescan: {:?}",
"Failed to resolve checkpoint block hash at height {} for wallet rescan from height {}: {:?}",
checkpoint_height,
height,
e,
);
Expand Down
63 changes: 41 additions & 22 deletions tests/integration_tests_rust.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1557,19 +1557,20 @@ async fn do_onchain_wallet_full_scan_stop_gap_recovers_far_funds(

#[cfg(feature = "chain-bitcoind")]
#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
async fn onchain_wallet_recovery_rescans_from_birthday_height() {
async fn onchain_wallet_recovery_includes_rescan_height() {
// End-to-end test for `wallet_rescan_from_height` against a bitcoind chain source. The
// scenario:
//
// 1. Create a node at some "birthday" height and generate two receive addresses.
// 2. Shut the node down and drop all persisted state except the seed.
// 3. Advance the chain past the birthday.
// 4. Send funds to the addresses generated at the birthday height and confirm them.
// 4. Send funds to both addresses and confirm both transactions in the same block.
// 5. Restart a fresh node with just the seed and no rescan height. Its wallet birthday
// is pinned at the current tip, which is above the blocks containing the funding
// transactions — so the node must not see the funds.
// 6. Restart again with `wallet_rescan_from_height: Some(birthday)`. Now the wallet must
// find and report both funding transactions.
// is pinned at the funding block, so the node must not see the funds.
// 6. Restart with the original birthday as `wallet_rescan_from_height` and confirm both
// transactions are found, preserving the previous test case.
// 7. Restart again with the funding block itself as `wallet_rescan_from_height` and confirm
// both transactions are found, proving that the configured height is inclusive.
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
// We specifically exercise the bitcoind RPC backend because that's where
// `rescan_from_height` is honored precisely (via `get_block_hash_by_height`).
Expand All @@ -1587,7 +1588,6 @@ async fn onchain_wallet_recovery_rescans_from_birthday_height() {

let addr_1 = original_node.onchain_payment().new_address().unwrap();
let addr_2 = original_node.onchain_payment().new_address().unwrap();

let birthday_height: u32 = bitcoind
.client
.get_blockchain_info()
Expand All @@ -1600,11 +1600,11 @@ async fn onchain_wallet_recovery_rescans_from_birthday_height() {
original_node.stop().unwrap();
drop(original_node);

// Step 3: advance the chain past the birthday, so a fresh node would otherwise pin its
// wallet birthday at a height above the funding transactions in step 4.
// Step 3: advance the chain past the original wallet birthday.
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 10).await;

// Step 4: fund both addresses and confirm them.
// Step 4: queue both transactions before mining so they are confirmed in the same block, as
// exercised by the previous version of this test.
let txid_1 = bitcoind
.client
.send_to_address(&addr_1, Amount::from_sat(premine_amount_sat))
Expand All @@ -1621,33 +1621,52 @@ async fn onchain_wallet_recovery_rescans_from_birthday_height() {
.parse()
.unwrap();
wait_for_tx(&electrsd.client, txid_2).await;
let funding_height: u32 =
(bitcoind.client.get_blockchain_info().expect("failed to get blockchain info").blocks + 1)
.try_into()
.unwrap();
generate_blocks_and_wait(&bitcoind.client, &electrsd.client, 1).await;

// Step 5: restart a fresh node with only the seed and no rescan height. It must NOT see
// the funds, because its wallet birthday sits above the funding transactions.
// Step 5: restart a fresh node with only the seed and no rescan height. It must NOT see the
// funds, because its wallet birthday is the block containing both funding transactions.
let mut pinned_config = random_config();
pinned_config.node_entropy = original_node_entropy;
let pinned_node = setup_node(&chain_source, pinned_config);
pinned_node.sync_wallets().unwrap();
assert_eq!(
pinned_node.list_balances().spendable_onchain_balance_sats,
0,
"fresh node without rescan height should not find funds below its wallet birthday"
"fresh node without rescan height should not scan its wallet birthday block"
);
pinned_node.stop().unwrap();
drop(pinned_node);

// Step 6: restart with a rescan height set to the birthday height. Funds must be
// re-discovered.
let mut recovered_config = random_config();
recovered_config.node_entropy = original_node_entropy;
recovered_config.wallet_rescan_from_height = Some(birthday_height);
let recovered_node = setup_node(&chain_source, recovered_config);
recovered_node.sync_wallets().unwrap();
// Step 6: recover from the original wallet birthday, retaining the previous test's case where
// both transactions are found 11 blocks after the configured rescan height.
let mut birthday_recovery_config = random_config();
birthday_recovery_config.node_entropy = original_node_entropy;
birthday_recovery_config.wallet_rescan_from_height = Some(birthday_height);
let birthday_recovered_node = setup_node(&chain_source, birthday_recovery_config);
birthday_recovered_node.sync_wallets().unwrap();
assert_eq!(
recovered_node.list_balances().spendable_onchain_balance_sats,
birthday_recovered_node.list_balances().spendable_onchain_balance_sats,
premine_amount_sat * 2,
"node recovered from the wallet birthday should find both same-block transactions"
);
birthday_recovered_node.stop().unwrap();
drop(birthday_recovered_node);

// Step 7: recover from the funding block itself. Both transactions must still be found, proving
// that `wallet_rescan_from_height` is inclusive.
let mut funding_block_recovery_config = random_config();
funding_block_recovery_config.node_entropy = original_node_entropy;
funding_block_recovery_config.wallet_rescan_from_height = Some(funding_height);
let funding_block_recovered_node = setup_node(&chain_source, funding_block_recovery_config);
funding_block_recovered_node.sync_wallets().unwrap();
assert_eq!(
funding_block_recovered_node.list_balances().spendable_onchain_balance_sats,
premine_amount_sat * 2,
"node recovered with rescan_from_height should see funds sent to pre-birthday addresses"
"node recovered from the funding block should find both transactions in that block"
);
}

Expand Down
Loading