snarkVM
snarkVM copied to clipboard
A Virtual Machine for Zero-Knowledge Executions
Table of Contents
- 1. Overview
- 2. Build Guide
- 3. Usage Guide
- 4. License
1. Overview
Package | Crate.io | std |
wasm |
---|---|---|---|
snarkvm | :white_check_mark: | :white_check_mark: | |
snarkvm-algorithms | :white_check_mark: | :white_check_mark: | |
snarkvm-bytecode | :white_check_mark: | :white_check_mark: | |
snarkvm-circuit | :white_check_mark: | :white_check_mark: | |
snarkvm-console | :white_check_mark: | :white_check_mark: | |
snarkvm-curves | :white_check_mark: | :white_check_mark: | |
snarkvm-fields | :white_check_mark: | :white_check_mark: | |
snarkvm-parameters | :white_check_mark: | :white_check_mark: | |
snarkvm-r1cs | :white_check_mark: | :white_check_mark: | |
snarkvm-utilities | :white_check_mark: | :white_check_mark: | |
snarkvm-wasm | :white_check_mark: | :white_check_mark: |
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.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