docs: update cargo features in README to match Cargo.toml#300
Open
Musab1258 wants to merge 1 commit into
Open
Conversation
The README referenced outdated compile-time feature flags `kyoto` and `sp`, which caused build failures for users following the instructions. This commit updates the documentation to use the correct flags `cbf` and `silent-payments` as defined in the current Cargo.toml.
Author
|
Hi @tvpeter, can you please check this out? |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #300 +/- ##
=======================================
Coverage 56.89% 56.89%
=======================================
Files 22 22
Lines 3661 3661
=======================================
Hits 2083 2083
Misses 1578 1578
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
tvpeter
approved these changes
Jul 10, 2026
va-an
approved these changes
Jul 10, 2026
va-an
left a comment
There was a problem hiding this comment.
ACK 4a1ff1b
Not related to this PR, but a possible follow-up: the flags in this example don't match the code - the command uses --scan_key / --spend_key (src/handlers/descriptor.rs), not --scan_public_key / --spend_public_key.
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
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.
Description
The README referenced outdated cargo feature flags
kyotoandsp, which will cause build failures for users following the instructions. This commit updates the documentation to use the correct flagscbfandsilent-paymentsas defined in the currentCargo.toml.Fixes #299
Notes to the reviewers
This is a documentation update to the
README.md. I specifically left the reference toKyotoin the "About" section intact, as it correctly refers to the underlyingbdk_kyotolibrary/concept, and only updated the actual Cargo feature flags in the code blocks and feature lists.Changelog notice
kyoto->cbfandsp->silent-payments) in the README instructions.Checklists
All Submissions:
cargo fmtandcargo clippybefore committingBugfixes: