snarkOS

1. Overview
2. Build Guide
3. Usage Guide
4. JSON-RPC Interface
5. Additional Information
6. License

1. Overview

snarkOS is a decentralized operating system for private applications. It forms the backbone of Aleo and enables applications to verify and store state in a publicly verifiable manner.

2. Build Guide

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

2.2a Build from Crates.io

We recommend installing snarkOS 1.1.4 way. In your terminal, run:

cargo install snarkos

Now to use snarkOS, in your terminal, run:

snarkos

2.2b Build from Source Code

Alternatively, you can install snarkOS 1.1.4 building from the source code as follows:

# Download the source code
git clone https://github.com/AleoHQ/snarkOS
cd snarkOS

# Build in release mode
$ cargo build --release

This will generate an executable under the ./target/release directory. To run snarkOS, run the following command:

./target/release/snarkos

2.2c Build with Docker

Docker build

docker build -t snarkos:latest .

docker-compose build

Docker run

docker run -d -p 4131:4131 --name snarkos snarkos

docker-compose up

3. Usage Guide

3.1 Connecting to the Aleo network

To start a client node, run:

snarkos

To start a mining node, run:

snarkos --is-miner

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

3.2 Command Line Interface

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

snarkOS 1.1.4
Run an Aleo node (include -h for more options)

USAGE:
    snarkos [FLAGS] [OPTIONS]

FLAGS:
    -h, --help           Prints help information
        --is-bootnode    Run the node as a bootnode (IP is hard coded in the protocol)
        --is-miner       Start mining blocks from this node
        --no-jsonrpc     Run the node without running the json rpc server

OPTIONS:
        --connect <ip>                           Specify one or more node ip addresses to connect to on startup
    -i, --ip <ip>                                Specify the ip of your node
        --max-peers <max-peers>                  Specify the maximum number of peers the node can connect to
        --mempool-interval <mempool-interval>    Specify the frequency in seconds the node should fetch a sync node's mempool
        --min-peers <min-peers>                  Specify the minimum number of peers the node should connect to
        --miner-address <miner-address>          Specify the address that will receive miner rewards
        --network <network-id>                   Specify the network id (default = 1) of the node
    -d, --path <path>                            Specify the node's storage path
    -p, --port <port>                            Specify the port the node is run on
        --rpc-password <rpc-password>            Specify a password for rpc authentication
        --rpc-port <rpc-port>                    Specify the port the json rpc server is run on
        --rpc-username <rpc-username>            Specify a username for rpc authentication
        --verbose <verbose>                      Specify the verbosity (default = 1) of the node [possible values: 0, 1, 2]

Examples

Guard RPC endpoints

snarkos --rpc-username <Username> --rpc-password <Password>

Manually connect to a peer on the network

snarkos --connect "<IP ADDRESS>"

3.3 Configuration File

A config.toml file is generated in the ~/.snarkOS/ directory when the node is initialized for the time. Updating this config.toml file allows node operators to specify default settings for the node without having to specify additional information in the CLI.

4. JSON-RPC Interface

By default, snarkOS 1.1.4 a JSON-RPC server to allow external interfacing with the Aleo network. Documentation of the RPC endpoints can be found here

5. Additional Information

For additional information, please refer to the official Aleo documentation page.

ljedrz/snarkOS