[develop] Add mina as a git submodule for o1js #1318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…essary compilation of mina directory
…prevent Jest from running tests in this directory
…t tests This change is temporary until 'snarkyjs' is removed from the mina repo.
…om jest tests This change was made because the 'snarkyjs' inside the mina repo has been removed, making the condition unnecessary.
…n and README-dev.md for better clarity and consistency
…directory structure, ensuring correct files are ignored by Prettier
…build scripts - Replace opam with Dune in the list of required tools to reflect changes in the build process - Add a new section about build scripts, explaining the role of update-snarkyjs-bindings.sh - Expand on the OCaml bindings section, detailing the use of Dune and Js_of_ocaml in the build process - Add information about the WebAssembly bindings build process, including the output files - Introduce a section about generated constant types, explaining how they are created and their role in ensuring protocol consistency
Co-authored-by: Gregor Mitscha-Baude <gregor.mitscha-baude@gmx.at>
Co-authored-by: Gregor Mitscha-Baude <gregor.mitscha-baude@gmx.at>
Co-authored-by: Gregor Mitscha-Baude <gregor.mitscha-baude@gmx.at>
…lity and maintainability feat(package.json): add new build commands for bindings, update-bindings, and wasm chore(src/bindings): update subproject commit hash for latest changes
…cript commands for better readability and maintainability
…date functionalities and bug fixes
MartinMinkov
changed the title
This was referenced Dec 13, 2023
mitschabaude
approved these changes
Dec 14, 2023
Co-authored-by: Gregor Mitscha-Baude <gregor.mitscha-baude@gmx.at>
This reverts commit 78452c4.
Trivo25
approved these changes
Dec 16, 2023
|
|
||
| If you need to regenerate the OCaml and WebAssembly artifacts, you can do so within the o1js repo. The [bindings](https://github.com/o1-labs/o1js-bindings) and [Mina](https://github.com/MinaProtocol/mina) repos are both submodules of o1js, so you can build them from within the o1js repo. | ||
|
|
||
| o1js depends on OCaml code that is transpiled to JavaScript using [Js_of_ocaml](https://github.com/ocsigen/js_of_ocaml), and Rust code that is transpiled to WebAssembly using [wasm-pack](https://github.com/rustwasm/wasm-pack). These artifacts allow o1js to call into [Pickles](https://github.com/o1-labs/snarkyhttps://github.com/MinaProtocol/mina/blob/develop/src/lib/pickles/README.md), [snarky](https://github.com/o1-labs/snarky), and [Kimchi](https://github.com/o1-labs/proof-systems) to write zk-SNARKs and zkApps. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Addresses #1096
🔗 Mina: MinaProtocol/mina#14649
🔗 o1js-bindings: o1-labs/o1js-bindings#222
This PR aims to add mina as a submodule of o1js and add support to build everything in the top level directory. To do so, the following changes were made:
src/mina, and target the PR aboveREADME-dev.mdto elaborate on how to build the bindings and give contextual informationpackage-lock.json, modifying some config files, etc.dune-projectfile to let dune build all OCaml dependencies in the current root context.