fix(chain): clamp derivation index before apply_changeset - #2265
Open
busayo-OD wants to merge 1 commit into
Open
fix(chain): clamp derivation index before apply_changeset#2265busayo-OD wants to merge 1 commit into
busayo-OD wants to merge 1 commit into
Conversation
KeychainTxOutIndex::apply_changeset accepts ChangeSet::last_revealed values above BIP32_MAX_INDEX, violating an invariant relied on by the indexer. Clamp each last_revealed value to BIP32_MAX_INDEX before storing it, keeping changeset application infallible and monotone.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes bdk_wallet/issues/60
Description
KeychainTxOutIndex::apply_changesetacceptsChangeSet::last_revealedvalues aboveBIP32_MAX_INDEX, violating an invariant relied on by the indexer. This PR clamps eachlast_revealedvalue toBIP32_MAX_INDEXbefore storing it.The change follows the approach discussed in #1792, keeping changeset application infallible and monotone. The added regression test verifies that an out-of-range
last_revealedvalue is clamped toBIP32_MAX_INDEX.Notes to the reviewers
The test uses a non-wildcard descriptor and verifies the sanitization directly rather than reproducing the downstream panic itself. A wildcard descriptor with a large
last_revealedcausesreplenish_inner_indexto eagerly derive a very large number of script pubkeys beforeapply_changesetreturns, making a direct reproduction of the downstream panic impractical.Changelog notice
Clamp
last_revealedtoBIP32_MAX_INDEXwhen applying aChangeSettoKeychainTxOutIndex.Checklists
All Submissions
just pbefore committingBugfixes