ghostant-1017 / sdk

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

Aleo SDK

The Aleo SDK is a developer framework to make it simple to create a new account, craft a transaction, and broadcast it to the network.

Table of Contents

• 🍎 Overview
• 🏗️ Build Guide
  • 🦀 Install Rust
  • 🐙 Build from Source Code
• ❤️ Contributors

🍎 Overview

The Aleo github repository is the home of

1. sdk/ - The Aleo SDK in Rust https://crates.io/crates/aleo
2. sdk/sdk - The Aleo SDK in Javascript https://www.npmjs.com/package/@aleohq/sdk
3. sdk/wasm - The Aleo Wasm library in Rust https://crates.io/crates/aleo-wasm
4. sdk/wasm/pkg - The Aleo Wasm library in JavaScript https://www.npmjs.com/package/@aleohq/wasm

We recommend developers to use the interfaces provided by the Aleo SDKs (1. and 2.) for their respective languages.

For more information on Aleo, visit Welcome to Aleo to get started.

🏗️ Build Guide

🦀 Install Rust

We recommend installing Rust using rustup. You can install rustup as follows:

• macOS or Linux:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Windows (64-bit):

  Download the Windows 64-bit executable or Windows 32-bit executable and follow the on-screen instructions.

🐙 Build from Source Code

We recommend installing aleo this way. In your terminal, run:

# Download the source code
git clone https://github.com/AleoHQ/sdk.git

# Enter the 'sdk' directory
cd sdk

# Install 'aleo'
cargo install --path .

Now to use aleo, in your terminal, run:

aleo

❤️ Contributors

Thanks goes to these wonderful people (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 💻
Dependabot 💻	All Contributors 📖
Add your contributions

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