🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
2021-02-25 09:58:25 -08:00
.cargo Update .cargo/config 2020-08-21 04:23:52 -07:00
.circleci Fix variables in ci 2021-02-25 09:58:25 -08:00
.github Merge branch 'master' of https://github.com/AleoHQ/leo into ci-publish-workflow 2021-02-25 09:04:57 -08:00
.resources Update README 2021-02-24 19:59:50 -08:00
.travis Adds SSH key for snarkOS 2020-06-07 22:55:49 -07:00
asg Rename all instances of 'ctx' to 'context' 2021-02-24 18:13:36 -08:00
ast re-add syntax in, then add deprecation warning for it 2021-02-16 15:33:31 -05:00
compiler Rename all instances of 'ctx' to 'context' 2021-02-24 18:13:36 -08:00
examples rebase and replace const keyword in tests 2021-02-16 14:19:20 -05:00
gadgets refactor Field + PrimeField -> PrimeField, all tests still pass 2021-02-16 14:41:59 -05:00
grammar re-add syntax in, then add deprecation warning for it 2021-02-16 15:33:31 -05:00
imports Rename all instances of 'ctx' to 'context' 2021-02-24 18:13:36 -08:00
input Adds README.md 2021-02-10 22:27:37 -08:00
leo Adds 'leo clone' command 2021-02-25 09:29:50 -08:00
linter Adds README.md 2021-02-10 22:27:37 -08:00
package Clippy 2021-02-24 19:43:03 -08:00
state bump snarkvm module versions to 0.0.4 2021-02-11 17:33:53 -08:00
.codecov.yml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.gitignore Update .gitignore 2021-02-24 20:46:54 -08:00
.licenserc.json Update license to 2021 2021-02-01 20:26:56 -08:00
.rustfmt.toml prefer rust fmt imports_granularity over deprecated merge_imports 2021-02-01 09:16:37 -08:00
.rusty-hook.toml Update precommit hook to use stable for clippy 2021-02-01 20:28:33 -08:00
.travis.yml Migrate to snarkVM 2020-12-30 12:40:45 -04:00
bors.toml Set bors approval minimum to 1 2021-02-11 13:21:40 -08:00
Cargo.lock Merge #690 #691 2021-02-25 01:33:51 +00:00
Cargo.toml Bump self_update from 0.24.0 to 0.25.0 2021-02-24 10:48:02 +00:00
CONTRIBUTING.md add contributing.md 2021-02-16 15:22:02 -08:00
DEVELOPMENT.md Adds DEVELOPMENT.md 2021-02-24 20:28:27 -08:00
FAQs.md Update and rename FAQ.md to FAQs.md 2020-08-15 03:01:30 -07:00
LICENSE.md Adds LICENSE.md 2021-02-10 22:23:45 -08:00
README.md Update README.md 2021-02-24 20:06:04 -08:00
SECURITY.md Adds SECURITY.md 2021-02-10 22:31:12 -08:00

The Leo Programming Language

Bors enabled

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-lang

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 Leo, 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