Merge pull request #418 from proto-kit/feature/tx-hook-config-validation

Added static config validation for transaction fee hook

Author: rpanic

.github/workflows/pull-request-develop.yml

@@ -113,7 +113,7 @@ jobs:
         image: redis:6.2-alpine
         ports:
           - 6379:6379
-      lighnet:
+      lightnet:
         image: o1labs/mina-local-network:compatible-latest-lightnet
         env:
           RUN_ARCHIVE_NODE: true
@@ -151,4 +151,4 @@ jobs:
           polling-interval-ms: 5000
 
       - name: "Integration tests"
-        run: npm run test:integration
+        run: npm run test:integration

packages/library/src/hooks/TransactionFeeHook.ts

@@ -67,7 +67,9 @@ export class TransactionFeeHook extends ProvableTransactionHook<TransactionFeeHo
   // check if the fee config is compatible with the current runtime
   // we couldn't resolve this purely on the type level, so we have to do it here
   public verifyConfig() {
-    Object.keys(super.config.methods).forEach((combinedMethodName) => {
+    const { config } = this;
+
+    Object.keys(config.methods).forEach((combinedMethodName) => {
       const [runtimeModule, runtimeMethod] = combinedMethodName.split(".");
       const resolvedRuntimeModule = this.runtime.resolve(runtimeModule);
 
@@ -79,8 +81,26 @@ export class TransactionFeeHook extends ProvableTransactionHook<TransactionFeeHo
         throw errors.invalidMethod(combinedMethodName);
       }
     });
+
+    const properties = [
+      "feeRecipient",
+      "tokenId",
+      "baseFee",
+      "perWeightUnitFee",
+    ] as const;
+    const missing = properties
+      .filter((property) => {
+        return config[property] === undefined;
+      })
+      .join(", ");
+
+    if (missing.length > 0) {
+      throw new Error(`TransactionFeeHook is missing config values ${missing}`);
+    }
   }
 
+  private async checkConfig() {}
+
   public async start() {
     this.persistedFeeAnalyzer = new RuntimeFeeAnalyzerService(this.runtime);
     this.verifyConfig();

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts

@@ -19,6 +19,7 @@ import { BaseLayer, StaticBaseLayer } from "./BaseLayer";
 import { LocalBlockchainUtils } from "./network-utils/LocalBlockchainUtils";
 import { LightnetUtils } from "./network-utils/LightnetUtils";
 import { RemoteNetworkUtils } from "./network-utils/RemoteNetworkUtils";
+import { MinaNetworkUtils } from "./network-utils/MinaNetworkUtils";
 
 export type LocalMinaBaseLayerConfig = {
   type: "local";
@@ -96,7 +97,9 @@ export class MinaBaseLayer
     if (this.config.network.type === "remote") {
       throw new Error("NetworkUtils not available for remote networks");
     }
-    return this.sequencer.dependencyContainer.resolve("NetworkUtils");
+    return this.sequencer.dependencyContainer.resolve<MinaNetworkUtils>(
+      "NetworkUtils"
+    );
   }
 
   public isLocalBlockChain(): boolean {

packages/sequencer/src/settlement/MinaSigner.ts

@@ -1,8 +1,9 @@
 import { Field, PrivateKey, PublicKey, Signature, Transaction } from "o1js";
-import { noop } from "@proto-kit/common";
-import { injectable } from "tsyringe";
 
-import { SequencerModule } from "../sequencer/builder/SequencerModule";
+import {
+  sequencerModule,
+  SequencerModule,
+} from "../sequencer/builder/SequencerModule";
 
 /**
  * Options for signing transactions.
@@ -117,7 +118,7 @@ export interface InMemorySignerConfig {
  * for the Mina blockchain protocol. This implementation is suitable for
  * server-side sequencer operations where keys can be securely stored in memory.
  */
-@injectable()
+@sequencerModule()
 export class InMemoryMinaSigner
   extends SequencerModule<InMemorySignerConfig>
   implements MinaSigner
@@ -330,6 +331,5 @@ export class InMemoryMinaSigner
    */
   public async start() {
     this.initializeKeyMap();
-    noop();
   }
 }