feat: upgrade from snarkyjs to o1js

proto-kit · Oct 19, 2023 · a0a8eb8 · a0a8eb8
1 parent 3b59814
commit a0a8eb8
Show file tree

Hide file tree

Showing 99 changed files with 375 additions and 206 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -23,7 +23,7 @@
     "typescript-memoize": "^1.1.1"
   },
   "peerDependencies": {
-    "snarkyjs": "0.12.0",
+    "o1js": "0.13.1",
     "tsyringe": "^4.7.0"
   },
   "devDependencies": {

diff --git a/packages/common/src/log.ts b/packages/common/src/log.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/unbound-method, putout/putout */
 import loglevel, { LogLevelDesc } from "loglevel";
-import { Provable } from "snarkyjs";
+import { Provable } from "o1js";
 
 function logProvable(
   logFunction: (...args: unknown[]) => void,

diff --git a/packages/common/src/utils.ts b/packages/common/src/utils.ts
@@ -1,4 +1,4 @@
-import { Field, FlexibleProvablePure } from "snarkyjs";
+import { Field, FlexibleProvablePure } from "o1js";
 
 export function requireTrue(
   condition: boolean,
@@ -16,7 +16,10 @@ export function range(startOrEnd: number, end: number | undefined): number[] {
     end = startOrEnd;
     startOrEnd = 0;
   }
-  return Array.from({ length: end - startOrEnd }, (ignored, index) => index + startOrEnd);
+  return Array.from(
+    { length: end - startOrEnd },
+    (ignored, index) => index + startOrEnd
+  );
 }
 
 /**

diff --git a/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts b/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts
@@ -1,4 +1,4 @@
-import type { FlexibleProvable, Proof } from "snarkyjs";
+import type { FlexibleProvable, Proof } from "o1js";
 import { singleton } from "tsyringe";
 import uniqueId from "lodash/uniqueId";
 

diff --git a/packages/common/src/zkProgrammable/ZkProgrammable.ts b/packages/common/src/zkProgrammable/ZkProgrammable.ts
@@ -1,4 +1,4 @@
-import { Experimental, FlexibleProvablePure, Proof } from "snarkyjs";
+import { Experimental, FlexibleProvablePure, Proof } from "o1js";
 import { Memoize } from "typescript-memoize";
 
 import { mockProof } from "./provableMethod";

diff --git a/packages/common/src/zkProgrammable/provableMethod.ts b/packages/common/src/zkProgrammable/provableMethod.ts
@@ -1,4 +1,4 @@
-import { FlexibleProvable } from "snarkyjs";
+import { FlexibleProvable } from "o1js";
 import { container } from "tsyringe";
 
 import { ProvableMethodExecutionContext } from "./ProvableMethodExecutionContext";

diff --git a/packages/common/test/zkProgrammable/ZkProgrammable.test.ts b/packages/common/test/zkProgrammable/ZkProgrammable.test.ts
@@ -3,7 +3,7 @@ import "reflect-metadata";
 // eslint-disable-next-line @typescript-eslint/no-shadow
 import { jest } from "@jest/globals";
 import { container } from "tsyringe";
-import { Experimental, Field, Struct, Proof } from "snarkyjs";
+import { Experimental, Field, Struct, Proof } from "o1js";
 
 import {
   mockProof,

diff --git a/packages/module/package.json b/packages/module/package.json
@@ -28,7 +28,7 @@
   "peerDependencies": {
     "@proto-kit/common": "*",
     "@proto-kit/protocol": "*",
-    "snarkyjs": "0.12.0",
+    "o1js": "0.13.1",
     "tsyringe": "^4.7.0"
   },
   "gitHead": "b2528538c73747d000cc3ea99ee26ee415d8248d"

diff --git a/packages/module/src/method/MethodParameterDecoder.ts b/packages/module/src/method/MethodParameterDecoder.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-underscore-dangle */
-import { Field } from "snarkyjs";
+import { Field } from "o1js";
 
 import { RuntimeModule } from "../runtime/RuntimeModule";
 

diff --git a/packages/module/src/method/decorator.test.ts b/packages/module/src/method/decorator.test.ts
@@ -1,6 +1,6 @@
 import "reflect-metadata";
 
-import { Bool, Field } from "snarkyjs";
+import { Bool, Field } from "o1js";
 import { Option, StateTransition } from "@proto-kit/protocol";
 
 import { toStateTransitionsHash } from "./runtimeMethod.js";

diff --git a/packages/module/src/method/runtimeMethod.ts b/packages/module/src/method/runtimeMethod.ts
@@ -1,4 +1,4 @@
-import { Field, FlexibleProvable, Poseidon } from "snarkyjs";
+import { Field, FlexibleProvable, Poseidon } from "o1js";
 import { container } from "tsyringe";
 import {
   StateTransition,

diff --git a/packages/module/src/runtime/MethodIdResolver.ts b/packages/module/src/runtime/MethodIdResolver.ts
@@ -1,5 +1,5 @@
 import { stringToField } from "@proto-kit/protocol";
-import { Poseidon } from "snarkyjs";
+import { Poseidon } from "o1js";
 
 import type { Runtime, RuntimeModulesRecord } from "./Runtime";
 

diff --git a/packages/module/src/runtime/Runtime.ts b/packages/module/src/runtime/Runtime.ts
@@ -1,6 +1,6 @@
 // eslint-disable-next-line max-len
 /* eslint-disable @typescript-eslint/no-explicit-any,@typescript-eslint/no-unsafe-assignment,max-lines */
-import { Experimental } from "snarkyjs";
+import { Experimental } from "o1js";
 import { DependencyContainer, injectable } from "tsyringe";
 import {
   StringKeyOf,

diff --git a/packages/module/src/state/InMemoryStateService.ts b/packages/module/src/state/InMemoryStateService.ts
@@ -1,4 +1,4 @@
-import { Field } from "snarkyjs";
+import { Field } from "o1js";
 import { StateService } from "@proto-kit/protocol";
 
 /**

diff --git a/packages/module/test/Runtime.test.ts b/packages/module/test/Runtime.test.ts
@@ -1,4 +1,4 @@
-import { Bool } from "snarkyjs";
+import { Bool } from "o1js";
 
 import { InMemoryStateService, MethodIdResolver, Runtime } from "../src";
 
@@ -32,10 +32,9 @@ describe("runtime", () => {
     const moduleName = "Balances";
     const methodName = "getTotalSupply";
 
-    const methodId = runtime.dependencyContainer.resolve<MethodIdResolver>("MethodIdResolver").getMethodId(
-      moduleName,
-      methodName
-    );
+    const methodId = runtime.dependencyContainer
+      .resolve<MethodIdResolver>("MethodIdResolver")
+      .getMethodId(moduleName, methodName);
     const method = runtime.getMethodById(methodId);
 
     // eslint-disable-next-line jest/no-restricted-matchers

diff --git a/packages/module/test/modules/Admin.ts b/packages/module/test/modules/Admin.ts
@@ -1,4 +1,4 @@
-import { PublicKey } from "snarkyjs";
+import { PublicKey } from "o1js";
 
 import { runtimeModule } from "../../src/module/decorator.js";
 import { RuntimeModule } from "../../src/runtime/RuntimeModule.js";

diff --git a/packages/module/test/modules/Balances.test.ts b/packages/module/test/modules/Balances.test.ts
@@ -8,7 +8,7 @@ import {
   Proof,
   PublicKey,
   UInt64,
-} from "snarkyjs";
+} from "o1js";
 import { container } from "tsyringe";
 import {
   type ProvableStateTransition,

diff --git a/packages/module/test/modules/Balances.ts b/packages/module/test/modules/Balances.ts
@@ -1,4 +1,4 @@
-import { Bool, PublicKey, UInt64 } from "snarkyjs";
+import { Bool, PublicKey, UInt64 } from "o1js";
 import { Option, State, StateMap } from "@proto-kit/protocol";
 import { Presets } from "@proto-kit/common";
 

diff --git a/packages/module/test/modules/State.test.ts b/packages/module/test/modules/State.test.ts
@@ -1,18 +1,15 @@
 import "reflect-metadata";
-import { Bool, PublicKey, UInt64 } from "snarkyjs";
+import { Bool, PublicKey, UInt64 } from "o1js";
 import { container } from "tsyringe";
 import {
   NetworkState,
   Option,
   RuntimeMethodExecutionContext,
   RuntimeTransaction,
-  StateService
+  StateService,
 } from "@proto-kit/protocol";
 
-import {
-  InMemoryStateService,
-  Runtime
-} from "../../src";
+import { InMemoryStateService, Runtime } from "../../src";
 
 import { Admin } from "./Admin";
 import { Balances } from "./Balances";

diff --git a/packages/module/test/modules/methodId.test.ts b/packages/module/test/modules/methodId.test.ts
@@ -1,5 +1,5 @@
 import "reflect-metadata";
-import { Bool, Field } from "snarkyjs";
+import { Bool, Field } from "o1js";
 import { beforeAll, beforeEach } from "@jest/globals";
 
 import { Runtime } from "../../src/runtime/Runtime";
@@ -56,21 +56,19 @@ describe("methodId", () => {
     ["Admin", "isAdminWithAVeryVeryVeryVeryLongName"],
     ["Balance", "getTotalSupply"],
     ["Balance", "getBalance"],
-  ])(
-    "should pass and encode correctly",
-    (givenModuleName, givenMethodName) => {
-      expect.assertions(2);
+  ])("should pass and encode correctly", (givenModuleName, givenMethodName) => {
+    expect.assertions(2);
 
-      const methodId = resolver.getMethodId(givenModuleName, givenMethodName);
+    const methodId = resolver.getMethodId(givenModuleName, givenMethodName);
 
-      const [moduleName, methodName] = resolver.getMethodNameFromId(
-        methodId
-      ) ?? [undefined, undefined];
+    const [moduleName, methodName] = resolver.getMethodNameFromId(methodId) ?? [
+      undefined,
+      undefined,
+    ];
 
-      expect(moduleName).toBe(givenModuleName);
-      expect(methodName).toBe(givenMethodName);
-    }
-  );
+    expect(moduleName).toBe(givenModuleName);
+    expect(methodName).toBe(givenMethodName);
+  });
 
   it("should fail for invalid module name", () => {
     expect.assertions(1);