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

rpanic · web-flow · commit 7da2dd2ab15b · 2025-02-11T13:40:12.000+01:00
State Decorator homogenization
diff --git a/packages/common/src/utils.ts b/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);
+}
diff --git a/packages/library/src/runtime/Balances.ts b/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";
diff --git a/packages/library/src/runtime/Withdrawals.ts b/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";
 
diff --git a/packages/module/src/index.ts b/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";
diff --git a/packages/module/src/method/runtimeMethod.ts b/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;
diff --git a/packages/module/src/runtime/Runtime.ts b/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);
   }
diff --git a/packages/module/src/runtime/RuntimeModule.ts b/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;
 
diff --git a/packages/module/src/state/decorator.ts b/packages/module/src/state/decorator.ts
diff --git a/packages/protocol/src/hashing/mina-prefixes.ts b/packages/protocol/src/hashing/mina-prefixes.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",
+};
diff --git a/packages/protocol/src/hashing/protokit-prefixes.ts b/packages/protocol/src/hashing/protokit-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",
+});
diff --git a/packages/protocol/src/hooks/AccountStateHook.ts b/packages/protocol/src/hooks/AccountStateHook.ts
@@ -3,7 +3,7 @@ import { injectable } from "tsyringe";
 import { noop } from "@proto-kit/common";
 
 import { StateMap } from "../state/StateMap";
-import { protocolState } from "../state/protocol/ProtocolState";
+import { state } from "../state/protocol/ProtocolState";
 import {
   ProvableTransactionHook,
   BeforeTransactionHookArguments,
@@ -16,7 +16,7 @@ export class AccountState extends Struct({
 
 @injectable()
 export class AccountStateHook extends ProvableTransactionHook {
-  @protocolState() public accountState = StateMap.from<PublicKey, AccountState>(
+  @state() public accountState = StateMap.from<PublicKey, AccountState>(
     PublicKey,
     AccountState
   );
diff --git a/packages/protocol/src/index.ts b/packages/protocol/src/index.ts
@@ -60,3 +60,5 @@ export * from "./settlement/modules/NetworkStateSettlementModule";
 export * from "./settlement/messages/Deposit";
 export * from "./settlement/messages/Withdrawal";
 export { constants as ProtocolConstants } from "./Constants";
+export * from "./hashing/protokit-prefixes";
+export * from "./hashing/mina-prefixes";
diff --git a/packages/protocol/src/model/Path.ts b/packages/protocol/src/model/Path.ts
@@ -1,4 +1,5 @@
 import { Field, type FlexibleProvablePure, Poseidon } from "o1js";
+import { hashWithPrefix } from "@proto-kit/common";
 
 import { stringToField } from "../utils/utils";
 
@@ -21,10 +22,15 @@ export class Path {
    *
    * @param className
    * @param propertyKey
+   * @param prefix
    * @returns Field representation of class name + property name
    */
-  public static fromProperty(className: string, propertyKey: string): Field {
-    return Poseidon.hash([
+  public static fromProperty(
+    className: string,
+    propertyKey: string,
+    prefix: string
+  ): Field {
+    return hashWithPrefix(prefix, [
       Path.toField(className),
       Path.toField(propertyKey),
       Field(0),
diff --git a/packages/protocol/src/protocol/Protocol.ts b/packages/protocol/src/protocol/Protocol.ts
@@ -99,7 +99,7 @@ export class Protocol<
     containedModule: InstanceType<Modules[StringKeyOf<Modules>]>
   ) {
     log.debug(`Decorated ${moduleName}`);
-    containedModule.protocol = this;
+    containedModule.parent = this;
 
     if (containedModule instanceof TransitioningProtocolModule) {
       containedModule.name = moduleName;
diff --git a/packages/protocol/src/protocol/ProtocolModule.ts b/packages/protocol/src/protocol/ProtocolModule.ts
@@ -11,10 +11,10 @@ import { ProtocolEnvironment } from "./ProtocolEnvironment";
 export abstract class ProtocolModule<
   Config = NoConfig,
 > extends ConfigurableModule<Config> {
-  public protocol?: ProtocolEnvironment;
+  public parent?: ProtocolEnvironment;
 
   public get areProofsEnabled(): AreProofsEnabled | undefined {
-    return this.protocol?.getAreProofsEnabled();
+    return this.parent?.getAreProofsEnabled();
   }
 
   public create(childContainerProvider: ChildContainerProvider): void {
diff --git a/packages/protocol/src/protocol/ProvableBlockHook.ts b/packages/protocol/src/protocol/ProvableBlockHook.ts
@@ -1,4 +1,5 @@
 import { Field } from "o1js";
+import { NoConfig } from "@proto-kit/common";
 
 import { NetworkState } from "../model/network/NetworkState";
 import { MethodPublicOutput } from "../model/MethodPublicOutput";
@@ -53,7 +54,7 @@ export function toAfterTransactionHookArgument(
 
 // Purpose is to build transition from -> to network state
 export abstract class ProvableBlockHook<
-  Config,
+  Config = NoConfig,
 > extends TransitioningProtocolModule<Config> {
   public abstract beforeBlock(
     networkState: NetworkState,
diff --git a/packages/protocol/src/settlement/contracts/BridgeContract.ts b/packages/protocol/src/settlement/contracts/BridgeContract.ts
@@ -23,6 +23,7 @@ import {
 } from "../messages/OutgoingMessageArgument";
 import { Path } from "../../model/Path";
 import { Withdrawal } from "../messages/Withdrawal";
+import { PROTOKIT_PREFIXES } from "../../hashing/protokit-prefixes";
 
 import type { SettlementContractType } from "./SettlementSmartContract";
 
@@ -137,7 +138,11 @@ export abstract class BridgeContractBase extends TokenContractV2 {
 
     const [withdrawalModule, withdrawalStateName] =
       BridgeContractBase.args.withdrawalStatePath;
-    const mapPath = Path.fromProperty(withdrawalModule, withdrawalStateName);
+    const mapPath = Path.fromProperty(
+      withdrawalModule,
+      withdrawalStateName,
+      PROTOKIT_PREFIXES.STATE_RUNTIME
+    );
 
     // Count account creation fee to return later, so that the sender can fund
     // those accounts with a separate AU
diff --git a/packages/protocol/src/state/protocol/ProtocolState.ts b/packages/protocol/src/state/protocol/ProtocolState.ts
diff --git a/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts b/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts
diff --git a/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts b/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts
diff --git a/packages/sequencer/src/settlement/BridgingModule.ts b/packages/sequencer/src/settlement/BridgingModule.ts
diff --git a/packages/stack/src/scripts/graphql/server.ts b/packages/stack/src/scripts/graphql/server.ts

Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,7 @@ export class Runtime<Modules extends RuntimeModulesRecord>`
`371`	`371`	`containedModule: InstanceType<Modules[StringKeyOf<Modules>]>`
`372`	`372`	`) {`
`373`	`373`	`containedModule.name = moduleName;`
`374`		`- containedModule.runtime = this;`
	`374`	`+ containedModule.parent = this;`
`375`	`375`
`376`	`376`	`super.decorateModule(moduleName, containedModule);`
`377`	`377`	`}`