-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,35 @@ | ||
# Starkyx | ||
# StarkyX | ||
|
||
<a title="Rama, CC BY-SA 3.0 FR <https://creativecommons.org/licenses/by-sa/3.0/fr/deed.en>, via Wikimedia Commons" href="https://commons.wikimedia.org/wiki/File:Curta_type_I-CnAM_40092-IMG_6721-white.jpg"><img width="256" alt="Curta type I-CnAM 40092-IMG 6721-white" src="https://upload.wikimedia.org/wikipedia/commons/thumb/4/40/Curta_type_I-CnAM_40092-IMG_6721-white.jpg/256px-Curta_type_I-CnAM_40092-IMG_6721-white.jpg"></a> | ||
|
||
|
||
## Introduction | ||
Starkyx is a library for writing AIR constraints with composable and typed constraints. Currently, the main purpose of the library is to prove STARK-based accelerators for [Plonky2](https://github.com/mir-protocol/plonky2) circuits. | ||
|
||
Stark proofs and verification are implemented via [Starky](https://github.com/0xPolygonZero/plonky2/tree/main/starky). This repository contains a modified fork of Starky to enable the support a 1-round AIR with random challenges and using the Starkyx AIR constraints. All the cryptographic primitives are imported from the [Plonky2](https://github.com/mir-protocol/plonky2) proving system. | ||
StarkyX is a library for writing AIR constraints with composable and typed constraints. Currently, the main purpose of the library is to prove STARK-based accelerators for [Plonky2](https://github.com/mir-protocol/plonky2) circuits. | ||
|
||
Stark proofs and verification are implemented via [Starky](https://github.com/0xPolygonZero/plonky2/tree/main/starky). This repository contains a modified fork of Starky to enable the support a 1-round AIR with random challenges and using the StarkyX AIR constraints. All the cryptographic primitives are imported from the [Plonky2](https://github.com/mir-protocol/plonky2) proving system. | ||
|
||
## Building | ||
Starkyx requires the use of the nightly Rust toolchain. To use it by default, run the following command: | ||
|
||
StarkyX requires the use of the nightly Rust toolchain. To use it by default, run the following command: | ||
|
||
```bash | ||
rustup override set nightly | ||
``` | ||
In the root directory of the project. | ||
|
||
In the root directory of the project. | ||
|
||
We recommend running the tests using the `--release` flag, as they are quite slow otherwise. | ||
|
||
```bash | ||
cargo test --release | ||
``` | ||
|
||
## Usage | ||
|
||
## Building an AIR computation using Starkyx | ||
|
||
## Building an AIR computation using StarkyX | ||
|
||
## Creating a STARK proof for an AIR computation | ||
|
||
|
||
## Integrating into a Plonky2 circuit | ||
Starkyx starks can be integrated into a [Plonky2](https://github.com/mir-protocol/plonky2) circuit | ||
|
||
StarkyX starks can be integrated into a [Plonky2](https://github.com/mir-protocol/plonky2) circuit |