Merge pull request #101 from proto-kit/feature/tx-fees

Feature/tx fees

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "yab",
+  "name": "protokit",
   "version": "0.0.0",
   "license": "MIT",
   "type": "module",

packages/api/src/graphql/modules/QueryGraphqlModule.ts

@@ -23,6 +23,7 @@ import {
   RuntimeModulesRecord,
 } from "@proto-kit/module";
 import {
+  MandatoryProtocolModulesRecord,
   NetworkState,
   Protocol,
   ProtocolModulesRecord,
@@ -80,7 +81,9 @@ export class QueryGraphqlModule<
     private readonly networkStateTransportModule: NetworkStateTransportModule,
     @inject("Runtime") private readonly runtime: Runtime<RuntimeModules>,
     @inject("Protocol")
-    private readonly protocol: Protocol<ProtocolModulesRecord>,
+    private readonly protocol: Protocol<
+      MandatoryProtocolModulesRecord & ProtocolModulesRecord
+    >,
     @inject("BlockStorage")
     private readonly blockStorage: BlockStorage & HistoricalBlockStorage
   ) {

packages/cli/package.json

@@ -36,6 +36,7 @@
     "@proto-kit/protocol": "*",
     "@proto-kit/sdk": "*",
     "@proto-kit/sequencer": "*",
+    "@proto-kit/library": "*",
     "o1js": "0.13.1"
   },
   "devDependencies": {
@@ -46,6 +47,7 @@
     "@proto-kit/protocol": "*",
     "@proto-kit/sdk": "*",
     "@proto-kit/sequencer": "*",
+    "@proto-kit/library": "*",
     "@types/figlet": "^1.5.7",
     "@types/ink": "^2.0.3",
     "@types/node": "^20.8.10",

packages/cli/src/LocalhostAppChain.ts

@@ -2,25 +2,16 @@ import "reflect-metadata";
 import { PrivateKey } from "o1js";
 import { Runtime, RuntimeModulesRecord } from "@proto-kit/module";
 import {
-  BlockProver,
-  StateTransitionProver,
-  VanillaProtocol,
-  AccountStateModule,
+  MandatoryProtocolModulesRecord,
+  Protocol,
   ProtocolModulesRecord,
 } from "@proto-kit/protocol";
-import { ModulesConfig } from "@proto-kit/common";
 import {
-  BlockProducerModule,
-  InMemoryDatabase,
-  LocalTaskQueue,
-  LocalTaskWorkerModule,
-  ManualBlockTrigger,
-  NoopBaseLayer,
-  PrivateMempool,
-  Sequencer,
-  SequencerModulesRecord,
-  UnprovenProducerModule,
-} from "@proto-kit/sequencer";
+  InMemorySequencerModules,
+  VanillaProtocolModules,
+  VanillaRuntimeModules,
+} from "@proto-kit/library";
+import { Sequencer, SequencerModulesRecord } from "@proto-kit/sequencer";
 import {
   BlockStorageResolver,
   GraphqlSequencerModule,
@@ -33,41 +24,37 @@ import {
 } from "@proto-kit/api";
 import {
   AppChain,
-  AppChainModulesRecord,
-  InMemorySigner,
-  InMemoryTransactionSender,
   StateServiceQueryModule,
   BlockStorageNetworkStateModule,
+  AppChainModulesRecord,
+  InMemoryTransactionSender,
 } from "@proto-kit/sdk";
 
 export class LocalhostAppChain<
-  RuntimeModules extends RuntimeModulesRecord
+  RuntimeModules extends RuntimeModulesRecord,
+  ProtocolModules extends ProtocolModulesRecord &
+    MandatoryProtocolModulesRecord,
+  SequencerModules extends SequencerModulesRecord,
+  AppChainModules extends AppChainModulesRecord
 > extends AppChain<
   RuntimeModules,
-  ProtocolModulesRecord,
-  SequencerModulesRecord,
-  AppChainModulesRecord
+  ProtocolModules,
+  SequencerModules,
+  AppChainModules
 > {
-  public static fromRuntime<
-    RuntimeModules extends RuntimeModulesRecord
-  >(definition: { modules: RuntimeModules }) {
+  public static fromRuntime<RuntimeModules extends RuntimeModulesRecord>(
+    runtimeModules: RuntimeModules
+  ) {
     const appChain = LocalhostAppChain.from({
-      runtime: Runtime.from(definition),
-
-      protocol: VanillaProtocol.from({}),
-
-      sequencer: Sequencer.from({
-        modules: {
-          Database: InMemoryDatabase,
-          Mempool: PrivateMempool,
-          GraphqlServer,
-          LocalTaskWorkerModule,
-          BaseLayer: NoopBaseLayer,
-          BlockProducerModule,
-          UnprovenProducerModule,
-          BlockTrigger: ManualBlockTrigger,
-          TaskQueue: LocalTaskQueue,
-
+      Runtime: Runtime.from({
+        modules: VanillaRuntimeModules.with(runtimeModules),
+      }),
+      Protocol: Protocol.from({
+        modules: VanillaProtocolModules.with({}),
+      }),
+      Sequencer: Sequencer.from({
+        modules: InMemorySequencerModules.with({
+          GraphqlServer: GraphqlServer,
           Graphql: GraphqlSequencerModule.from({
             modules: {
               MempoolResolver,
@@ -78,26 +65,32 @@ export class LocalhostAppChain<
               MerkleWitnessResolver,
             },
           }),
-        },
+        }),
       }),
-
       modules: {
+        // TODO: remove in favour of a real tx sender for the SettlementModule
+        // temporary dependency to make the SettlementModule work
+        TransactionSender: InMemoryTransactionSender,
         QueryTransportModule: StateServiceQueryModule,
         NetworkStateTransportModule: BlockStorageNetworkStateModule,
       },
     });
 
-    appChain.configure({
-      ...appChain.config,
-
+    appChain.configurePartial({
       Protocol: {
         BlockProver: {},
         StateTransitionProver: {},
         AccountState: {},
         BlockHeight: {},
         LastStateRoot: {},
+        TransactionFee: {
+          tokenId: 0n,
+          feeRecipient: PrivateKey.random().toPublicKey().toBase58(),
+          baseFee: 0n,
+          perWeightUnitFee: 0n,
+          methods: {},
+        },
       },
-
       Sequencer: {
         Database: {},
         UnprovenProducerModule: {},
@@ -123,8 +116,10 @@ export class LocalhostAppChain<
         BaseLayer: {},
         TaskQueue: {},
         BlockTrigger: {},
+        SettlementModule: {
+          feepayer: PrivateKey.random(),
+        },
       },
-
       QueryTransportModule: {},
       NetworkStateTransportModule: {},
     });

packages/cli/src/commands/start.tsx

@@ -10,12 +10,13 @@ import {
   state,
 } from "@proto-kit/module";
 import {
-  AccountStateModule,
+  AccountStateHook,
   Option,
+  Protocol,
   State,
   StateMap,
-  VanillaProtocol,
 } from "@proto-kit/protocol";
+import { VanillaProtocolModules } from "@proto-kit/library";
 import { Presets, log, TypedClass } from "@proto-kit/common";
 import {
   AsyncStateService,
@@ -54,98 +55,6 @@ import { Spinner } from "@inkjs/ui";
 
 log.setLevel("ERROR");
 
-export async function startServer({
-  runtime,
-}: {
-  runtime: TypedClass<Runtime<RuntimeModulesRecord>>;
-}) {
-  const appChain = AppChain.from({
-    runtime,
-
-    protocol: VanillaProtocol.from({}),
-
-    sequencer: Sequencer.from({
-      modules: {
-        Mempool: PrivateMempool,
-        GraphqlServer,
-        LocalTaskWorkerModule,
-        BaseLayer: NoopBaseLayer,
-        BlockProducerModule,
-        BlockTrigger: ManualBlockTrigger,
-        TaskQueue: LocalTaskQueue,
-
-        Graphql: GraphqlSequencerModule.from({
-          modules: {
-            MempoolResolver,
-            QueryGraphqlModule,
-            BlockStorageResolver,
-            NodeStatusResolver,
-          },
-
-          config: {
-            MempoolResolver: {},
-            QueryGraphqlModule: {},
-            BlockStorageResolver: {},
-            NodeStatusResolver: {},
-          },
-        }),
-      },
-    }),
-
-    modules: {
-      Signer: InMemorySigner,
-      TransactionSender: InMemoryTransactionSender,
-      QueryTransportModule: StateServiceQueryModule,
-    },
-  });
-
-  appChain.configure({
-    Runtime: {
-      Balances: {},
-    },
-
-    Protocol: {
-      BlockProver: {},
-      StateTransitionProver: {},
-      AccountState: {},
-    },
-
-    Sequencer: {
-      GraphqlServer: {
-        port: 8080,
-        host: "0.0.0.0",
-        graphiql: true,
-      },
-
-      Graphql: {
-        QueryGraphqlModule: {},
-        MempoolResolver: {},
-        BlockStorageResolver: {},
-        NodeStatusResolver: {},
-      },
-
-      Mempool: {},
-      BlockProducerModule: {},
-      LocalTaskWorkerModule: {},
-      BaseLayer: {},
-      TaskQueue: {},
-
-      BlockTrigger: {},
-    },
-
-    TransactionSender: {},
-    QueryTransportModule: {},
-
-    Signer: {
-      signer: PrivateKey.random(),
-    },
-  });
-
-  await appChain.start();
-
-  return appChain;
-}
-
 let appChain: AppChain<any, any, any, any>;
 
 export interface UnprovenBlockExtras {

packages/cli/test/chain.config.ts

@@ -39,9 +39,7 @@ export class Balances extends RuntimeModule<object> {
 }
 
 const appChain = LocalhostAppChain.fromRuntime({
-  modules: {
-    Balances,
-  },
+  Balances,
 });
 
 appChain.configurePartial({

packages/common/src/config/ConfigurableModule.ts

@@ -19,7 +19,7 @@ export interface Configurable<Config> {
   config: Config;
 }
 
-export type NoConfig = Record<string, never>;
+export type NoConfig = Record<never, never>;
 
 /**
  * Used by various module sub-types that may need to be configured

packages/common/src/config/ModuleContainer.ts

@@ -289,19 +289,21 @@ export class ModuleContainer<
     this.config = config;
   }
 
-  public configurePartial(
-    config: RecursivePartial<ModulesConfig<Modules>>
-  ) {
+  public configurePartial(config: RecursivePartial<ModulesConfig<Modules>>) {
     this.config = merge<
-      (ModulesConfig<Modules>) | NoConfig,
+      ModulesConfig<Modules> | NoConfig,
       RecursivePartial<ModulesConfig<Modules>>
     >(this.currentConfig ?? {}, config);
   }
 
+  public get config() {
+    return super.config;
+  }
+
   // eslint-disable-next-line accessor-pairs
   public set config(config: ModulesConfig<Modules>) {
     super.config = merge<
-      (ModulesConfig<Modules>) | NoConfig,
+      ModulesConfig<Modules> | NoConfig,
       ModulesConfig<Modules>
     >(this.currentConfig ?? {}, config);
   }
@@ -346,9 +348,7 @@ export class ModuleContainer<
     moduleName: StringKeyOf<Modules>,
     containedModule: InstanceType<Modules[StringKeyOf<Modules>]>
   ) {
-    // Has to be super.config, getters behave really weird when subtyping
-    const config = super.config?.[moduleName];
-
+    const config = this.config?.[moduleName];
     // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
     if (!config) {
       throw errors.configNotSetInContainer(moduleName.toString());

packages/common/src/zkProgrammable/ZkProgrammable.ts

@@ -46,6 +46,7 @@ export interface PlainZkProgram<PublicInput = undefined, PublicOutput = void> {
         ...args: any
       ) => Promise<Proof<PublicInput, PublicOutput>>)
   >;
+  analyzeMethods: ReturnType<typeof Experimental.ZkProgram>["analyzeMethods"];
 }
 
 export function verifyToMockable<PublicInput, PublicOutput>(

packages/common/src/zkProgrammable/provableMethod.ts

@@ -5,7 +5,8 @@ import { ProvableMethodExecutionContext } from "./ProvableMethodExecutionContext
 import type { WithZkProgrammable, ZkProgrammable } from "./ZkProgrammable";
 import { ToFieldable } from "../utils";
 
-export type O1JSPrimitive = InferProvable<ProvableExtended<unknown>> & ToFieldable;
+export type O1JSPrimitive = InferProvable<ProvableExtended<unknown>> &
+  ToFieldable;
 export type ArgumentTypes = (O1JSPrimitive | Proof<unknown, unknown>)[];
 
 // eslint-disable-next-line etc/prefer-interface

packages/library/package.json

@@ -17,13 +17,16 @@
     "access": "public"
   },
   "dependencies": {
-    "@proto-kit/protocol": "*",
     "bigint-isqrt": "^0.3.2",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.1",
     "reflect-metadata": "^0.1.13"
   },
   "peerDependencies": {
+    "@proto-kit/protocol": "*",
+    "@proto-kit/module": "*",
+    "@proto-kit/common": "*",
+    "@proto-kit/sequencer": "*",
     "o1js": "0.13.1",
     "tsyringe": "^4.7.0"
   },