🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Go to file
2024-06-12 11:06:13 -07:00
.cargo Fix 2024-05-30 11:35:15 -07:00
.circleci WIP update examples 2024-05-15 20:52:30 -07:00
.github Update testnet3 to mainnet 2024-05-14 13:31:33 -07:00
.resources chore(leo): bump version for new release 2024-05-13 13:36:45 -07:00
compiler fix 2024-06-12 10:58:24 -07:00
docs Merge branch 'mainnet' into update/from-testnet3 2024-05-14 14:47:33 -07:00
errors update error message 2024-06-11 16:41:27 -07:00
examples Remove lock 2024-06-04 16:44:13 -07:00
leo fmt 2024-06-11 14:09:51 -07:00
tests add test 2024-06-12 11:06:13 -07:00
utils clippy 2024-06-11 14:38:41 -07: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 Implement Leo Account (#2513) 2023-08-07 16:01:33 -07:00
.rustfmt.toml Update fmt and pre-commit config 2023-03-26 23:16:19 -07:00
.rusty-hook.toml Update fmt and pre-commit config 2023-03-26 23:16:19 -07:00
build.rs Fmts and clippies 2023-03-26 23:18:03 -07:00
Cargo.lock Bump clap from 4.5.6 to 4.5.7 2024-06-11 21:06:33 +00:00
Cargo.toml local execution working for both testnet and mainnet 2024-06-07 16:15:19 -07:00
CONTRIBUTING.md Update testnet3 to mainnet 2024-05-14 13:31:33 -07:00
CONTRIBUTORS.md add whitelisted contributors 2024-02-26 14:44:05 -08: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 Update testnet3 to mainnet 2024-05-14 13:31:33 -07: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

🍎 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.

⚙️ Build Guide

🦀 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.

🐙 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

🦁 Update from Leo

You can update Leo to the latest version using the following command:

leo update

Now to check the version of leo, in your terminal, run:

leo --version

📦 Download using Cargo

You can also install Leo directly from crates.io using cargo:

cargo install leo-lang

Now to use leo, in your terminal, run:

leo

🚀 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 main 0u32 1u32

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.

🧰 Troubleshooting

If you are having trouble installing and using Leo, please check out our guide.

If the issue still persists, please open an issue.

📖 Documentation

🤝 Contributing

Please see our guidelines in the developer documentation

❤️ Contributors

View all Leo contributors here.

🛡️ License

License: GPL v3

🔼 Back to top