bitcoindevkit / bdk / 12396100452

79%

push

github

Merge bitcoindevkit/bdk#1779: `transactions` method should only return relevant transactions

<a class=hub.com/bitcoindevkit/bdk/commit/<a class="double-link" href="https://git"><a class=hub.com/bitcoindevkit/bdk/commit/<a class="double-link" href="https://git"><a class=hub.com/bitcoindevkit/bdk/commit/75fae3ef56be838787306fc81862eb5ae500f635">75fae3ef5<a href="https://github.com/bitcoindevkit/bdk/commit/3e01d56ae7917fe204709cd2c2e5de30597519ed"> test(wallet): verify Wallet::transactions method only returns relevant txs (Steve Myers)
<a class="double-link" href="https://github.com/bitcoindevkit/bdk/commit/3e1fd2b0a2b39668e5ab29c6968e85949623e447">3e1fd2b0a</a> fix(wallet): `transactions` method should only return relevant txs (志宇)

Pull request description:

  Fixes #1239

  ### Description

  Currently the behavior of `Wallet::transactions` is not well defined and unintuitive.

  The approach taken in this PR is to make `Wallet::transactions` return what most wallets would like the caller to see (i.e. transactions that are part of the canonical history and spend from/to a tracked spk). A.k.a make the method more restrictive.

  Documentation is updated to refer the caller to the underlying `bdk_chain` structures for any over usecase.

  After #1765 gets merged, the behavior of `Wallet::transactions` will become even more unintuitive. Refer to https://github.com/bitcoindevkit/bdk/pull/1765#pullrequestreview-2503968540.

  ### Notes to the reviewers

  **Why not have multiple methods in `Wallet` that return different sets of transactions?**

  I think it's better to only provide common usecase histories from `Wallet` and I can only think of one.

  ### Changelog notice

  * Change `Wallet::transactions` to only include "relevant" transactions.

  ### 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:
  luisschwab:
    tACK 75fae3ef56be838787306fc81862eb5ae500f635
  notmandatory:
    tACK 75fae3ef56be838787306fc81862eb5ae500f635
  oleonardolima:
    tACK 75fae3ef56be838787306fc81862eb5ae500f635
  ValuedMammal:
    ACK 75fae3ef

Tree-SHA512: abf159e0c5d07bb14558dfc74abb9d4... (continued)

4 of 4 new or added lines in 1 file covered. (100.0%)

11988 of 14289 relevant lines covered (83.9%)

20145.3 hits per line