@proto-kit/protocol 0.1.1-develop.336 → 0.1.1-develop.455

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);
+  }
+}

package/src/prover/statetransition/StateTransitionProver.ts

@@ -6,13 +6,10 @@ import {
   log,
   PlainZkProgram,
   provableMethod,
+  RollupMerkleTreeWitness,
   ZkProgrammable,
 } from "@proto-kit/common";
 
-import {
-  MerkleTreeUtils,
-  RollupMerkleWitness,
-} from "../../utils/merkletree/RollupMerkleTree.js";
 import {
   DefaultProvableHashList,
   ProvableHashList,
@@ -25,7 +22,7 @@ import {
 import { constants } from "../../Constants";
 import { ProtocolModule } from "../../protocol/ProtocolModule";
 
-import { StateTransitionWitnessProvider } from "./StateTransitionWitnessProvider.js";
+import { StateTransitionWitnessProvider } from "./StateTransitionWitnessProvider";
 import {
   StateTransitionProvable,
   StateTransitionProverPublicInput,
@@ -192,12 +189,11 @@ export class StateTransitionProverProgrammable extends ZkProgrammable<
     type: ProvableStateTransitionType,
     index = 0
   ) {
-    const treeWitness = Provable.witness(RollupMerkleWitness, () =>
+    const witness = Provable.witness(RollupMerkleTreeWitness, () =>
       this.witnessProvider.getWitness(transition.path)
     );
 
-    const membershipValid = MerkleTreeUtils.checkMembership(
-      treeWitness,
+    const membershipValid = witness.checkMembership(
       state.stateRoot,
       transition.path,
       transition.from.value
@@ -212,10 +208,7 @@ export class StateTransitionProverProgrammable extends ZkProgrammable<
         )
       );
 
-    const newRoot = MerkleTreeUtils.computeRoot(
-      treeWitness,
-      transition.to.value
-    );
+    const newRoot = witness.calculateRoot(transition.to.value);
 
     state.stateRoot = Provable.if(
       transition.to.isSome,
@@ -345,7 +338,7 @@ export class StateTransitionProverProgrammable extends ZkProgrammable<
 
 @injectable()
 export class StateTransitionProver
-  extends ProtocolModule<object>
+  extends ProtocolModule
   implements StateTransitionProvable
 {
   public readonly zkProgrammable: StateTransitionProverProgrammable;

package/src/prover/statetransition/StateTransitionWitnessProvider.ts

@@ -1,7 +1,6 @@
 import type { Field } from "o1js";
 import { injectable } from "tsyringe";
-
-import { RollupMerkleWitness } from "../../utils/merkletree/RollupMerkleTree.js";
+import { RollupMerkleTreeWitness } from "@proto-kit/common";
 
 /**
  * Interface for providing merkle witnesses to the state-transition prover
@@ -11,14 +10,14 @@ export interface StateTransitionWitnessProvider {
    * Provides the merkle witness corresponding to the given key
    * @param key Merkle-tree key
    */
-  getWitness: (key: Field) => RollupMerkleWitness;
+  getWitness: (key: Field) => RollupMerkleTreeWitness;
 }
 
 @injectable()
 export class NoOpStateTransitionWitnessProvider
   implements StateTransitionWitnessProvider
 {
-  public getWitness(): RollupMerkleWitness {
-    return new RollupMerkleWitness({ path: [], isLeft: [] });
+  public getWitness(): RollupMerkleTreeWitness {
+    return new RollupMerkleTreeWitness({ path: [], isLeft: [] });
   }
 }

package/src/state/State.ts

@@ -54,6 +54,13 @@ export class State<Value> extends Mixin(WithPath, WithStateServiceProvider) {
     super();
   }
 
+  /**
+   * Returns the state that is currently the current state tree
+   * value: The value-fields, or if not state was found, dummy values
+   * isSome: Whether the values where found in the state or not
+   * (Basically, whether the value-fields are dummy values or actual values
+   * @private
+   */
   private getState(): { value: Value; isSome: Bool } {
     this.hasStateServiceOrFail();
     this.hasPathOrFail();
@@ -99,7 +106,7 @@ export class State<Value> extends Mixin(WithPath, WithStateServiceProvider) {
    *
    * @returns Optional value of the current state
    */
-  private witnessState() {
+  private witnessFromState() {
     // get the value from storage, or return a dummy value instead
     const value = Provable.witness(this.valueType, () => this.getState().value);
 
@@ -116,7 +123,7 @@ export class State<Value> extends Mixin(WithPath, WithStateServiceProvider) {
    * @returns Option representation of the current state.
    */
   public get(): Option<Value> {
-    const option = this.witnessState();
+    const option = this.witnessFromState();
 
     this.hasPathOrFail();
 
@@ -142,8 +149,8 @@ export class State<Value> extends Mixin(WithPath, WithStateServiceProvider) {
    */
   public set(value: Value) {
     // link the transition to the current state
-    const fromOption = this.witnessState();
-    const toOption = Option.from(Bool(true), value, this.valueType);
+    const fromOption = this.witnessFromState();
+    const toOption = Option.fromValue(value, this.valueType);
 
     this.hasPathOrFail();
 

package/src/state/StateServiceProvider.ts

@@ -14,14 +14,6 @@ const errors = {
 export class StateServiceProvider {
   private readonly stateServiceStack: StateService[] = [];
 
-  public constructor(
-    @inject("StateService") private readonly baseStateService?: StateService
-  ) {
-    if (baseStateService !== undefined) {
-      this.stateServiceStack.push(baseStateService);
-    }
-  }
-
   public get stateService(): StateService {
     if (this.stateServiceStack.length === 0) {
       throw errors.stateServiceNotSet();
@@ -37,8 +29,8 @@ export class StateServiceProvider {
   }
 
   public popCurrentStateService() {
-    if (this.stateServiceStack.length === 1) {
-      log.trace("Trying to pop last available (root) stateservice");
+    if (this.stateServiceStack.length === 0) {
+      log.trace("Trying to pop from empty state-service stack");
       return;
     }
     this.stateServiceStack.pop();