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`, `assertCorrectEncryptedItemInput`
`@cofhe/sdk/web`	`createCofheConfig`, `createCofheClient` (browser defaults)
`@cofhe/sdk/node`	`createCofheConfig`, `createCofheClient` (Node.js defaults)
`@cofhe/sdk/permits`	`PermitUtils`, `setPermit`, `setActivePermitHash`, `getPermit`, `getActivePermitHash`
`@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`	`InEbool`
`Encryptable.uint8(value)`	`bigint \| string`	`InEuint8`
`Encryptable.uint16(value)`	`bigint \| string`	`InEuint16`
`Encryptable.uint32(value)`	`bigint \| string`	`InEuint32`
`Encryptable.uint64(value)`	`bigint \| string`	`InEuint64`
`Encryptable.uint128(value)`	`bigint \| string`	`InEuint128`
`Encryptable.address(value)`	`bigint \| string`	`InEaddress`
`Encryptable.create(type, value)`	varies	varies

Enum of supported FHE types used with decryptForView.

type EncryptedItemInput = {
  ctHash: bigint;
  securityZone: number;
  utype: FheTypes;
  signature: string;
};

Enum values fired during the encryption pipeline: