0.7.0

.github/workflows/build-action.yml

@@ -8,17 +8,19 @@ on:
     branches:
       - main
       - releases
+  workflow_dispatch: {}
 
 jobs:
   Build-And-Test-Server:
+    timeout-minutes: 180
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
       - name: Setup Node
         uses: actions/setup-node@v2
         with:
-          node-version: "18"
+          node-version: '18'
       - name: Build SnarkyJS and Execute Tests
         run: |
           npm ci
@@ -35,14 +37,15 @@ jobs:
           INPUT_TOKEN: ${{ secrets.NPM_TOKEN }}
 
   Build-And-Test-Web:
+    timeout-minutes: 90
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
       - name: Setup Node
         uses: actions/setup-node@v2
         with:
-          node-version: "18"
+          node-version: '18'
       - name: Install Node Dependencies
         run: npm ci
       - name: Install Playwright Browsers

CHANGELOG.md

@@ -15,9 +15,55 @@ 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/f0837188...HEAD)
+## [Unreleased](https://github.com/o1-labs/snarkyjs/compare/9a94231c...HEAD)
 
-(no unreleased changes yet)
+## [0.7.0](https://github.com/o1-labs/snarkyjs/compare/f0837188...9a94231c)
+
+### Added
+
+- Added an optional string parameter to certain `assert` methods https://github.com/o1-labs/snarkyjs/pull/470
+- `Struct`, a new primitive for declaring composite, SNARK-compatible types https://github.com/o1-labs/snarkyjs/pull/416
+  - With this, we also added a way to include auxiliary, non-field element data in composite types
+  - Added `VerificationKey`, which is a `Struct` with auxiliary data, to pass verification keys to a `@method`
+  - BREAKING CHANGE: Change names related to circuit types: `AsFieldsAndAux<T>` -> `Provable<T>`, `AsFieldElement<T>` -> `ProvablePure<T>`, `circuitValue` -> `provable`
+  - BREAKING CHANGE: Change all `ofFields` and `ofBits` methods on circuit types to `fromFields` and `fromBits`
+- New option `proofsEnabled` for `LocalBlockchain` (default value: `true`), to quickly test transaction logic with proofs disabled https://github.com/o1-labs/snarkyjs/pull/462
+  - with `proofsEnabled: true`, proofs now get verified locally https://github.com/o1-labs/snarkyjs/pull/423
+- `SmartContract.approve()` to approve a tree of child account updates https://github.com/o1-labs/snarkyjs/pull/428 https://github.com/o1-labs/snarkyjs/pull/534
+  - AccountUpdates are now valid `@method` arguments, and `approve()` is intended to be used on them when passed to a method
+  - Also replaces `Experimental.accountUpdateFromCallback()`
+- `Circuit.log()` to easily log Fields and other provable types inside a method, with the same API as `console.log()` https://github.com/o1-labs/snarkyjs/pull/484
+- `SmartContract.init()` is a new method on the base `SmartContract` that will be called only during the first deploy (not if you re-deploy later to upgrade the contract) https://github.com/o1-labs/snarkyjs/pull/543
+  - Overriding `init()` is the new recommended way to add custom state initialization logic.
+- `transaction.toPretty()` and `accountUpdate.toPretty()` for debugging transactions by printing only the pieces that differ from default account updates https://github.com/o1-labs/snarkyjs/pull/428
+- `AccountUpdate.attachToTransaction()` for explicitly adding an account update to the current transaction. This replaces some previous behaviour where an account update got attached implicitly https://github.com/o1-labs/snarkyjs/pull/484
+- `SmartContract.requireSignature()` and `AccountUpdate.requireSignature()` as a simpler, better-named replacement for `.sign()` https://github.com/o1-labs/snarkyjs/pull/558
+
+### Changed
+
+- BREAKING CHANGE: `tx.send()` is now asynchronous: old: `send(): TransactionId` new: `send(): Promise<TransactionId>` and `tx.send()` now directly waits for the network response, as opposed to `tx.send().wait()` https://github.com/o1-labs/snarkyjs/pull/423
+- Sending transactions to `LocalBlockchain` now involves
+- `Circuit.witness` can now be called outside circuits, where it will just directly return the callback result https://github.com/o1-labs/snarkyjs/pull/484
+- The `FeePayerSpec`, which is used to specify properties of the transaction via `Mina.transaction()`, now has another optional parameter to specify the nonce manually. `Mina.transaction({ feePayerKey: feePayer, nonce: 1 }, () => {})` https://github.com/o1-labs/snarkyjs/pull/497
+- BREAKING CHANGE: Static methods of type `.fromString()`, `.fromNumber()` and `.fromBigInt()` on `Field`, `UInt64`, `UInt32` and `Int64` are no longer supported https://github.com/o1-labs/snarkyjs/pull/519
+  - use `Field(number | string | bigint)` and `UInt64.from(number | string | bigint)`
+- Move several features out of 'experimental' https://github.com/o1-labs/snarkyjs/pull/555
+  - `Reducer` replaces `Experimental.Reducer`
+  - `MerkleTree` and `MerkleWitness` replace `Experimental.{MerkleTree,MerkleWitness}`
+  - In a `SmartContract`, `this.token` replaces `this.experimental.token`
+
+### Deprecated
+
+- `CircuitValue` deprecated in favor of `Struct` https://github.com/o1-labs/snarkyjs/pull/416
+- Static props `Field.zero`, `Field.one`, `Field.minusOne` deprecated in favor of `Field(number)` https://github.com/o1-labs/snarkyjs/pull/524
+- `SmartContract.sign()` and `AccountUpdate.sign()` in favor of `.requireSignature()` https://github.com/o1-labs/snarkyjs/pull/558
+
+### Fixed
+
+- Uint comparisons and division fixed inside the prover https://github.com/o1-labs/snarkyjs/pull/503
+- Callback arguments are properly passed into method invocations https://github.com/o1-labs/snarkyjs/pull/516
+- Removed internal type `JSONValue` from public interfaces https://github.com/o1-labs/snarkyjs/pull/536
+- Returning values from a zkApp https://github.com/o1-labs/snarkyjs/pull/461
 
 ## [0.6.1](https://github.com/o1-labs/snarkyjs/compare/ba688523...f0837188)
 
