Installation

Prerequisites

Node.js 18+
TypeScript 5+
viem 2.38.6+

Install packages

npm install @cofhe/sdk@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0

pnpm add @cofhe/sdk@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0

yarn add @cofhe/sdk@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0

Package	Version	Purpose
`@cofhe/sdk`	`^0.7.1`	Client-side encryption, decryption, and ACP management
`@fhenixprotocol/cofhe-contracts`	`^0.2.0`	`FHE.sol`, the Solidity library imported by your contracts

@cofhe/sdk 0.7.x pairs with @fhenixprotocol/cofhe-contracts 0.2.0. Keep every @cofhe/* package on the same version. They are released together and pin each other exactly. The compatibility page carries the full table.

For Hardhat projects

If you are using Hardhat for development and testing, also install the plugin:

npm install @cofhe/hardhat-plugin@^0.7.1 @cofhe/sdk@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0

pnpm add @cofhe/hardhat-plugin@^0.7.1 @cofhe/sdk@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0

yarn add @cofhe/hardhat-plugin@^0.7.1 @cofhe/sdk@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0

Package	Version	Purpose
`@cofhe/hardhat-plugin`	`^0.7.1`	Extends Hardhat with `hre.cofhe`, deploys mock contracts automatically
`@cofhe/sdk`	`^0.7.1`	Client-side encryption, decryption, and ACP management
`@fhenixprotocol/cofhe-contracts`	`^0.2.0`	`FHE.sol`, the Solidity library imported by your contracts

See the Hardhat Plugin Getting Started guide for configuration details.

For Foundry projects

If you are using Foundry for development and testing, install the Foundry plugin and its peer packages as dev dependencies:

npm install -D @cofhe/foundry-plugin@^0.7.1 @cofhe/mock-contracts@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0 @openzeppelin/contracts
forge install foundry-rs/forge-std

pnpm add -D @cofhe/foundry-plugin@^0.7.1 @cofhe/mock-contracts@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0 @openzeppelin/contracts
forge install foundry-rs/forge-std

yarn add -D @cofhe/foundry-plugin@^0.7.1 @cofhe/mock-contracts@^0.7.1 @fhenixprotocol/cofhe-contracts@^0.2.0 @openzeppelin/contracts
forge install foundry-rs/forge-std

Package	Version	Purpose
`@cofhe/foundry-plugin`	`^0.7.1`	`CofheTest` and `CofheClient`, the Solidity test base and per-user SDK shim
`@cofhe/mock-contracts`	`^0.7.1`	Mock CoFHE contracts used by the Foundry plugin
`@fhenixprotocol/cofhe-contracts`	`^0.2.0`	`FHE.sol`, the Solidity library imported by your contracts

The Foundry plugin uses Solidity-only abstractions, so tests need no @cofhe/sdk (JS).

See the Foundry Plugin Getting Started guide for foundry.toml and remappings.txt setup.

Runtime entrypoints

Import from the entrypoint that matches your runtime:

// Browser apps (React, Next.js, etc.)
import { createCofheConfig, createCofheClient } from '@cofhe/sdk/web';

// Node.js scripts, backends, Hardhat tests
import { createCofheConfig, createCofheClient } from '@cofhe/sdk/node';

// Shared types (works in any runtime)
import { Encryptable, FheTypes } from '@cofhe/sdk';

Next steps

Quick start: write your first FHE contract and test.
Client setup: configure and connect the SDK client.

Introduction

Quick Start

Guides

Hardhat Plugin

Foundry Plugin

Examples

Reference

Prerequisites

Install packages

For Hardhat projects

For Foundry projects

Runtime entrypoints

Next steps

​Prerequisites

​Install packages

​For Hardhat projects

​For Foundry projects

​Runtime entrypoints

​Next steps

Prerequisites

Install packages

For Hardhat projects

For Foundry projects

Runtime entrypoints

Next steps