github.com/ProvableHQ/sdk @v0.11.3
Chat with this repoWhat it actually does AI analysis from the code graph — generated when you open this
README
<a href="https://docs.leo-lang.org"> <img alt="Website" src="https://img.shields.io/badge/Developer_Docs-online-blue"></a>
<a href="https://discord.com/invite/aleo"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a>
<a href="https://github.com/ProvableHQ/sdk#%EF%B8%8F-contributors"><img src="https://img.shields.io/badge/contributors-23-ee8449"/></a>
Zero-Knowledge Web App SDK
The Provable SDK provides tools for building zero-knowledge applications on the Aleo blockchain. It re-exports core protocol objects from SnarkVM as TypeScript & JavaScript libraries so developers can build Aleo dApps, wallets, servers, and CLI tools entirely in JS/TS.
All of this functionality is demonstrated on Provable.tools.
Table of Contents
📦 Packages — Provable SDK · Create-Leo-App · Aleo Wasm
⚙️ Features — Roadmap · Core · Aleo RPC · AI Agents · Networks · Runtimes
📚 Documentation — API reference, SDK guide, and tutorials
❤️ Contributors
Packages
The Provable SDK is divided into three TypeScript/JavaScript packages:
1. Provable SDK - Build Zero-Knowledge Web Apps
The official Provable SDK providing JavaScript/TypeScript tools for creating zero-knowledge applications.
⚡ Build your own app
Start here with the Provable SDK Readme to get started building your first zero-knowledge web app.
Source: @provablehq/sdk
2. Create-Leo-App - Zero-Knowledge Web App Examples
Create-Leo-App provides zero-knowledge web app examples in common web frameworks such as React. Developers looking to start with working examples should start here.
Source: create-leo-app
3. Aleo Wasm - Zero-Knowledge Algorithms in JavaScript + WebAssembly
Aleo Wasm is a Rust crate that compiles the Aleo source code responsible for creating and executing zero-knowledge programs into WebAssembly.
When compiled with wasm-pack, JavaScript bindings are generated for the WebAssembly, allowing Aleo zero-knowledge programs to be used in the browser and Node.js. This package is available on NPM (linked above). The Aleo Wasm
readme provides instructions for compiling this crate and using it in web projects for those interested in building from
source.
Source: @provablehq/wasm
Features
Roadmap
The SDK feature roadmap can be found in the repo milestones below.
Milestones
Core Features
| 🔑 Account Management | Create, import, and encrypt/decrypt Aleo accounts. Full key derivation chain (PrivateKey, ViewKey, ComputeKey, Address, GraphKey). Password-based private key encryption with key material zeroization for secure memory handling. |
| ⚡ Program Execution | Execute arbitrary Aleo programs locally or on-chain. Build and submit execution transactions with zero-knowledge proofs. Offline execution for testing. Dynamic dispatch support. |
| 🚀 Program Deployment | Deploy and upgrade Aleo programs to the network. Fee estimation, devnode deployments, and recursive import resolution. |
| 🔍 Program Inspection | Parse Aleo programs and introspect their structure: list functions, read function input/output types, enumerate mappings with key/value types, inspect record definitions and struct members, and resolve program imports. |
| 📋 Aleo Record Management | Full lifecycle management for Aleo records. Decrypt individual or bulk records in parallel. Read record data fields and check ownership. Discover unspent records via serial number and tag verification. Convert between static and dynamic (Merkle-root) record representations. Generate and share record view keys for selective disclosure. |
| 💸 Credit Transfers | Private, public, private-to-public, and public-to-private Aleo credit transfers. Record join and split operations. |
| 🏛️ Validator Operations | Bond/unbond validators, claim unbonded credits, and set validator state. |
| 🌐 Network Client | Full REST API client for the Aleo network: query blocks, transactions, programs, mappings, mempool, committee state, state roots, and public balances. Submit transactions and poll for confirmation. |
| 🧮 Cryptographic Primitives | Field, Group, and Scalar types. Hash functions: BHP256/512/768/1024, Pedersen64/128, Poseidon2/4/8. Digital signatures over raw bytes and typed Aleo values. These primitives enable custom cryptographic schemes for Aleo dApps, wallets that support Aleo, and servers and CLI applications that interact with the Aleo network. |
| ✅ Proof Verification | Single and batch zk-SNARK proof verification. Verify function execution proofs offline. |
| ✍️ Authorization & External Signing | Build execution and fee authorizations offline for hardware wallets, multi-signature schemes, and custom signing flows. Construct execution requests from externally signed data with multiple input-ID resolution strategies (explicit record view keys, view key derivation, pre-computed input IDs). |
| 🗝️ Proving Key Management | Synthesize, cache, fetch, and verify proving/verifying keys. In-memory and file-based keystores. SHA-256 fingerprint verification for key integrity. Offline key provider for air-gapped environments. |
| 🛡️ Security | Private key material zeroization on drop (Zeroize trait in Rust, Symbol.dispose in TS). libsodium crypto_box_seal encryption for delegated proving and record scanner payloads. Encrypted private key storage with password-based symmetric encryption. |
Aleo RPC Features
| ☁️ Delegated Proving Service | Offload expensive proof generation to a remote proving service. Proving requests and authorizations are encrypted with the service's X25519 public key via libsodium. Supports API key and JWT authentication. |
| 📡 Record Scanner Service | Privacy-preserving record discovery. Register an encrypted view key with the scanner service, then query for owned records without exposing the view key to the network. Supports revocation, status checking, serial number verification, and filtered queries. |
| ⚖️ Sealance Integration | Merkle tree construction and proof generation for compliance and KYC exclusion proofs using the Sealance compliant stablecoin standard. |
AI Agent Support
The Provable SDK is designed to be used by AI coding agents out of the box. The repository ships with built-in agent skills (.agents/skills/), project context (.claude/), and SDK documentation (docs/) — including a step-by-step guide, API reference, and runnable examples. Together these give AI assistants the context they need to build Aleo dApps, contribute to the SDK, and generate correct code against the Rust/WASM/TypeScript stack — no manual prompting required. Compatible with any agent framework that supports skill files, including Claude Code, GitHub Copilot, and Cursor.
Networks Supported
 |
Production Aleo mainnet. |
 |
Aleo testnet for development and testing. |
JavaScript Runtimes & Frameworks
Full browser support with single-threaded and multi-threaded (web worker) modes — multi-threaded uses Rust-native threading via rayon for significant performance improvements during proof generation. First-class Node.js support for server-side Aleo applications, CLI tools, and backend services. Compatible with Next.js, Bun, and Deno.
📚 Documentation
| Resource | Description |
|---|---|
| Aleo RPC / Provable API | Documentation on interacting with the Aleo network via Provable's API & RPC endpoints. |
| SDK Guide | Core concepts for executing zero-knowledge programs on the web, with detailed examples of how to build apps using Aleo. |
❤️ Contributors
Thanks goes to these wonderful people (emoji key):
Mike Turner
💻 🚧 💬 👀 |
Brent C
💻 🚧 💬 👀 |
Collin Chin
💻 🚧 💬 👀 |
Howard Wu
💻 🤔 🔬 |