@proto-kit/module 0.1.1-develop.191 → 0.1.1-develop.2024

package/src/state/State.ts

@@ -1,154 +0,0 @@
-/* eslint-disable new-cap */
-
-import { Mixin } from "ts-mixer";
-import { Bool, Field, Provable, type FlexibleProvablePure } from "snarkyjs";
-import { container } from "tsyringe";
-import { Option, StateTransition, type Path } from "@proto-kit/protocol";
-
-import { PartialRuntime } from "../runtime/RuntimeModule.js";
-import { RuntimeMethodExecutionContext } from "../method/RuntimeMethodExecutionContext.js";
-
-export class WithPath {
-  public path?: Field;
-
-  public hasPathOrFail(): asserts this is { path: Path } {
-    if (!this.path) {
-      throw new Error(
-        "Could not find 'path', did you forget to add '@state' to your state property?"
-      );
-    }
-  }
-}
-
-export class WithRuntime {
-  public runtime?: PartialRuntime;
-
-  public hasRuntimeOrFail(): asserts this is {
-    runtime: PartialRuntime;
-  } {
-    if (!this.runtime) {
-      throw new Error(
-        "Could not find 'runtime', did you forget to add '@state' to your state property?"
-      );
-    }
-  }
-}
-
-/**
- * Utilities for runtime module state, such as get/set
- */
-export class State<Value> extends Mixin(WithPath, WithRuntime) {
-  /**
-   * Creates a new state wrapper for the provided value type.
-   *
-   * @param valueType - Type of value to be stored (e.g. UInt64, Struct, ...)
-   * @returns New state for the given value type.
-   */
-  public static from<Value>(valueType: FlexibleProvablePure<Value>) {
-    return new State<Value>(valueType);
-  }
-
-  /**
-   * Computes a dummy value for the given value type.
-   *
-   * @param valueType - Value type to generate the dummy value for
-   * @returns Dummy value for the given value type
-   */
-  public static dummyValue<Value>(
-    valueType: FlexibleProvablePure<Value>
-  ): Value {
-    const length = valueType.sizeInFields();
-    const fields = Array.from({ length }, () => Field(0));
-
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return valueType.fromFields(fields) as Value;
-  }
-
-  public constructor(public valueType: FlexibleProvablePure<Value>) {
-    super();
-  }
-
-  /**
-   * Provides an in-circuit witness for the current state representation,
-   * and constructs an Option out of it.
-   *
-   * @returns Optional value of the current state
-   */
-  private witnessState() {
-    // get the value from storage, or return a dummy value instead
-    const value = Provable.witness(this.valueType, () => {
-      this.hasRuntimeOrFail();
-      this.hasPathOrFail();
-
-      const fields = this.runtime.stateService.get(this.path);
-      if (fields) {
-        // eslint-disable-next-line max-len
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        return this.valueType.fromFields(fields) as Value;
-      }
-
-      return State.dummyValue(this.valueType);
-    });
-
-    // check if the value exists in the storage or not
-    const isSome = Provable.witness(Bool, () => {
-      this.hasRuntimeOrFail();
-      this.hasPathOrFail();
-
-      const fields = this.runtime.stateService.get(this.path);
-
-      return Bool(fields !== undefined);
-    });
-
-    return Option.from(isSome, value, this.valueType);
-  }
-
-  /**
-   * Retrieves the current state and creates a state transition
-   * anchoring the use of the current state value in the circuit.
-   *
-   * @returns Option representation of the current state.
-   */
-  public get(): Option<Value> {
-    const option = this.witnessState();
-
-    this.hasPathOrFail();
-
-    const stateTransition = StateTransition.from(this.path, option);
-
-    container
-      .resolve(RuntimeMethodExecutionContext)
-      .addStateTransition(stateTransition);
-
-    return option;
-  }
-
-  /**
-   * Sets a new state value by creating a state transition from
-   * the current value to the newly set value.
-   *
-   * The newly set value isn't available via state.get(), since the
-   * state transitions are not applied within the same circuit.
-   * You can however store and access your new value in
-   * a separate circuit variable.
-   *
-   * @param value - Value to be set as the current state
-   */
-  public set(value: Value) {
-    // link the transition to the current state
-    const fromOption = this.witnessState();
-    const toOption = Option.from(Bool(true), value, this.valueType);
-
-    this.hasPathOrFail();
-
-    const stateTransition = StateTransition.fromTo(
-      this.path,
-      fromOption,
-      toOption
-    );
-
-    container
-      .resolve(RuntimeMethodExecutionContext)
-      .addStateTransition(stateTransition);
-  }
-}

