The official Provable SDK providing low-level Aleo protocol utilities and JavaScript/TypeScript helpers.
#### โก Get started
Start with the [Provable SDK README](sdk/README.md) for usage and documentation.
Source: [`@provablehq/sdk`](https://www.npmjs.com/package/@provablehq/sdk)
### 2. Create-Leo-App - Zero-Knowledge Application Examples
Create-Leo-App provides runnable SDK examples for Node.js and frameworks such as React.
Source: [`create-leo-app`](https://github.com/ProvableHQ/sdk/tree/mainnet/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 JavaScript projects for those interested in building from
source.
Source: [`@provablehq/wasm`](https://www.npmjs.com/package/@provablehq/wasm)
---
# Features
## Roadmap
The SDK feature roadmap can be found in the repo milestones below.
### [Milestones](https://github.com/ProvableHQ/sdk/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 applications, 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. |
| โ๏ธ 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. |
 |
Production Aleo mainnet. |
 |
Aleo testnet for development and testing. |
