/snarkVM

A Virtual Machine for Zero-Knowledge Executions

Primary LanguageRustGNU General Public License v3.0GPL-3.0

snarkVM

Table of Contents

1. Overview

Package Crate.io std wasm
snarkvm crates.io
snarkvm-algorithms crates.io
snarkvm-circuit crates.io
snarkvm-console crates.io
snarkvm-curves crates.io
snarkvm-fields crates.io
snarkvm-parameters crates.io
snarkvm-r1cs crates.io
snarkvm-synthesizer crates.io
snarkvm-utilities crates.io
snarkvm-wasm crates.io

For more information, visit Welcome to Aleo to get started.

2. Build Guide

2.1 Install Rust

We recommend installing Rust using rustup. You can install rustup as follows:

2.2a Build from Crates.io

We recommend installing snarkvm this way. In your terminal, run:

cargo install snarkvm

Now to use snarkvm, in your terminal, run:

snarkvm

2.2b Build from Source Code

Alternatively, you can install snarkvm by building from the source code as follows:

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

# Install snarkVM
$ cargo install --path .

Now to use snarkvm, in your terminal, run:

snarkvm

3. Usage Guide

4. License

License: GPL v3