bitcoindevkit / bdk / 7656245420

79%

push

github

Merge bitcoindevkit/bdk#1270: Improve performance of `bdk_file_store::EntryIter`

<a class=hub.com/bitcoindevkit/bdk/commit/51bd01b3dd3d68c1628d74be9dc6d0f1cf1f15fe">51bd01b3d<a href="https://github.com/bitcoindevkit/bdk/commit/07116df54156315b4f1fc67647a9b8118e464d43"> fix(file_store): recover file offset after read (志宇)
<a class="double-link" href="https://github.com/bitcoindevkit/bdk/commit/66dc34e75ab1ec2ae533bd540327721f6226eca1">66dc34e75</a><a href="https://github.com/bitcoindevkit/bdk/commit/07116df54156315b4f1fc67647a9b8118e464d43"> refactor(file_store): Use BufReader but simplify (LLFourn)
</a><a class="double-link" href="https://github.com/bitcoindevkit/bdk/commit/c8717646700bdac0f1e13ec499481bd1fee30ffd">c87176467</a><a href="https://github.com/bitcoindevkit/bdk/commit/07116df54156315b4f1fc67647a9b8118e464d43"> test(file_store): `last_write_is_short` (志宇)
</a><a class="double-link" href="https://github.com/bitcoindevkit/bdk/commit/a3aa8b6682a3a13958fd5fbadc4074a1907a78db">a3aa8b668</a> feat(file_store)!: optimize `EntryIter` by reducing syscalls (志宇)

Pull request description:

  ### Description

  `EntryIter` performance is improved by reducing syscalls. The underlying file reader is wrapped with `BufReader` (to reduce calls to `read` and `seek`).

  Two new tests are introduced. One ensures correct behavior when the last changeset write is too short. The other ensures the next write position is correct after a short read.

  ### Notes to the reviewers

  This is extracted from #1172 as suggested by https://github.com/bitcoindevkit/bdk/pull/1172#pullrequestreview-1817465627.

  ### Changelog notice

  Changed
  * `EntryIter` performance is improved by reducing syscalls.

  ### 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

  #### New Features:

  * [x] I've added tests for the new feature
  * [x] I've added docs for the new feature

ACKs for top commit:
  LLFourn:
    ACK 51bd01b3dd3d68c1628d74be9dc6d0f1cf1f15fe

Tree-SHA512: 9c25f9f208f037b34625415ea8d7ade3736

9088 of 11338 relevant lines covered (80.16%)

5861.36 hits per line