diff --git a/README.md b/README.md index a679958d..9313f5dd 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,35 @@ -# Starkyx +# StarkyX Curta type I-CnAM 40092-IMG 6721-white - ## 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 \ No newline at end of file + +StarkyX starks can be integrated into a [Plonky2](https://github.com/mir-protocol/plonky2) circuit