package/src/state/StateMap.ts

@@ -1,69 +0,0 @@
-import type { Field, FlexibleProvablePure } from "snarkyjs";
-import { Path, type Option } from "@proto-kit/protocol";
-import { Mixin } from "ts-mixer";
-
-import { State, WithRuntime, WithPath } from "./State.js";
-
-/**
- * Map-like wrapper for state
- */
-// eslint-disable-next-line new-cap
-export class StateMap<KeyType, ValueType> extends Mixin(WithPath, WithRuntime) {
-  /**
-   * Create a new state map with the given key and value types
-   *
-   * @param keyType - Type to be used as a key
-   * @param valueType - Type to be stored as a value
-   * @returns State map with provided key and value types.
-   */
-  public static from<KeyType, ValueType>(
-    keyType: FlexibleProvablePure<KeyType>,
-    valueType: FlexibleProvablePure<ValueType>
-  ) {
-    return new StateMap<KeyType, ValueType>(keyType, valueType);
-  }
-
-  public constructor(
-    public keyType: FlexibleProvablePure<KeyType>,
-    public valueType: FlexibleProvablePure<ValueType>
-  ) {
-    super();
-  }
-
-  public getPath(key: KeyType): Field {
-    this.hasPathOrFail();
-    return Path.fromKey(this.path, this.keyType, key);
-  }
-
-  /**
-   * Obtains a value for the provided key in the current state map.
-   *
-   * @param key - Key to obtain the state for
-   * @returns Value for the provided key.
-   */
-  public get(key: KeyType): Option<ValueType> {
-    const state = State.from(this.valueType);
-    this.hasPathOrFail();
-    this.hasRuntimeOrFail();
-
-    state.path = this.getPath(key);
-    state.runtime = this.runtime;
-    return state.get();
-  }
-
-  /**
-   * Sets a value for the given key in the current state map.
-   *
-   * @param key - Key to store the value under
-   * @param value - Value to be stored under the given key
-   */
-  public set(key: KeyType, value: ValueType) {
-    const state = State.from(this.valueType);
-    this.hasPathOrFail();
-    this.hasRuntimeOrFail();
-
-    state.path = Path.fromKey(this.path, this.keyType, key);
-    state.runtime = this.runtime;
-    state.set(value);
-  }
-}

package/src/state/StateServiceProvider.ts

@@ -1,24 +0,0 @@
-import { inject, injectable } from "tsyringe";
-
-import { StateService } from "./InMemoryStateService";
-
-@injectable()
-export class StateServiceProvider {
-  private readonly defaultStateService: StateService = this.currentStateService;
-
-  public constructor(
-    @inject("StateService") private currentStateService: StateService
-  ) {}
-
-  public get stateService(): StateService {
-    return this.currentStateService;
-  }
-
-  public setCurrentStateService(service: StateService) {
-    this.currentStateService = service;
-  }
-
-  public resetToDefault() {
-    this.currentStateService = this.defaultStateService;
-  }
-}

package/src/state/decorator.ts

