test: legacy descriptors #1130

realeinherjar · 2023-09-20T19:30:30Z

Description

We currently don't have much tests with legacy descriptors (pkh).
This PR adds some, mainly focused on fee stuff.

Notes to the reviewers

This discussion came up on #1115 and also in bitcoindevkit/bdk_wallet#134 (it doesn't fully close).

Changelog notice

Added

Tests for fee calculation and fee bump with legacy descriptors.

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

New Features:

I've added tests for the new feature
I've added docs for the new feature

Bugfixes:

This pull request breaks the existing API
I've added tests to reproduce the issue which are now passing
I'm linking the issue being fixed by this PR

crates/bdk/tests/wallet.rs

realeinherjar · 2023-09-20T19:31:37Z

crates/bdk/tests/wallet.rs

-        "shoulld be ok when outpoint does match psbt_input"
+        "should be ok when outpoint does match psbt_input"


This typo was autofixed by my linter.

realeinherjar · 2023-10-01T08:29:07Z

This is ready, Cc @notmandatory and @danielabrozzoni.

(PS: Thanks for all the help, Daniela)

realeinherjar · 2023-10-01T08:29:45Z

Cargo.toml

@@ -12,7 +12,7 @@ members = [
    "example-crates/wallet_esplora_blocking",
    "example-crates/wallet_esplora_async",
    "nursery/tmp_plan",
-    "nursery/coin_select"
+    "nursery/coin_select",


realeinherjar · 2023-10-01T08:29:55Z

crates/bdk/tests/wallet.rs

-            #[allow(unused_mut)]
+        #[allow(unused_mut)]


realeinherjar · 2023-10-01T08:35:22Z

crates/bdk/tests/wallet.rs

+/// A floating point assert! that takes an additional third argument `delta`
+/// as a tolerance value when test for equality the first and second argument.
+macro_rules! assert_delta {
+    ($x:expr, $y:expr, $d:expr) => {
+        if !($x - $y < $d || $y - $x < $d) {
+            panic!();
+        }
+    };
+}
+


This the way I've found to ignore rounding errors when comparing FeeRate::from_sat_per_vb after the wallet signed with PKH descriptor.

I think once #1141 is in you'll be able to use a different function to compare fee rates like to_sat_per_kwu(self) or to_sat_per_vb_ceil(self).

Yes, I am following #1141. Once it is in we can remove this.
It is your call if you want to add these tests before #1141.

fix: typo

oleonardolima · 2024-11-20T04:57:19Z

I think the proposed tests are useful and a great addition. However the PR has become stale and I guess we could move it out from 1.0.0-beta milestone, @notmandatory maybe to 1.1.0 ?

luisschwab · 2025-04-22T00:27:57Z

Hey @realeinherjar, this PR needs to be closed and moved to the new bdk_wallet repo. Here's how:

From your Github account, fork https://github.com/bitcoindevkit/bdk_wallet
From your local system bdk repo folder, push your PR changes to your bdk_wallet fork on Github:
```
git checkout <PR branch path>
git push [email protected]:<username>/bdk_wallet.git
```

Clone to your forked bdk_wallet repo to your local system and switch to your PR branch:

git clone [email protected]:<username>/bdk_wallet.git
cd bdk_wallet
git fetch origin <PR branch path>
git checkout -b <PR branch path> FETCH_HEAD
git rebase master

Resolve rebase conflicts (if any)
Force push your PR branch: git push origin -f
Create new PR in bitcoindevkit/bdk_wallet repo from your fork branch
Copy/paste title and description from your original bdk PR and add a link back to it in your new PR.
Close original PR with comment that includes link to new PR.

luisschwab · 2025-04-23T00:09:25Z

@notmandatory or @ValuedMammal, you need to close this one, he doesn't use this nym anymore.

5dcf128 test: fixup value of P2WPKH_FAKE_PK_SIZE (33) (valued mammal) 833ed78 chore(test): destructure `wallet.sent_and_received()` into `(sent, received)` (Luis Schwab) 9b3eb94 fix(test): `check_fee!` returns `Amount` instead of `Result<Amount>` (Luis Schwab) b56f4bd fix(test): push P2WPKH's signature and pubkey separately into witness (Luis Schwab) 1b4f31c fix: clippy (Luis Schwab) 4c963d9 test: add `test_legacy_bump_fee_add_input()` (Luis Schwab) 6c2e5a5 test: add `test_legacy_bump_fee_drain_wallet()` (Luis Schwab) a094c6e test: add `test_legacy_bump_fee_zero_abs()` (Luis Schwab) 19f9095 test: add `test_legacy_create_tx_custom_sighash()` (Luis Schwab) ba06877 test: add `test_legacy_create_tx_default_sighash()` (Luis Schwab) 2dcf7ad test: add `test_legacy_create_tx_absolute_high_fee()` (Luis Schwab) cc5ba73 test: add `test_legacy_create_tx_absolute_zero_fee()` (Luis Schwab) cf0125c test: add `test_legacy_create_tx_absolute_fee()` (Luis Schwab) a8a0df4 test: add `test_legacy_create_tx_custom_fee_rate()` (Luis Schwab) 73e9b6f test: add `test_legacy_get_funded_wallet_tx_fee_rate()` (Luis Schwab) a4de9be feat: create `assert_fee_rate_legacy!` macro (Luis Schwab) 5444fe7 test: add `get_test_pkh` (Luis Schwab) Pull request description:  ### Description This PR closes #134 and is a revival of bitcoindevkit/bdk#1130, which adds the following tests: - `test_legacy_bump_fee_no_change_add_input_and_change()` - `test_legacy_bump_fee_add_input()` - `test_legacy_bump_fee_drain_wallet()` - `test_legacy_bump_fee_zero_abs()` - `test_legacy_create_tx_custom_sighash()` - `test_legacy_create_tx_default_sighash()` - `test_legacy_create_tx_absolute_high_fee()` - `test_legacy_create_tx_absolute_zero_fee()` - `test_legacy_create_tx_absolute_fee()` - `test_legacy_create_tx_custom_fee_rate()` - `test_legacy_get_funded_wallet_tx_fee_rate()` ### Changelog: - Add the above mentioned tests. - Add a new `assert_fee_rate_legacy!` macro for legacy transactions. - The `check_fee!` macro now returns `Amount` instead of `Result<Amount>`. - All `wallet.sent_and_received` got destructured to `(sent, received)` instead of `sent_and_received.{0,1}`. - ~Swap `TweakedKeypair::to_inner()` for `TweakedKeypair::to_keypair()`.~ ### Checklists #### All Submissions: * [X] I've signed all my commits * [X] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [X] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: ValuedMammal: ACK 5dcf128 Tree-SHA512: 4ce84749f6611ee540bd0d161ef22f731b827c9bef80a567977ba954e68bbbd1a93a1eaaf35d91cfc87f82d10ce7a62f2866aeceb5fef87792a18c2f72e2ace7

realeinherjar commented Sep 20, 2023

View reviewed changes

crates/bdk/tests/wallet.rs Outdated Show resolved Hide resolved

realeinherjar commented Sep 20, 2023

View reviewed changes

notmandatory added the tests label Sep 21, 2023

notmandatory assigned realeinherjar Sep 21, 2023

nondiremanuel mentioned this pull request Sep 23, 2023

W39 Lib Team Call bitcoindevkit/.github#78

Closed

40 tasks

nondiremanuel added this to the 1.1.0-alpha.0 milestone Sep 26, 2023

realeinherjar commented Oct 1, 2023

View reviewed changes

crates/bdk/tests/wallet.rs

Comment on lines -154 to +170

#[allow(unused_mut)]

#[allow(unused_mut)]

Copy link

Contributor Author

realeinherjar Oct 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

autoformat

realeinherjar force-pushed the einherjar/legacy-tests branch from e47eedb to d5bf32c Compare October 1, 2023 08:34

realeinherjar commented Oct 1, 2023

View reviewed changes

realeinherjar added 12 commits October 2, 2023 04:57

test: add get_test_pkh for legacy descriptor

d39a974

fix: small typo

12c616a

test: add fee_rate tests for legacy descriptors

1bf7099

test: add absolute fee tests for legacy descriptors

8d7a284

test: add absolute zero fee tests for legacy descriptors

2a28698

test: add insufficient funds fee tests for legacy descriptors

2b4e4b7

test: add sighash tests for legacy descriptors

8056443

test: add legacy fee bumps tests for legacy descriptors

b6c9b2d

test: add custom fee rate tests for legacy descriptors

fb5cc37

fix: formatting codebase

ca9793f

fix: typo

test: add create custom fee rate for legacy descriptors

ab6833a

fix: remove segwit @add_signature from legacy tests

600824e

realeinherjar force-pushed the einherjar/legacy-tests branch from d5bf32c to 600824e Compare October 2, 2023 07:57

notmandatory modified the milestones: 1.1.0-alpha.0, 1.0.0-alpha.4, 1.0.0-beta.0 Nov 13, 2023

notmandatory added the module-descriptor label Mar 18, 2024

notmandatory removed this from the 1.0.0-beta milestone Nov 21, 2024

luisschwab mentioned this pull request Apr 22, 2025

feat(test): add legacy descriptor tests bitcoindevkit/bdk_wallet#214

Merged

3 tasks

notmandatory added this to BDK Chain Apr 23, 2025

notmandatory moved this to In Progress in BDK Chain Apr 23, 2025

notmandatory closed this Apr 24, 2025

github-project-automation bot moved this from In Progress to Done in BDK Wallet Apr 24, 2025

github-project-automation bot moved this from In Progress to Done in BDK Chain Apr 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test: legacy descriptors #1130

test: legacy descriptors #1130

Uh oh!

realeinherjar commented Sep 20, 2023

Uh oh!

Uh oh!

realeinherjar Sep 20, 2023

Uh oh!

realeinherjar commented Oct 1, 2023

Uh oh!

realeinherjar Oct 1, 2023

Uh oh!

realeinherjar Oct 1, 2023

Uh oh!

realeinherjar Oct 1, 2023

Uh oh!

notmandatory Oct 1, 2023

Uh oh!

realeinherjar Oct 1, 2023

Uh oh!

oleonardolima commented Nov 20, 2024

Uh oh!

luisschwab commented Apr 22, 2025

Uh oh!

luisschwab commented Apr 23, 2025

Uh oh!

Uh oh!

		"shoulld be ok when outpoint does match psbt_input"
		"should be ok when outpoint does match psbt_input"

test: legacy descriptors #1130

test: legacy descriptors #1130

Uh oh!

Conversation

realeinherjar commented Sep 20, 2023

Description

Notes to the reviewers

Changelog notice

Added

Checklists

All Submissions:

New Features:

Bugfixes:

Uh oh!

Uh oh!

realeinherjar Sep 20, 2023

Choose a reason for hiding this comment

Uh oh!

realeinherjar commented Oct 1, 2023

Uh oh!

realeinherjar Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

realeinherjar Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

realeinherjar Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

notmandatory Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

realeinherjar Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

oleonardolima commented Nov 20, 2024

Uh oh!

luisschwab commented Apr 22, 2025

Uh oh!

luisschwab commented Apr 23, 2025

Uh oh!

Uh oh!