@proto-kit/protocol 0.1.1-develop.340 → 0.1.1-develop.456

package/src/model/Option.ts

@@ -17,10 +17,67 @@ export class ProvableOption extends Struct({
   }
 }
 
+export abstract class OptionBase {
+  protected constructor(public isSome: Bool, public isForcedSome: Bool) {}
+
+  protected abstract encodeValueToFields(): Field[];
+
+  protected abstract clone(): OptionBase;
+
+  /**
+   * @returns Tree representation of the current value
+   */
+  public get treeValue() {
+    const treeValue = Poseidon.hash(this.encodeValueToFields());
+
+    return Provable.if(
+      this.isSome.and(this.isForcedSome.not()),
+      treeValue,
+      Field(0)
+    );
+  }
+
+  public forceSome() {
+    this.isForcedSome = Provable.if(this.isSome, Bool(false), Bool(true));
+    this.isSome = Bool(true);
+  }
+
+  /**
+   * Returns the `to`-value as decoded as a list of fields
+   * Not in circuit
+   */
+  public toFields(): Field[] {
+    if (this.isSome.toBoolean()) {
+      return this.encodeValueToFields();
+    }
+    return [Field(0)];
+  }
+
+  /**
+   * @returns Provable representation of the current option.
+   */
+  public toProvable() {
+    return new ProvableOption({
+      isSome: this.isSome,
+      value: this.treeValue,
+    });
+  }
+
+  public toJSON() {
+    const value = this.encodeValueToFields().map((field) => field.toString());
+
+    return {
+      isSome: this.isSome.toBoolean(),
+      isForcedSome: this.isForcedSome.toBoolean(),
+      value,
+    };
+  }
+}
+
 /**
  * Option facilitating in-circuit values that may or may not exist.
  */
