mirror of
https://github.com/AleoHQ/leo.git
synced 2024-09-11 06:55:43 +03:00
remove flying tour, update overview
This commit is contained in:
parent
e1c0fbf9f6
commit
faf979904a
121
README.md
121
README.md
@ -13,12 +13,7 @@ Leo is a functional, statically-typed programming language built for writing pri
|
||||
* [2.2a Build from Crates.io](#22a-build-from-cratesio)
|
||||
* [2.2b Build from Source Code](#22b-build-from-source-code)
|
||||
* [3. Quick Start](#3-quick-start)
|
||||
* [4. Flying Tour](#4-flying-tour)
|
||||
* [4.1 Functions](#41-functions)
|
||||
* [4.2 Testing](#42-testing)
|
||||
* [4.3 Data Types](#43-data-types)
|
||||
* [4.4 Circuits](#44-circuits)
|
||||
* [4.5 Imports](#45-imports)
|
||||
* [4. Documentation](#4-documentation)
|
||||
* [5. Contributing](#5-contributing)
|
||||
* [6. License](#6-license)
|
||||
|
||||
@ -26,10 +21,16 @@ Leo is a functional, statically-typed programming language built for writing pri
|
||||
## 1. Overview
|
||||
Welcome to the Leo programming language.
|
||||
|
||||
Leo exists to provide a simple high-level language that compiles to a rank one constraint system (R1CS) circuit.
|
||||
With Leo, you can write circuits to support zero-knowledge tokens, private stable coins, and decentralized marketplaces.
|
||||
Leo exists to provide a simple high-level language that abstracts low-level cryptographic concepts and makes it easy to
|
||||
integrate private applications into your stack. Leo compiles to R1CS circuits making zero-knowledge proofs practical.
|
||||
With Leo, you can support zero-knowledge tokens, private stable coins, and decentralized marketplaces.
|
||||
|
||||
The syntax of Leo is influenced by JavaScript, Python, Scala, and Rust with a strong emphasis on readability and ease-of-use.
|
||||
Leo provides developers with never before seen 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](https://aleo.org/). 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](https://aleo.studio/)
|
||||
and checking out the [Aleo Package Manager]().
|
||||
|
||||
## 2. Build Guide
|
||||
|
||||
@ -100,105 +101,12 @@ The `leo run` command will compile the main program, generate keys for a trusted
|
||||
|
||||
Congratulations! You've just run your first Leo program.
|
||||
|
||||
## 4. Flying Tour
|
||||
## 4. Documentation
|
||||
|
||||
The best way to get to know Leo is by writing some code. We will fly through a high level overview of a Leo file.
|
||||
To gain a deeper understanding of the Leo language, then check out the [developer documentation](https://developer.aleo.org/developer/getting_started/overview)
|
||||
|
||||
|
||||
**Square Root Example**: Let's prove that we know the square root of a number.
|
||||
|
||||
**`src/main.leo`**
|
||||
```rust // change this to leo
|
||||
function main(a: u32, b: u32) -> bool {
|
||||
return square_root(a, b)
|
||||
}
|
||||
|
||||
function square_root(a: u32, b: u32) -> bool {
|
||||
return a * a == b
|
||||
}
|
||||
|
||||
test function test_square_root() {
|
||||
let a: u32 = 5;
|
||||
let b: u32 = 25;
|
||||
|
||||
let result = square_root(a, b);
|
||||
|
||||
console.assert(result == true);
|
||||
}
|
||||
```
|
||||
|
||||
### 4.1 Functions
|
||||
The `main` function is the entrypoint of a Leo program.
|
||||
`leo run` will provide private inputs directly to the function for proving and store the program result in an output file.
|
||||
|
||||
The `square_root` function is called by `main` with private inputs `a` and `b` which are both unsigned `u32` integers.
|
||||
|
||||
### 4.2 Testing
|
||||
|
||||
A naive way to test `square_root` would be to execute `leo run` several times on different inputs and check the output of the program each time.
|
||||
|
||||
Luckily, we can write unit tests in Leo using the `test function` syntax.
|
||||
In `test_square_root` we can sanity check our code without having to load in private inputs from a file every time.
|
||||
Want to upgrade your test function into an integration test?
|
||||
In Leo you can add a test context annotation that loads different sets of private inputs to make your test suite even more robust.
|
||||
|
||||
The last line of `test_square_root` uses the console function `console.assert`.
|
||||
This function along with `console.log`, `console.debug`, and `console.error` provide developers with tools that are run without
|
||||
affecting the underlying constraint system.
|
||||
|
||||
### 4.3 Data Types
|
||||
|
||||
Leo supports boolean, unsigned integer, signed integer, field, group element, and address data types.
|
||||
Collections of data types can be created in the form of static arrays and tuples.
|
||||
|
||||
### 4.4 Circuits
|
||||
|
||||
**Circuits Example**
|
||||
|
||||
**`src/main.leo`**
|
||||
```rust
|
||||
circuit Point {
|
||||
x: u32,
|
||||
y: u32,
|
||||
|
||||
static function new() -> Self {
|
||||
return Self {
|
||||
x: 0,
|
||||
y: 0,
|
||||
}
|
||||
}
|
||||
|
||||
function add() -> u32 {
|
||||
return self.x + self.y
|
||||
}
|
||||
}
|
||||
|
||||
function main() {
|
||||
let mut p = Point::new();
|
||||
|
||||
p.x = 4u32;
|
||||
p.y = 6u32;
|
||||
|
||||
let sum = p.add();
|
||||
|
||||
console.log("The sum is {}", sum);
|
||||
}
|
||||
```
|
||||
|
||||
Circuits in leo are similar to structures in other object-oriented languages.
|
||||
They provide a composite data type that can store primitive values and provide functions for instantiation and computation.
|
||||
|
||||
The `static` keyword modifies the `new` function so it can be called without instantiating the circuit.
|
||||
|
||||
Leo introduces `Self` and `self` keywords to access circuit member values.
|
||||
|
||||
### 4.5 Imports
|
||||
|
||||
Imports fetch other circuits and functions and bring them into the current file scope.
|
||||
Leo supports imports for dependencies that are declared locally or in an imported package.
|
||||
|
||||
Importing packages can be accomplished using the `leo add` command in the CLI.
|
||||
* [Leo Hello World](https://developer.aleo.org/developer/getting_started/hello_world)
|
||||
* [Leo Language Documentation](https://developer.aleo.org/developer/language/layout)
|
||||
* [Leo CLI Documentation](https://developer.aleo.org/developer/cli/new)
|
||||
* [Homepage](https://developer.aleo.org/developer/getting_started/overview)
|
||||
|
||||
## 5. Contributing
|
||||
|
||||
@ -206,6 +114,5 @@ Please see our guidelines in the [developer documentation](https://developer.ale
|
||||
|
||||
Thank you for helping make Leo better!
|
||||
|
||||
|
||||
## 6. License
|
||||
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.md)
|
Loading…
Reference in New Issue
Block a user