@provablehq/sdk v0.9.1

Provable SDK for Building Zero-Knowledge Web Apps

The Provable SDK is an open source TypeScript/JavaScript SDK for building private full stack web applications. The SDK provides an easy API for using Aleo's core suite of cryptographic primitives, zk-SNARKs and private program execution protocol directly within Javascript. It also provides APIs for interacting with nodes and applications on the Aleo Network.

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 1. Aleo account management 2. Aleo cryptographic primitives 3. Web based zero-knowledge program execution and deployment 4. Aleo credit transfers and staking 5. Management of program state 6. Communication with the Aleo network

Start Building

Developers interested in using the SDK to build private web applications can get started with the following resources.

The SDK Guide

A step-by-step guide to building private web applications with the Provable SDK. The guide covers creating Aleo accounts, transferring and receiving aleo credits, executing/deploying/interacting with Aleo programs, managing private and public state, and best practices for building private web applications.

Create-Leo-App

A suite of examples and templates for building private web applications in a variety of Javascript frameworks. These examples can be easily installed and run using the create-leo-app command line tool. The examples cover a wide range of use cases such as Private NFTs, offline transaction signing, and usage of the SDK in React, Next, and VanillaJS.

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

For developers who want to build their own zero-knowledge programs, the Leo Language provides an easy-to-use imperative programming language for writing zero-knowledge programs on Aleo. In conjuction with the SDK, private programs built using Leo can be turned into fully functional private web applications.