• Stars
    star
    329
  • Rank 128,066 (Top 3 %)
  • Language
    Shell
  • Created about 2 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

📜 A Starter Guide to Build ZK Applications 📜

workshop

📜 A starter guide to build applications on Aleo 📜

Table of Contents

Build Guide

The following steps will install Aleo and Leo on your machine. This workshop is compatible on macOS, Linux, and Windows machines.

Prerequisites

This workshop requires the following prerequisites.

Installation

To install Aleo and Leo, run:

./install.sh

IDE Support

This workshop requires one of the following IDEs.

VSCode (Preferred)

Start by installing VSCode with bit.ly/start-vscode.

Next, in VSCode, open the VSCode Marketplace, type Leo into the search bar, and proceed to install the Leo plugin.

Leo VSCode

Sublime Text

Installation Steps

Start by installing Sublime Text with bit.ly/start-sublime.

Next, in Sublime Text, install Package Control:

  • On Windows/Linux: ctrl + shift + p, type Install Package Control, and press Enter.
  • On macOS: cmd + shift + p, type Install Package Control, and press Enter.

Next, in Sublime Text, install LSP:

  • On Windows/Linux: ctrl + shift + p, select Package Control: Install Package, type LSP, and press Enter.
  • On macOS: cmd + shift + p, select Package Control: Install Package, type LSP, and press Enter.

Lastly, in Sublime Text, install LSP-leo:

  • On Windows/Linux: ctrl + shift + p, select Package Control: Install Package, type LSP-leo, and press Enter.
  • On macOS: cmd + shift + p, select Package Control: Install Package, type LSP-leo, and press Enter.

IntelliJ IDEA

Installation Steps

Start by installing IntelliJ IDEA with bit.ly/start-intellij.

Next, in IntelliJ IDEA, open the IntelliJ Marketplace and select Plugins:

  • On Windows/Linux: ctrl + , and select Plugins on the left hand bar
  • On macOS: cmd + , and select Plugins on the left hand bar

Lastly, type Leo into the search bar, and install the official Leo plugin.

Application Walkthroughs

This workshop walks through the following applications:

  • auction - A first-price sealed-bid auction in Leo
  • basic_bank - A simple-interest yielding bank account in Leo
  • battleship- A two-player game of Battleship in Leo
  • tictactoe - A standard game of Tic-Tac-Toe in Leo
  • token - A transparent & shielded custom token in Leo
  • vote - A ballot voting example in Leo

🏛️ Auction

A first-price sealed-bid auction in Leo.

To see the auction example, run:

cd auction && ./run.sh

🏦 Basic Bank

A simple-interest yielding bank account in Leo.

To see the basic bank example, run:

cd basic_bank && ./run.sh

🛳️ Battleship

A two-player game of Battleship in Leo.

To see a game of Battleship between two players, run:

cd battleship && ./run.sh

⭕ Tic-Tac-Toe

A standard game of Tic-Tac-Toe in Leo.

To see a game of Tic-Tac-Toe between two players, run:

cd tictactoe && ./run.sh

🪙 Token

A transparent & shielded custom token in Leo.

To see an example of minting and transfering tokens, run:

cd token && ./run.sh

🗳️ Vote

A ballot voting example in Leo.

To see an example of a ballot, run:

cd vote && ./run.sh

More Repositories

1

leo

🦁 The Leo Programming Language. A Programming Language for Formally Verified, Zero-Knowledge Applications
Rust
4,789
star
2

sdk

A Software Development Kit (SDK) for Zero-Knowledge Transactions
JavaScript
589
star
3

welcome

👋 Welcome to Provable! Zero-Knowledge is Finally Here 🚀
319
star
4

aleo-education

Aleo Education
197
star
5

ARCs

Aleo Request for Comments (ARCs)
JavaScript
193
star
6

python-sdk

Python
40
star
7

aleo-rust

Rust
32
star
8

aleo-js

TypeScript
20
star
9

aleo-std

Rust
16
star
10

grammars

Grammar specifications for languages and formats in the Aleo ecosystem.
16
star
11

aleo-setup-integration-test

Integration testing for aleo-setup and aleo-setup-coordinator
Rust
10
star
12

aleo_lambda_blockchain

MVP for an aleo blockchain
Rust
8
star
13

community

A place for everyone to collaborate and communicate: Agendas and meeting notes.
7
star
14

aleo-instructions-syntax-vscode

Aleo instructions syntax
7
star
15

service

Rust
7
star
16

aleo_vm_lambda

Proof of concept for a ZK snark-based VM running Aleo Instructions.
Rust
6
star
17

nemean

Go
5
star
18

aleo-instructions-syntax-sublime

Aleo instructions syntax highlighting for Sublime editor
3
star
19

bounty-2022-ethdenver

The Aleo bounty descriptions for the EthDenver 2022 hackathon.
TypeScript
3
star
20

linguist-grammars

3
star
21

leo-syntax-vscode

Leo syntax
TypeScript
2
star
22

aleo-snap-chainsafe

JavaScript
2
star
23

leo-acl2-bin

2
star
24

mpmc-bus

Wrapper around bus to provide mp functionality.
Rust
1
star
25

collector

Leo Async Programming Example
1
star
26

leo-plugins

A repository to file bugs and feature requests for Leo plugins
1
star