@proto-kit/protocol 0.1.1-develop.263 → 0.1.1-develop.298

package/src/state/StateService.ts

@@ -1,6 +1,6 @@
-import { Field } from "snarkyjs";
+import { Field } from "o1js";
 
 export interface StateService {
   get: (key: Field) => Field[] | undefined;
   set: (key: Field, value: Field[] | undefined) => void;
-}
+}

package/src/state/StateServiceProvider.ts

@@ -1,37 +1,46 @@
 import { inject, injectable } from "tsyringe";
 
 import { StateService } from "./StateService";
+import { log } from "@proto-kit/common";
 
 const errors = {
   stateServiceNotSet: () =>
     new Error(
-      `StateService has not been set yet. Be sure to either call your runtime or 
-      protocol function by creating them with an AppChain or by setting the 
-      stateService manually.`
+      "StateService has not been set yet. Be sure to either call your runtime or protocol function by creating them with an AppChain or by setting the stateService manually."
     ),
 };
 
 @injectable()
 export class StateServiceProvider {
-  private readonly defaultStateService?: StateService =
-    this.currentStateService;
+  private readonly stateServiceStack: StateService[] = [];
 
   public constructor(
-    @inject("StateService") private currentStateService?: StateService
-  ) {}
+    @inject("StateService") private readonly baseStateService?: StateService
+  ) {
+    if (baseStateService !== undefined) {
+      this.stateServiceStack.push(baseStateService);
+    }
+  }
 
   public get stateService(): StateService {
-    if (this.currentStateService === undefined) {
+    if (this.stateServiceStack.length === 0) {
       throw errors.stateServiceNotSet();
     }
-    return this.currentStateService;
+
+    // Assertion here is ok, because we check that the array is not empty above
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return this.stateServiceStack.at(-1)!;
   }
 
   public setCurrentStateService(service: StateService) {
-    this.currentStateService = service;
+    this.stateServiceStack.push(service);
   }
 
-  public resetToDefault() {
-    this.currentStateService = this.defaultStateService;
+  public popCurrentStateService() {
+    if (this.stateServiceStack.length === 1) {
+      log.trace("Trying to pop last available (root) stateservice");
+      return;
+    }
+    this.stateServiceStack.pop();
   }
 }

package/src/state/assert/assert.test.ts

@@ -1,6 +1,6 @@
 import "reflect-metadata";
 
-import { Bool } from "snarkyjs";
+import { Bool } from "o1js";
 import { container } from "tsyringe";
 
 import { assert } from "./assert";

package/src/state/assert/assert.ts

@@ -1,4 +1,4 @@
-import { Bool } from "snarkyjs";
+import { Bool } from "o1js";
 import { container } from "tsyringe";
 import { log } from "@proto-kit/common";
 
@@ -19,7 +19,9 @@ export function assert(condition: Bool, message?: string) {
   const status = condition.and(previousStatus);
 
   if (!condition.toBoolean()) {
-    log.debug("Assertion failed: ", message);
+    if (!executionContext.current().isSimulated) {
+      log.debug("Assertion failed: ", message);
+    }
     executionContext.setStatusMessage(message);
   }
 

package/src/state/context/RuntimeMethodExecutionContext.ts

@@ -1,6 +1,9 @@
-import { Bool } from "snarkyjs";
+import { Bool } from "o1js";
 import { singleton } from "tsyringe";
-import { ProvableMethodExecutionContext, ProvableMethodExecutionResult } from "@proto-kit/common";
+import {
+  ProvableMethodExecutionContext,
+  ProvableMethodExecutionResult,
+} from "@proto-kit/common";
 import { StateTransition } from "../../model/StateTransition";
 import { RuntimeTransaction } from "../../model/transaction/RuntimeTransaction";
 import { NetworkState } from "../../model/network/NetworkState";
@@ -119,6 +122,7 @@ export class RuntimeMethodExecutionContext extends ProvableMethodExecutionContex
       isFinished: this.isFinished,
       result: this.result,
       input: this.lastInput,
+      isSimulated: this.isSimulated,
     };
   }
 }

package/src/state/protocol/ProtocolState.ts

