SDK Reference

This page is under construction. A full API reference documenting all functions, parameters, and return types will be added here.

Entrypoints

Entrypoint	Contents
`@cofhe/sdk`	Core types: `Encryptable`, `FheTypes`, `EncryptStep`, `CofheError`, `CofheErrorCode`, `isCofheError`
`@cofhe/sdk/web`	`createCofheConfig`, `createCofheClient` (browser defaults)
`@cofhe/sdk/node`	`createCofheConfig`, `createCofheClient` (Node.js defaults)
`@cofhe/sdk/acps`	`ACPUtils`, `setACP`, `setActiveACPHash`, `getACP`, `getActiveACPHash`
`@cofhe/sdk/adapters`	`Ethers5Adapter`, `Ethers6Adapter`, `WagmiAdapter`, `HardhatSignerAdapter`
`@cofhe/sdk/chains`	`chains`, `getChainById`, `getChainByName`, `hardhat`

Factory for creating encryptable input items.

Method	Input type	Solidity param
`Encryptable.bool(value)`	`boolean`	`externalEbool`
`Encryptable.uint8(value)`	`bigint \| string`	`externalEuint8`
`Encryptable.uint16(value)`	`bigint \| string`	`externalEuint16`
`Encryptable.uint32(value)`	`bigint \| string`	`externalEuint32`
`Encryptable.uint64(value)`	`bigint \| string`	`externalEuint64`
`Encryptable.uint128(value)`	`bigint \| string`	`externalEuint128`
`Encryptable.address(value)`	`bigint \| string`	`externalEaddress`
`Encryptable.create(type, value)`	varies	varies

Enum of supported FHE types used with decryptForView.

execute() returns one ciphertext handle per input, in order, followed by a single signature covering the whole batch:

type EncryptInputsResult = readonly `0x${string}`[];
// [ ...hashes, signature ]  -> inputs.length + 1 elements

The per-item EncryptedItemInput struct and its typed variants were removed in 0.7, along with asHashPlusProof().

Enum values fired during the encryption pipeline: