search

minerdao / snarkOS

GNU General Public License v3.0
2 stars 2 forks source link

readme

snarkOS

Table of Contents

1. Overview

snarkOS is a decentralized operating system for zero-knowledge applications. This code forms the backbone the Aleo network, which verifies transactions and stores the encrypted state applications in a publicly-verifiable manner.

2. Build Guide

2.1 Requirements

The following are minimum requirements to run an Aleo node:

Please note to run an Aleo Prover that is competitive, the machine will require more than these requirements.

2.2 Installation

Before beginning, please ensure your machine has Rust v1.65+ installed. Instructions to install Rust can be found here.

Start by cloning this Github repository:

git clone https://github.com/AleoHQ/snarkOS.git --depth 1

Next, move into the snarkOS directory:

cd snarkOS

[For Ubuntu users] A helper script to install dependencies is available. From the snarkOS directory, run:

./build_ubuntu.sh

Lastly, install snarkOS:

cargo install --path .

3. Run an Aleo Node

3a. Run an Aleo Client

Start by following the instructions in the Build Guide.

Next, to start a client node, from the snarkOS directory, run:

./run-client.sh

3b. Run an Aleo Prover

Start by following the instructions in the Build Guide.

Next, generate an Aleo account address:

snarkos account new

This will output a new Aleo account in the terminal.

Please remember to save the account private key and view key. The following is an example output:

 Attention - Remember to store this account private key and view key.

  Private Key  APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  <-- Save Me And Use In The Next Step
     View Key  AViewKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  <-- Save Me
      Address  aleo1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  <-- Save Me

Next, to start a proving node, from the snarkOS directory, run:

./run-prover.sh

When prompted, enter your Aleo private key:

Enter the Aleo Prover account private key:
APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

4. FAQs

1. My node is unable to compile.

2. My node is unable to connect to peers on the network.

3. I can't generate a new address

5. Command Line Interface

To run a node with custom settings, refer to the full list of options and flags available in the snarkOS CLI.

The full list of CLI flags and options can be viewed with snarkos --help:

snarkOS 
The Aleo Team <hello@aleo.org>

USAGE:
    snarkos [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -h, --help                     Print help information
    -v, --verbosity <VERBOSITY>    Specify the verbosity [options: 0, 1, 2, 3] [default: 2]

SUBCOMMANDS:
    account    Commands to manage Aleo accounts
    clean      Cleans the snarkOS node storage
    help       Print this message or the help of the given subcommand(s)
    start      Starts the snarkOS node
    update     Update snarkOS

The following are the options for the snarkos start command:

snarkos-start 
Starts the snarkOS node

USAGE:
    snarkos start [OPTIONS]

OPTIONS:
        --beacon <BEACON>          Specify this as a beacon, with the given account private key for this node
        --client <CLIENT>          Specify this as a client, with an optional account private key for this node
        --connect <CONNECT>        Specify the IP address and port of a peer to connect to [default: ]
        --dev <DEV>                Enables development mode, specify a unique ID for this node
    -h, --help                     Print help information
        --logfile <LOGFILE>        Specify the path to the file where logs will be stored [default: /tmp/snarkos.log]
        --network <NETWORK>        Specify the network of this node [default: 3]
        --node <NODE>              Specify the IP address and port for the node server [default: 0.0.0.0:4133]
        --nodisplay                If the flag is set, the node will not render the display
        --norest                   If the flag is set, the node will not initialize the REST server
        --prover <PROVER>          Specify this as a prover, with the given account private key for this node
        --rest <REST>              Specify the IP address and port for the REST server [default: 0.0.0.0:3033]
        --validator <VALIDATOR>    Specify this as a validator, with the given account private key for this node
        --verbosity <VERBOSITY>    Specify the verbosity of the node [options: 0, 1, 2, 3] [default: 2]

6. Development

6.1 Quick Start

In one terminal, start the beacon by running:

cargo run --release -- start --nodisplay --dev 0 --beacon ""

In a second terminal, run:

cargo run --release -- start --nodisplay --dev 1 --prover ""

This procedure can be repeated to start more nodes.

6.2 Operations

It is important to initialize the nodes starting from 0 and incrementing by 1 for each new node.

The following is a list of options to initialize a node (replace XX with a number starting from 0):

cargo run --release -- start --nodisplay --dev XX --beacon ""
cargo run --release -- start --nodisplay --dev XX --validator ""
cargo run --release -- start --nodisplay --dev XX --prover ""
cargo run --release -- start --nodisplay --dev XX --client ""
cargo run --release -- start --nodisplay --dev XX

When no node type is specified, the node will default to --client.

Clean Up

To clean up the node storage, run:

cargo run --release -- clean --dev XX

7. License

We welcome all contributions to snarkOS. Please refer to the license for the terms of contributions.

License: GPL v3