🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
2022-09-20 13:58:52 -07:00
.cargo one more fix for cargo config 2021-06-16 15:05:29 +03:00
.circleci Merge pull request #2076 from AleoHQ/example/auction 2022-09-20 10:39:58 -07:00
.github prepare for testnet3 as repo branch 2022-07-18 18:28:23 -07:00
.resources prepare for testnet3 as repo branch 2022-07-18 18:28:23 -07:00
compiler push code to parse external calls 2022-09-20 13:58:52 -07:00
docs [ABNF] Improve a rule name. 2022-09-17 21:26:09 -07:00
errors push code to parse external calls 2022-09-20 13:58:52 -07:00
examples push code to parse external calls 2022-09-20 13:58:52 -07:00
leo remove checkmark, clarify leo output for all commands 2022-09-17 16:08:19 +02:00
tests Merge pull request #2073 from AleoHQ/fix/core-function-composite-data-types 2022-09-20 00:14:22 +02:00
.codecov.yml Adds configuration files for tooling 2020-06-07 22:53:45 -07:00
.gitattributes state the input files should be cloned with lf 2022-04-28 12:56:08 -07:00
.gitignore added scalar tests 2022-05-14 20:27:08 -07:00
.rustfmt.toml feat: introduce a build script checking licenses 2022-07-02 13:40:29 -07:00
.rusty-hook.toml merge upstream testnet2 2022-01-24 10:02:15 -08:00
build.rs Fmt, clippy 2022-07-06 16:16:19 -07:00
Cargo.lock Allow records and circuits for core functions 2022-09-18 02:32:35 +02:00
Cargo.toml use crates.io snarkvm dep 2022-09-16 18:31:56 +02:00
CONTRIBUTING.md prepare for testnet3 as repo branch 2022-07-18 18:28:23 -07:00
DEVELOPMENT.md Adds DEVELOPMENT.md 2021-02-24 20:28:27 -08:00
LICENSE.md Adds LICENSE.md 2021-02-10 22:23:45 -08:00
README.md fix broken links 2022-09-06 14:17:50 +02:00
SECURITY.md Cleanup out dated docs 2022-08-18 15:45:30 -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. The language is currently in an alpha stage and is subject to breaking changes.

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.2 Build from Source Code

We recommend installing Leo by building from the source code as follows:

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

# Install 'leo'
$ cargo install --path .

Now to use leo, in your terminal, run:

leo

3. Quick Start

Use the Leo CLI to create a new project

# create a new `hello-world` Leo project
leo new helloworld
cd helloworld

# 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 program into Aleo instructions and run 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