From 5aad4c9ac335f64b2fab12445b0e5bbc11cfd666 Mon Sep 17 00:00:00 2001 From: boleklebovski <160799963+boleklebovski@users.noreply.github.com> Date: Sun, 9 Aug 2026 23:29:18 +0200 Subject: [PATCH] docs: update CoFHE package versions to the current 0.6.1 line 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> --- client-sdk/foundry-plugin/getting-started.mdx | 12 +++---- client-sdk/introduction/installation.mdx | 36 +++++++++---------- client-sdk/quick-start/foundry.mdx | 6 ++-- client-sdk/quick-start/hardhat.mdx | 6 ++-- client-sdk/quick-start/javascript.mdx | 6 ++-- client-sdk/reference/foundry-reference.mdx | 6 ++-- get-started/introduction/compatibility.mdx | 12 +++---- 7 files changed, 42 insertions(+), 42 deletions(-) diff --git a/client-sdk/foundry-plugin/getting-started.mdx b/client-sdk/foundry-plugin/getting-started.mdx index 9186e1a..27553f3 100644 --- a/client-sdk/foundry-plugin/getting-started.mdx +++ b/client-sdk/foundry-plugin/getting-started.mdx @@ -31,15 +31,15 @@ The plugin and its dependencies are distributed via npm. Install them as dev dep ```bash npm -npm install -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +npm install -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts ``` ```bash pnpm -pnpm add -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +pnpm add -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts ``` ```bash yarn -yarn add -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +yarn add -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts ``` @@ -129,9 +129,9 @@ Known-aligned tuple as of writing: | Package | Version | | --- | --- | -| `@cofhe/foundry-plugin` | `0.5.2` | -| `@cofhe/mock-contracts` | `0.5.2` | -| `@fhenixprotocol/cofhe-contracts` | `0.1.3` | +| `@cofhe/foundry-plugin` | `0.6.1` | +| `@cofhe/mock-contracts` | `0.6.1` | +| `@fhenixprotocol/cofhe-contracts` | `0.1.4` | See the [Compatibility](/get-started/introduction/compatibility) page for the canonical table. diff --git a/client-sdk/introduction/installation.mdx b/client-sdk/introduction/installation.mdx index 78bdd61..932b19c 100644 --- a/client-sdk/introduction/installation.mdx +++ b/client-sdk/introduction/installation.mdx @@ -14,26 +14,26 @@ description: "Install and configure @cofhe/sdk for your project" ```bash npm -npm install @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +npm install @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` ```bash pnpm -pnpm add @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +pnpm add @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` ```bash yarn -yarn add @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +yarn add @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` | Package | Version | Purpose | | --- | --- | --- | -| `@cofhe/sdk` | `^0.5.2` | Client-side encryption, decryption, and permit management | -| `@fhenixprotocol/cofhe-contracts` | `^0.1.3` | `FHE.sol` — the Solidity library imported by your contracts | +| `@cofhe/sdk` | `^0.6.1` | Client-side encryption, decryption, and permit management | +| `@fhenixprotocol/cofhe-contracts` | `^0.1.4` | `FHE.sol` — the Solidity library imported by your contracts | -`@fhenixprotocol/cofhe-contracts@0.1.3` requires `@cofhe/sdk` version `>= 0.5.1`. Latest published is `0.5.2`. +`@cofhe/hardhat-plugin@0.6.1` and `@cofhe/foundry-plugin@0.6.1` pin `@fhenixprotocol/cofhe-contracts` to `0.1.4`. Latest published `@cofhe/*` is `0.6.1`. ## For Hardhat projects @@ -43,24 +43,24 @@ If you are using Hardhat for development and testing, also install the plugin: ```bash npm -npm install @cofhe/hardhat-plugin@^0.5.2 @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +npm install @cofhe/hardhat-plugin@^0.6.1 @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` ```bash pnpm -pnpm add @cofhe/hardhat-plugin@^0.5.2 @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +pnpm add @cofhe/hardhat-plugin@^0.6.1 @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` ```bash yarn -yarn add @cofhe/hardhat-plugin@^0.5.2 @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +yarn add @cofhe/hardhat-plugin@^0.6.1 @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` | Package | Version | Purpose | | --- | --- | --- | -| `@cofhe/hardhat-plugin` | `^0.5.2` | Extends Hardhat with `hre.cofhe`, deploys mock contracts automatically | -| `@cofhe/sdk` | `^0.5.2` | Client-side encryption, decryption, and permit management | -| `@fhenixprotocol/cofhe-contracts` | `^0.1.3` | `FHE.sol` — the Solidity library imported by your contracts | +| `@cofhe/hardhat-plugin` | `^0.6.1` | Extends Hardhat with `hre.cofhe`, deploys mock contracts automatically | +| `@cofhe/sdk` | `^0.6.1` | Client-side encryption, decryption, and permit management | +| `@fhenixprotocol/cofhe-contracts` | `^0.1.4` | `FHE.sol` — the Solidity library imported by your contracts | See the [Hardhat Plugin Getting Started](/client-sdk/hardhat-plugin/getting-started) guide for configuration details. @@ -71,17 +71,17 @@ If you are using Foundry for development and testing, install the Foundry plugin ```bash npm -npm install -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +npm install -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts forge install foundry-rs/forge-std ``` ```bash pnpm -pnpm add -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +pnpm add -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts forge install foundry-rs/forge-std ``` ```bash yarn -yarn add -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +yarn add -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts forge install foundry-rs/forge-std ``` @@ -89,9 +89,9 @@ forge install foundry-rs/forge-std | Package | Version | Purpose | | --- | --- | --- | -| `@cofhe/foundry-plugin` | `^0.5.2` | `CofheTest` and `CofheClient` — Solidity test base and per-user SDK shim | -| `@cofhe/mock-contracts` | `^0.5.2` | Mock CoFHE contracts used by the Foundry plugin | -| `@fhenixprotocol/cofhe-contracts` | `^0.1.3` | `FHE.sol` — the Solidity library imported by your contracts | +| `@cofhe/foundry-plugin` | `^0.6.1` | `CofheTest` and `CofheClient` — Solidity test base and per-user SDK shim | +| `@cofhe/mock-contracts` | `^0.6.1` | Mock CoFHE contracts used by the Foundry plugin | +| `@fhenixprotocol/cofhe-contracts` | `^0.1.4` | `FHE.sol` — the Solidity library imported by your contracts | The Foundry plugin uses Solidity-only abstractions — no `@cofhe/sdk` (JS) needed for tests. diff --git a/client-sdk/quick-start/foundry.mdx b/client-sdk/quick-start/foundry.mdx index d5307a9..b7db10c 100644 --- a/client-sdk/quick-start/foundry.mdx +++ b/client-sdk/quick-start/foundry.mdx @@ -21,17 +21,17 @@ The plugin and its CoFHE dependencies are distributed via npm. Install them as d ```bash npm -npm install -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +npm install -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts forge install foundry-rs/forge-std ``` ```bash pnpm -pnpm add -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +pnpm add -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts forge install foundry-rs/forge-std ``` ```bash yarn -yarn add -D @cofhe/foundry-plugin@^0.5.2 @cofhe/mock-contracts@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 @openzeppelin/contracts +yarn add -D @cofhe/foundry-plugin@^0.6.1 @cofhe/mock-contracts@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 @openzeppelin/contracts forge install foundry-rs/forge-std ``` diff --git a/client-sdk/quick-start/hardhat.mdx b/client-sdk/quick-start/hardhat.mdx index ffb9fcf..4b4d848 100644 --- a/client-sdk/quick-start/hardhat.mdx +++ b/client-sdk/quick-start/hardhat.mdx @@ -20,15 +20,15 @@ Want to skip the setup? Clone the [cofhe-hardhat-starter](https://github.com/Fhe ```bash npm -npm install @cofhe/hardhat-plugin@^0.5.2 @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +npm install @cofhe/hardhat-plugin@^0.6.1 @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` ```bash pnpm -pnpm add @cofhe/hardhat-plugin@^0.5.2 @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +pnpm add @cofhe/hardhat-plugin@^0.6.1 @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` ```bash yarn -yarn add @cofhe/hardhat-plugin@^0.5.2 @cofhe/sdk@^0.5.2 @fhenixprotocol/cofhe-contracts@^0.1.3 +yarn add @cofhe/hardhat-plugin@^0.6.1 @cofhe/sdk@^0.6.1 @fhenixprotocol/cofhe-contracts@^0.1.4 ``` diff --git a/client-sdk/quick-start/javascript.mdx b/client-sdk/quick-start/javascript.mdx index 1a31b22..ab4d163 100644 --- a/client-sdk/quick-start/javascript.mdx +++ b/client-sdk/quick-start/javascript.mdx @@ -16,15 +16,15 @@ Connect to an FHE-enabled contract, encrypt a value, send it on-chain, and decry ```bash npm -npm install @cofhe/sdk@^0.5.2 viem +npm install @cofhe/sdk@^0.6.1 viem ``` ```bash pnpm -pnpm add @cofhe/sdk@^0.5.2 viem +pnpm add @cofhe/sdk@^0.6.1 viem ``` ```bash yarn -yarn add @cofhe/sdk@^0.5.2 viem +yarn add @cofhe/sdk@^0.6.1 viem ``` diff --git a/client-sdk/reference/foundry-reference.mdx b/client-sdk/reference/foundry-reference.mdx index fea280d..abcc7da 100644 --- a/client-sdk/reference/foundry-reference.mdx +++ b/client-sdk/reference/foundry-reference.mdx @@ -136,8 +136,8 @@ hardhat/=node_modules/forge-std/src/ | Package | Version | | --- | --- | -| `@cofhe/foundry-plugin` | `0.5.2` | -| `@cofhe/mock-contracts` | `0.5.2` | -| `@fhenixprotocol/cofhe-contracts` | `0.1.3` | +| `@cofhe/foundry-plugin` | `0.6.1` | +| `@cofhe/mock-contracts` | `0.6.1` | +| `@fhenixprotocol/cofhe-contracts` | `0.1.4` | See the [Compatibility](/get-started/introduction/compatibility) page for the canonical table. diff --git a/get-started/introduction/compatibility.mdx b/get-started/introduction/compatibility.mdx index 2b039ad..4ecd0cd 100644 --- a/get-started/introduction/compatibility.mdx +++ b/get-started/introduction/compatibility.mdx @@ -17,12 +17,12 @@ The following table lists all core CoFHE components with their current and minim | Component | Current Version | Minimum Compatible Version | Notes | |-----------|----------------|----------------------------|-------| -| **@fhenixprotocol/cofhe-contracts** | [`0.1.3`](https://github.com/FhenixProtocol/cofhe-contracts/tree/v0.1.3) | `0.1.3` | Solidity libraries and smart contracts for FHE operations | -| **@cofhe/sdk** | [`0.5.2`](https://github.com/FhenixProtocol/cofhesdk/releases/tag/v0.5.2) | `0.5.2` | JavaScript library for interacting with FHE contracts and the CoFHE coprocessor | -| **@cofhe/hardhat-plugin** | `0.5.2` | `0.5.2` | Hardhat plugin that deploys mock contracts and exposes utilities | -| **@cofhe/hardhat-3-plugin** | `0.5.2` | `0.5.2` | Hardhat 3 plugin that deploys mock contracts and exposes utilities | -| **@cofhe/foundry-plugin** | `0.5.2` | `0.5.2` | Foundry plugin that deploys mock contracts and exposes utilities | -| **@cofhe/mock-contracts** | `0.5.2` | `0.5.2` | Mock contracts for local development and testing | +| **@fhenixprotocol/cofhe-contracts** | [`0.1.4`](https://github.com/FhenixProtocol/cofhe-contracts/tree/v0.1.4) | `0.1.3` | Solidity libraries and smart contracts for FHE operations | +| **@cofhe/sdk** | [`0.6.1`](https://github.com/FhenixProtocol/cofhesdk/releases/tag/%40cofhe%2Fsdk%400.6.1) | `0.5.2` | JavaScript library for interacting with FHE contracts and the CoFHE coprocessor | +| **@cofhe/hardhat-plugin** | `0.6.1` | `0.5.2` | Hardhat plugin that deploys mock contracts and exposes utilities | +| **@cofhe/hardhat-3-plugin** | `0.6.1` | `0.5.2` | Hardhat 3 plugin that deploys mock contracts and exposes utilities | +| **@cofhe/foundry-plugin** | `0.6.1` | `0.5.2` | Foundry plugin that deploys mock contracts and exposes utilities | +| **@cofhe/mock-contracts** | `0.6.1` | `0.5.2` | Mock contracts for local development and testing | ## Additional Packages