Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aleonet/snarkvm

A Virtual Machine for Zero-Knowledge Executions
https://github.com/aleonet/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/aleonet/snarkvm
Owner: AleoNet
License: apache-2.0
Created: 2020-03-14T05:13:57.000Z (almost 5 years ago)
Default Branch: staging
Last Pushed: 2024-10-26T21:02:51.000Z (3 months ago)
Last Synced: 2024-10-29T15:32:52.856Z (3 months ago)
Topics: aleo, blockchain, cryptography, rust, zero-knowledge, zkp
Language: Rust
Homepage: https://snarkvm.org
Size: 269 MB
Stars: 1,070
Watchers: 50
Forks: 1,497
Open Issues: 121
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md

Awesome Lists containing this project

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

  ```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 --branch mainnet --single-branch https://github.com/AleoNet/snarkVM.git 

cd snarkVM

git checkout tags/testnet-beta

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