snarkvm 4.4.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:

  • macOS or Linux:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

    For macOS users, you will need to subsequently install the following packages:

    brew install pkgconf
brew install openssl

  • Windows (64-bit):

    Download the Windows 64-bit executable or Windows 32-bit executable and follow the on-screen instructions.

2.2 Using snarkVM as a Library

snarkVM is primarily designed to be used as a library in Rust projects. Add it to your Cargo.toml with your favourite published version:

[dependencies]
snarkvm = "<major>.<minor>.<patch>"

2.3 Build from Source Code

You can also build snarkVM from source:

# Fetch the repository's development (staging) branch
git clone --branch staging --single-branch https://github.com/ProvableHQ/snarkVM.git 
cd snarkVM
# Build the library
cargo build --release

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