Skip to content

Commit

Permalink
added instructions to run examples and tests, noted cargo version issue
Browse files Browse the repository at this point in the history
  • Loading branch information
dibi91 committed Sep 26, 2024
1 parent 7265a6b commit a3ff18d
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,27 @@ let (verifier_solidity, vk_solidity) = generator.render_separately().unwrap();

Check [`examples/separately.rs`](./examples/separately.rs) for more details.

> [!NOTE]
> Currently examples are broken due to a `cargo` update ([rust-lang/rust#123285](https://github.com/rust-lang/rust/issues/123285)), to run them override cargo version:
>
> - Install `1.77.0` version with `rustup`:
>
> ```bash
> rustup install 1.77.0
> ```
>
> - Override cargo version:
>
> ```bash
> rustup override set 1.77.0
> ```
>
> - Run examples:
>
> ```bash
> cargo run --example separately --features=evm
> ```
### Generate verifier and verifying key in a single solidity contract
```rust
Expand All @@ -32,6 +53,29 @@ let calldata = encode_calldata(vk_address, &proof, &instances);

Note that function selector is already included.

## Test

> [!NOTE]
> Currently tests are broken due to a `cargo` update ([rust-lang/rust#123285](https://github.com/rust-lang/rust/issues/123285)), to run them override cargo version:
>
> - Install `1.77.0` version with `rustup`:
>
> ```bash
> rustup install 1.77.0
> ```
>
> - Override cargo version:
>
> ```bash
> rustup override set 1.77.0
> ```
>
> - Run examples:
>
> ```bash
> cargo test
> ```
## Limitations & Caveats
- It only allows circuit with **less or equal than 1 instance column** and **no rotated query to this instance column**.
Expand Down

0 comments on commit a3ff18d

Please sign in to comment.