Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: readme #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Verifiers for Hylé

This repository contains various programs to verify zero-knowledge proofs within the (Hylé blockchain)[http://github.com/hyle-org/hyle].
This repository contains various programs to verify zero-knowledge proofs within the [Hylé blockchain](http://github.com/hyle-org/hyle).

Structure:
- `hyle-contract` works as a minimal SDK, specifying required outputs for verifying ZK proofs.
- `midenvm-verifier` implements (WIP) a verifier for MASM. See (their doc)[https://0xpolygonmiden.github.io/miden-vm/intro/main.html]
- `midenvm-verifier` implements (WIP) a verifier for MASM. See [their doc](https://0xpolygonmiden.github.io/miden-vm/intro/main.html)
- `noir-verifier` is a verifier for Noir/Barretenberg proofs, most used within the Aztec blockchain.
- `risc0-verifier` is used with RISC zero.
- `sp1-verifier`is used with SP1.
Expand All @@ -19,7 +19,7 @@ Simply run `cargo build --release` within the repository to compile everything

### Typescript

The noir verifier is a typescript project. We recommend using `bun` to run it. Installations instructions (here)[https://bun.sh]
The noir verifier is a typescript project. We recommend using `bun` to run it. Installations instructions [here](https://bun.sh)
There's no need to actually build it, but hylé expects `bun` to be in the path.

## Using within Hylé
Expand Down