Overview

TypeScript SDK for confidential smart contracts — shield, transfer, and unshield tokens with Fully Homomorphic Encryption.

Welcome to the Zama SDK!

Looking for the legacy Relayer SDK?

This is the new default SDK for building on the Zama Protocol. The legacy @zama-fhe/relayer-sdk lives at github.com/zama-ai/relayer-sdk.

Where to go next

If you're new to the Zama Protocol, start with the Litepaper or the Protocol Overview to understand the foundations.

Otherwise:

🟨 Go to Quick start to get from zero to a working confidential transfer in under 5 minutes.

🟨 Go to Build your first confidential dApp for an end-to-end React tutorial.

🟨 Go to Configuration for step-by-step instructions on shielding, transfers, balances, and more.

🟨 Go to SDK reference for the full core SDK API.

🟨 Go to React reference for all React hooks and components.

Features

Shield & unshield

Convert public ERC-20 tokens into encrypted form and back. The SDK handles approvals, encryption, and the two-step unshield flow.

Confidential transfers

Encrypt amounts client-side before submitting on-chain. On-chain observers see the transaction but never the value.

React hooks

TanStack Query-based hooks with cached decryption, automatic cache invalidation, and one-signature permit management.

Two packages, one import

Package	Use when...
@zama-fhe/sdk	You are building with vanilla TypeScript, Node.js, or any non-React framework
@zama-fhe/react-sdk	You are building a React app (hooks and React-specific providers)

If you are using React, install both packages: @zama-fhe/react-sdk provides the hooks and ZamaProvider, while @zama-fhe/sdk is a peer dependency that provides core utilities, relayer factories, chain presets, and error helpers. For wagmi apps, build the config with createConfig from @zama-fhe/react-sdk/wagmi and pass it to <ZamaProvider config={zamaConfig}>. For non-React apps, use createConfig from @zama-fhe/sdk/viem or @zama-fhe/sdk/ethers.

Install

pnpm

# React app
pnpm add @zama-fhe/react-sdk @zama-fhe/sdk @tanstack/react-query

# Vanilla TypeScript / Node.js
pnpm add @zama-fhe/sdk

npm

# React app
npm install @zama-fhe/react-sdk @zama-fhe/sdk @tanstack/react-query

# Vanilla TypeScript / Node.js
npm install @zama-fhe/sdk

yarn

# React app
yarn add @zama-fhe/react-sdk @zama-fhe/sdk @tanstack/react-query

# Vanilla TypeScript / Node.js
yarn add @zama-fhe/sdk

Your first confidential transfer in 30 seconds

import { createPublicClient, createWalletClient, custom, http } from "viem";
import { sepolia } from "viem/chains";
import { createConfig } from "@zama-fhe/sdk/viem";
import { ZamaSDK } from "@zama-fhe/sdk";
import { web } from "@zama-fhe/sdk/web";
import { sepolia as sepoliaFhe, type FheChain } from "@zama-fhe/sdk/chains";

const publicClient = createPublicClient({ chain: sepolia, transport: http() });
const walletClient = createWalletClient({ chain: sepolia, transport: custom(window.ethereum!) });

const mySepolia = {
  ...sepoliaFhe,
  relayerUrl: "https://your-app.com/api/relayer/11155111",
} as const satisfies FheChain;

const config = createConfig({
  chains: [mySepolia],
  publicClient,
  walletClient,
  relayers: { [mySepolia.id]: web() },
});

const sdk = new ZamaSDK(config);
const wrappedToken = sdk.createWrappedToken("0xYourWrappedToken");

await wrappedToken.shield(1000n); // deposit public tokens
const [address] = await walletClient.getAddresses();
const balance = await wrappedToken.balanceOf(address); // decrypt your balance
await wrappedToken.confidentialTransfer("0xRecipient", 500n); // private send
await wrappedToken.unshield(500n); // withdraw back to public

Ready to build? Jump to the Quick start for a full working example with your stack.

Help center

Ask technical questions, discuss with the community, or report a bug.

• Community forum

• Discord channel

• Open an issue on the SDK repository