Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ProvableHQ/sdk

A Software Development Kit (SDK) for Zero-Knowledge Transactions
https://github.com/ProvableHQ/sdk

aleo blockchain sdk zero-knowledge zksnarks

Last synced: about 2 months ago
JSON representation

A Software Development Kit (SDK) for Zero-Knowledge Transactions

Host: GitHub
URL: https://github.com/ProvableHQ/sdk
Owner: ProvableHQ
License: gpl-3.0
Created: 2021-01-02T20:49:45.000Z (almost 4 years ago)
Default Branch: testnet3
Last Pushed: 2024-09-10T23:17:15.000Z (about 2 months ago)
Last Synced: 2024-09-12T18:04:44.422Z (about 2 months ago)
Topics: aleo, blockchain, sdk, zero-knowledge, zksnarks
Language: JavaScript
Homepage: https://provable.tools
Size: 182 MB
Stars: 584
Watchers: 55
Forks: 468
Open Issues: 86
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

best-of-crypto - GitHub - 34% open · ⏱️ 15.05.2024): (Others)

README

# Zero-Knowledge Web App SDK

The [Aleo SDK](https://github.com/ProvableHQ/sdk) provides tools for building zero-knowledge applications. It consists of
several TypeScript & JavaScript libraries which provide the following functionality:
1. [Aleo account management](https://provable.tools/account)
2. [Web-based program execution and deployment](https://provable.tools/develop)
3. [Aleo credit transfers](https://provable.tools/transfer)
4. [Management of program state and data](https://provable.tools/record)
5. [Communication with the Aleo network](https://provable.tools/rest)

All of this functionality is demonstrated on [Provable.tools](https://provable.tools).

The Aleo SDK is divided into three TypeScript/JavaScript packages:

## 1. Aleo SDK - Build Zero-Knowledge Web Apps

The official Aleo SDK providing JavaScript/TypeScript tools for creating zero-knowledge applications.

### ⚡ Build your own app

Start here with the [Aleo SDK Readme](https://github.com/ProvableHQ/sdk#readme) to get started building your
first zero-knowledge web app.

#### Source: [`Aleo SDK`](https://www.npmjs.com/package/@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: [`sdk/create-leo-app`](https://github.com/ProvableHQ/sdk/tree/testnet3/create-leo-app)

## 3. Aleo Wasm - Zero-Knowledge Algorithms in JavaScript + WebAssembly

Aleo Wasm is a Rust crate which 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.

❗ Currently, program execution is only available in web browsers. However, account, program, and data management within
NodeJS is functional.

Source: [Aleo Wasm](https://www.npmjs.com/package/@provablehq/wasm)

## 📚 Documentation

#### [API Documentation](https://developer.aleo.org/sdk/typescript/overview)
API Documentation, tutorials for the Aleo SDK, and documentation on how to build Leo and Aleo Instructions programs can
be found on the [Aleo Developer Docs](https://developer.aleo.org/sdk/typescript/overview) page.

#### [SDK Readme](https://github.com/ProvableHQ/sdk/tree/testnet3/sdk#readme)
The SDK readme provides concepts core to executing zero-knowledge programs in the web and several detailed examples of
how to use the SDK to build web apps using Aleo.

#### [Aleo Wasm Readme](https://github.com/ProvableHQ/sdk/tree/testnet3/wasm#readme)
The Aleo Wasm readme provides instructions for compiling the Aleo Wasm crate and using it in web projects. Those who
want to build from source or create their own WebAssembly bindings should start here.

## ❤️ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Mike Turner}
💻 🚧 💬 👀

_{Brent C}
💻 🚧 💬 👀

_{Collin Chin}
💻 🚧 💬 👀

_{Howard Wu}
💻 🤔 🔬 👀

_{Raymond Chu}
💻 🤔 🔬 👀

_d0cd
💻 🤔 🔬 👀

_{Alessandro Coglio}
📖 🔬 👀

_{a h}
💻 📖

_{Anthony DiPrinzio}
💻

_{Ali Mousa}
💻

_{Ivan Litteri}
💻

_{Nacho Avecilla}
💻

_ljedrz
💻

_{Facundo Olano}
💻

_{Nicolas Continanza}
💻

_Mike
💻

_{Javier Rodríguez Chatruc}
💻

_{Pablo Deymonnaz}
💻

_{Bob Niu}
💻

_sptg
💻

_{Hamza Khchichine}
💻

_Kendrick
💻

_Dependabot
💻

_{All Contributors}
📖

Add your contributions