🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
Howard Wu fce7435eae
Merge pull request #263 from AleoHQ/feat/version
Bump version and repair Leo update description
2020-08-19 03:39:06 -07:00
.cargo Remove revision peg for snarkOS dependency, change Leo to groth16, update to proper calling convention for snarks 2020-07-30 19:09:27 -07:00
.github Fix windows 2020-08-15 01:44:56 -07:00
.resources Add markdown changes 2020-06-20 08:42:33 +00:00
.travis Adds SSH key for snarkOS 2020-06-07 22:55:49 -07:00
ast Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
compiler Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
examples remove underscores 2020-08-18 23:05:42 -07:00
gadgets Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
input Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
leo Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
linter Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
package Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
state Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
typed Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
.codecov.yml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.gitignore allow outputs directory in leo package 2020-08-03 12:59:49 -07:00
.licenserc.json Add licenserc.json 2020-08-18 03:49:11 -07:00
.rustfmt.toml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.rusty-hook.toml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.travis.yml Update travis.yml 2020-06-08 00:21:15 -07:00
Cargo.lock Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
Cargo.toml Bump version and repair Leo update description 2020-08-19 03:00:30 -07:00
FAQs.md Update and rename FAQ.md to FAQs.md 2020-08-15 03:01:30 -07:00
README.md Update README.md 2020-08-19 01:34:50 -07:00

The Leo Programming Language

Leo is a functional, statically-typed programming language built for writing private applications.

Table of Contents

1. Overview

Welcome to the Leo programming language.

Leo provides a high-level language that abstracts low-level cryptographic concepts and makes it easy to integrate private applications into your stack. Leo compiles to circuits making zero-knowledge proofs practical.

The syntax of Leo is influenced by traditional programming languages like JavaScript, Scala, and Rust, with a strong emphasis on readability and ease-of-use. Leo offers developers with tools to sanity check circuits including unit tests, integration tests, and console functions.

Leo is one part of a greater ecosystem for building private applications on Aleo. If your goal is to build a user experience on the web that is both truly personal and truly private, then we recommend downloading the Aleo Studio IDE and checking out the Aleo Package Manager.

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 and follow the on-screen instructions.

  • Windows (32-bit):

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

2.2a Build from Crates.io

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

cargo install leo

Now to use Leo, in your terminal, run:

leo

2.2b Build from Source Code

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

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

# Build in release mode
$ cargo build --release

This will generate an executable under the ./target/release directory. To run snarkOS, run the following command:

./target/release/leo

3. Quick Start

Use the Leo CLI to create a new project

# create a new `hello_world` Leo project
leo new hello_world
cd hello_world

# build & setup & prove & verify
leo run

The leo new command creates a new Leo project with a given name.

The leo run command will compile the main program, generate keys for a trusted setup, fetch inputs, generate a proof and verify it.

Congratulations! You've just run your first Leo program.

4. Documentation

5. Contributing

Please see our guidelines in the developer documentation

Thank you for helping make Leo better!

6. License

License: GPL v3