@@ -35,10 +81,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 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
+- 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`
+- BREAKING CHANGE: Move `ZkProgram` to `Experimental.ZkProgram`
 
 ## [0.5.4](https://github.com/o1-labs/snarkyjs/compare/3461333...f2ad423)
 
@@ -83,7 +129,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `this.account.isNew` to assert that an account did not (or did) exist before the transaction https://github.com/MinaProtocol/mina/pull/11524
 - `LocalBlockchain.setTimestamp` and other setters for network state, to test network preconditions locally https://github.com/o1-labs/snarkyjs/pull/329
 - **Experimental APIs** are now collected under the `Experimental` import, or on `this.experimental` in a smart contract.
-- Custom tokens (_experimental_), via `this.experimental.token`. RFC: https://github.com/o1-labs/snarkyjs/issues/233, PR: https://github.com/o1-labs/snarkyjs/pull/273,
+- Custom tokens (_experimental_), via `this.token`. RFC: https://github.com/o1-labs/snarkyjs/issues/233, PR: https://github.com/o1-labs/snarkyjs/pull/273,
 - Actions / sequence events support (_experimental_), via `Experimental.Reducer`. RFC: https://github.com/o1-labs/snarkyjs/issues/265, PR: https://github.com/o1-labs/snarkyjs/pull/274
 - Merkle tree implementation (_experimental_) via `Experimental.MerkleTree` https://github.com/o1-labs/snarkyjs/pull/343
 

MINA_COMMIT

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

package.json

@@ -1,7 +1,7 @@
 {
   "name": "snarkyjs",
   "description": "JavaScript bindings for SnarkyJS",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/web/index.js",
@@ -32,7 +32,7 @@
     "dev": "npx tsc -p tsconfig.node.json && cp src/snarky.d.ts dist/node/snarky.d.ts",
     "make": "make -C ../../../.. snarkyjs",
     "build": "rimraf ./dist/node && npx tsc -p tsconfig.node.json && cp -r src/node_bindings dist/node/_node_bindings && node src/build/buildNode.js && cp src/snarky.d.ts dist/node/snarky.d.ts",
-    "build:test": "rimraf ./dist/test && npx tsc -p tsconfig.test.json && cp -r src/node_bindings dist/test/_node_bindings && cp src/snarky.d.ts dist/test/snarky.d.ts",
+    "build:test": "npx tsc -p tsconfig.test.json && cp src/snarky.d.ts dist/node/snarky.d.ts",
     "build:node": "npm run build",
     "build:web": "rimraf ./dist/web && node src/build/buildWeb.js",
     "build:examples": "rimraf ./dist/examples && npx tsc -p tsconfig.examples.json || exit 0",

run-integration-tests.sh

@@ -1,7 +1,7 @@
-./run src/examples/zkapps/hello_world/run.ts || exit 1
-./run src/examples/zkapps/voting/run.ts || exit 1
+./run src/examples/zkapps/hello_world/run.ts --bundle || exit 1
+./run src/examples/zkapps/voting/run.ts --bundle || exit 1
 ./run src/examples/simple_zkapp.ts || exit 1
 ./run src/examples/zkapps/reducer/reducer_composite.ts || exit 1
 ./run src/examples/zkapps/composability.ts || exit 1
 ./run src/examples/zkapps/token_with_proofs.ts || exit 1
-./run src/examples/zkapps/dex/run.ts || exit 1
+./run src/examples/zkapps/dex/run.ts --bundle || exit 1

run-unit-tests.sh

@@ -1,5 +1,5 @@
 npm run build:test
-for f in ./dist/test/**/*.unit-test.js; do
+for f in ./dist/node/**/*.unit-test.js; do
   echo "Running $f"
-  node $f || (echo 'tests failed' && exit 1)
+  node $f || exit 1;
 done

src/build/buildExample.js

@@ -3,7 +3,7 @@ import path from 'path';
 import ts from 'typescript';
 import esbuild from 'esbuild';
 
-export { buildAndImport, build };
+export { buildAndImport, build, buildOne };
 
 async function buildAndImport(srcPath, { keepFile = false }) {
   let absPath = await build(srcPath);
@@ -37,6 +37,29 @@ async function build(srcPath) {
   return absPath;
 }
 
+async function buildOne(srcPath) {
+  let tsConfig = findTsConfig() ?? defaultTsConfig;
+
+  let outfile = path.resolve(
+    './dist/node',
+    srcPath.replace('.ts', '.js').replace('src', '.')
+  );
+
+  await esbuild.build({
+    entryPoints: [srcPath],
+    format: 'esm',
+    platform: 'node',
+    outfile,
+    target: 'esnext',
+    resolveExtensions: ['.node.js', '.ts', '.js'],
+    logLevel: 'error',
+    plugins: [typescriptPlugin(tsConfig)],
+  });
+
+  let absPath = path.resolve('.', outfile);
+  return absPath;
+}
+
 const defaultTsConfig = {
   compilerOptions: {
     module: 'esnext',

src/build/jsLayoutToTypes.mjs

@@ -93,7 +93,7 @@ function writeType(typeData, isJson, withTypeMap) {
     output += indent + '}';
     return { output, dependencies, converters };
   }
-  if (withTypeMap) {
+  if (withTypeMap & !builtinLeafTypes.has(type)) {
     type = `${isJson ? 'Json.' : ''}TypeMap["${type}"]`;
   }
   // built in type
@@ -118,7 +118,7 @@ function writeTsContent(types, isJson) {
     mergeObject(converters, inner.converters);
     output += `type ${Type} = ${inner.output};\n\n`;
     if (!isJson) {
-      output += `let ${Type} = asFieldsAndAux<${Type}, Json.${Type}>(jsLayout.${Type} as any, customTypes);\n\n`;
+      output += `let ${Type} = provableFromLayout<${Type}, Json.${Type}>(jsLayout.${Type} as any);\n\n`;
     }
   }
 
@@ -127,6 +127,7 @@ function writeTsContent(types, isJson) {
   let imports = new Set();
   mergeSet(imports, dependencies);
   mergeSet(imports, new Set(customTypeNames));
+  let typeMapKeys = diffSets(dependencies, new Set(customTypeNames));
 
   let importPath = isJson
     ? '../transaction-leaves-json.js'
@@ -136,7 +137,8 @@ function writeTsContent(types, isJson) {
 import { ${[...imports].join(', ')} } from '${importPath}';
 ${
   !isJson
-    ? "import { asFieldsAndAux, AsFieldsAndAux } from '../transaction-helpers.js';\n" +
+    ? "import { GenericProvableExtended } from '../../provable/generic.js';\n" +
+      "import { ProvableFromLayout, GenericLayout } from '../../provable/from-layout.js';\n" +
       "import * as Json from './transaction-json.js';\n" +
       "import { jsLayout } from './js-layout.js';\n"
     : ''
@@ -145,17 +147,41 @@ ${
 export { ${[...exports].join(', ')} };
 ${
   !isJson
-    ? 'export { Json };\n' + "export * from '../transaction-leaves.js';\n"
-    : "export * from '../transaction-leaves-json.js';\n"
+    ? 'export { Json };\n' +
+      "export * from '../transaction-leaves.js';\n" +
+      'export { provableFromLayout, toJSONEssential, Layout };\n'
+    : "export * from '../transaction-leaves-json.js';\n" +
+      'export { TypeMap };\n'
 }
 
+type TypeMap = {
+  ${[...typeMapKeys].map((type) => `${type}: ${type};`).join('\n')}
+}
 ${
   (!isJson || '') &&
   `