@@ -1,65 +0,0 @@
-import { Path } from "@proto-kit/protocol";
-
-import type { RuntimeModule } from "../runtime/RuntimeModule.js";
-
-import type { State } from "./State.js";
-
-const errors = {
-  missingName: (className: string) =>
-    new Error(
-      `Unable to provide a unique identifier for state, ${className} is missing a name. 
-      Did you forget to extend your runtime module with 'extends RuntimeModule'?`
-    ),
-
-  missingRuntime: (className: string) =>
-    new Error(
-      `Unable to provide 'runtime' for state, ${className} is missing a name. 
-      Did you forget to extend your runtime module with 'extends RuntimeModule'?`
-    ),
-};
-
-/**
- * Decorates a runtime module property as state, passing down some
- * underlying values to improve developer experience.
- */
-export function state() {
-  return <TargetRuntimeModule extends RuntimeModule<unknown>>(
-    target: TargetRuntimeModule,
-    propertyKey: string
-  ) => {
-    // eslint-disable-next-line @typescript-eslint/init-declarations
-    let value: State<unknown> | undefined;
-
-    Object.defineProperty(target, propertyKey, {
-      enumerable: true,
-
-      get: function get() {
-        // eslint-disable-next-line max-len
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        const self = this as TargetRuntimeModule;
-
-        if (self.name === undefined) {
-          throw errors.missingName(self.constructor.name);
-        }
-
-        if (!self.runtime) {
-          throw errors.missingRuntime(self.constructor.name);
-        }
-
-        const path = Path.fromProperty(self.name, propertyKey);
-        if (value) {
-          value.path = path;
-          // eslint-disable-next-line no-warning-comments
-          // TODO: why is this complaining about `any`?
-
-          value.runtime = self.runtime;
-        }
-        return value;
-      },
-
-      set: (newValue: State<unknown>) => {
-        value = newValue;
-      },
-    });
-  };
-}

package/test/state/MerkleTree.test.ts

@@ -1,95 +0,0 @@
-import {
-  CachedMerkleTreeStore,
-  InMemoryMerkleTreeStorage,
-  RollupMerkleTree,
-} from "@proto-kit/protocol";
-import { MockAsyncMerkleTreeStore } from "./MockAsyncMerkleStore";
-import { beforeEach } from "@jest/globals";
-import { Field, Poseidon } from "snarkyjs";
-import { log } from "@proto-kit/common";
-
-describe("cachedMerkleTree", () => {
-  let store: MockAsyncMerkleTreeStore;
-  let syncStore: InMemoryMerkleTreeStorage;
-  let tree: RollupMerkleTree;
-
-  let cached: CachedMerkleTreeStore;
-  let cachedTree: RollupMerkleTree;
-
-  beforeEach(async () => {
-    log.setLevel("DEBUG");
-
-    store = new MockAsyncMerkleTreeStore();
-    syncStore = store.store;
-    tree = new RollupMerkleTree(syncStore);
-
-    tree.setLeaf(1n, Field(10));
-    tree.setLeaf(3n, Field(30));
-    tree.setLeaf(5n, Field(50));
-
-    cached = new CachedMerkleTreeStore(store);
-    await cached.preloadKey(1n);
-    await cached.preloadKey(3n);
-    await cached.preloadKey(5n);
-    cachedTree = new RollupMerkleTree(cached);
-  });
-
-  it("should have the same root", async () => {
-    expect(cached.getNode(1n, 0)).toBe(10n);
-    expect(cached.getNode(3n, 0)).toBe(30n);
-    expect(cached.getNode(5n, 0)).toBe(50n);
-    expect(syncStore.getNode(5n, 0)).toBe(50n);
-
-    expect(cached.getNode(0n, 1)).toBe(
-      Poseidon.hash([Field(0), Field(10)]).toBigInt()
-    );
-
-    expect(cached.getNode(0n, 254)).toBe(await store.getNode(0n, 254));
-    expect(cached.getNode(0n, 254)).toBe(syncStore.getNode(0n, 254));
-
-    expect(cachedTree.getRoot().toBigInt()).toBe(tree.getRoot().toBigInt());
-  });
-
-  it("should load the correct root when only loading a subset of keys", async () => {
-    await cached.preloadKey(3n);
-
-    const correctRoot = tree.getRoot();
-    expect(cachedTree.getRoot().toBigInt()).toBe(correctRoot.toBigInt());
-  });
-
-  it("should generate correct witnesses when only loading a subset of keys", async () => {
-    await cached.preloadKey(5n);
-
-    const correctRoot = tree.getRoot();
-    const witness = tree.getWitness(5n);
-    expect(witness.calculateRoot(Field(50)).toBigInt()).toBe(
-      correctRoot.toBigInt()
-    );
-  });
-
-  it("should generate correct witnesses after merging", async () => {
-    expect(cachedTree.getRoot().toBigInt()).toBe(tree.getRoot().toBigInt());
-
-    await cached.preloadKey(5n);
-    cachedTree.setLeaf(5n, Field(100));
-
-    const correctRoot = cachedTree.getRoot();
-
-    await cached.mergeIntoParent();
-
-    const cached2 = new CachedMerkleTreeStore(store);
-    await cached2.preloadKey(1n);
-    await cached2.preloadKey(3n);
-    await cached2.preloadKey(5n);
-    expect(cached2.getNode(1n, 0)).toBe(10n);
-    expect(cached2.getNode(3n, 0)).toBe(30n);
-    expect(cached2.getNode(5n, 0)).toBe(100n);
-    const tree2 = new RollupMerkleTree(cached2);
-
-    const witness = tree2.getWitness(3n);
-
-    expect(witness.calculateRoot(Field(30)).toBigInt()).toBe(
-      correctRoot.toBigInt()
-    );
-  });
-});

