wwarodom / AleoWorkshop

📜 A Starter Guide to Build ZK Applications 📜

📜 A starter guide to build applications on Aleo 📜

Table of Contents

• Build Guide
  • Prerequisites
  • Installation
• IDE Support
  • VSCode
  • Sublime Text
  • IntelliJ IDEA
• Application Walkthroughs
  • 🏛️ Auction (Source Code)
  • 🏦 Basic Bank (Source Code)
  • 🛳️ Battleship (Source Code)
  • ⭕ Tic-Tic-Toe (Source Code)
  • 🪙 Token (Source Code)
  • 🗳️ Vote (Source Code)

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.

• Install git with bit.ly/start-git
• Install Rustwith bit.ly/start-rust

Installation

To install Aleo and Leo, run:

./install.sh

IDE Support

This workshop requires one of the following IDEs.

• VSCode
• Sublime Text
• IntelliJ IDEA

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.

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