v1 — Developer Preview
The current version of the Encrypted Balances SDK. Fully functional but APIs may evolve in v2.
Guide
Step-by-step tutorials for building with Encrypted Balances.
| Page | Description |
|---|---|
| What is ZK Privacy EB? | Overview, three privacy layers, key concepts |
| Installation | npm registry setup, packages, CDN assets, React Native |
| Quick Start | First transaction in 5 minutes |
| Shield & Unshield | Entry/exit between public and encrypted balances |
| Private Transfers | Hidden-amount transfers with ZK proofs |
| Stealth Addresses | Unlinkable receive addresses |
| Relayer | Gasless transactions, authorization model |
| Atomic Swaps | Cross-token private exchange |
| Compliance | UKRC threshold decryption, blacklist, freeze |
API Reference
| Page | Description |
|---|---|
| Setup & Configuration | createClient, EBClient, key derivation, contract addresses |
| Wallet API | Balances, shield, transfer, unshield, registration, history |
| L3 Staking | Stake, unstake, transfer from stealth |
| Stealth Addresses | Create, list, balances, auto-stake watcher, recovery |
| Swap API | SwapClient — offers, rates, atomic swap execution |
| Contracts | ABIs, deployment addresses, events |
| Types | All TypeScript interfaces and type definitions |
| Low-Level Exports | Grumpkin curve, ElGamal, DLog solver, L3 crypto |