snarkvm

Table of Contents

• 1. Overview
• 2. Build Guide
• 3. Contributors
• 4. License

1. Overview

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

• Windows (64-bit):

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

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?

Howard Wu 💻 🚧 🤔 👀	Raymond Chu 💻 🚧 🤔 👀	d0cd 💻 🚧 🤔 👀	Pratyush Mishra 💻 🚧 🤔 👀	vicsn 💻 🚧 📖 👀	ljedrz 💻 🔧 👀	Mike Turner 💻 📖 👀
Collin Chin 💻 📖 👀	Alessandro Coglio 💻 📖 ⚠️	Niklas Long 💻	jules 💻	Ali Mousa 💻	Weikeng Chen 💻	Evan Schott 💻
Max Bruce 💻	zhiqiangxu 💻	Javier Rodríguez Chatruc 💻	Eduardo Morais 💻	Maciej Zwoliński 💻	Ivan Litteri 💻	Francisco Strambini 💻
Haruka 🐛 💻	StarLI-Trapdoor 💻	Vesa-Ville 💻	Jos Dehaes 💻	apruden2008 💻	Evan Marshall 🐛 💻	Psi Vesely 💻
swift-mx 💻	Nacho Avecilla 💻	qy3u 💻	Yt 💻	Kostyan 💻	stanlagermin 💻	Sukey 💻
Alex Zhao 💻	ghost ant 💻	Psi Vesely 💻	Dependabot 💻	Dependabot Preview 💻	All Contributors 📖
Add your contributions

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

4. License