Skip to content

Commit fd78585

Browse files
authored
Merge pull request #619 from o1-labs/api/reexport
[easy] re-export crates being used in Kimchi
2 parents 5744d14 + 675dfbf commit fd78585

File tree

5 files changed

+28
-1
lines changed

5 files changed

+28
-1
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ You can read more about this project on the [Kimchi book](https://o1-labs.github
99

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

12+
# Kombucha
13+
14+
This repository contains **kombucha**, the Kimchi circuit constructor for external users.
15+
16+
## Guidelines
17+
18+
When using this library, make sure to include in your Cargo.toml the following dependency:
19+
20+
```toml
21+
[dependencies]
22+
circuit-construction = { git = "https://github.com/o1-labs/proof-systems" }
23+
```
24+
1225
## Example
1326

1427
The following is an example to demonstrate a full cycle workflow using circuit-construction:

cairo/src/lib.rs

+6
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,9 @@ pub mod helper;
99
pub mod memory;
1010
pub mod runner;
1111
pub mod word;
12+
13+
pub use self::{
14+
memory::CairoMemory,
15+
runner::{CairoInstruction, CairoProgram, Pointers},
16+
word::{FlagBits, Offsets},
17+
};

kimchi/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,4 @@ To obtain a flamegraph:
5353
the [binary](src/bin/flamegraph.rs) will run forever, so you have to C-c to exit and produce the `flamegraph.svg` file.
5454

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

kimchi/src/lib.rs

+7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
#[macro_use]
44
extern crate num_derive;
55

6+
pub use cairo;
7+
pub use commitment_dlog;
8+
pub use groupmap;
9+
pub use mina_curves;
10+
pub use o1_utils;
11+
pub use oracle;
12+
613
pub mod alphas;
714
pub mod bench;
815
pub mod circuits;

kimchi/src/tests/turshi.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::circuits::gate::CircuitGate;
22
use crate::circuits::polynomials::turshi::{testing::*, witness::*};
3-
use cairo::{memory::CairoMemory, runner::CairoProgram};
3+
use cairo::{CairoMemory, CairoProgram};
44
use mina_curves::pasta::fp::Fp as F;
55

66
#[test]

0 commit comments

Comments
 (0)