Back to Fhevm

Overview

sdk/js-sdk/docs/README.md

0.13.0-01.8 KB
Original Source

Overview

Welcome to the FHEVM SDK Guides!

This section covers @fhevm/sdk — the JavaScript/TypeScript SDK for building applications on FHEVM chains. With the SDK, your app encrypts values in the browser, sends encrypted handles to your smart contract, and decrypts results — all without the user needing to interact directly with the underlying Zama Protocol.

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 Getting started to install the SDK and run your first encryption and decryption.

🟨 Clone the FHEVM React template for a ready-made Next.js project with wallet connection, encryption, and decryption already wired up.

🟨 Go to Encryption to learn how to encrypt values for your smart contracts.

🟨 Go to Decryption to read public values, decrypt private data with permits, and decrypt on behalf of other users.

🟨 Go to Clients to understand the different client types and when to use each.

🟨 Go to Migration guide if you're upgrading from @zama-fhe/relayer-sdk.

🟨 Go to Solidity Guides for the contract side — encrypted types, ACL, FHE.allow(), and decryption flows.

For complete working dApps, see the FHEVM dApps repository.

Help center

Ask technical questions and discuss with the community.