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 Guides 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 session 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 (includes everything from the core SDK)

If you are using React, @zama-fhe/react-sdk re-exports most of the core SDK (hooks, providers, RelayerWeb, storage singletons). You still import signer adapters from their sub-paths (e.g. @zama-fhe/sdk/viem, @zama-fhe/sdk/ethers).

Install

pnpm

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

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

npm

yarn

Your first confidential transfer in 30 seconds

import { ZamaSDK, RelayerWeb, indexedDBStorage } from "@zama-fhe/sdk";
import { ViemSigner } from "@zama-fhe/sdk/viem";

const sdk = new ZamaSDK({
  relayer: new RelayerWeb({
    getChainId: () => signer.getChainId(),
    transports: {
      [1]: {
        relayerUrl: "https://your-app.com/api/relayer/1",
        network: "https://mainnet.infura.io/v3/YOUR_KEY",
      },
      [11155111]: {
        relayerUrl: "https://your-app.com/api/relayer/11155111",
        network: "https://sepolia.infura.io/v3/YOUR_KEY",
      },
    },
  }),
  signer: new ViemSigner({ walletClient, publicClient }),
  storage: indexedDBStorage,
});

const token = sdk.createToken("0xYourEncryptedERC20");

await token.shield(1000n); // deposit public tokens
const balance = await token.balanceOf(); // decrypt your balance
await token.confidentialTransfer("0xRecipient", 500n); // private send
await token.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 and discuss with the community.

• Community forum

• Discord channel