🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
2022-01-24 10:02:15 -08:00
.cargo one more fix for cargo config 2021-06-16 15:05:29 +03:00
.circleci merge testnet2 2022-01-21 13:06:30 -08:00
.github fix spelling mistake, re-add codecov 2022-01-21 13:13:15 -08:00
.resources chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
asg migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
asg-passes migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
ast migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
ast-passes migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
compiler migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
deprecated/state clippy 2022-01-17 16:30:08 -08:00
docs Merge pull request #1414 from AleoHQ/rfc/static-circuit-members 2021-10-27 21:46:34 -07:00
errors have to temproarily disable pre commit checks while migrating 2022-01-21 12:24:38 -08:00
examples Update main.leo 2021-09-29 12:26:40 -07:00
grammar Merge pull request #1406 from AleoHQ/abnf-empty-circuit 2021-10-20 04:25:14 -07:00
imports migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
input migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
leo clippy 2022-01-17 16:30:08 -08:00
linter migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
package migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
parser migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
span fix spelling mistake, re-add codecov 2022-01-21 13:13:15 -08:00
stdlib add some READMES 2021-09-14 21:38:07 -07:00
synthesizer migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
test-framework migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
tests Merge pull request #1362 from AleoHQ/feature/remove-span-snapshot 2021-09-30 15:33:18 -07:00
wasm clippy 2022-01-17 16:30:08 -08:00
.codecov.yml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.gitattributes now its just mac release list failing 2021-08-12 09:51:00 -07:00
.gitignore finish docs, setup ci to publish docs pages, test docs generation 2021-08-10 19:59:27 -07:00
.licenserc.json Update license to 2021 2021-02-01 20:26:56 -08:00
.rustfmt.toml migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08:00
.rusty-hook.toml merge upstream testnet2 2022-01-24 10:02:15 -08:00
bors.toml Set bors approval minimum to 1 2021-02-11 13:21:40 -08:00
Cargo.lock have to temproarily disable pre commit checks while migrating 2022-01-21 12:24:38 -08:00
Cargo.toml migrate spans crate, which involves rust 2021 ed, and dep updates 2022-01-21 12:04:37 -08: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-04-27 19:37:41 -07: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