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.

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

[easy] re-export crates being used in Kimchi #619

Merged
merged 23 commits into from
Jun 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@ You can read more about this project on the [Kimchi book](https://o1-labs.github

[See here for the rust documentation](https://o1-labs.github.io/proof-systems/rustdoc).

# Kombucha

This repository contains **kombucha**, the Kimchi circuit constructor for external users.

## Guidelines

When using this library, make sure to include in your Cargo.toml the following dependency:

```toml
[dependencies]
circuit-construction = { git = "https://github.com/o1-labs/proof-systems" }
```

## Example

The following is an example to demonstrate a full cycle workflow using circuit-construction:
Expand Down
6 changes: 6 additions & 0 deletions cairo/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,9 @@ pub mod helper;
pub mod memory;
pub mod runner;
pub mod word;

pub use self::{
memory::CairoMemory,
runner::{CairoInstruction, CairoProgram, Pointers},
word::{FlagBits, Offsets},
};
1 change: 1 addition & 0 deletions kimchi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,4 @@ To obtain a flamegraph:
the [binary](src/bin/flamegraph.rs) will run forever, so you have to C-c to exit and produce the `flamegraph.svg` file.

Note: lots of good advice on system performance in the [flamegraph repo](https://github.com/flamegraph-rs/flamegraph#systems-performance-work-guided-by-flamegraphs).

7 changes: 7 additions & 0 deletions kimchi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
#[macro_use]
extern crate num_derive;

pub use cairo;
pub use commitment_dlog;
pub use groupmap;
pub use mina_curves;
pub use o1_utils;
pub use oracle;

pub mod alphas;
pub mod bench;
pub mod circuits;
Expand Down
2 changes: 1 addition & 1 deletion kimchi/src/tests/turshi.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use crate::circuits::gate::CircuitGate;
use crate::circuits::polynomials::turshi::{testing::*, witness::*};
use cairo::{memory::CairoMemory, runner::CairoProgram};
use cairo::{CairoMemory, CairoProgram};
use mina_curves::pasta::fp::Fp as F;

#[test]
Expand Down