mirror of https://github.com/ProvableHQ/leo.git synced 2024-11-24 07:48:04 +03:00

🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications

compiler leo programming-language starred-provablehq-repo starred-repo zero-knowledge zksnarks

Go to file

evan-schott 909289c83c Update compiler/parser/src/parser/file.rs Co-authored-by: d0cd <pranavsaig@gmail.com> Signed-off-by: evan-schott <53463459+evan-schott@users.noreply.github.com>		2023-10-04 13:05:34 -07:00
.cargo	one more fix for cargo config	2021-06-16 15:05:29 +03:00
.circleci	fix leo execute command line argument parsing (#2530 )	2023-08-15 13:59:50 -07:00
.github	Update release.yml	2023-09-26 13:11:05 -07:00
.resources	chore(leo): bump version for new release	2023-09-08 10:18:21 -07:00
compiler	Update compiler/parser/src/parser/file.rs	2023-10-04 13:05:34 -07:00
docs	chore(leo): bump version for new release	2023-09-08 10:18:21 -07:00
errors	Update errors/src/errors/type_checker/type_checker_error.rs	2023-10-04 13:05:34 -07:00
examples	commit run scripts, bump rust ci img versions (#2526 )	2023-08-15 08:48:18 -07:00
leo	Bump toml from 0.7.8 to 0.8.0	2023-09-13 10:16:02 +00:00
tests	change AST	2023-10-04 13:05:32 -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 reqwest from 0.11.21 to 0.11.22	2023-10-04 10:29:32 +00:00
Cargo.toml	Bump reqwest from 0.11.21 to 0.11.22	2023-10-04 10:29:32 +00: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	add aharshbe to readme contributors (#2607 )	2023-09-25 09:04:13 -07:00
SECURITY.md	Cleanup out dated docs	2022-08-18 15:45:30 -07:00

README.md

The Leo Programming Language

Leo is a functional, statically-typed programming language built for writing private applications.

🍎 Overview
⚙️️ Build Guide
- 🦀 Install Rust
- 🐙 Build from Source Code
🚀 Quick Start
🧰 Troubleshooting
📖 Documentation
🤝 Contributing
❤️ Contributors
🛡️ License

🍎 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

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

🧰 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

Thank you for helping make Leo better!
What do the emojis mean?🧐

_d0cd 💻 🚧 💬 👀	_{Collin Chin} 💻 📖 🚧 👀	_{Howard Wu} 🤔 🚧 🔬 👀	_{Alessandro Coglio} 📖 🚧 💬 👀	_{Eric McCarthy} 📖 🚧 💬 👀	_{Raymond Chu} 🤔 💻 🔬	_ljedrz 🐛 💻 💬
_aharshbe ✅🐛 💬	_{Mazdak Farrokhzad} 💻	_{Damir Shamanaev} 💻	_gluax 💻	_0rphon 💻	_{Max Bruce} 💻	_{Sergey Isaev} 💻
_{François Garillot} 💻	_{Weikeng Chen} 🔬	_sptg 🐛 💻	_LouisWT 💻	_yuliyu123 💻	_detailyang 💻	_{Tom-OriginStorage} 💻
_omahs 💻	_Haruka 🐛 💻	_swift-mx 💻	_{Francisco Strambini} 💻	_{Daniel Gushchyan} ✅	_{allcontributors[bot]} 📖	_{actions-user[bot]} 📖
_{dependabot[bot]} 📖
Add your contributions