Repository navigation
Add CHANGELOG.md and ship it in the npm package - #12
Merged
Merged
Conversation
Covers 1.0.0 (required keepAlive, hedged signatures, ML-DSA-65, the node-reported block hash fix, immortal warning) and summarises earlier versions; linked from the README.
n13
commented
Oct 9, 2026
n13
left a comment
Contributor
Author
There was a problem hiding this comment.
Reviewer model: GPT-6.1 Sol
Verdict (advisory): Approve
Reviewed the complete diff from 9fb2c2f to dd1fa6dfa651ecb0b1a7607e652d7fb6e2446e74. No blocking findings. The changelog matches the released signing APIs and release history, including the required keepAlive choice, hedged signatures, ML-DSA-65, and node-reported mortal-era block hashes. The package change adds the changelog without removing any runtime files from the allowlist.
Validation:
- Local
git diff --check: passed. - Local
npm pack --dry-run --json: confirmedCHANGELOG.mdis included (3,409 bytes), alongside the README and package metadata. - CI at the reviewed head: passed
npm test, including 10 Rust tests, the wasm/TypeScript build, and 20 JavaScript tests, including the runtime packaging test. - The full suite was not repeated locally: the installed
wasm-packexecutable fails withbad CPU type in executable. Local changelog packaging validation and the successful CI results are separate evidence.
Posted as an advisory comment because the authenticated account authored this PR.
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.
Why
npmjs.com only renders the README, and the auto-generated GitHub Release notes for v1.0.0 list PR titles that no longer describe the final change (the PR title said "default to transfer_keep_alive"; the released API makes
keepAliverequired with no default). A maintained changelog gives integrators one accurate place to read what changed, inside the package and on GitHub.What changes
CHANGELOG.mdin Keep-a-Changelog style: a full 1.0.0 entry (breakingkeepAlive, hedged signatures, ML-DSA-65, the node-reportedblockHashfix, the immortal-era warning, docs) and short entries for 0.3.1 back to 0.1.0.package.jsonfilesincludesCHANGELOG.md, so it ships in the tarball from the next release (verified withnpm pack --dry-run;test/package.test.jspasses).No code changes.