chore(codec): clarify crate description for crates.io#48
Merged
Conversation
…accurate) Replace "Brotli via JS shim" with an accurate phrase that notes Brotli is applied at the JS/wire layer, not inside the Rust crate itself. Leads with schema-v1-locked TLV identity and mentions keccak256 hash.
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.
What
Single-field metadata change in
packages/codec/Cargo.toml—descriptiononly.Why
The old description (
"Canonical Invoice codec — TLV wire format, Brotli via JS shim") was misleading for a Rust consumer: the Rust crate does not perform Brotli compression. Brotli is applied entirely at the JS/wire layer viabrotli-wasmin the TS shim (src/index.ts). This is documented explicitly inlib.rs's module-level doc comment.Old → New
Canonical Invoice codec — TLV wire format, Brotli via JS shimCanonical invoice codec — schema-v1 locked TLV wire format with keccak256 content hash; Brotli compression applied at the JS/wire layerThe new description: leads with what the crate IS, surfaces the schema-v1-locked / perpetual property, mentions keccak256 (a genuine Rust-crate capability), and accurately states Brotli is at the wire/JS layer — not inside the crate.
Verification
cargo metadata --no-depsparses the manifest cleanly