Skip to content

docs: clarify CheckPoint and walk_descendants and SpkIterator behavior - #2457

Open
reez wants to merge 3 commits into
bitcoindevkit:masterfrom
reez:issue-59
Open

reez wants to merge 3 commits into
bitcoindevkit:masterfrom
reez:issue-59

Conversation

@reez

@reez reez commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Description

Addresses the remaining chain related documentation items in bitcoindevkit/bdk_wallet#59:

  • Documents that CheckPoint always contains at least one checkpoint.
  • Clarifies that walk_descendants excludes the starting transaction.
  • Explains how SpkIterator keeps derivation indices within the non hardened range.

Notes to the reviewers

  • CheckPoint wording from Steve’s description in the Issue
  • walk_descendants follows the existing related verbiage in another spot in same file.
  • SpkIterator wording I was trying to use some upstream rust-bitcoin wording as a guide.

Checklists

All Submissions:

@reez
reez requested a review from a team as a code owner November 4, 2026 19:44
@github-project-automation github-project-automation Bot moved this to Triage in BDK Chain Nov 4, 2026
@reez reez changed the title docs: improve chain documentation for checkpoint and iterator invariants docs: clarify CheckPoint and walk_descendants and SpkIterator behavior Nov 4, 2026
@codecov

codecov Bot commented Nov 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.25%. Comparing base (02b7b12) to head (c7656b0).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2457   +/-   ##
=======================================
  Coverage   83.25%   83.25%           
=======================================
  Files          31       31           
  Lines        6236     6236           
  Branches      293      293           
=======================================
  Hits         5192     5192           
  Misses        976      976           
  Partials       68       68           
Flag Coverage Δ
rust 83.25% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@reez reez mentioned this pull request Nov 4, 2026
2 of 6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Triage

Development

Successfully merging this pull request may close these issues.

1 participant