-
Notifications
You must be signed in to change notification settings - Fork 330
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Blockchain stop_gap testing improvements
This is a continuation of the #651 fix. We should also check whether the same bug affects esplora as noted by @afilini. To achieve this, I've introduced a `ConfigurableBlockchainTester` trait that can test multiple blockchain implementations. * Introduce `ConfigurableBlockchainTester` trait. * Use the aforementioned trait to also test esplora. * Change the electrum test to also use the new trait. * Fix some complaints by clippy in ureq.rs file (why is CI not seeing this?).
- Loading branch information
1 parent
475b005
commit 924b320
Showing
5 changed files
with
200 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| use bitcoin::Network; | ||
|
|
||
| use crate::{ | ||
| blockchain::ConfigurableBlockchain, database::MemoryDatabase, testutils, wallet::AddressIndex, | ||
| Wallet, | ||
| }; | ||
|
|
||
| use super::blockchain_tests::TestClient; | ||
|
|
||
| /// Trait for testing [`BlockchainFactory`] implementations with varying configurations. | ||
| pub trait ConfigurableBlockchainTester<B: ConfigurableBlockchain>: Sized { | ||
| /// Blockchain name for logging. | ||
| const BLOCKCHAIN_NAME: &'static str; | ||
|
|
||
| /// Generates a blockchain config with a given stop_gap. | ||
| /// | ||
| /// If this returns [`Option::None`], then the associated tests will not run. | ||
| fn config_with_stop_gap( | ||
| &self, | ||
| _test_client: &mut TestClient, | ||
| _stop_gap: usize, | ||
| ) -> Option<B::Config> { | ||
| None | ||
| } | ||
|
|
||
| /// Runs all avaliable tests. | ||
| fn run(&self) { | ||
| let test_client = &mut TestClient::default(); | ||
|
|
||
| test_wallet_sync_with_stop_gaps(test_client, self); | ||
| } | ||
| } | ||
|
|
||
| /// Test whether blockchain implementation syncs with expected behaviour given different `stop_gap` | ||
| /// parameters. | ||
| /// | ||
| /// For each test vector: | ||
| /// * Fill wallet's derived addresses with balances (as specified by test vector). | ||
| /// * [0..addrs_before] => 1000sats for each address | ||
| /// * [addrs_before..actual_gap] => empty addresses | ||
| /// * [actual_gap..addrs_after] => 1000sats for each address | ||
| /// * Then, perform wallet sync and obtain wallet balance | ||
| /// * Check balance is within expected range (we can compare `stop_gap` and `actual_gap` to | ||
| /// determine this). | ||
| fn test_wallet_sync_with_stop_gaps<T, B>(test_client: &mut TestClient, tester: &T) | ||
| where | ||
| T: ConfigurableBlockchainTester<B>, | ||
| B: ConfigurableBlockchain, | ||
| { | ||
| // Generates wallet descriptor | ||
| let descriptor_of_account = |account_index: usize| -> String { | ||
| format!("wpkh([c258d2e4/84h/1h/0h]tpubDDYkZojQFQjht8Tm4jsS3iuEmKjTiEGjG6KnuFNKKJb5A6ZUCUZKdvLdSDWofKi4ToRCwb9poe1XdqfUnP4jaJjCB2Zwv11ZLgSbnZSNecE/{account_index}/*)") | ||
| }; | ||
|
|
||
| // Amount (in satoshis) provided to a single address (which expects to have a balance) | ||
| const AMOUNT_PER_TX: u64 = 1000; | ||
|
|
||
| // [stop_gap, actual_gap, addrs_before, addrs_after] | ||
| // | ||
| // [0] stop_gap: Passed to [`ElectrumBlockchainConfig`] | ||
| // [1] actual_gap: Range size of address indexes without a balance | ||
| // [2] addrs_before: Range size of address indexes (before gap) which contains a balance | ||
| // [3] addrs_after: Range size of address indexes (after gap) which contains a balance | ||
| let test_vectors: Vec<[u64; 4]> = vec![ | ||
| [0, 0, 0, 5], | ||
| [0, 0, 5, 5], | ||
| [0, 1, 5, 5], | ||
| [0, 2, 5, 5], | ||
| [1, 0, 5, 5], | ||
| [1, 1, 5, 5], | ||
| [1, 2, 5, 5], | ||
| [2, 1, 5, 5], | ||
| [2, 2, 5, 5], | ||
| [2, 3, 5, 5], | ||
| ]; | ||
|
|
||
| for (account_index, vector) in test_vectors.into_iter().enumerate() { | ||
| let [stop_gap, actual_gap, addrs_before, addrs_after] = vector; | ||
| let descriptor = descriptor_of_account(account_index); | ||
|
|
||
| let blockchain_config = match tester.config_with_stop_gap(test_client, stop_gap as _) { | ||
| Some(b) => b, | ||
| None => { | ||
| println!( | ||
| "SKIPPING: '{}' cannot be configured to have stop gaps.", | ||
| T::BLOCKCHAIN_NAME | ||
| ); | ||
| return; | ||
| } | ||
| }; | ||
|
|
||
| let blockchain = B::from_config(&blockchain_config).unwrap(); | ||
|
|
||
| let wallet = Wallet::new( | ||
| descriptor.as_str(), | ||
| None, | ||
| Network::Regtest, | ||
| MemoryDatabase::new(), | ||
| ) | ||
| .unwrap(); | ||
|
|
||
| // fill server-side with txs to specified address indexes | ||
| // return the max balance of the wallet (also the actual balance) | ||
| let max_balance = (0..addrs_before) | ||
| .chain(addrs_before + actual_gap..addrs_before + actual_gap + addrs_after) | ||
| .fold(0_u64, |sum, i| { | ||
| let address = wallet.get_address(AddressIndex::Peek(i as _)).unwrap(); | ||
| test_client.receive(testutils! { | ||
| @tx ( (@addr address.address) => AMOUNT_PER_TX ) | ||
| }); | ||
| sum + AMOUNT_PER_TX | ||
| }); | ||
|
|
||
| // minimum allowed balance of wallet (based on stop gap) | ||
| let min_balance = if actual_gap > stop_gap { | ||
| addrs_before * AMOUNT_PER_TX | ||
| } else { | ||
| max_balance | ||
| }; | ||
|
|
||
| // perform wallet sync | ||
| wallet.sync(&blockchain, Default::default()).unwrap(); | ||
|
|
||
| let wallet_balance = wallet.get_balance().unwrap(); | ||
|
|
||
| let details = format!( | ||
| "test_vector: [stop_gap: {}, actual_gap: {}, addrs_before: {}, addrs_after: {}]", | ||
| stop_gap, actual_gap, addrs_before, addrs_after, | ||
| ); | ||
| assert!( | ||
| wallet_balance <= max_balance, | ||
| "wallet balance is greater than received amount: {}", | ||
| details | ||
| ); | ||
| assert!( | ||
| wallet_balance >= min_balance, | ||
| "wallet balance is smaller than expected: {}", | ||
| details | ||
| ); | ||
|
|
||
| // generate block to confirm new transactions | ||
| test_client.generate(1, None); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters