ProvableHQ/leo
1
1
Fork 0
mirror of https://github.com/ProvableHQ/leo.git synced 2024-11-24 07:48:04 +03:00
Code Issues Packages Projects Releases Wiki Activity
🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
4,126 Commits 53 Branches 44 Tags 331 MiB
Rust 97.6%
Shell 2.4%
fc01610e13
Go to file
dependabot[bot] fc01610e13
Bump thiserror from 1.0.30 to 1.0.31 
Bumps [thiserror](https://github.com/dtolnay/thiserror) from 1.0.30 to 1.0.31.
- [Release notes](https://github.com/dtolnay/thiserror/releases)
- [Commits](https://github.com/dtolnay/thiserror/compare/1.0.30...1.0.31)

---
updated-dependencies:
- dependency-name: thiserror
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-02 10:14:59 +00:00
.cargo one more fix for cargo config 2021-06-16 15:05:29 +03:00
.circleci updated circleci to use latest rust version 2022-03-15 17:28:12 -07:00
.github Remove cd dir 2022-03-14 13:34:01 -07:00
.resources chore(leo): bump version for new release 2021-07-29 18:59:08 -07:00
compiler [Impl] Ast Visitor (#1769) 2022-04-22 16:05:50 -07:00
docs [Impl] Ast Visitor (#1769) 2022-04-22 16:05:50 -07:00
examples implement real address literal check 2022-04-13 15:21:08 -07:00
leo Bump thiserror from 1.0.30 to 1.0.31 2022-05-02 10:14:59 +00:00
tests [lexer] add "_fail" suffix on test file names for tests that are supposed to fail (#1770) 2022-04-25 08:58:41 -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 merge testnet3 2022-04-22 09:07:47 -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
Cargo.lock Bump thiserror from 1.0.30 to 1.0.31 2022-05-02 10:14:59 +00:00
Cargo.toml Bump self_update from 0.29.0 to 0.30.0 2022-04-26 10:29:46 +00: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 remove unused bors 2022-02-22 15:43:19 -08:00
SECURITY.md Adds SECURITY.md 2021-02-10 22:31:12 -08:00

README.md

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