https://github.com/AleoHQ/snarkVM

A Virtual Machine for Zero-Knowledge Executions
https://github.com/AleoHQ/snarkVM

aleo blockchain cryptography rust zero-knowledge zkp

Last synced: about 1 month ago
JSON representation

A Virtual Machine for Zero-Knowledge Executions

• Host: GitHub
• URL: https://github.com/AleoHQ/snarkVM
• Owner: AleoHQ
• License: apache-2.0
• Created: 2020-03-14T05:13:57.000Z (over 4 years ago)
• Default Branch: mainnet-staging
• Last Pushed: 2024-04-13T17:32:20.000Z (3 months ago)
• Last Synced: 2024-04-14T07:03:23.124Z (3 months ago)
• Topics: aleo, blockchain, cryptography, rust, zero-knowledge, zkp
• Language: Rust
• Homepage: https://snarkvm.org
• Size: 250 MB
• Stars: 936
• Watchers: 50
• Forks: 1,416
• Open Issues: 116
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Security: SECURITY.md

Lists

• awesome-aleo - snarkVM - 虚拟机 (代码仓库)
• awesome-stars - AleoHQ/snarkVM - Knowledge Executions (Rust)
• awesome-stars - AleoHQ/snarkVM - A Virtual Machine for Zero-Knowledge Executions (Rust)
• awesome-ccamel - AleoHQ/snarkVM - A Virtual Machine for Zero-Knowledge Executions (Rust)
• best-of-crypto - GitHub - 36% open · ⏱️ 06.05.2024): (Others)

README

        


    





    

    

    

    

    



## Table of Contents

* [1. Overview](#1-overview)

* [2. Build Guide](#2-build-guide)

* [3. Usage Guide](#3-usage-guide)

* [4. Contributors](#4-contributors)

* [5. License](#5-license)

## 1. Overview

|       Package       | Crate.io                                                                         |        `std`       |       `wasm`       |

|:-------------------:|----------------------------------------------------------------------------------|:------------------:|:------------------:|

|       snarkvm       | ![crates.io](https://img.shields.io/crates/v/snarkvm.svg?color=neon)             | :white_check_mark: | :white_check_mark: |

| snarkvm-algorithms  | ![crates.io](https://img.shields.io/crates/v/snarkvm-algorithms.svg?color=neon)  | :white_check_mark: | :white_check_mark: |

|   snarkvm-circuit   | ![crates.io](https://img.shields.io/crates/v/snarkvm-circuit.svg?color=neon)     | :white_check_mark: | :white_check_mark: |

|   snarkvm-console   | ![crates.io](https://img.shields.io/crates/v/snarkvm-console.svg?color=neon)     | :white_check_mark: | :white_check_mark: |

|   snarkvm-curves    | ![crates.io](https://img.shields.io/crates/v/snarkvm-curves.svg?color=neon)      | :white_check_mark: | :white_check_mark: |

|   snarkvm-fields    | ![crates.io](https://img.shields.io/crates/v/snarkvm-fields.svg?color=neon)      | :white_check_mark: | :white_check_mark: |

|   snarkvm-ledger    | ![crates.io](https://img.shields.io/crates/v/snarkvm-ledger.svg?color=neon)      | :white_check_mark: | :white_check_mark: |

| snarkvm-parameters  | ![crates.io](https://img.shields.io/crates/v/snarkvm-parameters.svg?color=neon)  | :white_check_mark: | :white_check_mark: |

| snarkvm-synthesizer | ![crates.io](https://img.shields.io/crates/v/snarkvm-synthesizer.svg?color=neon) | :white_check_mark: | :white_check_mark: |

|  snarkvm-utilities  | ![crates.io](https://img.shields.io/crates/v/snarkvm-utilities.svg?color=neon)   | :white_check_mark: | :white_check_mark: |

|    snarkvm-wasm     | ![crates.io](https://img.shields.io/crates/v/snarkvm-wasm.svg?color=neon)        | :white_check_mark: | :white_check_mark: |

For more information, visit [Welcome to Aleo](https://github.com/AleoHQ/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:

  ```bash

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

  ```

- 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.1 Build from Crates.io

We recommend installing `snarkvm` this way. In your terminal, run:

```bash

cargo install snarkvm

```

Now to use `snarkvm`, in your terminal, run:

```bash

snarkvm

```

### 2.2.2 Build from Source Code

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

```bash

# 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:

```bash

snarkvm

```

## 3. Usage Guide

## 4. Contributors

Thank you for helping make snarkVM better!  

[🧐 What do the emojis mean?](https://allcontributors.org/docs/en/emoji-key)

  

    

      
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](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## 5. License

[![License: GPL v3](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE.md)