@provablehq/sdk
v0.12.1
Published
A Software Development Kit (SDK) for Zero-Knowledge Transactions
Readme
Provable SDK
The Provable SDK provides low level tools for building zero-knowledge applications on the Aleo blockchain. It re-exports core protocol objects from SnarkVM via wasm with TypeScript & JavaScript bindings so developers who need low level control can build wallets, servers, and CLI tools entirely in JS/TS.
Veil
Builders looking for more developer friendly tooling for building on Aleo should choose Veil. Veil provides a Viem like interface that has familiar concepts from Viem such as wallet/public clients, actions, transport configurations, and client/action composability.
It can be used to build both browser and mobile dapps as well as server-side applications, scripts, and AI agents.
| Package | Purpose | Documentation | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | 🧩 veil-core | Viem-like clients, actions, transports, and types for building Aleo applications | README | | 🤖 veil-aleo-sdk | Adapter for the Provable SDK for building server side apps, scripts, wallets, and AI agents | README | | 🌐 veil-aleo-wallet-adapter | Build Aleo browser and mobile dapps using a viem-like interface | README | | 💸 aleo-bridge-sdk | Bridge assets into and out of Aleo. | README | | 🦁 veil-leo | Build and deploy Leo programs from JavaScript/TypeScript. | README | | 🧪 veil-aleo-devnode | Local nodes, block mining, and snapshots for Foundry-like test harnesses. | README |
Applications
Applications built with the Provable SDK include:
- Private DeFi
- Private Data Custody Systems
- Zk Games & Gaming Toolkits
- ZkML
- Zero-Knowledge Identity Management
- Aleo Wallets
Features
The Provable SDK provides the following features. Follow the links below for live demonstrations of these features on provable.tools
- Aleo account management
- Aleo cryptographic primitives
- Zero-knowledge program execution and deployment
- Aleo credit transfers and staking
- Management of program state
- Communication with the Aleo network
Start Building
Use the following resources to build with the SDK's protocol utilities.
The SDK Guide
A step-by-step guide to creating Aleo accounts, transferring and receiving Aleo credits, executing and deploying Aleo programs, and managing private and public state with the Provable SDK.
Create-Leo-App
Runnable SDK examples and templates for Node.js and frameworks such as React and Next.js. Install and run them with
the create-leo-app command line tool. Examples include private NFTs and offline transaction signing.
SDK API Documentation
For developers who prefer to dive straight into the code, the SDK API documentation provides a comprehensive reference for all the SDK's classes, methods, and interfaces. The documentation is generated from the SDK's TypeScript source code.
Leo Language Documentation
Leo is an imperative language for writing zero-knowledge programs on Aleo. Use the SDK to deploy and execute programs written in Leo.