+const TypeMap: {
+  [K in keyof TypeMap]: ProvableExtended<TypeMap[K], Json.TypeMap[K]>;
+} = {
+  ${[...typeMapKeys].join(', ')}
+}
+`
+}
+
+${
+  (!isJson || '') &&
+  `
+type ProvableExtended<T, TJson> = GenericProvableExtended<T, TJson, Field>;
+type Layout = GenericLayout<TypeMap>;
+
 type CustomTypes = { ${customTypes
-    .map((c) => `${c.typeName}: AsFieldsAndAux<${c.type}, ${c.jsonType}>;`)
+    .map((c) => `${c.typeName}: ProvableExtended<${c.type}, ${c.jsonType}>;`)
     .join(' ')} }
 let customTypes: CustomTypes = { ${customTypeNames.join(', ')} };
+let { provableFromLayout, toJSONEssential } = ProvableFromLayout<
+  TypeMap,
+  Json.TypeMap
+>(TypeMap, customTypes);
 `
 }
 
@@ -171,7 +197,7 @@ async function writeTsFile(content, relPath) {
   await fs.writeFile(absPath, content);
 }
 
-let genPath = '../../snarky/gen';
+let genPath = '../../provable/gen';
 await ensureDir(genPath);
 
 let jsonTypesContent = writeTsContent(jsLayout, true);
@@ -195,6 +221,13 @@ function mergeSet(target, source) {
     target.add(x);
   }
 }
+function diffSets(s0, s1) {
+  let s = new Set(s0);
+  for (let x of s1) {
+    s.delete(x);
+  }
+  return s;
+}
 
 function mergeObject(target, source) {
   if (source === undefined) return;

src/build/run.js

@@ -1,26 +1,33 @@
 #!/usr/bin/env node
 import minimist from 'minimist';
-import { buildAndImport } from './buildExample.js';
-import { shutdown } from '../../dist/node/index.js';
+import { buildAndImport, buildOne } from './buildExample.js';
 
 let {
   _: [filePath],
   main,
   default: runDefault,
-  keypair: keyPair,
   keep,
+  bundle,
 } = minimist(process.argv.slice(2));
 
 if (!filePath) {
   console.log(`Usage:
 npx snarky-run [file]`);
   process.exit(0);
 }
-
-let module = await buildAndImport(filePath, { keepFile: !!keep });
-if (main) await module.main();
-if (runDefault) await module.default();
-if (keyPair) {
-  console.log(module.default.generateKeypair());
+if (!bundle) {
+  let absPath = await buildOne(filePath);
+  console.log(`running ${absPath}`);
+  let module = await import(absPath);
+  if (main) await module.main();
+  if (runDefault) await module.default();
+  let { shutdown } = await import('../../dist/node/index.js');
+  shutdown();
+} else {
+  let { isReady, shutdown } = await import('../../dist/node/index.js');
+  await isReady;
+  let module = await buildAndImport(filePath, { keepFile: !!keep });
+  if (main) await module.main();
+  if (runDefault) await module.default();
+  shutdown();
 }
-shutdown();