refactor(keyring-api): make capabilities boolean fields exact optionals #453
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.
To avoid having to update every keyrings after we add a new capability.
Note
Medium Risk
Moderate risk because it changes the validation/typing contract for
KeyringCapabilities.bip44and updates multiple keyring wrappers/tests; consumers that relied on explicitfalsevalues may need to treat missing fields as unsupported.Overview
Makes BIP-44 capability flags optional in
KeyringCapabilities. TheKeyringCapabilitiesStructnow treatsbip44.derivePath,deriveIndex,deriveIndexRange, anddiscoverasexactOptional(boolean()), so keyrings can omit unsupported capabilities instead of setting them tofalse.Updates Ethereum keyring wrappers (HD/Ledger/QR/Trezor) and their tests to stop emitting/asserting
falsefor unsupported BIP-44 capabilities, and documents the new semantics in thekeyring-apichangelog (and references the PR in downstream package changelogs).Written by Cursor Bugbot for commit e152b20. This will update automatically on new commits. Configure here.