🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
Alessandro Coglio f1ba77f9ed
Merge pull request #1207 from AleoHQ/fix/address-issue
Fix the AssignmentMissing error involving non-constant addresses
2021-07-30 13:46:50 -07:00
.cargo one more fix for cargo config 2021-06-16 15:05:29 +03:00
.circleci update the test as well as ci 2021-07-17 01:55:11 -07:00
.github remove CARGO_NET_GIT_FETCH_WITH_CLI: true 2021-07-08 11:29:20 -07:00
.resources chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
asg chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
asg-passes chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
ast chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
compiler Merge pull request #1207 from AleoHQ/fix/address-issue 2021-07-30 13:46:50 -07:00
docs/rfc Merge pull request #1202 from AleoHQ/rfc-built-in-decls 2021-07-28 11:07:41 -07:00
examples hacky, but optional comma only allowed on last member variable 2021-04-29 15:22:17 -04:00
grammar chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
imports chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
input chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
leo merge master, color only at cli as it breaks tests, remove debug 2021-07-26 16:49:33 -07:00
linter chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
package chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
parser chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
state chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
synthesizer chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
test-framework chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
tests Merge pull request #1207 from AleoHQ/fix/address-issue 2021-07-30 13:46:50 -07:00
.codecov.yml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.gitignore fmt fixes, realized they have to be in that format for outputs 2021-07-08 04:05:00 -07: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
bors.toml Set bors approval minimum to 1 2021-02-11 13:21:40 -08:00
Cargo.lock chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
Cargo.toml chore(leo): bump version for new release 2021-07-29 18:59:08 -07: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
FORMAT_ABNF_GRAMMER.md remove old abnf comments, format abnf 2021-07-21 14:42:25 -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