🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
2021-09-20 10:07:49 -07:00
.cargo one more fix for cargo config 2021-06-16 15:05:29 +03:00
.circleci Merge branch 'master' into leo-manifest-dependencies 2021-08-19 18:04:05 +03:00
.github Update acl2.yml 2021-08-31 20:41:04 +03:00
.resources chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
asg Merge pull request #1324 from AleoHQ/abnf 2021-09-08 09:59:52 -07:00
asg-passes core function imports 2021-08-18 18:52:56 -07:00
ast resolve merge conflicts 2021-09-07 02:59:35 -07:00
ast-passes merge master and resolve conflicts 2021-09-10 02:27:37 -07:00
compiler resolve merge conflicts 2021-09-07 02:59:35 -07:00
docs [RFC] Mention also Output as suggested. 2021-09-20 10:07:49 -07:00
errors [Bug] Fix ordering in unexpected_type error (#1329) 2021-09-07 13:11:44 +03:00
examples adds more examples from playground, updates manifests 2021-09-08 19:26:27 +03:00
grammar [ABNF] Re-generate markdown file. 2021-09-09 12:00:22 -07:00
imports fix imported circuit return from function in import 2021-09-06 06:12:58 -07:00
input circleci updated rust version 2021-08-13 10:48:38 -07:00
leo merge master, add clean for imports ast 2021-08-27 09:40:25 -07:00
linter chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
package merge master, add clean for imports ast 2021-08-27 09:40:25 -07:00
parser resolve merge conflicts 2021-09-07 02:59:35 -07:00
state Merge branch 'master' of github.com:AleoHQ/leo into feature/better-errors 2021-08-18 14:42:19 -07:00
synthesizer Merge branch 'master' of github.com:AleoHQ/leo into feature/better-errors 2021-08-18 14:42:19 -07:00
test-framework fix imported circuit return from function in import 2021-09-06 06:12:58 -07:00
tests merge master and resolve conflicts 2021-09-10 02:27:37 -07: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 fmt stable only features, test all the platforms, cc stable 2021-07-14 13:55:01 -07:00
.rusty-hook.toml re-enable clippy and fmt checks, remove old errors 2021-08-27 08:54:53 -07:00
bors.toml Set bors approval minimum to 1 2021-02-11 13:21:40 -08:00
Cargo.lock Bump anyhow from 1.0.43 to 1.0.44 (#1340) 2021-09-13 14:06:32 +03:00
Cargo.toml Bump assert_cmd from 2.0.0 to 2.0.1 (#1331) 2021-09-07 14:24:04 +03: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