docs: install instructions pin ^0.5.2, which cannot resolve to the current 0.6.1 release - #35
Open
boleklebovski wants to merge 1 commit into
Conversation
The documented install ranges pin ^0.5.2, which semver excludes 0.6.x, so readers install a full minor behind the published packages. Signed-off-by: boleklebovski <160799963+boleklebovski@users.noreply.github.com>
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.
Problem
Every install command and version table in the client-SDK docs pins the CoFHE packages at
^0.5.2(and@fhenixprotocol/cofhe-contractsat^0.1.3). All five@cofhe/*packages are now published at 0.6.1, and the contracts package at 0.1.4.Because these are
0.xversions, the caret range is narrower than people expect:^0.5.2means>=0.5.2 <0.6.0, so it can never resolve to 0.6.1. Anyone following the docs installs a full minor line behind, and no warning is produced.Verified against two independent registry mirrors (jsDelivr and unpkg):
@cofhe/sdk^0.5.2@cofhe/hardhat-plugin^0.5.2@cofhe/hardhat-3-plugin0.5.2@cofhe/foundry-plugin^0.5.2@cofhe/mock-contracts^0.5.2@fhenixprotocol/cofhe-contracts^0.1.3Fix
Bump the documented ranges to
^0.6.1/^0.1.4across the install commands and version tables.The contracts bump is required rather than cosmetic:
@cofhe/hardhat-plugin@0.6.1declares a peer dependency of@fhenixprotocol/cofhe-contracts >=0.1.4, and@cofhe/foundry-plugin@0.6.1and@cofhe/mock-contracts@0.6.1both pin it to exactly0.1.4. So the "keep all three aligned" note in the Foundry reference stays true only if the tuple moves together.Two smaller things ride along, both on lines already being touched:
client-sdk/introduction/installation.mdxstated "@fhenixprotocol/cofhe-contracts@0.1.3requires@cofhe/sdkversion>= 0.5.1. Latest published is0.5.2." — the last sentence is now wrong. Replaced with the pinning relationship I could verify from the published manifests.@cofhe/sdklink in the compatibility table pointed atreleases/tag/v0.5.2, which 404s — this repo tags releases as@cofhe/sdk@<version>, notv<version>, so that link has never resolved. Repointed at the real 0.6.1 release tag (verified 200).Scope note
I deliberately left the Minimum Compatible Version column in
compatibility.mdxuntouched. Bumping "current" is a fact I can verify from the registry; deciding the lowest still-supported version is your call, not mine. I also left the historical note infhe-library/reference/fhe-sol/utility.mdxabout the rename incofhe-contracts@v0.1.3, since that is a statement about the past.Docs-only: 7 files, no code or config touched.