@proto-kit/module 0.1.1-develop.211 → 0.1.1-develop.2137

package/dist/state/State.js

@@ -1,114 +0,0 @@
-/* eslint-disable new-cap */
-import { Mixin } from "ts-mixer";
-import { Bool, Field, Provable } from "snarkyjs";
-import { container } from "tsyringe";
-import { Option, StateTransition } from "@proto-kit/protocol";
-import { RuntimeMethodExecutionContext } from "../method/RuntimeMethodExecutionContext.js";
-export class WithPath {
-    hasPathOrFail() {
-        if (!this.path) {
-            throw new Error("Could not find 'path', did you forget to add '@state' to your state property?");
-        }
-    }
-}
-export class WithRuntime {
-    hasRuntimeOrFail() {
-        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 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.
-     */
-    static from(valueType) {
-        return new State(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
-     */
-    static dummyValue(valueType) {
-        const length = valueType.sizeInFields();
-        const fields = Array.from({ length }, () => Field(0));
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        return valueType.fromFields(fields);
-    }
-    constructor(valueType) {
-        super();
-        this.valueType = valueType;
-    }
-    /**
-     * Provides an in-circuit witness for the current state representation,
-     * and constructs an Option out of it.
-     *
-     * @returns Optional value of the current state
-     */
-    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);
-            }
-            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.
-     */
-    get() {
-        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
-     */
-    set(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/dist/state/StateMap.d.ts

@@ -1,37 +0,0 @@
-import type { Field, FlexibleProvablePure } from "snarkyjs";
-import { type Option, ToFieldable } from "@proto-kit/protocol";
-import { WithRuntime, WithPath } from "./State.js";
-declare const StateMap_base: import("ts-mixer/dist/types/types.js").Class<any[], WithPath & WithRuntime, typeof WithPath & typeof WithRuntime, false>;
-/**
- * Map-like wrapper for state
- */
-export declare class StateMap<KeyType, ValueType extends ToFieldable> extends StateMap_base {
-    keyType: FlexibleProvablePure<KeyType>;
-    valueType: FlexibleProvablePure<ValueType>;
-    /**
-     * 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.
-     */
-    static from<KeyType, ValueType extends ToFieldable>(keyType: FlexibleProvablePure<KeyType>, valueType: FlexibleProvablePure<ValueType>): StateMap<KeyType, ValueType>;
-    constructor(keyType: FlexibleProvablePure<KeyType>, valueType: FlexibleProvablePure<ValueType>);
-    getPath(key: KeyType): Field;
-    /**
-     * 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.
-     */
-    get(key: KeyType): Option<ValueType>;
-    /**
-     * 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
-     */
-    set(key: KeyType, value: ValueType): void;
-}
-export {};
-//# sourceMappingURL=StateMap.d.ts.map

package/dist/state/StateMap.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StateMap.d.ts","sourceRoot":"","sources":["../../src/state/StateMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAQ,KAAK,MAAM,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGrE,OAAO,EAAS,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;;AAE1D;;GAEG;AAEH,qBAAa,QAAQ,CAAC,OAAO,EAAE,SAAS,SAAS,WAAW,CAAE,SAAQ,aAA4B;IAgBvF,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;IACtC,SAAS,EAAE,oBAAoB,CAAC,SAAS,CAAC;IAhBnD;;;;;;OAMG;WACW,IAAI,CAAC,OAAO,EAAE,SAAS,SAAS,WAAW,EACvD,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACtC,SAAS,EAAE,oBAAoB,CAAC,SAAS,CAAC;gBAMnC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACtC,SAAS,EAAE,oBAAoB,CAAC,SAAS,CAAC;IAK5C,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK;IAKnC;;;;;OAKG;IACI,GAAG,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC;IAU3C;;;;;OAKG;IACI,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS;CAS1C"}

package/dist/state/StateMap.js

@@ -1,56 +0,0 @@
-import { Path } 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 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.
-     */
-    static from(keyType, valueType) {
-        return new StateMap(keyType, valueType);
-    }
-    constructor(keyType, valueType) {
-        super();
-        this.keyType = keyType;
-        this.valueType = valueType;
-    }
-    getPath(key) {
-        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.
-     */
-    get(key) {
-        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
-     */
-    set(key, value) {
-        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/dist/state/StateServiceProvider.d.ts

@@ -1,10 +0,0 @@
-import { StateService } from "./InMemoryStateService";
-export declare class StateServiceProvider {
-    private currentStateService;
-    private readonly defaultStateService;
-    constructor(currentStateService: StateService);
-    get stateService(): StateService;
-    setCurrentStateService(service: StateService): void;
-    resetToDefault(): void;
-}
-//# sourceMappingURL=StateServiceProvider.d.ts.map

package/dist/state/StateServiceProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StateServiceProvider.d.ts","sourceRoot":"","sources":["../../src/state/StateServiceProvider.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,qBACa,oBAAoB;IAIL,OAAO,CAAC,mBAAmB;IAHrD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA0C;gBAG5C,mBAAmB,EAAE,YAAY;IAGnE,IAAW,YAAY,IAAI,YAAY,CAEtC;IAEM,sBAAsB,CAAC,OAAO,EAAE,YAAY;IAI5C,cAAc;CAGtB"}

package/dist/state/StateServiceProvider.js

@@ -1,34 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-import { inject, injectable } from "tsyringe";
-let StateServiceProvider = class StateServiceProvider {
-    constructor(currentStateService) {
-        this.currentStateService = currentStateService;
-        this.defaultStateService = this.currentStateService;
-    }
-    get stateService() {
-        return this.currentStateService;
-    }
-    setCurrentStateService(service) {
-        this.currentStateService = service;
-    }
-    resetToDefault() {
-        this.currentStateService = this.defaultStateService;
-    }
-};
-StateServiceProvider = __decorate([
-    injectable(),
-    __param(0, inject("StateService")),
-    __metadata("design:paramtypes", [Object])
-], StateServiceProvider);
-export { StateServiceProvider };

package/src/method/MethodParameterDecoder.ts

@@ -1,70 +0,0 @@
-/* eslint-disable no-underscore-dangle */
-import { Field } from "snarkyjs";
-
-import { RuntimeModule } from "../runtime/RuntimeModule";
-
-export interface Fieldable {
-  toFields: () => Field[];
-}
-
-export interface FromFieldClass {
-  new: (...args: any[]) => any;
-  fromFields: (fields: Field[]) => Fieldable;
-  name: string;
-  // Maybe this is wrong IDK
-  prototype: {
-    _fields?: any[];
-  };
-  sizeInFields?: () => number;
-}
-
-const errors = {
-  fieldLengthNotMatching: (expected: number, actual: number) =>
-    new Error(`Expected ${expected} field elements, got ${actual}`),
-
-  typeNotCompatible: (name: string) =>
-    new Error(
-      `Cannot decode type ${name}, it has to be either a Struct, CircuitValue or built-in snarkyjs type`
-    ),
-};
-
-export class MethodParameterDecoder {
-  public static fromMethod(target: RuntimeModule<unknown>, methodName: string) {
-    const paramtypes = Reflect.getMetadata(
-      "design:paramtypes",
-      target,
-      methodName
-    );
-
-    return new MethodParameterDecoder(paramtypes);
-  }
-
-  private constructor(private readonly types: FromFieldClass[]) {}
-
-  public fromFields(fields: Field[]): Fieldable[] {
-    if (fields.length < this.fieldSize) {
-      throw errors.fieldLengthNotMatching(this.fieldSize, fields.length);
-    }
-
-    let stack = fields.slice();
-
-    return this.types.map((type) => {
-      const numberFieldsNeeded =
-        type.prototype._fields?.length ?? type.sizeInFields?.() ?? -1;
-      if (numberFieldsNeeded === -1) {
-        throw errors.typeNotCompatible(type.name);
-      }
-      const structFields = stack.slice(0, numberFieldsNeeded);
-      stack = stack.slice(numberFieldsNeeded);
-      return type.fromFields(structFields);
-    });
-  }
-
-  public get fieldSize(): number {
-    return this.types
-      .map(
-        (type) => type.prototype._fields?.length ?? type.sizeInFields?.() ?? 0
-      )
-      .reduce((a, b) => a + b, 0);
-  }
-}

package/src/state/decorator.ts

@@ -1,63 +0,0 @@
-import { Path, State } from "@proto-kit/protocol";
-
-import type { RuntimeModule } from "../runtime/RuntimeModule.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.stateServiceProvider = self.runtime.stateServiceProvider;
-        }
-        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 "@proto-kit/protocol";
-
-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"
-  ]
-}