ProvableHQ/snarkVM

GitHub: ProvableHQ/snarkVM

Stars: 1156 | Forks: 1549

snarkVM

## Table of Contents * [1. Overview](#1-overview) * [2. Build Guide](#2-build-guide) * [3. Contributors](#3-contributors) * [4. License](#4-license) ## 1. Overview | Package | crates.io | docs.rs | `std` | `wasm` | Description | |:-------------------:|:-----------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|:------------------:|:------------------:|:----------------------------------------------| | snarkvm | [![crates.io](https://img.shields.io/crates/v/snarkvm) ](https://crates.io/crates/snarkvm) | [![docs.rs](https://img.shields.io/docsrs/snarkvm) ](https://docs.rs/snarkvm) | :white_check_mark: | :white_check_mark: | Meta-package that contains all other crates | | snarkvm-algorithms | [![crates.io](https://img.shields.io/crates/v/snarkvm-algorithms) ](https://crates.io/crates/snarkvm-algorithms) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-algorithms) ](https://docs.rs/snarkvm-algorithms) | :white_check_mark: | :white_check_mark: | | | snarkvm-circuit | [![crates.io](https://img.shields.io/crates/v/snarkvm-circuit) ](https://crates.io/crates/snarkvm-circuit) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-circuit) ](https://docs.rs/snarkvm-circuit) | :white_check_mark: | :white_check_mark: | Arithmetic circuits for snarkVM | | snarkvm-console | [![crates.io](https://img.shields.io/crates/v/snarkvm-console) ](https://crates.io/crates/snarkvm-console) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-console) ](https://docs.rs/snarkvm-console) | :white_check_mark: | :white_check_mark: | | | snarkvm-curves | [![crates.io](https://img.shields.io/crates/v/snarkvm-curves) ](https://crates.io/crates/snarkvm-curves) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-curves) ](https://docs.rs/snarkvm-curves) | :white_check_mark: | :white_check_mark: | Cryptographic curves for snarkVM | | snarkvm-fields | [![crates.io](https://img.shields.io/crates/v/snarkvm-fields) ](https://crates.io/crates/snarkvm-fields) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-fields) ](https://docs.rs/snarkvm-fields) | :white_check_mark: | :white_check_mark: | Arithmetic fields for snarkVM | | snarkvm-ledger | [![crates.io](https://img.shields.io/crates/v/snarkvm-ledger) ](https://crates.io/crates/snarkvm-ledger) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-ledger) ](https://docs.rs/snarkvm-ledger) | :white_check_mark: | :white_check_mark: | Ledger implementation for the Aleo blockchain | | snarkvm-parameters | [![crates.io](https://img.shields.io/crates/v/snarkvm-parameters) ](https://crates.io/crates/snarkvm-parameters) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-parameters) ](https://docs.rs/snarkvm-parameters) | :white_check_mark: | :white_check_mark: | | | snarkvm-synthesizer | [![crates.io](https://img.shields.io/crates/v/snarkvm-synthesizer)](https://crates.io/crates/snarkvm-synthesizer) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-synthesizer)](https://docs.rs/snarkvm-synthesizer) | :white_check_mark: | :white_check_mark: | Program synthesizer for snarkVM | | snarkvm-utilities | [![crates.io](https://img.shields.io/crates/v/snarkvm-utilities) ](https://crates.io/crates/snarkvm-utilities) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-utilities) ](https://docs.rs/snarkvm-utilities) | :white_check_mark: | :white_check_mark: | Helper functions for snarkVM | | snarkvm-wasm | [![crates.io](https://img.shields.io/crates/v/snarkvm-wasm) ](https://crates.io/crates/snarkvm-wasm) | [![docs.rs](https://img.shields.io/docsrs/snarkvm-wasm) ](https://docs.rs/snarkvm-wasm) | :white_check_mark: | :white_check_mark: | WASM bindings for snarkVM | For more information, visit [Welcome to Aleo](https://github.com/AleoNet/welcome) to get started. ## 2. Build Guide ### 2.1 Install Rust We recommend installing Rust using [rustup](https://www.rustup.rs/). 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](https://win.rustup.rs/x86_64) or [Windows 32-bit executable](https://win.rustup.rs/i686) 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 = ".." ### 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 ## 4. License [![License: GPL v3](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE.md)
标签:通知系统