https://github.com/zama-ai/sdk
TypeScript SDK for confidential FHE smart contracts on Zama Protocol
https://github.com/zama-ai/sdk
blockchain fully-homomorphic-encryption privacy sdk
Last synced: 2 months ago
JSON representation
TypeScript SDK for confidential FHE smart contracts on Zama Protocol
- Host: GitHub
- URL: https://github.com/zama-ai/sdk
- Owner: zama-ai
- License: bsd-3-clause
- Created: 2026-02-20T11:52:56.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-03T21:08:40.000Z (3 months ago)
- Last Synced: 2026-04-04T04:52:42.284Z (3 months ago)
- Topics: blockchain, fully-homomorphic-encryption, privacy, sdk
- Language: TypeScript
- Homepage:
- Size: 4.71 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-zama - sdk
README
📒 Documentation | 💛 Community support | 📚 FHE resources by Zama
## About
### What is Zama SDK?
**Zama SDK** is a suite of TypeScript libraries for building privacy-preserving dApps on EVM-compatible blockchains powered by the _Zama Confidential Blockchain Protocol_. It provides everything you need to interact with confidential smart contracts using [Fully Homomorphic Encryption (FHE)](https://docs.zama.org/protocol/protocol/overview) — from encrypting inputs and decrypting results to managing access control — all from familiar TypeScript and React environments.
Zama SDK is designed for developers who want to integrate confidential operations into their applications without learning cryptography:
- **End-to-end encryption:** Transaction data and on-chain state remain encrypted at all times.
- **Framework-agnostic core:** Works with viem, ethers, or any EVM library.
- **React-ready:** First-class React hooks powered by `@tanstack/react-query`.
### Table of contents
- [About](#about)
- [What is Zama SDK?](#what-is-zama-sdk)
- [Table of contents](#table-of-contents)
- [Packages](#packages)
- [Main features](#main-features)
- [Working with Zama SDK](#working-with-zama-sdk)
- [Install](#install)
- [Development](#development)
- [Claude Code Setup](#claude-code-setup)
- [Contributing](#contributing)
- [License](#license)
- [Resources](#resources)
- [Support](#support)
### Packages
| Package | Description |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| [`@zama-fhe/sdk`](./packages/sdk/) | Core SDK — confidential contract operations, FHE relayer, contract call builders, viem/ethers adapters, Web Worker support |
| [`@zama-fhe/react-sdk`](./packages/react-sdk/) | React hooks wrapping the core SDK via `@tanstack/react-query`, with wagmi sub-path |
### Main features
- **TypeScript-first:** Fully typed APIs with tree-shakeable ESM builds for minimal bundle size.
- **Privacy by design:** Encrypt inputs, decrypt outputs, and manage access control for confidential smart contracts.
- **Multi-library support:** Adapters for both viem and ethers, so you can use whichever EVM library your project already depends on.
- **React hooks:** Dedicated React package with hooks for encrypting, decrypting, reencrypting, and querying confidential state — all backed by `@tanstack/react-query` for caching and suspense.
- **Workers:** Offload heavy FHE operations to workers in Web and Node.js environments for non-blocking performance.
- **Wagmi integration:** Drop-in wagmi connector support for seamless wallet and provider management in React apps.
## Working with Zama SDK
### Install
```bash
# Core SDK (vanilla TypeScript)
pnpm add @zama-fhe/sdk
# or: npm install @zama-fhe/sdk / yarn add @zama-fhe/sdk
# React hooks
pnpm add @zama-fhe/react-sdk @tanstack/react-query
# or: npm install @zama-fhe/react-sdk @tanstack/react-query / yarn add @zama-fhe/react-sdk @tanstack/react-query
```
### Development
**Prerequisites:** Node.js >= 22, pnpm >= 10
```bash
pnpm install # Install dependencies
pnpm build # Build all (sdk first, then react-sdk)
pnpm test # Watch mode
pnpm test:run # Single run
pnpm typecheck # Type checking
pnpm lint # Linting
pnpm format:check # Formatting check
```
**E2E tests:**
```bash
pnpm e2e:test # Run Playwright E2E tests
pnpm e2e:test:ui # Playwright UI mode
```
> **Note:** The `forge-fhevm` submodule and its soldeer dependencies are installed automatically by `pnpm install`.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full contributor guide (branching, PRs, code style, architecture).
### Claude Code Setup
This repository includes an opt-in [Claude Code](https://docs.anthropic.com/en/docs/claude-code) configuration in `claude-setup/settings.json`. It provides:
- **Auto-allowed commands** — `pnpm build`, `pnpm test`, `pnpm lint`, `pnpm typecheck`, `pnpm format`, and git diff variants run without prompting.
- **Denied reads** — `.env` files and `.next/` are blocked to prevent accidental secret exposure.
- **Ask-before-running** — destructive commands (`rm`), remote pushes (`git push`), and release commands require explicit approval.
- **Post-edit hooks** — every file write/edit automatically triggers `pnpm typecheck`, `pnpm lint`, and `pnpm format`.
- **Custom skills** — custom skills required for good development practices to contribute to this repo.
To use it, install [Claude Code](https://docs.anthropic.com/en/docs/claude-code) and run `pnpm setup:claude`.
### Contributing
There are two ways to contribute to Zama SDK:
- [Open issues](https://github.com/zama-ai/sdk/issues/new/choose) to report bugs and typos, or to suggest new ideas
- Request to become an official contributor by emailing hello@zama.ai.
Becoming an approved contributor involves signing our Contributor License Agreement (CLA). Only approved contributors can send pull requests, so please make sure to get in touch before you do!
### License
This software is distributed under the **BSD-3-Clause-Clear** license. Read [this](LICENSE) for more details.
## Resources
- [Documentation](https://docs.zama.org/protocol) — Official documentation of the Zama Confidential Blockchain Protocol.
- [Awesome Zama – FHEVM](https://github.com/zama-ai/awesome-zama?tab=readme-ov-file#fhevm) — Curated articles, talks, and ecosystem projects.
## Support
🌟 If you find this project helpful or interesting, please consider giving it a star on GitHub! Your support helps to grow the community and motivates further development.