/ README.md
README.md
1 <p align="center"> 2 <img alt="snarkOS" width="1412" src="https://aleo.org/snarkOS.png"> 3 </p> 4 5 <p align="center"> 6 <a href="https://circleci.com/gh/ProvableHQ/snarkOS"><img src="https://circleci.com/gh/ProvableHQ/snarkOS.svg?style=svg"></a> 7 <a href="https://codecov.io/gh/ProvableHQ/snarkOS"><img src="https://codecov.io/gh/ProvableHQ/snarkOS/branch/master/graph/badge.svg?token=cck8tS9HpO"/></a> 8 <a href="https://discord.gg/aleo"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a> 9 <a href="https://twitter.com/AleoHQ"><img src="https://img.shields.io/twitter/follow/AleoHQ?style=social"/></a> 10 <a href="https://GitHub.com/ProvableHQ/snarkOS"><img src="https://img.shields.io/badge/contributors-59-ee8449"/></a> 11 </p> 12 13 ## <a name='TableofContents'></a>Table of Contents 14 15 * [1. Overview](#1-overview) 16 * [2. Build Guide](#2-build-guide) 17 * [2.1 Requirements](#21-requirements) 18 * [2.2 Installation](#22-installation) 19 * [3. Run an Aleo Node](#3-run-an-aleo-node) 20 * [3.1 Run an Aleo Client](#31-run-an-aleo-client) 21 * [3.2 Run an Aleo Validator](#32-run-an-aleo-validator) 22 * [3.3 Run an Aleo Prover](#33-run-an-aleo-prover) 23 * [4. FAQs](#4-faqs) 24 * [5. Command Line Interface](#5-command-line-interface) 25 * [6. Development Guide](#6-development-guide) 26 * [6.1 Quick Start](#61-quick-start) 27 * [6.2 Operations](#62-operations) 28 * [6.3 Local Devnet](#63-local-devnet) 29 * [6.4 Feature Flags](#64-feature-flags) 30 * [7. Contributors](#7-contributors) 31 * [8. License](#8-license) 32 33 [comment]: <> (* [4. JSON-RPC Interface](#4-json-rpc-interface)) 34 [comment]: <> (* [5. Additional Information](#5-additional-information)) 35 36 ## 1. Overview 37 38 __snarkOS__ is a decentralized operating system for zero-knowledge applications. 39 This code forms the backbone of [Aleo](https://aleo.org/) network, 40 which verifies transactions and stores the encrypted state applications in a publicly-verifiable manner. 41 42 ## 2. Build Guide 43 44 ### 2.1 Definitions 45 46 The following snarkOS node types exist in the Aleo network: 47 - **Validator**: Validator nodes participate in consensus and must be started with an account that is bonded into the committee. 48 - **Client**: Clients do not participate in consensus but maintain a ledger. They are capable of providing information about the network as well as accepting solutions and transactions and communicating them to their peers. All clients run the same software, however, for the purposes of configuration management, this document defines two types of clients: 49 - Core Client: Client node connected directly to a validator node. 50 - Outer Client: Client node connected only to other clients or prover nodes. 51 - **Prover**: Prover nodes are dedicated to solving the Aleo puzzle. They do not participate in consensus or maintain a copy of the ledger. 52 53 ### 2.2 Requirements 54 55 The following are the requirements to run an Aleo node: 56 - **OS**: 64-bit architectures only, latest up-to-date for security 57 - Clients: Ubuntu 22.04 (LTS), macOS Ventura or later, Windows 11 or later 58 - Validators: Ubuntu 22.04 (LTS) 59 - **CPU**: 64-bit architectures only, Latest Intel Xeon or Better 60 - Clients: 24-cores (32-cores or larger preferred) 61 - Validators: 64-cores (128-cores or larger preferred) 62 - **RAM**: DDR4 or better 63 - Clients: 128GiB of memory (192GiB or larger preferred) 64 - Validators: 256GiB of memory (384GiB or larger preferred) 65 - **Storage**: PCIe Gen 3 x4, PCIe Gen 4 x2 NVME SSD, or better 66 - Clients: 2TB of disk space (4TB or larger preferred) 67 - Validators: 4TB of disk space (6TB or larger preferred) 68 - **Network**: Symmetric, commercial, always-on 69 - Clients: 250Mbps of upload **and** download bandwidth 70 - Validators: 500Mbps of upload **and** download bandwidth 71 72 No explicit recommendations are made for proving nodes as proving hardware may be highly variable. If interested in running Aleo Provers nodes, please refer to resources published by the Aleo community. 73 74 ### 2.3 Installation 75 76 Before beginning, please ensure your machine has Rust installed, with at least [this version](rust-toolchain). Instructions to [install Rust can be found here.](https://www.rust-lang.org/tools/install) 77 78 Start by cloning this GitHub repository: 79 ``` 80 git clone --branch mainnet --single-branch https://github.com/ProvableHQ/snarkOS.git 81 ``` 82 83 Next, move into the `snarkOS` directory: 84 ``` 85 cd snarkOS 86 ``` 87 88 **[For Ubuntu users]** A helper script to install dependencies is available. From the `snarkOS` directory, run: 89 ``` 90 ./build_ubuntu.sh 91 ``` 92 93 Lastly, install `snarkOS`: 94 ``` 95 cargo install --locked --path . 96 ``` 97 98 #### Optional: CUDA Acceleration for Provers 99 100 > This CUDA build is optional. The current snarkOS puzzle does not leverage CUDA accelerationβit is a leftover from a previous event, although CUDA may become relevant again with ARC-43. 101 > 102 > The CUDA feature is considered unstable and experimental; expect breaking changes. 103 104 For prover operators who want to experiment with GPU support: 105 ``` 106 cargo install --locked --path . --features cuda 107 ``` 108 109 Please ensure ports `4130/tcp` and `3030/tcp` are open on your router and OS firewall. 110 ### 2.4 Port Configuration 111 112 #### 2.4.1 For Core Clients 113 114 | Port | Protocol | Allow/Deny | Source | Explanation | 115 |----------|----------|------------|------------------------------|------------------------------------------------------------| 116 | 4130/tcp | TCP | Allow | All IPv4/IPv6 | TCP traffic to peers | 117 118 #### 2.4.2 For Outer Clients 119 120 | Port | Protocol | Allow/Deny | Source | Explanation | 121 |----------|----------|------------|------------------------------|------------------------------------------------------------| 122 | 3030/tcp | TCP | Allow | All IPv4/IPv6 | REST server | 123 | 4130/tcp | TCP | Allow | All IPv4/IPv6 | TCP traffic to peers | 124 125 #### 2.4.3 For Validators 126 127 | Port | Protocol | Allow/Deny | Source | Explanation | 128 |----------|----------|------------|------------------------------|------------------------------------------------------------| 129 | 4130/tcp | TCP | Allow | All IPv4/IPv6 | TCP traffic to peers | 130 | 5000/tcp | TCP | Allow | Trusted Validator IPs | TCP traffic between validators for BFT communication | 131 | 3000/tcp | TCP | Allow | Internal VPC or VPN | Metrics dashboard, should only be open within an internal VPC or VPN | 132 | 3030/tcp | TCP | Deny | All IPv4/IPv6 | REST server. This should **always** be disabled for validators | 133 | 9000/tcp | TCP | Allow | Internal VPC or VPN | Metrics export, should only be open within an internal VPC or VPN | 134 | 9090/tcp | TCP | Allow | Internal VPC or VPN | Prometheus metrics, should only be open within an internal VPC or VPN | 135 136 **Note:** Ensure that your open file limit is set to 16,384 or above. 137 For the recommended setting run: 138 ``` 139 # Increase the open file limit for the current user (replace <username> with your username) 140 echo "<username> - nofile 65536" | sudo tee -a /etc/security/limits.conf 141 # Increase the default system open file limit 142 sudo bash -c 'echo "DefaultLimitNOFILE=65536" >> /etc/systemd/system.conf' 143 ``` 144 145 ## 3. Run an Aleo Node 146 147 ## 3.1 Run an Aleo Client 148 149 Start by following the instructions in the [Build Guide](#2-build-guide). 150 The guide below provides information on running `core` and `outer` clients (as defined in Section 2.2.) Aleo community members running validators are recommended to run 1-3 `core` clients as their exclusive client peers. This will ensure network traffic from the public internet is verified prior to reaching the validator. 151 152 Any client **not** connected directly to a validator can be considered an `outer` client. 153 154 ### 3.1.1 Run an Aleo Core Client 155 156 The following command is recommended when starting a client node that is connected to a validator: 157 `snarkos start --client --nodisplay --node 0.0.0.0:4130 --peers "validator_ip:4130,core_client_ip_1:4130,core_client_ip_2:4130,core_client_ip3:4130,outer_client_ip_1:4130,..." --verbosity 1 --norest` 158 159 To start a core client node, you can also run the following command from the `snarkOS` directory: 160 ``` 161 ./scripts/run-core-client.sh 162 ``` 163 164 ### 3.1.2 Run an Aleo Outer Client 165 166 The following command is recommended when starting a client node that is NOT connected to a validator: 167 `snarkos start --client --nodisplay --node 0.0.0.0:4130 --peers "core_client_ip_1:4130,core_client_ip_2:4130,core_client_ip3:4130,outer_client_ip_1:4130,..." --verbosity 1 --rest 0.0.0.0:3030` 168 169 To start an outer client node, you can also run the following command from the `snarkOS` directory: 170 ``` 171 ./scripts/run-outer-client.sh 172 ``` 173 174 Outer clients can be bootstrap clients that serve as accessible entry points for new nodes joining the network with publicly known or static IPs. 175 For bootstrap clients, we also recommend the use of `--rotate-external-peers` to avoid the bootstrap peerlist from filling up. 176 177 ## 3.2 Run an Aleo Validator 178 179 Start by following the instructions in the [Build Guide](#2-build-guide). 180 181 The following command is recommended when starting a validator node: 182 `snarkos start --validator --nodisplay --bft 0.0.0.0:5000 --node 0.0.0.0:4130 --peers "validator_ip_1:4130,validator_ip_2:4130,...,core_client_ip_1:4130,core_client_ip_2:4130,..." --validators "validator_ip_1:5000,validator_ip_2:5000,..." --verbosity 1 --norest --private-key-file ~/snarkOS/privatekey` 183 184 Instead of specifying a private key file (`--private-key-file` flag), the private key can also be defined explicitly (`--private-key` flag). 185 186 To start a validator, you can also run the following command from the `snarkOS` directory: 187 ``` 188 ./scripts/run-validator.sh 189 ``` 190 191 ### 3.2.1 Enable Validator Telemetry Metrics (Optional) 192 193 Validator telemetry allows you to track participation in consensus. This is optional and can be enabled using the `telemetry` feature flag. 194 195 Once enabled, telemetry metrics are available through: 196 197 1. Node logs 198 2. REST API endpoints 199 ``` 200 // GET /{network}/validators/participation 201 // GET /{network}/validators/participation?metadata={true} 202 ``` 203 204 You can enable telemetry in one of the following ways: 205 206 #### 1. Enable via [installation](#2.3-installation) 207 208 Add the `telemetry` feature flag to the installation command. 209 ``` 210 cargo install --locked --path . --features telemetry 211 ``` 212 213 #### 2. Enable via `./run-validator.sh` 214 215 Run the `./scripts/run-validator.sh` script and enable telemetry when prompted: 216 ``` 217 Do you want to enable validator telemetry? (y/n, default: y): 218 ``` 219 220 ## 3.3 Run an Aleo Prover 221 222 Start by following the instructions in the [Build Guide](#2-build-guide). 223 224 Next, generate an Aleo account address: 225 ``` 226 snarkos account new 227 ``` 228 This will output a new Aleo account in the terminal. 229 230 **Please remember to save the account private key and view key.** The following is an example output: 231 ``` 232 Attention - Remember to store this account private key and view key. 233 234 Private Key APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me And Use In The Next Step 235 View Key AViewKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me 236 Address ax1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx <-- Save Me 237 ``` 238 239 Next, to start a proving node, from the `snarkOS` directory, run: 240 ``` 241 ./scripts/run-prover.sh 242 ``` 243 When prompted, enter your Aleo private key: 244 ``` 245 Enter the Aleo Prover account private key: 246 APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 247 ``` 248 249 ## 4. FAQs 250 251 ### 1. My node is unable to compile. 252 253 - Ensure your machine has Rust installed, with at least [this version](rust-toolchain). Instructions to [install Rust can be found here.](https://www.rust-lang.org/tools/install) 254 - If large errors appear during compilation, try running `cargo clean`. 255 - Ensure `snarkOS` is started using `./scripts/run-client.sh` or `./scripts/run-prover.sh`. 256 257 ### 2. My node is unable to connect to peers on the network. 258 259 - Ensure ports `4130/tcp` and `3030/tcp` are open on your router and OS firewall. 260 - Ensure `snarkOS` is started using `./scripts/run-client.sh` or `./scripts/run-prover.sh`. 261 262 ### 3. I can't generate a new address ### 263 264 - Before running the command above (`snarkos account new`) try `source ~/.bashrc` 265 - Also double-check the spelling of `snarkos`. Note the directory is `/snarkOS`, and the command is `snarkos` 266 267 ### 4. How do I use the CLI to sign and verify a message? 268 269 1. Generate an account with `snarkos account new` if you haven't already 270 2. Sign a message with your private key using `snarkos account sign --raw -m "Message" --private-key-file=<PRIVATE_KEY_FILE>` 271 3. Verify your signature with `snarkos account verify --raw -m "Message" -s sign1SignatureHere -a ax1YourAccountAddress` 272 273 Note, using the `--raw` flag with the command will sign plaintext messages as bytes rather than [Aleo values](https://developer.alpha.org/guides/aleo/language#data-types-and-values) such as `1u8` or `100field`. 274 275 276 ## 5. Command Line Interface 277 278 To run a node with custom settings, refer to the options and flags available in the `snarkOS` CLI. 279 280 The full list of CLI flags and options can be viewed with `snarkos --help`: 281 ``` 282 snarkOS 283 The Aleo Team <hello@aleo.org> 284 285 USAGE: 286 snarkos [OPTIONS] <SUBCOMMAND> 287 288 OPTIONS: 289 -h, --help Print help information 290 -v, --verbosity <VERBOSITY> Specify the verbosity [options: 0, 1, 2, 3] [default: 2] 291 292 SUBCOMMANDS: 293 account Commands to manage Aleo accounts 294 clean Cleans the snarkOS node storage 295 help Print this message or the help of the given subcommand(s) 296 start Starts the snarkOS node 297 update Update snarkOS 298 ``` 299 300 The following are the options for the `snarkos start` command: 301 ``` 302 USAGE: 303 snarkos start [OPTIONS] 304 305 OPTIONS: 306 --network <NETWORK_ID> Specify the network ID of this node [default: 3] 307 308 --validator Specify this node as a validator 309 --prover Specify this node as a prover 310 --client Specify this node as a client 311 312 --private-key <PRIVATE_KEY> Specify the node's account private key 313 --private-key-file <PRIVATE_KEY_FILE> Specify the path to a file containing the node's account private key 314 315 --node <IP:PORT> Specify the IP address and port for the node server [default: 0.0.0.0:4130] 316 --connect <IP:PORT> Specify the IP address and port of a peer to connect to 317 318 --rest <REST> Specify the IP address and port for the REST server [default: 0.0.0.0:3030] 319 --norest If the flag is set, the node will not initialize the REST server 320 321 --nodisplay If the flag is set, the node will not render the display 322 --verbosity <VERBOSITY_LEVEL> Specify the verbosity of the node [options: 0, 1, 2, 3] [default: 2] 323 --logfile <PATH> Specify the path to the file where logs will be stored [default: /tmp/snarkos.log] 324 325 --dev <NODE_ID> Enables development mode, specify a unique ID for this node 326 ``` 327 328 ## 6. Development Guide 329 330 ### 6.1 Quick Start 331 332 In the first terminal, start the first validator by running: 333 ``` 334 cargo run --release -- start --nodisplay --dev 0 --validator 335 ``` 336 In the second terminal, start the second validator by running: 337 ``` 338 cargo run --release -- start --nodisplay --dev 1 --validator 339 ``` 340 In the third terminal, start the third validator by running: 341 ``` 342 cargo run --release -- start --nodisplay --dev 2 --validator 343 ``` 344 In the fourth terminal, start the fourth validator by running: 345 ``` 346 cargo run --release -- start --nodisplay --dev 3 --validator 347 ``` 348 349 From here, this procedure can be used to further start-up provers and clients. 350 351 ### 6.2 Operations 352 353 It is important to initialize the nodes starting from `0` and incrementing by `1` for each new node. 354 355 The following is a list of options to initialize a node (replace `<NODE_ID>` with a number starting from `0`): 356 ``` 357 cargo run --release -- start --nodisplay --dev <NODE_ID> --validator 358 cargo run --release -- start --nodisplay --dev <NODE_ID> --prover 359 cargo run --release -- start --nodisplay --dev <NODE_ID> --client 360 cargo run --release -- start --nodisplay --dev <NODE_ID> 361 ``` 362 363 When no node type is specified, the node will default to `--client`. 364 365 ### 6.3 Local Devnet 366 367 #### 6.3.1 Install `tmux` 368 369 To run a local devnet with the script, start by installing `tmux`. 370 371 <details><summary>macOS</summary> 372 373 To install `tmux` on macOS, you can use the `Homebrew` package manager. 374 If you haven't installed `Homebrew` yet, you can find instructions at [their website](https://brew.sh/). 375 ```bash 376 # Once Homebrew is installed, run: 377 brew install tmux 378 ``` 379 380 </details> 381 382 <details><summary>Ubuntu</summary> 383 384 On Ubuntu and other Debian-based systems, you can use the `apt` package manager: 385 ```bash 386 sudo apt update 387 sudo apt install tmux 388 ``` 389 390 </details> 391 392 <details><summary>Windows</summary> 393 394 There are a couple of ways to use `tmux` on Windows: 395 396 ### Using Windows Subsystem for Linux (WSL) 397 398 1. First, install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install). 399 2. Once WSL is set up and you have a Linux distribution installed (e.g., Ubuntu), open your WSL terminal and install `tmux` as you would on a native Linux system: 400 ```bash 401 sudo apt update 402 sudo apt install tmux 403 ``` 404 405 </details> 406 407 #### 6.3.2 Start a Local Devnet 408 409 To start a local devnet, run: 410 ``` 411 ./scripts/devnet.sh 412 ``` 413 Follow the instructions in the terminal to start the devnet. 414 415 #### 6.3.3 View a Local Devnet 416 417 #### Switch Nodes (forward) 418 419 To toggle to the next node in a local devnet, run: 420 ``` 421 Ctrl+b n 422 ``` 423 424 #### Switch Nodes (backwards) 425 426 To toggle to the previous node in a local devnet, run: 427 ``` 428 Ctrl+b p 429 ``` 430 431 #### Select a Node (choose-tree) 432 433 To select a node in a local devnet, run: 434 ``` 435 Ctrl+b w 436 ``` 437 438 #### Select a Node (manually) 439 440 To select a node manually in a local devnet, run: 441 ``` 442 Ctrl+b :select-window -t {NODE_ID} 443 ``` 444 445 #### 6.3.4 Stop a Local Devnet 446 447 To stop a local devnet, run: 448 ``` 449 Ctrl+b :kill-session 450 ``` 451 Then, press `Enter`. 452 453 ### Clean Up 454 455 To clean up the node storage, run: 456 ``` 457 cargo run --release -- clean --dev <NODE_ID> 458 ``` 459 460 ## 6.4 Feature Flags 461 462 By default, the metrics feature is turned on for some internal crates. 463 464 * **history** - 465 Enables a /history REST endpoint. 466 * **telemetry** - 467 Allows the node to upload telemetry data. 468 * **cuda** - 469 Allows some operations to run on the (NVidia) GPU, instead of on the CPU. See [CUDA acceleration for provers](#optional-cuda-acceleration-for-provers) for install tips and current puzzle status. 470 * **locktick** - 471 This feature turns on code for detecting deadlocks. 472 * **test_targets** - 473 This feature allows the lowering of coinbase and proof targets for testing. 474 475 ## 6.5 Local backups 476 477 The snarkOS node implementation uses rocksdb under the hood. By using its native checkpointing mechanism, you can create backups locally and efficiently. The backups leverage hard links on your filesystem, thereby incurring only a marginal amount of extra space. The aim of these local backups is for you to be able to recover quickly in case your node were to halt. 478 479 You can find a basic sample script in `scripts/backup.sh` which you can run as a cron-job e.g. every minute. Each run of the script creates a new backup folder with a timestamp postfix. It will ensure a backup is kept which is 1 minute old, 5 minutes old, 1 hour old and 1 day old. In more detail, on each run it will: 480 - always overwrite the latest backup 481 - only overwrite the 5 minute backup if it is older than 5 minutes 482 - only overwrite the 1 hour backup if it is older than 1 hour 483 - only overwrite the 1 day backup if it is older than 1 day 484 485 You may want to change the `NETWORK`, `BASE_DIR`, `ENDPOINT` and `JWT` variables. 486 487 ## 7. Contributors 488 Thank you for helping make snarkOS better! 489 [π§ What do the emojis mean?](https://allcontributors.org/docs/en/emoji-key) 490 491 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> 492 <!-- prettier-ignore-start --> 493 <!-- markdownlint-disable --> 494 <table> 495 <tbody> 496 <tr> 497 <td align="center" valign="top" width="14.28%"><a href="https://github.com/howardwu"><img src="https://avatars.githubusercontent.com/u/9260812?v=4?s=100" width="100px;" alt="Howard Wu"/><br /><sub><b>Howard Wu</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=howardwu" title="Code">π»</a> <a href="#maintenance-howardwu" title="Maintenance">π§</a> <a href="#ideas-howardwu" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/ProvableHQ/snarkOS/pulls?q=is%3Apr+reviewed-by%3Ahowardwu" title="Reviewed Pull Requests">π</a></td> 498 <td align="center" valign="top" width="14.28%"><a href="https://github.com/raychu86"><img src="https://avatars.githubusercontent.com/u/14917648?v=4?s=100" width="100px;" alt="Raymond Chu"/><br /><sub><b>Raymond Chu</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=raychu86" title="Code">π»</a> <a href="#maintenance-raychu86" title="Maintenance">π§</a> <a href="#ideas-raychu86" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/ProvableHQ/snarkOS/pulls?q=is%3Apr+reviewed-by%3Araychu86" title="Reviewed Pull Requests">π</a></td> 499 <td align="center" valign="top" width="14.28%"><a href="https://github.com/ljedrz"><img src="https://avatars.githubusercontent.com/u/3750347?v=4?s=100" width="100px;" alt="ljedrz"/><br /><sub><b>ljedrz</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=ljedrz" title="Code">π»</a> <a href="#maintenance-ljedrz" title="Maintenance">π§</a> <a href="#ideas-ljedrz" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/ProvableHQ/snarkOS/pulls?q=is%3Apr+reviewed-by%3Aljedrz" title="Reviewed Pull Requests">π</a></td> 500 <td align="center" valign="top" width="14.28%"><a href="https://github.com/niklaslong"><img src="https://avatars.githubusercontent.com/u/13221615?v=4?s=100" width="100px;" alt="Niklas Long"/><br /><sub><b>Niklas Long</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=niklaslong" title="Code">π»</a> <a href="#maintenance-niklaslong" title="Maintenance">π§</a> <a href="#ideas-niklaslong" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/ProvableHQ/snarkOS/pulls?q=is%3Apr+reviewed-by%3Aniklaslong" title="Reviewed Pull Requests">π</a></td> 501 <td align="center" valign="top" width="14.28%"><a href="https://github.com/collinc97"><img src="https://avatars.githubusercontent.com/u/16715212?v=4?s=100" width="100px;" alt="Collin Chin"/><br /><sub><b>Collin Chin</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=collinc97" title="Code">π»</a> <a href="https://github.com/ProvableHQ/snarkOS/commits?author=collinc97" title="Documentation">π</a> <a href="https://github.com/ProvableHQ/snarkOS/pulls?q=is%3Apr+reviewed-by%3Acollinc97" title="Reviewed Pull Requests">π</a></td> 502 <td align="center" valign="top" width="14.28%"><a href="https://github.com/iamalwaysuncomfortable"><img src="https://avatars.githubusercontent.com/u/26438809?v=4?s=100" width="100px;" alt="Mike Turner"/><br /><sub><b>Mike Turner</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=iamalwaysuncomfortable" title="Code">π»</a> <a href="https://github.com/ProvableHQ/snarkOS/commits?author=iamalwaysuncomfortable" title="Documentation">π</a> <a href="https://github.com/ProvableHQ/snarkOS/pulls?q=is%3Apr+reviewed-by%3Aiamalwaysuncomfortable" title="Reviewed Pull Requests">π</a></td> 503 <td align="center" valign="top" width="14.28%"><a href="https://gakonst.com/"><img src="https://avatars.githubusercontent.com/u/17802178?v=4?s=100" width="100px;" alt="Georgios Konstantopoulos"/><br /><sub><b>Georgios Konstantopoulos</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=gakonst" title="Code">π»</a></td> 504 </tr> 505 <tr> 506 <td align="center" valign="top" width="14.28%"><a href="https://github.com/kobigurk"><img src="https://avatars.githubusercontent.com/u/3520024?v=4?s=100" width="100px;" alt="Kobi Gurkan"/><br /><sub><b>Kobi Gurkan</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=kobigurk" title="Code">π»</a></td> 507 <td align="center" valign="top" width="14.28%"><a href="https://github.com/vvp"><img src="https://avatars.githubusercontent.com/u/700877?v=4?s=100" width="100px;" alt="Vesa-Ville"/><br /><sub><b>Vesa-Ville</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=vvp" title="Code">π»</a></td> 508 <td align="center" valign="top" width="14.28%"><a href="https://github.com/jules"><img src="https://avatars.githubusercontent.com/u/30194392?v=4?s=100" width="100px;" alt="jules"/><br /><sub><b>jules</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=jules" title="Code">π»</a></td> 509 <td align="center" valign="top" width="14.28%"><a href="https://github.com/daniilr"><img src="https://avatars.githubusercontent.com/u/1212355?v=4?s=100" width="100px;" alt="Daniil"/><br /><sub><b>Daniil</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=daniilr" title="Code">π»</a></td> 510 <td align="center" valign="top" width="14.28%"><a href="https://github.com/akattis"><img src="https://avatars.githubusercontent.com/u/4978114?v=4?s=100" width="100px;" alt="akattis"/><br /><sub><b>akattis</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=akattis" title="Code">π»</a></td> 511 <td align="center" valign="top" width="14.28%"><a href="https://github.com/wcannon"><img src="https://avatars.githubusercontent.com/u/910589?v=4?s=100" width="100px;" alt="William Cannon"/><br /><sub><b>William Cannon</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=wcannon" title="Code">π»</a></td> 512 <td align="center" valign="top" width="14.28%"><a href="https://github.com/wcannon-aleo"><img src="https://avatars.githubusercontent.com/u/93155840?v=4?s=100" width="100px;" alt="wcannon-aleo"/><br /><sub><b>wcannon-aleo</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=wcannon-aleo" title="Code">π»</a></td> 513 </tr> 514 <tr> 515 <td align="center" valign="top" width="14.28%"><a href="https://github.com/sadroeck"><img src="https://avatars.githubusercontent.com/u/31270289?v=4?s=100" width="100px;" alt="Sam De Roeck"/><br /><sub><b>Sam De Roeck</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=sadroeck" title="Code">π»</a></td> 516 <td align="center" valign="top" width="14.28%"><a href="https://github.com/soft2dev"><img src="https://avatars.githubusercontent.com/u/35427355?v=4?s=100" width="100px;" alt="soft2dev"/><br /><sub><b>soft2dev</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=soft2dev" title="Code">π»</a></td> 517 <td align="center" valign="top" width="14.28%"><a href="https://github.com/amousa11"><img src="https://avatars.githubusercontent.com/u/12452142?v=4?s=100" width="100px;" alt="Ali Mousa"/><br /><sub><b>Ali Mousa</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=amousa11" title="Code">π»</a></td> 518 <td align="center" valign="top" width="14.28%"><a href="https://pyk.sh/"><img src="https://avatars.githubusercontent.com/u/2213646?v=4?s=100" width="100px;" alt="pyk"/><br /><sub><b>pyk</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=pyk" title="Code">π»</a></td> 519 <td align="center" valign="top" width="14.28%"><a href="https://github.com/whalelephant"><img src="https://avatars.githubusercontent.com/u/18553484?v=4?s=100" width="100px;" alt="Belsy"/><br /><sub><b>Belsy</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=whalelephant" title="Code">π»</a></td> 520 <td align="center" valign="top" width="14.28%"><a href="https://github.com/apruden2008"><img src="https://avatars.githubusercontent.com/u/39969542?v=4?s=100" width="100px;" alt="apruden2008"/><br /><sub><b>apruden2008</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=apruden2008" title="Code">π»</a></td> 521 <td align="center" valign="top" width="14.28%"><a href="https://stackoverflow.com/story/fabianoprestes"><img src="https://avatars.githubusercontent.com/u/976612?v=4?s=100" width="100px;" alt="Fabiano Prestes"/><br /><sub><b>Fabiano Prestes</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=zosorock" title="Code">π»</a></td> 522 </tr> 523 <tr> 524 <td align="center" valign="top" width="14.28%"><a href="https://github.com/HarukaMa"><img src="https://avatars.githubusercontent.com/u/861659?v=4?s=100" width="100px;" alt="Haruka"/><br /><sub><b>Haruka</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=HarukaMa" title="Code">π»</a></td> 525 <td align="center" valign="top" width="14.28%"><a href="https://github.com/e4m7he6g"><img src="https://avatars.githubusercontent.com/u/95574065?v=4?s=100" width="100px;" alt="e4m7he6g"/><br /><sub><b>e4m7he6g</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=e4m7he6g" title="Code">π»</a></td> 526 <td align="center" valign="top" width="14.28%"><a href="https://github.com/w4ll3"><img src="https://avatars.githubusercontent.com/u/8595904?v=4?s=100" width="100px;" alt="GregΓ³rio Granado MagalhΓ£es"/><br /><sub><b>GregΓ³rio Granado MagalhΓ£es</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=w4ll3" title="Code">π»</a></td> 527 <td align="center" valign="top" width="14.28%"><a href="https://stake.nodes.guru/"><img src="https://avatars.githubusercontent.com/u/44749897?v=4?s=100" width="100px;" alt="Evgeny Garanin"/><br /><sub><b>Evgeny Garanin</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=evgeny-garanin" title="Code">π»</a></td> 528 <td align="center" valign="top" width="14.28%"><a href="https://github.com/macro-ss"><img src="https://avatars.githubusercontent.com/u/59944291?v=4?s=100" width="100px;" alt="Macro Hoober"/><br /><sub><b>Macro Hoober</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=macro-ss" title="Code">π»</a></td> 529 <td align="center" valign="top" width="14.28%"><a href="https://github.com/code-pangolin"><img src="https://avatars.githubusercontent.com/u/89436546?v=4?s=100" width="100px;" alt="code-pangolin"/><br /><sub><b>code-pangolin</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=code-pangolin" title="Code">π»</a></td> 530 <td align="center" valign="top" width="14.28%"><a href="https://github.com/kaola526"><img src="https://avatars.githubusercontent.com/u/88829586?v=4?s=100" width="100px;" alt="kaola526"/><br /><sub><b>kaola526</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=kaola526" title="Code">π»</a></td> 531 </tr> 532 <tr> 533 <td align="center" valign="top" width="14.28%"><a href="https://github.com/clarenous"><img src="https://avatars.githubusercontent.com/u/18611530?v=4?s=100" width="100px;" alt="clarenous"/><br /><sub><b>clarenous</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=clarenous" title="Code">π»</a></td> 534 <td align="center" valign="top" width="14.28%"><a href="https://github.com/unordered-set"><img src="https://avatars.githubusercontent.com/u/78592281?v=4?s=100" width="100px;" alt="Kostyan"/><br /><sub><b>Kostyan</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=unordered-set" title="Code">π»</a></td> 535 <td align="center" valign="top" width="14.28%"><a href="https://github.com/austinabell"><img src="https://avatars.githubusercontent.com/u/24993711?v=4?s=100" width="100px;" alt="Austin Abell"/><br /><sub><b>Austin Abell</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=austinabell" title="Code">π»</a></td> 536 <td align="center" valign="top" width="14.28%"><a href="https://github.com/yelhousni"><img src="https://avatars.githubusercontent.com/u/16170090?v=4?s=100" width="100px;" alt="Youssef El Housni"/><br /><sub><b>Youssef El Housni</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=yelhousni" title="Code">π»</a></td> 537 <td align="center" valign="top" width="14.28%"><a href="https://github.com/ghostant-1017"><img src="https://avatars.githubusercontent.com/u/53888545?v=4?s=100" width="100px;" alt="ghostant-1017"/><br /><sub><b>ghostant-1017</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=ghostant-1017" title="Code">π»</a></td> 538 <td align="center" valign="top" width="14.28%"><a href="https://pencil.li/"><img src="https://avatars.githubusercontent.com/u/5947268?v=4?s=100" width="100px;" alt="Miguel Gargallo"/><br /><sub><b>Miguel Gargallo</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=miguelgargallo" title="Code">π»</a></td> 539 <td align="center" valign="top" width="14.28%"><a href="https://github.com/wang384670111"><img src="https://avatars.githubusercontent.com/u/78151109?v=4?s=100" width="100px;" alt="Chines Wang"/><br /><sub><b>Chines Wang</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=wang384670111" title="Code">π»</a></td> 540 </tr> 541 <tr> 542 <td align="center" valign="top" width="14.28%"><a href="https://github.com/ayushgw"><img src="https://avatars.githubusercontent.com/u/14152340?v=4?s=100" width="100px;" alt="Ayush Goswami"/><br /><sub><b>Ayush Goswami</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=ayushgw" title="Code">π»</a></td> 543 <td align="center" valign="top" width="14.28%"><a href="https://github.com/timsmith1337"><img src="https://avatars.githubusercontent.com/u/77958700?v=4?s=100" width="100px;" alt="Tim - o2Stake"/><br /><sub><b>Tim - o2Stake</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=timsmith1337" title="Code">π»</a></td> 544 <td align="center" valign="top" width="14.28%"><a href="https://github.com/liusen-adalab"><img src="https://avatars.githubusercontent.com/u/74092505?v=4?s=100" width="100px;" alt="liu-sen"/><br /><sub><b>liu-sen</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=liusen-adalab" title="Code">π»</a></td> 545 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Pa1amar"><img src="https://avatars.githubusercontent.com/u/20955327?v=4?s=100" width="100px;" alt="Palamar"/><br /><sub><b>Palamar</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=Pa1amar" title="Code">π»</a></td> 546 <td align="center" valign="top" width="14.28%"><a href="https://github.com/swift-mx"><img src="https://avatars.githubusercontent.com/u/80231732?v=4?s=100" width="100px;" alt="swift-mx"/><br /><sub><b>swift-mx</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=swift-mx" title="Code">π»</a></td> 547 <td align="center" valign="top" width="14.28%"><a href="https://github.com/dtynn"><img src="https://avatars.githubusercontent.com/u/1426666?v=4?s=100" width="100px;" alt="Caesar Wang"/><br /><sub><b>Caesar Wang</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=dtynn" title="Code">π»</a></td> 548 <td align="center" valign="top" width="14.28%"><a href="https://github.com/paulip1792"><img src="https://avatars.githubusercontent.com/u/52645166?v=4?s=100" width="100px;" alt="Paul IP"/><br /><sub><b>Paul IP</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=paulip1792" title="Code">π»</a></td> 549 </tr> 550 <tr> 551 <td align="center" valign="top" width="14.28%"><a href="https://philipglazman.com/"><img src="https://avatars.githubusercontent.com/u/8378656?v=4?s=100" width="100px;" alt="Philip Glazman"/><br /><sub><b>Philip Glazman</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=philipglazman" title="Code">π»</a></td> 552 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Avadon"><img src="https://avatars.githubusercontent.com/u/404177?v=4?s=100" width="100px;" alt="Ruslan Nigmatulin"/><br /><sub><b>Ruslan Nigmatulin</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=Avadon" title="Code">π»</a></td> 553 <td align="center" valign="top" width="14.28%"><a href="https://www.garillot.net/"><img src="https://avatars.githubusercontent.com/u/4142?v=4?s=100" width="100px;" alt="FranΓ§ois Garillot"/><br /><sub><b>FranΓ§ois Garillot</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=huitseeker" title="Code">π»</a></td> 554 <td align="center" valign="top" width="14.28%"><a href="https://github.com/aolcr"><img src="https://avatars.githubusercontent.com/u/67066732?v=4?s=100" width="100px;" alt="aolcr"/><br /><sub><b>aolcr</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=aolcr" title="Code">π»</a></td> 555 <td align="center" valign="top" width="14.28%"><a href="https://github.com/zvolin"><img src="https://avatars.githubusercontent.com/u/34972409?v=4?s=100" width="100px;" alt="Maciej ZwoliΕski"/><br /><sub><b>Maciej ZwoliΕski</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=zvolin" title="Code">π»</a></td> 556 <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/ignacio-avecilla-39386a191/"><img src="https://avatars.githubusercontent.com/u/63374472?v=4?s=100" width="100px;" alt="Nacho Avecilla"/><br /><sub><b>Nacho Avecilla</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=IAvecilla" title="Code">π»</a></td> 557 <td align="center" valign="top" width="14.28%"><a href="https://github.com/Protryon"><img src="https://avatars.githubusercontent.com/u/8600837?v=4?s=100" width="100px;" alt="Max Bruce"/><br /><sub><b>Max Bruce</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=Protryon" title="Code">π»</a></td> 558 </tr> 559 <tr> 560 <td align="center" valign="top" width="14.28%"><a href="https://github.com/whalelephant"><img src="https://avatars.githubusercontent.com/u/18553484?v=4?s=100" width="100px;" alt="whalelephant"/><br /><sub><b>Belsy</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=whalelephant" title="Code">π»</a></td> 561 <td align="center" valign="top" width="14.28%"><a href="https://github.com/tranhoaison"><img src="https://avatars.githubusercontent.com/u/31094102?v=4?s=100" width="100px;" alt="tranhoaison"/><br /><sub><b>Santala</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=tranhoaison" title="Code">π»</a></td> 562 <td align="center" valign="top" width="14.28%"><a href="https://github.com/web3deadline"><img src="https://avatars.githubusercontent.com/u/89900222?v=4?s=100" width="100px;" alt="web3deadline"/><br /><sub><b>deadline</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=web3deadline" title="Code">π»</a></td> 563 <td align="center" valign="top" width="14.28%"><a href="https://github.com/CedricYanYuhui"><img src="https://avatars.githubusercontent.com/u/136431832?v=4?s=100" width="100px;" alt="CedricYanYuhui"/><br /><sub><b>CedricYanYuhui</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=CedricYanYuhui" title="Code">π»</a></td> 564 <td align="center" valign="top" width="14.28%"><a href="https://github.com/craigjson"><img src="https://avatars.githubusercontent.com/u/16459396?v=4?s=100" width="100px;" alt="craigjson"/><br /><sub><b>Craig Johnson</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=craigjson" title="Code">π»</a></td> 565 <td align="center" valign="top" width="14.28%"><a href="https://github.com/vbar"><img src="https://avatars.githubusercontent.com/u/108574?v=4?s=100" width="100px;" alt="vbar"/><br /><sub><b>Vaclav Barta</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=vbar" title="Code">π»</a></td> 566 <td align="center" valign="top" width="14.28%"><a href="https://github.com/features/security"><img src="https://avatars.githubusercontent.com/u/27347476?v=4?s=100" width="100px;" alt="Dependabot"/><br /><sub><b>Dependabot</b></sub></a><br /><a href="https://github.com/ProvableHQ/snarkOS/commits?author=dependabot" title="Code">π»</a></td> 567 </tr> 568 </tbody> 569 <tfoot> 570 <tr> 571 <td align="center" size="13px" colspan="7"> 572 <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg"> 573 <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a> 574 </img> 575 </td> 576 </tr> 577 </tfoot> 578 </table> 579 580 <!-- markdownlint-restore --> 581 <!-- prettier-ignore-end --> 582 583 <!-- ALL-CONTRIBUTORS-LIST:END --> 584 585 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! 586 587 ## 8. License 588 589 We welcome all contributions to `snarkOS`. Please refer to the [license](#7-license) for the terms of contributions. 590 591 [](./LICENSE.md)