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

package/src/state/assert/assert.ts

@@ -1,9 +1,8 @@
-import { Bool, Provable } from "snarkyjs";
+import { Bool, Provable } from "o1js";
 import { container } from "tsyringe";
 import { log } from "@proto-kit/common";
 
 import { RuntimeMethodExecutionContext } from "../context/RuntimeMethodExecutionContext";
-import { exec } from "child_process";
 
 /**
  * Maintains an execution status of the current runtime module method,
@@ -14,15 +13,26 @@ import { exec } from "child_process";
  * @param condition - Result of the assertion made about the execution status
  * @param message - Optional message describing the prior status
  */
-export function assert(condition: Bool, message?: string) {
+export function assert(condition: Bool, message?: string | (() => string)) {
   const executionContext = container.resolve(RuntimeMethodExecutionContext);
   const previousStatus = executionContext.current().result.status;
-  const status = Provable.if(previousStatus, Bool, condition, previousStatus);
+  const status = condition.and(previousStatus);
 
-  if (!condition.toBoolean()) {
-    log.debug("Assertion failed: ", message);
-    executionContext.setStatusMessage(message);
-  }
+  Provable.asProver(() => {
+    if (!condition.toBoolean() && previousStatus.toBoolean()) {
+      const messageString =
+        message !== undefined && typeof message === "function"
+          ? message()
+          : message;
+
+      // If no isSimulated was set, we treat it as not simulated,
+      // therefore printing the log
+      if (!(executionContext.current().isSimulated ?? false)) {
+        log.debug("Assertion failed: ", messageString);
+      }
+      executionContext.setStatusMessage(messageString, new Error().stack);
+    }
+  });
 
   executionContext.setStatus(status);
 }

package/src/state/context/RuntimeMethodExecutionContext.ts

@@ -1,6 +1,10 @@
-import { Bool } from "snarkyjs";
+import { Bool, FlexibleProvablePure, Provable, Struct } 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";
@@ -13,12 +17,20 @@ const errors = {
 };
 
 export class RuntimeProvableMethodExecutionResult extends ProvableMethodExecutionResult {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public stateTransitions: StateTransition<any>[] = [];
 
   public status: Bool = Bool(true);
 
   public statusMessage?: string;
+
+  public stackTrace?: string;
+
+  public events: {
+    eventType: FlexibleProvablePure<any>;
+    event: any;
+    eventName: string;
+    condition: Bool;
+  }[] = [];
 }
 
 export interface RuntimeMethodExecutionData {
@@ -26,6 +38,13 @@ export interface RuntimeMethodExecutionData {
   networkState: NetworkState;
 }
 
+export class RuntimeMethodExecutionDataStruct
+  extends Struct({
+    transaction: RuntimeTransaction,
+    networkState: NetworkState,
+  })
+  implements RuntimeMethodExecutionData {}
+
 /**
  * Execution context used to wrap runtime module methods,
  * allowing them to post relevant information (such as execution status)
@@ -37,12 +56,17 @@ export class RuntimeMethodExecutionContext extends ProvableMethodExecutionContex
 
   public input: RuntimeMethodExecutionData | undefined;
 
-  // The input corresponding to the current result
-  private lastInput: RuntimeMethodExecutionData | undefined;
+  private isSimulated: boolean = false;
 
-  public override result = new RuntimeProvableMethodExecutionResult();
+  // The inputs corresponding to the current result
+  private lastInputs:
+    | {
+        input: RuntimeMethodExecutionData | undefined;
+        isSimulated: boolean;
+      }
+    | undefined;
 
-  private isSimulated: boolean = false;
+  public override result = new RuntimeProvableMethodExecutionResult();
 
   private assertSetupCalled(): asserts this is {
     input: RuntimeMethodExecutionData;
@@ -61,15 +85,31 @@ export class RuntimeMethodExecutionContext extends ProvableMethodExecutionContex
     this.result.stateTransitions.push(stateTransition);
   }
 
+  public addEvent<T>(
+    eventType: FlexibleProvablePure<T>,
+    event: T,
+    eventName: string,
+    condition: Bool = Bool(true)
+  ) {
+    this.assertSetupCalled();
+    this.result.events.push({
+      eventType,
+      event,
+      eventName,
+      condition,
+    });
+  }
+
   /**
    * @param message - Status message to acompany the current status
    */
-  public setStatusMessage(message?: string) {
+  public setStatusMessage(message?: string, stackTrace?: string) {
     this.assertSetupCalled();
     if (this.isSimulated) {
       return;
     }
     this.result.statusMessage ??= message;
+    this.result.stackTrace ??= stackTrace;
   }
 
   /**
@@ -90,6 +130,18 @@ export class RuntimeMethodExecutionContext extends ProvableMethodExecutionContex
     this.input = input;
   }
 
+  public witnessInput(): RuntimeMethodExecutionDataStruct {
+    this.assertSetupCalled();
+    return Provable.witness(RuntimeMethodExecutionDataStruct, () => {
+      // TODO Is that right? Or this.current().input
+      const { transaction, networkState } = this.input!;
+      return new RuntimeMethodExecutionDataStruct({
+        networkState,
+        transaction,
+      });
+    });
+  }
+
   public setSimulated(simulated: boolean) {
     this.isSimulated = simulated;
   }
@@ -104,8 +156,12 @@ export class RuntimeMethodExecutionContext extends ProvableMethodExecutionContex
   public afterMethod() {
     super.afterMethod();
     if (this.isFinished) {
-      this.lastInput = this.input;
-      this.input = undefined;
+      this.lastInputs = {
+        input: this.input,
+        isSimulated: this.isSimulated,
+      };
+      // TODO: find out why input isnt set in TransactionFeeHook during assert
+      // this.input = undefined;
       this.isSimulated = false;
     }
   }
@@ -118,7 +174,8 @@ export class RuntimeMethodExecutionContext extends ProvableMethodExecutionContex
     return {
       isFinished: this.isFinished,
       result: this.result,
-      input: this.lastInput,
+      input: this.lastInputs?.input,
+      isSimulated: this.lastInputs?.isSimulated,
     };
   }
 }

package/src/state/context/TransitionMethodExecutionContext.ts

@@ -1,7 +1,6 @@
 import { StateTransition } from "../../model/StateTransition";
 
 export class TransitionMethodExecutionResult {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public stateTransitions: StateTransition<any>[] = [];
 }
 

package/src/state/protocol/ProtocolState.ts

@@ -1,6 +1,9 @@
-import { State } from "../State";
-import { ToFieldable } from "../../model/Option";
+import { createReference, Reference } from "@proto-kit/common";
+
+import { WithPath, WithStateServiceProvider } from "../State";
 import { Path } from "../../model/Path";
+import { StateServiceProvider } from "../StateServiceProvider";
+import { PROTOKIT_PREFIXES } from "../../hashing/protokit-prefixes";
 import { TransitioningProtocolModule } from "../../protocol/TransitioningProtocolModule";
 
 const errors = {
@@ -10,53 +13,85 @@ const errors = {
       Did you forget to extend your block module with 'extends ...Hook'?`
     ),
 
-  missingProtocol: (className: string) =>
+  missingParent: (className: string, type: string, moduleType: string) =>
     new Error(
-      `Unable to provide 'procotol' for state, ${className} is missing a name. 
-      Did you forget to extend your block module with 'extends ...Hook'?`
+      `Unable to provide parent '${type}' for state, ${className} is missing a name. 
+      Did you forget to extend your module with 'extends ${moduleType}'?`
     ),
 };
 
+export interface StatefulModule {
+  name?: string;
+  parent?: {
+    stateServiceProvider: StateServiceProvider;
+  };
+}
+
 /**
  * Decorates a runtime module property as state, passing down some
  * underlying values to improve developer experience.
  */
-export function protocolState() {
-  return <TargetTransitioningModule extends TransitioningProtocolModule>(
+export function state() {
+  return <TargetTransitioningModule extends StatefulModule>(
     target: TargetTransitioningModule,
     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 TargetTransitioningModule;
+      get: function get(this: TargetTransitioningModule) {
+        // The reason for why we store the state value in this weird way is that
+        // in the decorator on the prototype of the class. This means that if there
+        // are multiple instances of this class, any closure that this getter shares
+        // will be the same for all instances.
+        // Therefore, we need to somehow save the set instance on the instance itself
 
-        if (self.name === undefined) {
-          throw errors.missingName(self.constructor.name);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const reference:
+          | Reference<WithPath & WithStateServiceProvider>
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+          | undefined = (this as any)[`protokit_state_cache_${propertyKey}`];
+
+        // Short-circuit this to return the state in case its already initialized
+        if (reference !== undefined && reference.value.path !== undefined) {
+          return reference.value;
+        }
+
+        if (this.name === undefined) {
+          throw errors.missingName(this.constructor.name);
         }
 
-        if (!self.protocol) {
-          throw errors.missingProtocol(self.constructor.name);
+        const isProtocol = target instanceof TransitioningProtocolModule;
+
+        if (!this.parent) {
+          const debugInfo = isProtocol
+            ? { parentName: "protocol", baseModuleNames: "...Hook" }
+            : { parentName: "runtime", baseModuleNames: "RuntimeModule" };
+
+          throw errors.missingParent(
+            this.constructor.name,
+            debugInfo.parentName,
+            debugInfo.baseModuleNames
+          );
         }
 
-        // eslint-disable-next-line no-warning-comments
-        // TODO Add Prefix?
-        const path = Path.fromProperty(self.name, propertyKey);
-        if (value) {
+        const statePrefix = isProtocol
+          ? PROTOKIT_PREFIXES.STATE_PROTOCOL
+          : PROTOKIT_PREFIXES.STATE_RUNTIME;
+        const path = Path.fromProperty(this.name, propertyKey, statePrefix);
+        if (reference) {
+          const { value } = reference;
           value.path = path;
-          value.stateServiceProvider = self.protocol.stateServiceProvider;
+          value.stateServiceProvider = this.parent.stateServiceProvider;
         }
-        return value;
+        return reference?.value;
       },
 
-      set: (newValue: State<unknown>) => {
-        value = newValue;
+      set: function set(
+        this: TargetTransitioningModule & any,
+        newValue: WithPath & WithStateServiceProvider
+      ) {
+        this[`protokit_state_cache_${propertyKey}`] = createReference(newValue);
       },
     });
   };

package/src/utils/FieldOptions.ts

@@ -0,0 +1,13 @@
+import { Bool, Field, Provable, Struct } from "o1js";
+
+export class FieldOption extends Struct({
+  isSome: Bool,
+  value: Field,
+}) {
+  public static from(isSome: Bool, potentialValue: Field) {
+    return {
+      isSome,
+      value: Provable.if(isSome, potentialValue, Field(0)),
+    };
+  }
+}

package/src/utils/MinaPrefixedProvableHashList.ts

@@ -0,0 +1,70 @@
+import { Field, Poseidon, ProvablePure } from "o1js";
+import { hashWithPrefix, prefixToField } from "@proto-kit/common";
+
+import { MINA_PREFIXES, MINA_SALTS } from "../hashing/mina-prefixes";
+
+import { ProvableHashList } from "./ProvableHashList";
+
+function salt(prefix: string) {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return Poseidon.update(
+    [Field(0), Field(0), Field(0)],
+    [prefixToField(prefix)]
+  ) as [Field, Field, Field];
+}
+
+export function emptyActions(): Field {
+  return salt(MINA_SALTS.empty_actions)[0];
+}
+
+export function emptyEvents(): Field {
+  return salt(MINA_SALTS.empty_events)[0];
+}
+
+export class MinaActions {
+  static actionHash(
+    action: Field[],
+    previousHash: Field = emptyActions()
+  ): Field {
+    const actionDataHash = hashWithPrefix(MINA_PREFIXES.event, action);
+    return hashWithPrefix(MINA_PREFIXES.sequenceEvents, [
+      previousHash,
+      actionDataHash,
+    ]);
+  }
+}
+
+export class MinaEvents {
+  static eventHash(event: Field[], previousHash: Field = emptyEvents()): Field {
+    const actionDataHash = hashWithPrefix(MINA_PREFIXES.event, event);
+    return hashWithPrefix(MINA_PREFIXES.events, [previousHash, actionDataHash]);
+  }
+}
+
+export class MinaPrefixedProvableHashList<
+  Value,
+> extends ProvableHashList<Value> {
+  public constructor(
+    valueType: ProvablePure<Value>,
+    public readonly prefix: string,
+    internalCommitment?: Field
+  ) {
+    super(valueType, internalCommitment);
+  }
+
+  public empty(): Field {
+    return Field(0);
+  }
+
+  protected hash(elements: Field[]): Field {
+    const init = salt(this.prefix);
+    const digest = Poseidon.update(init, elements);
+    return digest[0];
+  }
+}
+
+export class MinaActionsHashList extends MinaPrefixedProvableHashList<Field> {
+  public constructor(internalCommitment?: Field) {
+    super(Field, MINA_PREFIXES.sequenceEvents, internalCommitment);
+  }
+}

package/src/utils/PrefixedProvableHashList.ts

@@ -1,4 +1,4 @@
-import { Field, FlexibleProvablePure, Poseidon } from "snarkyjs";
+import { Field, ProvablePure, Poseidon } from "o1js";
 
 import { ProvableHashList } from "./ProvableHashList.js";
 import { stringToField } from "./utils";
@@ -7,7 +7,7 @@ export class PrefixedProvableHashList<Value> extends ProvableHashList<Value> {
   private readonly prefix: Field;
 
   public constructor(
-    valueType: FlexibleProvablePure<Value>,
+    valueType: ProvablePure<Value>,
     prefix: string,
     internalCommitment: Field = Field(0)
   ) {
@@ -15,6 +15,10 @@ export class PrefixedProvableHashList<Value> extends ProvableHashList<Value> {
     this.prefix = stringToField(prefix);
   }
 
+  public empty(): Field {
+    return Field(0);
+  }
+
   protected hash(elements: Field[]): Field {
     return Poseidon.hash([this.prefix, ...elements]);
   }

package/src/utils/ProvableHashList.ts

@@ -1,16 +1,101 @@
-import { Field, Poseidon, FlexibleProvablePure, Bool, Provable } from "snarkyjs";
+import {
+  Field,
+  Poseidon,
+  Bool,
+  Provable,
+  ProvablePure,
+  Unconstrained,
+} from "o1js";
+
+import { NonMethods } from "./utils";
+
+export type ProvableHashListData<Value> = {
+  preimage: Field;
+  value: NonMethods<Value>;
+};
+
+export type VerifiedTransition<T> = {
+  from: T;
+  to: T;
+};
 
 /**
  * Utilities for creating a hash list from a given value type.
  */
 export abstract class ProvableHashList<Value> {
+  public commitment: Field;
+
   public constructor(
-    private readonly valueType: FlexibleProvablePure<Value>,
-    public commitment: Field = Field(0)
-  ) {}
+    protected readonly valueType: ProvablePure<Value>,
+    commitment?: Field | undefined,
+    private unconstrainedList: Unconstrained<
+      ProvableHashListData<Value>[]
+    > = Unconstrained.from([])
+  ) {
+    this.commitment = commitment ?? this.empty();
+  }
+
+  protected abstract empty(): Field;
 
   protected abstract hash(elements: Field[]): Field;
 
+  private pushUnconstrained(preimage: Field, value: Value, condition?: Bool) {
+    this.unconstrainedList.updateAsProver((array) => {
+      if (condition !== undefined && !condition.toBoolean()) {
+        return array;
+      }
+      return [
+        ...array,
+        {
+          preimage: preimage.toConstant(),
+          value: Provable.toConstant(this.valueType, value),
+        },
+      ];
+    });
+  }
+
+  /**
+   * Fast-forwards the state of the hashlist to a specified new tip.
+   * This assumes the transition (from -> to) to be already verified somewhere
+   * else that is outside this scope.
+   */
+  public fastForward(
+    transition: VerifiedTransition<Field>,
+    message: string = "some hashlist"
+  ) {
+    const { from, to } = transition;
+    from.assertEquals(
+      this.commitment,
+      `From-commitment for ${message} not matching`
+    );
+
+    this.commitment = to;
+  }
+
+  public fastForwardIf(
+    transition: VerifiedTransition<Field>,
+    condition: Bool,
+    message: string = "some hashlist"
+  ) {
+    const { from, to } = transition;
+
+    // Equal to condition -> (from == this.commitment)
+    from
+      .mul(condition.toField())
+      .assertEquals(
+        this.commitment.mul(condition.toField()),
+        `From-commitment for ${message} not matching`
+      );
+
+    this.commitment = Provable.if(condition, to, this.commitment);
+  }
+
+  public witnessTip(preimage: Field, value: Value): Bool {
+    return this.hash([preimage, ...this.valueType.toFields(value)]).equals(
+      this.commitment
+    );
+  }
+
   /**
    * Converts the provided value to Field[] and appends it to
    * the current hashlist.
@@ -19,19 +104,25 @@ export abstract class ProvableHashList<Value> {
    * @returns Current hash list.
    */
   public push(value: Value) {
+    this.pushUnconstrained(this.commitment, value);
+
     this.commitment = this.hash([
       this.commitment,
       ...this.valueType.toFields(value),
     ]);
+
     return this;
   }
 
   public pushIf(value: Value, condition: Bool) {
+    this.pushUnconstrained(this.commitment, value, condition);
+
     const newCommitment = this.hash([
       this.commitment,
       ...this.valueType.toFields(value),
     ]);
     this.commitment = Provable.if(condition, newCommitment, this.commitment);
+
     return this;
   }
 
@@ -41,10 +132,24 @@ export abstract class ProvableHashList<Value> {
   public toField() {
     return this.commitment;
   }
+
+  public isEmpty(): Bool {
+    return this.commitment.equals(this.empty());
+  }
+
+  public getUnconstrainedValues(): Unconstrained<
+    ProvableHashListData<Value>[]
+  > {
+    return this.unconstrainedList;
+  }
 }
 
 export class DefaultProvableHashList<Value> extends ProvableHashList<Value> {
   public hash(elements: Field[]): Field {
     return Poseidon.hash(elements);
   }
+
+  public empty(): Field {
+    return Field(0);
+  }
 }

package/src/utils/ProvableReductionHashList.ts

@@ -0,0 +1,77 @@
+import { Bool, Field, Poseidon, Provable, ProvablePure } from "o1js";
+
+import { NonMethods } from "./utils";
+
+export class ProvableReductionHashList<Value> {
+  public constructor(
+    protected readonly valueType: ProvablePure<Value>,
+    public commitment: Field = Field(0)
+  ) {}
+
+  public unconstrainedList: Value[] = [];
+
+  private constrainedLastValue: Value | undefined = undefined;
+
+  private preimage: Field = this.commitment;
+
+  public pushAndReduce(
+    value: Value,
+    reduce: (previous: Value) => [Value, Bool]
+  ): { popLast: Bool; value: Value } {
+    let valueToPush = value;
+    let popLast = Bool(false);
+
+    // Theoretically, we can feed the preimage + last value as a witness
+    // for non-zero commitment starts (like used in the BlockProver), because
+    // currently it won't reduce across chunks. But this is okay for now I think
+    if (this.constrainedLastValue !== undefined) {
+      [valueToPush, popLast] = reduce(this.constrainedLastValue);
+    }
+
+    Provable.asProver(() => {
+      if (popLast.toBoolean()) {
+        this.unconstrainedList.pop();
+      }
+
+      const valueAsConstant = this.valueType.fromFields(
+        this.valueType.toFields(valueToPush).map((field) => field.toConstant())
+      );
+      this.unconstrainedList.push(valueAsConstant);
+    });
+
+    const currentCommitment = this.commitment;
+    const noPopCommitment = this.hash([
+      currentCommitment,
+      ...this.valueType.toFields(valueToPush),
+    ]);
+
+    const popCommitment = this.hash([
+      this.preimage,
+      ...this.valueType.toFields(valueToPush),
+    ]);
+
+    this.commitment = Provable.if(popLast, popCommitment, noPopCommitment);
+
+    this.constrainedLastValue = valueToPush;
+    this.preimage = Provable.if(popLast, this.preimage, currentCommitment);
+
+    return {
+      popLast,
+      value: valueToPush,
+    };
+  }
+
+  public pushIf(value: Value, condition: Bool) {
+    throw new Error("pushIf is not implemented for ReducedHashList");
+
+    return this;
+  }
+
+  public hash(elements: Field[]): Field {
+    return Poseidon.hash(elements);
+  }
+
+  public getUnconstrainedValues(): NonMethods<Value>[] {
+    return this.unconstrainedList;
+  }
+}