ErkanDERELI / aleo

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

• 1. Overview
• 2. Build Guide
• 3. Usage Guide

1. Overview

** ATTENTION: This codebase is in active development. **

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

2. Build Guide

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

2.2a Build from Crates.io

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

cargo install aleo

Now to use aleo, in your terminal, run:

aleo

2.2b Build from Source Code

Alternatively, you can install aleo by building from the source code as follows:

# Download the source code
git clone https://github.com/AleoHQ/aleo && cd aleo

# Install Aleo
$ cargo install --path .

Now to use aleo, in your terminal, run:

aleo

3. Usage Guide

3.1 Generate a new Aleo account.

To generate a new Aleo account, run:

aleo account new [FLAGS] [OPTIONS]

The command can be run with the following optional parameters:

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -s, --seed <seed> 

3.2 Generate a new Aleo transaction.

To generate a new Aleo transaction, run:

aleo tx new [FLAGS] [OPTIONS]

The command can be run with the following optional parameters:

FLAGS:
    -d, --dummy      Craft a dummy transaction
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -s, --seed <seed> 

Note: Only dummy transactions are currently supported.