-export class Option<Value> {
+export class Option<Value> extends OptionBase {
   /**
    * Creates a new Option from the provided parameters
    *
@@ -58,57 +115,28 @@ export class Option<Value> {
     return new Option(Bool(false), Field(0), Field);
   }
 
-  public isForcedSome = Bool(false);
-
   public constructor(
-    public isSome: Bool,
+    isSome: Bool,
     public value: Value,
-    public valueType: FlexibleProvablePure<Value>
-  ) {}
-
-  public clone() {
-    return new Option(this.isSome, this.value, this.valueType);
+    public valueType: FlexibleProvablePure<Value>,
+    isForcedSome = Bool(false)
+  ) {
+    super(isSome, isForcedSome);
   }
 
-  public forceSome() {
-    this.isForcedSome = Provable.if(this.isSome, Bool(false), Bool(true));
-    this.isSome = Bool(true);
+  public encodeValueToFields(): Field[] {
+    return this.valueType.toFields(this.value);
   }
 
-  /**
-   * @returns Tree representation of the current value
-   */
-  public get treeValue() {
-    const treeValue = Poseidon.hash(this.valueType.toFields(this.value));
-
-    return Provable.if(
-      this.isSome.and(this.isForcedSome.not()),
-      treeValue,
-      Field(0)
+  public clone(): Option<Value> {
+    return new Option(
+      this.isSome,
+      this.value,
+      this.valueType,
+      this.isForcedSome
     );
   }
 
-  /**
-   * Returns the `to`-value as decoded as a list of fields
-   * Not in circuit
-   */
-  public toFields(): Field[] {
-    if (this.isSome.toBoolean()) {
-      return this.valueType.toFields(this.value);
-    }
-    return [Field(0)];
-  }
-
-  /**
-   * @returns Provable representation of the current option.
-   */
-  public toProvable() {
-    return new ProvableOption({
-      isSome: this.isSome,
-      value: this.treeValue,
-    });
-  }
-
   /**
    * @returns Returns the value of this option if it isSome,
    * otherwise returns the given defaultValue
@@ -121,17 +149,4 @@ export class Option<Value> {
       defaultValue
     );
   }
-
-  public toJSON() {
-    const valueContent = this.valueType
-      .toFields(this.value)
-      .map((field) => field.toString())
-      .reduce((a, b) => `${a}, ${b}`);
-
-    return {
-      isSome: this.isSome.toBoolean(),
-
-      value: `[${valueContent}]`,
-    };
-  }
 }

package/src/model/StateTransition.ts

@@ -73,8 +73,8 @@ export class StateTransition<Value> {
   public toJSON() {
     return {
       path: this.path.toString(),
-      from: this.from.toJSON(),
-      to: this.to.toJSON(),
+      from: this.fromValue.toJSON(),
+      to: this.toValue.toJSON(),
     };
   }
 }

package/src/model/network/NetworkState.ts

@@ -4,18 +4,18 @@ export class CurrentBlock extends Struct({
   height: UInt64,
 }) {}
 
-export class PreviousBlock extends Struct({
-  rootHash: Field,
-}) {}
-
 export class NetworkState extends Struct({
   block: CurrentBlock,
-  previous: PreviousBlock,
 }) {
   public hash(): Field {
-    return Poseidon.hash([
-      ...CurrentBlock.toFields(this.block),
-      ...PreviousBlock.toFields(this.previous),
-    ]);
+    return Poseidon.hash(CurrentBlock.toFields(this.block));
+  }
+
+  public static empty(){
+    return new NetworkState({
+      block: {
+        height: UInt64.zero,
+      },
+    })
   }
 }

package/src/protocol/Protocol.ts

@@ -22,15 +22,23 @@ import { ProvableTransactionHook } from "./ProvableTransactionHook";
 import { NoopTransactionHook } from "../blockmodules/NoopTransactionHook";
 import { ProtocolEnvironment } from "./ProtocolEnvironment";
 import { AccountStateModule } from "../blockmodules/AccountStateModule";
+import { ProvableBlockHook } from "./ProvableBlockHook";
+import { NoopBlockHook } from "../blockmodules/NoopBlockHook";
+import { BlockHeightHook } from "../blockmodules/BlockHeightHook";
+
+const PROTOCOL_INJECTION_TOKENS = {
+  ProvableTransactionHook: "ProvableTransactionHook",
+  ProvableBlockHook: "ProvableBlockHook",
+};
 
 export type GenericProtocolModuleRecord = ModulesRecord<
   TypedClass<ProtocolModule<unknown>>
 >;
 
-interface BlockProverType extends ProtocolModule<object>, BlockProvable {}
+interface BlockProverType extends ProtocolModule, BlockProvable {}
 
 interface StateTransitionProverType
-  extends ProtocolModule<object>,
+  extends ProtocolModule,
     StateTransitionProvable {}
 
 export interface ProtocolCustomModulesRecord {
@@ -126,67 +134,60 @@ export class Protocol<Modules extends ProtocolModulesRecord>
     // Register the BlockModules seperately since we need to
     // inject them differently later
     let atLeastOneTransactionHookRegistered = false;
+    let atLeastOneBlockHookRegistered = false;
     Object.entries(this.definition.modules).forEach(([key, value]) => {
       if (Object.prototype.isPrototypeOf.call(ProvableTransactionHook, value)) {
         this.container.register(
-          "ProvableTransactionHook",
+          PROTOCOL_INJECTION_TOKENS.ProvableTransactionHook,
           { useToken: key },
           { lifecycle: Lifecycle.ContainerScoped }
         );
         atLeastOneTransactionHookRegistered = true;
       }
+      if (Object.prototype.isPrototypeOf.call(ProvableBlockHook, value)) {
+        this.container.register(
+          PROTOCOL_INJECTION_TOKENS.ProvableBlockHook,
+          { useToken: key },
+          { lifecycle: Lifecycle.ContainerScoped }
+        );
+        atLeastOneBlockHookRegistered = true;
+      }
     });
 
     // We need this so that tsyringe doesn't throw when no hooks are registered
     if (!atLeastOneTransactionHookRegistered) {
       this.container.register(
-        "ProvableTransactionHook",
+        PROTOCOL_INJECTION_TOKENS.ProvableTransactionHook,
         { useClass: NoopTransactionHook },
         { lifecycle: Lifecycle.ContainerScoped }
       );
     }
+    if (!atLeastOneBlockHookRegistered) {
+      this.container.register(
+        PROTOCOL_INJECTION_TOKENS.ProvableBlockHook,
+        { useClass: NoopBlockHook },
+        { lifecycle: Lifecycle.ContainerScoped }
+      );
+    }
   }
 }
 
 export const VanillaProtocol = {
   create() {
-    return VanillaProtocol.from(
-      {},
-      {
-        BlockProver: {},
-        StateTransitionProver: {},
-        AccountState: {},
-      }
-    );
+    return VanillaProtocol.from({});
   },
 
   from<AdditonalModules extends GenericProtocolModuleRecord>(
-    additionalModules: AdditonalModules,
-    config: ModulesConfig<
-      AdditonalModules & {
-        StateTransitionProver: typeof StateTransitionProver;
-        BlockProver: typeof BlockProver;
-        AccountState: typeof AccountStateModule;
-      }
-    >
-  ): TypedClass<
-    Protocol<
-      AdditonalModules & {
-        StateTransitionProver: typeof StateTransitionProver;
-        BlockProver: typeof BlockProver;
-        AccountState: typeof AccountStateModule;
-      }
-    >
-  > {
-    return Protocol.from({
+    additionalModules: AdditonalModules
+  ): TypedClass<Protocol<ProtocolModulesRecord>> {
+    return Protocol.from<ProtocolModulesRecord>({
       modules: {
         StateTransitionProver,
         BlockProver,
         AccountState: AccountStateModule,
+        BlockHeight: BlockHeightHook,
         ...additionalModules,
       },
-
-      config,
     });
   },
 };

package/src/protocol/ProtocolModule.ts

@@ -1,14 +1,14 @@
 import {
   AreProofsEnabled,
   ChildContainerProvider,
-  ConfigurableModule,
-  noop,
+  ConfigurableModule, NoConfig,
+  noop
 } from "@proto-kit/common";
 
 import { ProtocolEnvironment } from "./ProtocolEnvironment";
 
 export abstract class ProtocolModule<
-  Config
+  Config = NoConfig
 > extends ConfigurableModule<Config> {
   public protocol?: ProtocolEnvironment;
 

package/src/protocol/ProvableBlockHook.ts

@@ -0,0 +1,22 @@
+import type { BlockProverState } from "../prover/block/BlockProver";
+import { NetworkState } from "../model/network/NetworkState";
+
+import { TransitioningProtocolModule } from "./TransitioningProtocolModule";
+
+export interface BeforeBlockParameters {
+  state: BlockProverState;
+  networkState: NetworkState;
+}
+
+export interface AfterBlockParameters {
+  state: BlockProverState;
+  networkState: NetworkState;
+}
+
+// Purpose is to validate transition from -> to network state
+export abstract class ProvableBlockHook<
+  Config
+> extends TransitioningProtocolModule<Config> {
+  public abstract beforeBlock(blockData: BeforeBlockParameters): NetworkState;
+  public abstract afterBlock(blockData: AfterBlockParameters): NetworkState;
+}

package/src/protocol/ProvableTransactionHook.ts

@@ -1,7 +1,10 @@
 import { BlockProverExecutionData } from "../prover/block/BlockProvable";
 
 import { TransitioningProtocolModule } from "./TransitioningProtocolModule";
+import { NoConfig } from "@proto-kit/common";
 
-export abstract class ProvableTransactionHook<Config> extends TransitioningProtocolModule<Config> {
+export abstract class ProvableTransactionHook<
+  Config = NoConfig
+> extends TransitioningProtocolModule<Config> {
   public abstract onTransaction(executionData: BlockProverExecutionData): void;
 }

package/src/protocol/TransitioningProtocolModule.ts

@@ -1,5 +1,9 @@
 import { ProtocolModule } from "./ProtocolModule";
 
+/**
+ * A Protocolmodule that enables it's implementing module to access to
+ * StateTransitions and state
+ */
 export abstract class TransitioningProtocolModule<
   Config
 > extends ProtocolModule<Config> {

package/src/prover/block/BlockProvable.ts

@@ -1,10 +1,11 @@
-import { Field, Proof, Struct } from "o1js";
+import { Bool, Field, Proof, Struct } from "o1js";
 import { WithZkProgrammable } from "@proto-kit/common";
 
 import { StateTransitionProof } from "../statetransition/StateTransitionProvable";
 import { MethodPublicOutput } from "../../model/MethodPublicOutput";
 import { ProtocolTransaction } from "../../model/transaction/ProtocolTransaction";
 import { NetworkState } from "../../model/network/NetworkState";
+import { BlockTransactionPosition } from "./BlockTransactionPosition";
 
 export class BlockProverPublicInput extends Struct({
   transactionsHash: Field,
@@ -15,6 +16,7 @@ export class BlockProverPublicInput extends Struct({
 export class BlockProverPublicOutput extends Struct({
   transactionsHash: Field,
   stateRoot: Field,
+  networkStateHash: Field,
 }) {}
 
 export type BlockProverProof = Proof<
@@ -25,7 +27,7 @@ export type BlockProverProof = Proof<
 export class BlockProverExecutionData extends Struct({
   transaction: ProtocolTransaction,
   networkState: NetworkState,
-  // accountstate
+  transactionPosition: BlockTransactionPosition,
 }) {}
 
 export interface BlockProvable

package/src/prover/block/BlockProver.ts

@@ -1,5 +1,13 @@
 /* eslint-disable max-lines */
-import { Experimental, Field, type Proof, Provable, SelfProof } from "o1js";
+import {
+  Bool,
+  Experimental,
+  Field,
+  type Proof,
+  Provable,
+  SelfProof,
+  Struct,
+} from "o1js";
 import { container, inject, injectable, injectAll } from "tsyringe";
 import {
   AreProofsEnabled,
@@ -29,7 +37,9 @@ import {
 import { ProvableStateTransition } from "../../model/StateTransition";
 import { ProvableTransactionHook } from "../../protocol/ProvableTransactionHook";
 import { RuntimeMethodExecutionContext } from "../../state/context/RuntimeMethodExecutionContext";
-import { Protocol, ProtocolModulesRecord } from "../../protocol/Protocol";
+import { ProvableBlockHook } from "../../protocol/ProvableBlockHook";
+import { NetworkState } from "../../model/network/NetworkState";
+import { BlockTransactionPosition } from "./BlockTransactionPosition";
 
 const errors = {
   stateProofNotStartingAtZero: () =>
@@ -75,7 +85,8 @@ export class BlockProverProgrammable extends ZkProgrammable<
       StateTransitionProverPublicOutput
     >,
     public readonly runtime: ZkProgrammable<undefined, MethodPublicOutput>,
-    private readonly blockModules: ProvableTransactionHook<unknown>[]
+    private readonly transactionHooks: ProvableTransactionHook<unknown>[],
+    private readonly blockHooks: ProvableBlockHook<unknown>[]
   ) {
     super();
   }
@@ -165,17 +176,6 @@ export class BlockProverProgrammable extends ZkProgrammable<
       "Network state provided to BlockProver does not match the publicInput"
     );
 
-    // Append tx to transaction list
-    const transactionList = new DefaultProvableHashList(
-      Field,
-      state.transactionsHash
-    );
-
-    const { transactionHash } = appProof.publicOutput;
-    transactionList.push(transactionHash);
-
-    stateTo.transactionsHash = transactionList.commitment;
-
     return stateTo;
   }
 
@@ -204,7 +204,7 @@ export class BlockProverProgrammable extends ZkProgrammable<
     });
     executionContext.beforeMethod("", "", []);
 
-    this.blockModules.forEach((module) => {
+    this.transactionHooks.forEach((module) => {
       module.onTransaction(executionData);
     });
 
@@ -234,6 +234,83 @@ export class BlockProverProgrammable extends ZkProgrammable<
     );
   }
 
+  private getBeforeBlockNetworkState(
+    state: BlockProverState,
+    networkState: NetworkState
+  ) {
+    return this.blockHooks.reduce<NetworkState>((networkState, blockHook) => {
+      return blockHook.beforeBlock({
+        state,
+        networkState,
+      });
+    }, networkState);
+  }
+
+  private getAfterBlockNetworkState(
+    state: BlockProverState,
+    networkState: NetworkState
+  ) {
+    return this.blockHooks.reduce<NetworkState>((networkState, blockHook) => {
+      return blockHook.afterBlock({
+        state,
+        networkState,
+      });
+    }, networkState);
+  }
+
+  private addTransactionToBundle(
+    state: BlockProverState,
+    stateTransitionProof: StateTransitionProof,
+    appProof: Proof<void, MethodPublicOutput>,
+    executionData: BlockProverExecutionData
+  ): {
+    state: BlockProverState;
+    networkState: NetworkState;
+    bundleOpened: Bool;
+    bundleClosed: Bool;
+  } {
+    const { transactionPosition, networkState } = executionData;
+    const stateTo = {
+      ...state,
+    };
+
+    // Execute beforeBlook hooks and apply if it is the first tx of the bundle
+    const beforeHookResult = this.getBeforeBlockNetworkState(
+      state,
+      networkState
+    );
+    const bundleOpened = transactionPosition.equals(
+      BlockTransactionPosition.fromPositionType("FIRST")
+    );
+    const resultingNetworkState = new NetworkState(
+      Provable.if(bundleOpened, NetworkState, beforeHookResult, networkState)
+    );
+    stateTo.networkStateHash = resultingNetworkState.hash();
+
+    // TODO Modify bundle merkle tree as per specs
+
+    // Append tx to transaction list
+    const transactionList = new DefaultProvableHashList(
+      Field,
+      state.transactionsHash
+    );
+
+    const { transactionHash } = appProof.publicOutput;
+    transactionList.push(transactionHash);
+
+    stateTo.transactionsHash = transactionList.commitment;
+
+    return {
+      state: stateTo,
+      networkState: resultingNetworkState,
+      bundleOpened,
+
+      bundleClosed: transactionPosition.equals(
+        BlockTransactionPosition.fromPositionType("LAST")
+      ),
+    };
+  }
+
   @provableMethod()
   public proveTransaction(
     publicInput: BlockProverPublicInput,
@@ -247,16 +324,46 @@ export class BlockProverProgrammable extends ZkProgrammable<
       networkStateHash: publicInput.networkStateHash,
     };
 
-    const stateTo = this.applyTransaction(
+    const bundleInclusionResult = this.addTransactionToBundle(
       state,
       stateProof,
       appProof,
       executionData
     );
 
+    const stateTo = this.applyTransaction(
+      bundleInclusionResult.state,
+      stateProof,
+      appProof,
+      {
+        transaction: executionData.transaction,
+        transactionPosition: executionData.transactionPosition,
+        networkState: bundleInclusionResult.networkState,
+      }
+    );
+
+    // Apply afterBlock hooks
+    const afterBlockNetworkState = this.getAfterBlockNetworkState(
+      stateTo,
+      bundleInclusionResult.networkState
+    );
+    const bundleClosed = executionData.transactionPosition.equals(
+      BlockTransactionPosition.fromPositionType("LAST")
+    );
+
+    // We only need the hash here since this computed networkstate
+    // is only used as an input in the next bundle
+    const resultingNetworkStateHash = Provable.if(
+      bundleClosed,
+      afterBlockNetworkState.hash(),
+      stateTo.networkStateHash
+    );
+
     return new BlockProverPublicOutput({
       stateRoot: stateTo.stateRoot,
       transactionsHash: stateTo.transactionsHash,
+      // eslint-disable-next-line putout/putout
+      networkStateHash: resultingNetworkStateHash,
     });
   }
 
@@ -294,7 +401,7 @@ export class BlockProverProgrammable extends ZkProgrammable<
       proof1.publicInput.networkStateHash,
       errors.transactionsHashNotMatching("publicInput.from -> proof1.from")
     );
-    publicInput.networkStateHash.assertEquals(
+    proof1.publicOutput.networkStateHash.assertEquals(
       proof2.publicInput.networkStateHash,
       errors.transactionsHashNotMatching("proof1.to -> proof2.from")
     );
@@ -302,6 +409,7 @@ export class BlockProverProgrammable extends ZkProgrammable<
     return new BlockProverPublicOutput({
       stateRoot: proof2.publicOutput.stateRoot,
       transactionsHash: proof2.publicOutput.transactionsHash,
+      networkStateHash: proof2.publicOutput.networkStateHash,
     });
   }
 
@@ -387,7 +495,10 @@ export class BlockProverProgrammable extends ZkProgrammable<
  * then be merged to be committed to the base-layer contract
  */
 @injectable()
-export class BlockProver extends ProtocolModule<object> implements BlockProvable {
+export class BlockProver
+  extends ProtocolModule
+  implements BlockProvable
+{
   public zkProgrammable: BlockProverProgrammable;
 
   public constructor(
@@ -399,15 +510,17 @@ export class BlockProver extends ProtocolModule<object> implements BlockProvable
     @inject("Runtime")
     public readonly runtime: WithZkProgrammable<undefined, MethodPublicOutput>,
     @injectAll("ProvableTransactionHook")
-    transactionHooks: ProvableTransactionHook<unknown>[]
+    transactionHooks: ProvableTransactionHook<unknown>[],
+    @injectAll("ProvableBlockHook")
+    blockHooks: ProvableBlockHook<unknown>[]
   ) {
     super();
     this.zkProgrammable = new BlockProverProgrammable(
       this,
       stateTransitionProver.zkProgrammable,
       runtime.zkProgrammable,
-      transactionHooks
-      // protocol.dependencyContainer.resolveAll("P rovableTransactionHook")
+      transactionHooks,
+      blockHooks
     );
   }
 

package/src/prover/block/BlockTransactionPosition.ts

@@ -0,0 +1,34 @@
+import { Bool, Field, Struct } from "o1js";
+import { match } from "ts-pattern";
+
+export type BlockTransactionPositionType = "FIRST" | "LAST" | "MIDDLE";
+
+export class BlockTransactionPosition extends Struct({
+  type: Field,
+}) {
+  private static readonly fieldMapping: Record<
+    BlockTransactionPositionType,
+    number
+  > = {
+    FIRST: 0,
+    MIDDLE: 1,
+    LAST: 2,
+  };
+
+  public static fromPositionType(type: BlockTransactionPositionType) {
+    return new BlockTransactionPosition({
+      type: Field(BlockTransactionPosition.fieldMapping[type]).toConstant(),
+    });
+  }
+
+  public static positionTypeFromIndex(index: number, bundleLength: number) {
+    return match<number, BlockTransactionPositionType>(index)
+      .with(0, () => "FIRST")
+      .with(bundleLength - 1, () => "LAST")
+      .otherwise(() => "MIDDLE");
+  }
+
+  public equals(type: BlockTransactionPosition): Bool {
+    return this.type.equals(type.type);
+  }
+}