Merge pull request #264 from proto-kit/refactor/state-homogenization

State Decorator homogenization

Author: rpanic

packages/common/src/utils.ts

@@ -259,3 +259,24 @@ export function batch<T>(
 
   return range(0, numBatches).map((i) => partitioned[i].map((x) => x[0]));
 }
+
+export type Reference<T> = {
+  set value(value: T);
+  get value(): T;
+};
+
+class ReferenceObject<T> {
+  public constructor(private internalValue: T) {}
+
+  get value() {
+    return this.internalValue;
+  }
+
+  set value(t: T) {
+    this.internalValue = t;
+  }
+}
+
+export function createReference<T>(initial: T): Reference<T> {
+  return new ReferenceObject(initial);
+}

packages/library/src/runtime/Balances.ts

@@ -1,11 +1,6 @@
 import { EventsRecord, NoConfig } from "@proto-kit/common";
-import {
-  RuntimeModule,
-  runtimeMethod,
-  state,
-  runtimeModule,
-} from "@proto-kit/module";
-import { StateMap, assert } from "@proto-kit/protocol";
+import { RuntimeModule, runtimeMethod, runtimeModule } from "@proto-kit/module";
+import { StateMap, assert, state } from "@proto-kit/protocol";
 import { Field, PublicKey, Struct, Provable } from "o1js";
 
 import { UInt64 } from "../math/UInt64";

packages/library/src/runtime/Withdrawals.ts

@@ -1,10 +1,5 @@
-import {
-  RuntimeEvents,
-  runtimeModule,
-  RuntimeModule,
-  state,
-} from "@proto-kit/module";
-import { StateMap, Withdrawal } from "@proto-kit/protocol";
+import { RuntimeEvents, runtimeModule, RuntimeModule } from "@proto-kit/module";
+import { StateMap, Withdrawal, state } from "@proto-kit/protocol";
 import { Field, PublicKey, Struct } from "o1js";
 import { inject } from "tsyringe";
 

packages/module/src/index.ts

@@ -4,7 +4,6 @@ export * from "./runtime/RuntimeModule";
 export * from "./runtime/RuntimeEnvironment";
 export * from "./runtime/Runtime";
 export * from "./state/InMemoryStateService";
-export * from "./state/decorator";
 export * from "./method/MethodParameterEncoder";
 export * from "./runtime/MethodIdResolver";
 export * from "./factories/MethodIdFactory";

packages/module/src/method/runtimeMethod.ts

@@ -98,7 +98,7 @@ export function toWrappedMethod(
     const stateTransitionsHash = toStateTransitionsHash(stateTransitions);
     const eventsHash = toEventsHash(events);
 
-    const { name, runtime } = this;
+    const { name, parent: runtime } = this;
 
     if (name === undefined) {
       throw errors.runtimeNameNotSet();
@@ -276,10 +276,10 @@ function runtimeMethodInternal(options: {
       executionContext.beforeMethod(constructorName, methodName, args);
 
       if (executionContext.isTopLevel) {
-        if (!this.runtime) {
+        if (!this.parent) {
           throw errors.runtimeNotProvided(constructorName);
         }
-        executionContext.setProver(prover.bind(this.runtime.zkProgrammable));
+        executionContext.setProver(prover.bind(this.parent.zkProgrammable));
       }
 
       let result: unknown;

packages/module/src/runtime/Runtime.ts

@@ -371,7 +371,7 @@ export class Runtime<Modules extends RuntimeModulesRecord>
     containedModule: InstanceType<Modules[StringKeyOf<Modules>]>
   ) {
     containedModule.name = moduleName;
-    containedModule.runtime = this;
+    containedModule.parent = this;
 
     super.decorateModule(moduleName, containedModule);
   }

packages/module/src/runtime/RuntimeModule.ts

@@ -75,7 +75,7 @@ export class RuntimeModule<
 
   public name?: string;
 
-  public runtime?: RuntimeEnvironment;
+  public parent?: RuntimeEnvironment;
 
   public events?: RuntimeEvents<any> = undefined;
 

packages/module/src/state/decorator.ts

@@ -0,0 +1,10 @@
+export const MINA_PREFIXES = {
+  event: "MinaZkappEvent******",
+  events: "MinaZkappEvents*****",
+  sequenceEvents: "MinaZkappSeqEvents**",
+} as const;
+
+export const MINA_SALTS = {
+  empty_actions: "MinaZkappActionsEmpty",
+  empty_events: "MinaZkappEventsEmpty",
+};

packages/protocol/src/hashing/mina-prefixes.ts

@@ -0,0 +1,23 @@
+import padEnd from "lodash/padEnd";
+import mapValues from "lodash/mapValues";
+
+const length = 20;
+function padToHashPrefix(s: string): string {
+  if (s.length > 20) {
+    throw new Error(`Prefix string ${s} is too long (max ${length})`);
+  }
+  return padEnd(s, length, "*");
+}
+
+function padPrefixRecord<T extends Record<string, string>>(
+  record: T
+): {
+  [Key in keyof T]: string;
+} {
+  return mapValues(record, padToHashPrefix);
+}
+
+export const PROTOKIT_PREFIXES = padPrefixRecord({
+  STATE_PROTOCOL: "pk-protocol-state",
+  STATE_RUNTIME: "pk-runtime-state",
+});