Merge pull request #176 from o1-labs/merge-main-develop

Merge main and adapt TS bindings to develop

Author: mitschabaude

.github/workflows/lint.yaml

@@ -11,12 +11,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Print prettier version
-        uses: creyD/prettier_action@v4.3
-        with:
-          prettier_options: -v
-
-      - name: Prettify code
-        uses: creyD/prettier_action@v4.3
-        with:
-          prettier_options: -c kimchi/js/**/*.js js/**/*.js
+      - name: Run prettier
+        run: |
+          npm init -y
+          npm i prettier
+          npx prettier -c kimchi/js/**/*.js js/**/*.js

LICENSE

@@ -9,8 +9,8 @@ Parameters
 
 Licensor:           O(1) Labs Operating Corporation
 
-Licensed Work:      snarkyjs-bindings, or any subsequent name assigned to this 
-                    Github repository
+Licensed Work:      o1js-bindings, or any subsequent name assigned to this 
+                    GitHub repository
 
 The Licensed Work is (c) 2021 O(1) Labs Operating Corporation
 
@@ -22,11 +22,11 @@ Licensed Work solely for development or use of apps and smart contracts running
 on the Mina Protocol, or any app or smart contract that settles to the Mina 
 Protocol.
 
-2. For the avoidance of doubt, excluding snarkyjs-bindings, SnarkyJS (as 
-implemented in the repository located at https://github.com/o1-labs/snarkyjs), 
-continues to be licensed under Apache 2.0 as shown in the applicable Github 
-repositories. Any use of this snarkyjs-bindings repository, without 
-modification, as a transitive dependency or derivative of the use of SnarkyJS, 
+2. For the avoidance of doubt, excluding o1js-bindings, o1js (as 
+implemented in the repository located at https://github.com/o1-labs/o1js), 
+continues to be licensed under Apache 2.0 as shown in the applicable GitHub 
+repositories. Any use of this o1js-bindings repository, without 
+modification, as a transitive dependency or derivative of the use of o1js, 
 is permitted. Modification of the software in this repository is not permitted 
 unless authorized under the Additional Use Grant #1 set forth above or #3 set 
 forth below.

MINA_COMMIT

@@ -1,2 +1,2 @@
 The mina commit used to generate the backends for node and web is
-0970329c483ad60fa63941e7e9a44b5014849557
+d37338b7f31a70fb81c2b1e9f1759727d8f04b69

README.md

@@ -1,53 +1,55 @@
-# SnarkyJS bindings
+# o1js bindings
 
-This repository collects code needed by [SnarkyJS](https://github.com/o1-labs/snarkyjs) to bind to lower layers of the proof system and the Mina transaction logic, which are written in Rust and OCaml.
+This repository collects code required by [o1js](https://github.com/o1-labs/o1js) to bind to lower layers of the proof system and the Mina transaction logic, which are written in Rust and OCaml.
 
-The repo is included as a git submodule in the [SnarkyJS repo](https://github.com/o1-labs/snarkyjs) under `src/bindings`, and typically used from there.
+The repo is included as a git submodule in the [o1js repo](https://github.com/o1-labs/o1js) under `src/bindings` and is typically used from there.
 
 **Directory structure**
 
-- `/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 SnarkyJS can be done with standard JS tooling and doesn't require setting up the full OCaml/Rust build pipeline.
+- `/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 SnarkyJS. Includes code for setting up workers to support using `rayon` in Rust.
+- `/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.
-- `/lib` - miscellaneous low-level TypeScript which underpins SnarkyJS and provides generic ways to connect with a proof system and blockchain protocol.
-- `/mina-transaction` - TS types and modules which 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 which help auto-generating TypeScript for Mina- and crypto-related types and constants.
-- `/scripts` - scripts which build parts of SnarkyJS from their OCaml and Rust sources, including the contents of `/compiled` and other generated TS files.
+- `/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.
+- `/scripts` - scripts that build parts of o1js from their OCaml and Rust sources, including the contents of `/compiled` and other generated TS files.
 - `MINA_COMMIT` - commit hash pointing to the commit of the [Mina repo](https://github.com/MinaProtocol/mina) that build artifacts in this repo where generated from.
 
-## Building the SnarkyJS bindings
+## Building the o1js bindings
 
-To instrument the scripts and build the SnarkyJS bindings from source, you need to work from the [Mina monorepo](https://github.com/MinaProtocol/mina).
+To instrument the scripts and build the o1js bindings from source, you need to work from the [Mina monorepo](https://github.com/MinaProtocol/mina).
 
-Inside the Mina repo, you'll find the [SnarkyJS repo](https://github.com/o1-labs/snarkyjs) as a git submodule under `src/lib/snarkyjs`. Inside `snarkyjs`, the `snarkyjs-bindings` repo is located at `src/bindings`. To make sure you have all nested submodules checked out, run (from the Mina root):
+Inside the Mina repo, you'll find the [o1js repo](https://github.com/o1-labs/o1js) as a git submodule under `src/lib/snarkyjs`. Inside `o1js`, the `o1js-bindings` repo is located at `src/bindings`. To make sure you have all nested submodules checked out, run (from the Mina root):
 
 ```sh
 git submodule update --init --recursive
 ```
 
-Then, switch to the SnarkyJS root in `src/lib/snarkyjs`. There are two different commands available, `npm run make` and `npm run bindings`, which you need for different purposes:
+Then, switch to the o1js root in `src/lib/snarkyjs`. 
+
+You use these two commands for different purposes:
 
 ```
 npm run make
 ```
 
-This command will
+This command:
 
-- regenerate TS files in the snarkyjs-bindings source tree
-- build the JS/Wasm artifacts for Node.js (also contained in `/compiled/node-bindings`), but only move them to their place in the `snarkyjs/dist/node` folder which is not part of the source tree.
+- Regenerates TS files in the o1js-bindings source tree
+- Builds the JS/Wasm artifacts for Node.js (also contained in `/compiled/node-bindings`), but only moves them to their place in the `o1js/dist/node` folder, which is not part of the source tree.
 
-> ℹ️ Use `npm run make` if you are developing on or testing the OCaml/Rust layers of SnarkyJS, and want to rebuild.
+> ℹ️ Use `npm run make` if you are developing on or testing the OCaml/Rust layers of o1js, and want to rebuild.
 
 ```
 npm run bindings
 ```
 
-This command will
+This command:
 
-- do everything `npm run make` does, plus
-- build the web version of the SnarkyJS bindings, plus
-- place the generated artifacts in the source tree, under `/compiled`
-- update the `MINA_COMMIT` file
+- Does everything `npm run make` does, plus
+- Builds the web version of the o1js bindings, plus
+- Places the generated artifacts in the source tree under `/compiled`
+- Updates the `MINA_COMMIT` file
 
-> ℹ️ Use `npm run bindings` to update the source tree after you have finished a batch of work / a PR which touches the OCaml/Rust layers. SnarkyJS CI depends on these artifacts, so this is a required step before merging such changes.
+> ℹ️ Use `npm run bindings` to update the source tree after you have finished a batch of work / a PR that touches the OCaml/Rust layers. o1js CI depends on these artifacts, so running this command is a required step before you can merge the changes.