Skip to content

Latest commit

 

History

History
145 lines (111 loc) · 15.2 KB

README.md

File metadata and controls

145 lines (111 loc) · 15.2 KB

Aleo SDK

Website

Zero Knowledge Web App SDK

The Aleo SDK provides tools for building zero knowledge applications. It consists of several TypeScript & JavaScript libraries which provide the following functionality:

  1. Aleo account management
  2. Web-based program execution and deployment
  3. Aleo credit transfers
  4. Management of program state and data
  5. Communication with the Aleo network

All of this functionality is demonstrated on Aleo.tools.

The Aleo SDK is divided into three Typescript/Javascript packages

1. Aleo SDK - Build Zero Knowledge Web Apps

Aleo SDK

The official Aleo SDK providing Javascript/Typescript tools for creating zero knowledge app.

⚡ Build your own app

Start here with the Aleo SDK Readme to get started building your first zero knowledge web app.

Source: sdk/sdk

2. Create-Aleo-App - Zero Knowledge Web App Examples

Create Aleo App

Create-aleo-app provides zero-knowledge web app examples in common web frameworks such as React. Developers looking to start with working examples should start here.

⚡ Build your own app

You can start with a template by running

npm create aleo-app@latest

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

Create Aleo App Create Aleo App Aleo-Wasm

Aleo Wasm is a Rust crate which compiles Aleo 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 NodeJS. 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: sdk/wasm

📚 Documentation

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 page.

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.

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):

Mike Turner
Mike Turner

💻 🚧 💬 👀
Brent C
Brent C

💻 🚧 💬 👀
Collin Chin
Collin Chin

💻 🚧 💬 👀
Howard Wu
Howard Wu

💻 🤔 🔬 👀
Raymond Chu
Raymond Chu

💻 🤔 🔬 👀
d0cd
d0cd

💻 🤔 🔬 👀
Alessandro Coglio
Alessandro Coglio

📖 🔬 👀
a h
a h

💻 📖
Anthony DiPrinzio
Anthony DiPrinzio

💻
Ali Mousa
Ali Mousa

💻
Ivan Litteri
Ivan Litteri

💻
Nacho Avecilla
Nacho Avecilla

💻
ljedrz
ljedrz

💻
Facundo Olano
Facundo Olano

💻
Nicolas Continanza
Nicolas Continanza

💻
Mike
Mike

💻
Javier Rodríguez Chatruc
Javier Rodríguez Chatruc

💻
Pablo Deymonnaz
Pablo Deymonnaz

💻
Bob Niu
Bob Niu

💻
sptg
sptg

💻
Hamza Khchichine
Hamza Khchichine

💻
Kendrick
Kendrick

💻
Dependabot
Dependabot

💻
All Contributors
All Contributors

📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!