Merge pull request #417 from o1-labs/release/0.6.0

0.6.0

.github/workflows/build-action.yml

@@ -15,19 +15,17 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
-
-      - name: Setup node
+      - name: Setup Node
         uses: actions/setup-node@v2
         with:
-          node-version: '16'
-
-      - name: run build:node & tests
+          node-version: "18"
+      - name: Build SnarkyJS and Execute Tests
         run: |
           npm ci
           npm run build:node
+          npm run test:unit
           npm run test
           npm run test:integration
-
       - name: Publish to NPM if version has changed
         uses: JS-DevTools/npm-publish@v1
         if: github.ref == 'refs/heads/releases'
@@ -36,18 +34,29 @@ jobs:
         env:
           INPUT_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-  Build-Web:
+  Build-And-Test-Web:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
-
-      - name: Setup node
+      - name: Setup Node
         uses: actions/setup-node@v2
         with:
-          node-version: '16'
-
-      - name: run build:web
+          node-version: "18"
+      - name: Install Node Dependencies
+        run: npm ci
+      - name: Install Playwright Browsers
+        run: npm run e2e:install
+      - name: Build SnarkyJS and Prepare the Web Server
         run: |
-          npm ci
           npm run build:web
+          npm run e2e:prepare-server
+      - name: Execute E2E Tests
+        run: npm run test:e2e
+      - name: Upload E2E Test Artifacts
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: e2e-tests-report
+          path: tests/report/
+          retention-days: 30

.github/workflows/doc.yml

@@ -19,7 +19,7 @@ jobs:
       - name: run typedoc
         run: |
           npm ci
-          npx typedoc --tsconfig tsconfig.server.json src/index.ts
+          npx typedoc --tsconfig tsconfig.node.json src/index.ts
 
       - name: deploy
         uses: peaceiris/actions-gh-pages@v3

.gitignore

@@ -2,3 +2,5 @@
 node_modules
 dist/
 o1labs*.tgz
+tests/report/
+tests/test-artifacts/

CHANGELOG.md

@@ -15,12 +15,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     _Security_ in case of vulnerabilities.
  -->
 
-## [Unreleased](https://github.com/o1-labs/snarkyjs/compare/f2ad423...HEAD)
+## [Unreleased](https://github.com/o1-labs/snarkyjs/compare/ba688523...HEAD)
+
+(no unreleased changes yet)
+
+## [0.6.0](https://github.com/o1-labs/snarkyjs/compare/f2ad423...ba688523)
 
 ### Added
 
 - `reducer.getActions` partially implemented for local testing https://github.com/o1-labs/snarkyjs/pull/327
 - `gte` and `assertGte` methods on `UInt32`, `UInt64` https://github.com/o1-labs/snarkyjs/pull/349
+- Return sent transaction `hash` for `RemoteBlockchain` https://github.com/o1-labs/snarkyjs/pull/399
+
+### Changed
+
+- **Breaking change:** Rename the `Party` class to `AccountUpdate`. Also, rename other occurrences of "party" to "account update". https://github.com/o1-labs/snarkyjs/pull/393
+- **Breaking change:** Don't require the account address as input to `SmartContract.compile()`, `SmartContract.digest()` and `SmartContract.analyzeMethods()` https://github.com/o1-labs/snarkyjs/pull/406
+  - This works because the address / public key is now a variable in the method circuit; it used to be a constant
+- **Breaking change:** Move `ZkProgram` to `Experimental.ZkProgram`
 
 ## [0.5.4](https://github.com/o1-labs/snarkyjs/compare/3461333...f2ad423)
 
@@ -77,7 +89,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `CircuitValue.fromObject({ prop1, prop2 })` is a new, better-typed alternative for using the base constructor.
   - Fixed: the overridden constructor is now free to have any argument structure -- previously, arguments had to be the props in their declared order. I.e., the behaviour that's now used by the base constructor used to be forced on all constructors, which is no longer the case.
 - `Mina.transaction` improvements
-  - Support zkApp proofs when there are other parties in the same transaction block https://github.com/o1-labs/snarkyjs/pull/280
+  - Support zkApp proofs when there are other account updates in the same transaction block https://github.com/o1-labs/snarkyjs/pull/280
   - Support multiple independent zkApp proofs in one transaction block https://github.com/o1-labs/snarkyjs/pull/296
 - Add previously unimplemented preconditions, like `this.network.timestamp` https://github.com/o1-labs/snarkyjs/pull/324 https://github.com/MinaProtocol/mina/pull/11577
 - Improve error messages thrown from Wasm, by making Rust's `panic` log to the JS console https://github.com/MinaProtocol/mina/pull/11644

MINA_COMMIT

@@ -1,2 +1,2 @@
 The mina commit used to generate the backends for node and chrome is
-4c810b1ece3a78dffdfddc32bc947bff718c47ec
+778f499316fe439a7a843f91cd3c6e05484b3f7d

README.md

@@ -8,7 +8,7 @@ See [CHANGELOG.md](https://github.com/o1-labs/snarkyjs/blob/main/CHANGELOG.md) f
 
 ## Run examples in Node
 
-```
+```sh
 npm install
 npm run build
 
@@ -17,7 +17,7 @@ npm run build
 
 ## Build and run web version
 
-```
+```sh
 npm install
 npm run build:web
 npm run serve:web
@@ -27,9 +27,30 @@ Then go to `http://localhost:8000/`
 
 ## Run tests
 
-```
-npm run test
-```
+- Unit tests
+
+  ```sh
+  npm run test
+  npm run test:unit
+  ```
+
+- Integration tests
+
+  ```sh
+  npm run test:integration
+  ```
+
+- E2E tests
+
+  ```sh
+  npm install
+  npm run e2e:install
+  npm run build:web
+
+  npm run e2e:prepare-server
+  npm run test:e2e
+  npm run e2e:show-report
+  ```
 
 ## Contributing
 

jest.config.js

@@ -1,6 +1,11 @@
-/** @type {import('@ts-jest/dist/types').InitialOptionsTsJest} */
-module.exports = {
-  preset: 'ts-jest',
+export default {
+  preset: 'ts-jest/presets/js-with-ts',
   testEnvironment: 'node',
-  collectCoverage: false,
+  extensionsToTreatAsEsm: ['.ts'],
+  transformIgnorePatterns: ["node_modules/", "dist/node/"],
+  globals: {
+    'ts-jest': {
+      useESM: true
+    }
+  }
 };