React reference

Welcome to the React reference!

API reference for the @zama-fhe/react-sdk package. Each page documents a single hook or component with parameters, return values, and working code examples. All hooks are built on TanStack Query with automatic cache invalidation and cached decryption.

Where to go next

🟨 Go to ZamaProvider for the required context provider that wires up the relayer, signer, and storage.

🟨 Go to useConfidentialBalance to decrypt and display a single token's balance.

🟨 Go to useShield to convert public ERC-20 tokens into confidential form.

🟨 Go to useConfidentialTransfer to send encrypted amounts on-chain.

🟨 Go to useUnshield to withdraw confidential tokens back to public ERC-20.

🟨 Go to Query keys for manual cache invalidation and custom query composition.

Help center

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

• Community forum

• Discord channel

• Open an issue on the SDK repository