Skip to content

docs: install instructions pin ^0.5.2, which cannot resolve to the current 0.6.1 release #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
boleklebovski wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: install instructions pin ^0.5.2, which cannot resolve to the current 0.6.1 release #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions client-sdk/foundry-plugin/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ The plugin and its dependencies are distributed via npm. Install them as dev dep
<CodeGroup>

```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
```

</CodeGroup>
Expand Down Expand Up @@ -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.

Expand Down
36 changes: 18 additions & 18 deletions client-sdk/introduction/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,26 @@ description: "Install and configure @cofhe/sdk for your project"
<CodeGroup>

```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
```

</CodeGroup>

| 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 |

<Note>
`@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`.
</Note>

## For Hardhat projects
Expand All @@ -43,24 +43,24 @@ If you are using Hardhat for development and testing, also install the plugin:
<CodeGroup>

```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
```

</CodeGroup>

| 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.

Expand All @@ -71,27 +71,27 @@ If you are using Foundry for development and testing, install the Foundry plugin
<CodeGroup>

```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
```

</CodeGroup>

| 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 |

<Note>
The Foundry plugin uses Solidity-only abstractions — no `@cofhe/sdk` (JS) needed for tests.
Expand Down
6 changes: 3 additions & 3 deletions client-sdk/quick-start/foundry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ The plugin and its CoFHE dependencies are distributed via npm. Install them as d
<CodeGroup>

```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
```

Expand Down
6 changes: 3 additions & 3 deletions client-sdk/quick-start/hardhat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Want to skip the setup? Clone the [cofhe-hardhat-starter](https://github.com/Fhe
<CodeGroup>

```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
```

</CodeGroup>
Expand Down
6 changes: 3 additions & 3 deletions client-sdk/quick-start/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Connect to an FHE-enabled contract, encrypt a value, send it on-chain, and decry
<CodeGroup>

```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
```

</CodeGroup>
Expand Down
6 changes: 3 additions & 3 deletions client-sdk/reference/foundry-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
12 changes: 6 additions & 6 deletions get-started/introduction/compatibility.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down