You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The cofhejs README appears to be carried over from the old fhenixjs package and hasn't been updated to reflect the current project.
Issues
Problem
Current (Incorrect)
Should Be
npm badge
Points to fhenixjs
Should point to cofhejs
CI badge
Points to fhenixprotocol/fhenix.js repo
Should point to cofhejs
Install command
npm install fhenixjs
npm install cofhejs
CDN link
fhenixjs@0.3.0-alpha.1
Should reference cofhejs
Docs link
fhenixjs.fhenix.zone
Should point to cofhe-docs.fhenix.zone
Title
"The JavaScript SDK for Fhenix"
Should mention CoFHE
Description
"fhenix.js allows developers..."
Should reference cofhejs
Additional Notes
The line "(only node 20+ is supported until I fix this)" reads as a personal dev note rather than documentation. The package.json already declares "engines": { "node": ">=20.0.0" }, so the README should just state the requirement cleanly.
The NextJS WASM config section references a TODO tracking next.js/issues/25852 — worth checking if that's still relevant.
The current npm version is 0.4.0-alpha.0 but nothing in the README reflects the current API surface (cofhejs.encrypt, Encryptable.*, permit system, etc.).
Happy to submit a PR updating the README if that would be helpful.
Summary
The
cofhejsREADME appears to be carried over from the oldfhenixjspackage and hasn't been updated to reflect the current project.Issues
fhenixjscofhejsfhenixprotocol/fhenix.jsrepocofhejsnpm install fhenixjsnpm install cofhejsfhenixjs@0.3.0-alpha.1cofhejsfhenixjs.fhenix.zonecofhe-docs.fhenix.zonecofhejsAdditional Notes
package.jsonalready declares"engines": { "node": ">=20.0.0" }, so the README should just state the requirement cleanly.next.js/issues/25852— worth checking if that's still relevant.0.4.0-alpha.0but nothing in the README reflects the current API surface (cofhejs.encrypt,Encryptable.*, permit system, etc.).Happy to submit a PR updating the README if that would be helpful.