snarkvm 4.2.0

A decentralized virtual machine
Documentation

Table of Contents

1. Overview

Package crates.io docs.rs std wasm Description
snarkvm crates.io docs.rs :white_check_mark: :white_check_mark: Meta-package that contains all other crates
snarkvm-algorithms crates.io docs.rs :white_check_mark: :white_check_mark:
snarkvm-circuit crates.io docs.rs :white_check_mark: :white_check_mark: Arithmetic circuits for snarkVM
snarkvm-console crates.io docs.rs :white_check_mark: :white_check_mark:
snarkvm-curves crates.io docs.rs :white_check_mark: :white_check_mark: Cryptographic curves for snarkVM
snarkvm-fields crates.io docs.rs :white_check_mark: :white_check_mark: Arithmetic fields for snarkVM
snarkvm-ledger crates.io docs.rs :white_check_mark: :white_check_mark: Ledger implementation for the Aleo blockchain
snarkvm-parameters crates.io docs.rs :white_check_mark: :white_check_mark:
snarkvm-synthesizer crates.io docs.rs :white_check_mark: :white_check_mark: Program synthesizer for snarkVM
snarkvm-utilities crates.io docs.rs :white_check_mark: :white_check_mark: Helper functions for snarkVM
snarkvm-wasm crates.io docs.rs :white_check_mark: :white_check_mark: WASM bindings for snarkVM

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.2.1 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.2.2 Build from Source Code

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

# Download the source code
git clone --branch mainnet --single-branch https://github.com/ProvableHQ/snarkVM.git 
cd snarkVM
git checkout tags/testnet-beta
# Install snarkVM
cargo install --path .

Now to use snarkvm, in your terminal, run:

snarkvm

3. Contributors

Thank you for helping make snarkVM better!
🧐 What do the emojis mean?

This project follows the all-contributors specification. Contributions of any kind welcome!

4. License

License: GPL v3