Skip to main content

API Reference Overview

Complete API reference for the FHEVM SDK.

Module Structure​

@fhevm/sdk
├── config/          # Configuration utilities
├── hooks/           # React hooks
├── core/            # Core encryption/decryption
├── storage/         # Storage adapters
├── types/           # TypeScript types
└── utils/           # Utility functions

Main Exports​

Configuration​

import {
  createConfig,
  FhevmProvider,
  useFhevmContext,
  useSyncWithWallet,
} from '@fhevm/sdk';

Hooks​

import {
  useContract,
  useReadContract,
  useWriteContract,
  useDecryptedValue,
  useTokenBalance,
  useTokenTransfer,
  useOperator,
  useBatchTransactions,
} from '@fhevm/sdk';

Core Functions​

import {
  createFhevmInstance,
  FhevmDecryptionSignature,
} from '@fhevm/sdk';

Storage​

import {
  GenericStringStorage,
  GenericStringInMemoryStorage,
} from '@fhevm/sdk';

Types​

import type {
  FhevmConfig,
  FhevmChainConfig,
  ContractConfig,
  FhevmInstance,
  FhevmDecryptionSignatureType,
  DecryptedResults,
} from '@fhevm/sdk';

Quick Reference​

CategoryItemsDocumentation
ConfigurationcreateConfig, FhevmProviderConfiguration API
HooksuseContract, useReadContract, useWriteContract, etc.Hooks API
TypesFhevmConfig, FhevmInstance, etc.Types API
StorageGenericStringStorageStorage API
ClientcreateFheClientClient API

TypeScript Support​

The SDK is fully typed with TypeScript:

import type { Abi } from 'abitype';
import { useReadContract } from '@fhevm/sdk';

type MyAbi = [...] as const;

const { data } = useReadContract<MyAbi>({
  abi: myAbi,
  functionName: 'getData', // Autocomplete works!
});

Next Steps​