@@ -21,7 +21,9 @@ const errors = {
  * underlying values to improve developer experience.
  */
 export function protocolState() {
-  return <TargetTransitioningModule extends TransitioningProtocolModule>(
+  return <
+    TargetTransitioningModule extends TransitioningProtocolModule<unknown>
+  >(
     target: TargetTransitioningModule,
     propertyKey: string
   ) => {

package/src/utils/PrefixedProvableHashList.ts

@@ -1,4 +1,4 @@
-import { Field, FlexibleProvablePure, Poseidon } from "snarkyjs";
+import { Field, FlexibleProvablePure, Poseidon } from "o1js";
 
 import { ProvableHashList } from "./ProvableHashList.js";
 import { stringToField } from "./utils";

package/src/utils/ProvableHashList.ts

@@ -1,4 +1,4 @@
-import { Field, Poseidon, FlexibleProvablePure, Bool, Provable } from "snarkyjs";
+import { Field, Poseidon, FlexibleProvablePure, Bool, Provable } from "o1js";
 
 /**
  * Utilities for creating a hash list from a given value type.

package/src/utils/merkletree/InMemoryMerkleTreeStorage.ts

@@ -1,8 +1,4 @@
-/* eslint-disable @typescript-eslint/no-magic-numbers */
-import { log } from "@proto-kit/common";
-
-import { RollupMerkleTree } from "./RollupMerkleTree.js";
-import { AsyncMerkleTreeStore, MerkleTreeStore } from "./MerkleTreeStore";
+import { MerkleTreeStore } from "./MerkleTreeStore";
 
 export class InMemoryMerkleTreeStorage implements MerkleTreeStore {
   protected readonly nodes: {
@@ -19,95 +15,3 @@ export class InMemoryMerkleTreeStorage implements MerkleTreeStore {
     (this.nodes[level] ??= {})[key.toString()] = value;
   }
 }
-
-export class CachedMerkleTreeStore extends InMemoryMerkleTreeStorage {
-  private writeCache: {
-    [key: number]: {
-      [key: string]: bigint;
-    };
-  } = {};
-
-  public constructor(private readonly parent: AsyncMerkleTreeStore) {
-    super();
-  }
-
-  public setNode(key: bigint, level: number, value: bigint) {
-    super.setNode(key, level, value);
-    (this.writeCache[level] ??= {})[key.toString()] = value;
-  }
-
-  public getWrittenNodes(): {
-    [key: number]: {
-      [key: string]: bigint;
-    };
-  } {
-    return this.writeCache;
-  }
-
-  public resetWrittenNodes() {
-    this.writeCache = {};
-  }
-
-  // eslint-disable-next-line sonarjs/cognitive-complexity
-  public async preloadKey(index: bigint): Promise<void> {
-    // Algo from RollupMerkleTree.getWitness()
-    const { leafCount, height } = RollupMerkleTree;
-
-    if (index >= leafCount) {
-      index %= leafCount;
-    }
-
-    // eslint-disable-next-line no-warning-comments,max-len
-    // TODO Not practical at the moment. Improve pattern when implementing DB storage
-    for (let level = 0; level < height; level++) {
-      const key = index;
-
-      const isLeft = index % 2n === 0n;
-      const siblingKey = isLeft ? index + 1n : index - 1n;
-
-      // Only preload node if it is not already preloaded.
-      // We also don't want to overwrite because changes will get lost (tracing)
-      if (this.getNode(key, level) === undefined) {
-        // eslint-disable-next-line no-await-in-loop
-        const value = await this.parent.getNode(key, level);
-        if (level === 0) {
-          log.debug(`Preloaded ${key} @ ${level} -> ${value ?? "-"}`);
-        }
-        if (value !== undefined) {
-          this.setNode(key, level, value);
-        }
-      }
-
-      if (this.getNode(siblingKey, level) === undefined) {
-        // eslint-disable-next-line no-await-in-loop
-        const sibling = await this.parent.getNode(siblingKey, level);
-        if (sibling !== undefined) {
-          this.setNode(siblingKey, level, sibling);
-        }
-      }
-      index /= 2n;
-    }
-  }
-
-  public async mergeIntoParent(): Promise<void> {
-    // In case no state got set we can skip this step
-    if (Object.keys(this.writeCache).length === 0) {
-      return;
-    }
-
-    this.parent.openTransaction();
-    const { height } = RollupMerkleTree;
-    const nodes = this.getWrittenNodes();
-
-    const promises = Array.from({ length: height }).flatMap((ignored, level) =>
-      Object.entries(nodes[level]).map(async (entry) => {
-        await this.parent.setNode(BigInt(entry[0]), level, entry[1]);
-      })
-    );
-
-    await Promise.all(promises);
-
-    this.parent.commit();
-    this.resetWrittenNodes();
-  }
-}

package/src/utils/merkletree/MerkleTreeStore.ts

@@ -3,9 +3,9 @@ export interface AsyncMerkleTreeStore {
 
   commit: () => void;
 
-  setNode: (key: bigint, level: number, value: bigint) => Promise<void>;
+  setNodeAsync: (key: bigint, level: number, value: bigint) => Promise<void>;
 
-  getNode: (key: bigint, level: number) => Promise<bigint | undefined>;
+  getNodeAsync: (key: bigint, level: number) => Promise<bigint | undefined>;
 }
 
 export interface MerkleTreeStore {

package/src/utils/merkletree/RollupMerkleTree.ts

@@ -2,7 +2,8 @@
 /* eslint-disable line-comment-position */
 /* eslint-disable no-inline-comments */
 /* eslint-disable @typescript-eslint/no-magic-numbers */
-import { Bool, Field, Poseidon, Provable, Struct } from "snarkyjs";
+import { Bool, Field, Poseidon, Provable, Struct } from "o1js";
+import { range } from "@proto-kit/common";
 
 import { notInCircuit } from "../utils";
 
@@ -69,6 +70,14 @@ class RollupMerkleWitness extends Struct({
 
     return index;
   }
+
+  public toShortenedEntries() {
+    return range(0, 5)
+      .concat(range(251, 255))
+      .map((index) =>
+        [this.path[index].toString(), this.isLeft[index].toString()].toString()
+      );
+  }
 }
 
 /**

package/src/utils/utils.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line max-len
-/* eslint-disable @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types, @typescript-eslint/no-unsafe-return,@typescript-eslint/no-empty-function */
+/* eslint-disable @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types, @typescript-eslint/no-unsafe-return */
 
-import { Field, Poseidon, Provable } from "snarkyjs";
+import { Field, Poseidon, Provable } from "o1js";
 import floor from "lodash/floor";
 
 export type ReturnType<FunctionType extends Function> = FunctionType extends (
@@ -82,5 +82,3 @@ export function singleFieldToString(value: Field | bigint): string {
   }
   return value.toString();
 }
-
-export function noop(): void {}

package/test/BlockProver.test.ts

@@ -1,12 +1,5 @@
 import "reflect-metadata";
-import {
-  Bool,
-  Experimental,
-  Field,
-  PrivateKey,
-  Proof,
-  UInt64,
-} from "snarkyjs";
+import { Bool, Experimental, Field, PrivateKey, Proof, UInt64 } from "o1js";
 
 import {
   BlockProver,
@@ -29,12 +22,16 @@ import { UnsignedTransaction } from "@proto-kit/sequencer";
 import { AccountStateModule } from "../src/blockmodules/AccountStateModule";
 import { container } from "tsyringe";
 import {
-  BlockModule, DefaultProvableHashList,
+  BlockModule,
+  DefaultProvableHashList,
   MethodPublicOutput,
   NetworkState,
-  Protocol, ProtocolMethodExecutionContext,
-  ProtocolTransaction, ProvableStateTransition, RuntimeTransaction,
-  StateTransitionProver
+  Protocol,
+  ProtocolMethodExecutionContext,
+  ProtocolTransaction,
+  ProvableStateTransition,
+  RuntimeTransaction,
+  StateTransitionProver,
 } from "../src";
 
 type BlockProverProofPair = [

package/test/State.test.ts

@@ -1,5 +1,5 @@
 import "reflect-metadata";
-import { Bool, Field, Provable, UInt64 } from "snarkyjs";
+import { Bool, Field, Provable, UInt64 } from "o1js";
 import { container } from "tsyringe";
 
 import {

package/test/StateTransition.test.ts

@@ -1,12 +1,14 @@
 import "reflect-metadata";
-import { Bool, Field } from "snarkyjs";
+import { Bool, Field } from "o1js";
 import { container } from "tsyringe";
 
 import {
   Option,
   ProvableStateTransition,
   DefaultProvableHashList,
-  StateTransitionProvableBatch, CachedMerkleTreeStore, InMemoryMerkleTreeStorage
+  StateTransitionProvableBatch,
+  CachedMerkleTreeStore,
+  InMemoryMerkleTreeStorage,
 } from "../src/index";
 import {
   RollupMerkleTree,

package/test/utils/MerkleTree.test.ts

@@ -1,5 +1,5 @@
 import { MockAsyncMerkleTreeStore } from "@proto-kit/module/test/state/MockAsyncMerkleStore";
-import { Field, Provable } from "snarkyjs";
+import { Field, Provable } from "o1js";
 
 import { CachedMerkleTreeStore, RollupMerkleTree } from "../../src";
 import { log } from "@proto-kit/common";

package/test/utils.test.ts

@@ -1,5 +1,5 @@
 import "reflect-metadata";
-import { Field } from "snarkyjs";
+import { Field } from "o1js";
 
 import { stringToField } from "../src";