package/test/state/MockAsyncMerkleStore.ts

@@ -1,28 +0,0 @@
-import { AsyncMerkleTreeStore, InMemoryMerkleTreeStorage, noop } from "@proto-kit/protocol";
-
-export class MockAsyncMerkleTreeStore implements AsyncMerkleTreeStore {
-  public readonly store = new InMemoryMerkleTreeStorage();
-
-  public commit(): void {
-    noop();
-  }
-
-  public openTransaction(): void {
-    noop();
-  }
-
-  public async getNode(
-    key: bigint,
-    level: number
-  ): Promise<bigint | undefined> {
-    return this.store.getNode(key, level);
-  }
-
-  public async setNode(
-    key: bigint,
-    level: number,
-    value: bigint
-  ): Promise<void> {
-    this.store.setNode(key, level, value);
-  }
-}

package/test/transaction.test.ts

@@ -1,82 +0,0 @@
-import "reflect-metadata";
-import { PrivateKey, Proof, PublicKey, UInt64 } from "snarkyjs";
-import { container } from "tsyringe";
-import {
-  InMemoryStateService,
-  MethodPublicOutput,
-  Runtime,
-  runtimeMethod,
-  RuntimeMethodExecutionContext,
-} from "../src";
-import { runtimeModule } from "../src/module/decorator";
-import { RuntimeModule } from "../src/runtime/RuntimeModule";
-import { state } from "../src/state/decorator";
-import { StateMap } from "../src/state/StateMap";
-
-interface BalancesConfig {}
-@runtimeModule()
-class Balances extends RuntimeModule<BalancesConfig> {
-  @state() public balances = StateMap.from<PublicKey, UInt64>(
-    PublicKey,
-    UInt64
-  );
-
-  @runtimeMethod()
-  public setBalance(to: PublicKey, amount: UInt64) {
-    this.balances.set(to, amount);
-  }
-
-  @runtimeMethod()
-  public transfer(from: PublicKey, to: PublicKey, amount: UInt64) {
-    const fromBalance = this.balances.get(from);
-    const toBalance = this.balances.get(to);
-
-    this.balances.set(from, fromBalance.value.sub(amount));
-    this.balances.set(to, toBalance.value.add(amount));
-  }
-}
-
-describe("transaction", () => {
-  it("should update the state", async () => {
-    expect.assertions(0);
-
-    const runtime = Runtime.from({
-      modules: {
-        Balances,
-      },
-
-      config: {
-        Balances: {},
-      },
-
-      state: new InMemoryStateService(),
-    });
-
-    const alice = PrivateKey.random().toPublicKey();
-    const bob = PrivateKey.random().toPublicKey();
-
-    const balances = runtime.resolve("Balances");
-
-    runtime.transaction(() => {
-      balances.setBalance(alice, UInt64.from(1000));
-    });
-
-    runtime.transaction(() => {
-      balances.transfer(alice, bob, UInt64.from(100));
-    });
-
-    const executionContext = container.resolve<RuntimeMethodExecutionContext>(
-      RuntimeMethodExecutionContext
-    );
-
-    const balanceAlice = balances.balances.get(alice);
-    const balanceBob = balances.balances.get(bob);
-
-    console.log("balances", {
-      // 900
-      alice: balanceAlice.value.toString(),
-      // 100
-      bob: balanceBob.value.toString(),
-    });
-  });
-});

package/tsconfig.test.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./../../tsconfig.json",
-  "include": [
-    "./src/**/*.test.ts",
-    "./test/**/*.ts",
-    "./test/*.ts",
-    "./src/**/*.ts"
-  ]
-}