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

[develop] Add support to build bindings using mina as a submodule in o1js repo #222

Merged
merged 17 commits into from
Dec 19, 2023
Merged

[develop] Add support to build bindings using mina as a submodule in o1js repo #222

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
0fed0c1
feat: copy config files from mina submodule and change paths
MartinMinkov Sep 28, 2023
775b4e1
fix(test_vectors): update paths to crypto/proof-systems in dump-test-…
MartinMinkov Oct 2, 2023
553b281
fix(build-snarkyjs-web.sh, update-snarkyjs-bindings.sh): change SNARK…
MartinMinkov Oct 27, 2023
0f16715
fix(dump-test-vectors.sh): change 'b10' to 'hex' in cargo run command…
MartinMinkov Oct 27, 2023
a0f12f9
feat(kimchi): remove kimchi, since it's been moved to mina repo
MartinMinkov Nov 14, 2023
e057e6f
feat: support compiling kimchi from mina repo
MartinMinkov Nov 14, 2023
dd3e1ea
fix(CODEOWNERS): remove kimchi directory from CODEOWNERS file as it n…
MartinMinkov Nov 15, 2023
ba45bf4
docs(README.md): remove '/kimchi' directory description as it is no l…
MartinMinkov Dec 13, 2023
a68de0e
feat: fix scripts for o1js building
MartinMinkov Dec 13, 2023
285d40f
fix(lint.yaml): remove kimchi lib
MartinMinkov Dec 13, 2023
cf8d10f
feat(build-snarkyjs-node-artifacts.sh): add dune build command for co…
MartinMinkov Dec 13, 2023
f5fa4ca
feat: fixup bindings to compile with mina submodule in o1js
MartinMinkov Dec 13, 2023
ea3dfed
move /kimchi/{wasm,js} to kimchi_bindings
mitschabaude Dec 19, 2023
887ed48
fix build scripts
mitschabaude Dec 19, 2023
863867b
add script to help with dune build
mitschabaude Dec 19, 2023
605608d
fixup
mitschabaude Dec 19, 2023
039e1a3
update bindings
mitschabaude Dec 19, 2023
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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ The repo is included as a git submodule in the [o1js repo](https://github.com/o1
- `/compiled` - compiled JS and Wasm artifacts produced by `js_of_ocaml` and `wasm-bindgen` from Rust and OCaml source code. We keep these artifacts in the source tree so that developing on o1js can be done with standard JS tooling and doesn't require setting up the full OCaml/Rust build pipeline.
- `/crypto` - pure TS implementations of a subset of the crypto primitives we use, including finite field and elliptic curve arithmetic. This is used by mina-signer (a pure TS package) to hash and sign transactions.
- `/js` - JS-side wrappers for the artifacts located in `/compiled`, which differs between the Node.js and web versions of o1js. Includes code for setting up workers to support using `rayon` in Rust.
- `/kimchi` - bindings to the [Kimchi proof system](https://o1-labs.github.io/proof-systems/kimchi/overview.html) which is implemented in Rust. This contains a Wasm compatibility layer written in Rust as well as a `js_of_ocaml`-to-`wasm-bindgen` glue layer written in JS.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More changes have to be made in this file I think, for instance the build instructions.

- `/lib` - miscellaneous low-level TypeScript, which underpins o1js and provides generic ways to connect with a proof system and blockchain protocol.
- `/mina-transaction` - TS types and modules that specialize the generic tooling in `/lib` to Mina's zkApp protocol; mostly auto-generated from OCaml.
- `/ocaml` - OCaml library exposing Snarky, Pickles and parts of the Mina transaction logic to JS. Also, OCaml scripts that help auto-generate TypeScript for Mina- and crypto-related types and constants.
Expand Down