@proto-kit/protocol 0.1.1-develop.1087 → 0.1.1-develop.1309

package/src/settlement/modularity/types.ts

@@ -0,0 +1,22 @@
+import { TypedClass } from "@proto-kit/common";
+
+import {
+  ContractModule,
+  SmartContractClassFromInterface,
+} from "../ContractModule";
+import type { SettlementModulesRecord } from "../SettlementContractModule";
+
+export type InferContractType<
+  Module extends TypedClass<ContractModule<any, any>>,
+> =
+  Module extends TypedClass<infer ConcreteModule>
+    ? ConcreteModule extends ContractModule<infer Contract, any>
+      ? Contract
+      : never
+    : never;
+
+export type GetContracts<SettlementModules extends SettlementModulesRecord> = {
+  [Key in keyof SettlementModules]: SmartContractClassFromInterface<
+    InferContractType<SettlementModules[Key]>
+  >;
+};

package/test/BlockProver.test.ts

@@ -34,7 +34,7 @@ class RuntimeZkProgrammable extends ZkProgrammable<
   undefined,
   MethodPublicOutput
 > {
-  get appChain(): AreProofsEnabled | undefined {
+  get areProofsEnabled(): AreProofsEnabled | undefined {
     return new MockAppChain();
   }
 
@@ -47,6 +47,7 @@ class RuntimeZkProgrammable extends ZkProgrammable<
 
     return [
       {
+        name: program.name,
         compile: program.compile.bind(program),
         verify: program.verify.bind(program),
         analyzeMethods: program.analyzeMethods.bind(program),

package/test/TestingProtocol.ts

@@ -1,22 +1,17 @@
-import { WithZkProgrammable, ZkProgrammable } from "@proto-kit/common";
 import { container } from "tsyringe";
+import { Runtime } from "@proto-kit/module";
+import { Balance } from "@proto-kit/sequencer/test/integration/mocks/Balance";
+import { NoopRuntime } from "@proto-kit/sequencer/test/integration/mocks/NoopRuntime";
 
 import {
   AccountStateHook,
   BlockHeightHook,
   BlockProver,
   LastStateRootBlockHook,
-  MethodPublicOutput,
-  NoOpStateTransitionWitnessProvider,
   Protocol,
   StateTransitionProver,
 } from "../src";
 
-class RuntimeMock implements WithZkProgrammable<undefined, MethodPublicOutput> {
-  zkProgrammable: ZkProgrammable<undefined, MethodPublicOutput> =
-    undefined as unknown as ZkProgrammable<undefined, MethodPublicOutput>;
-}
-
 export function createAndInitTestingProtocol() {
   const ProtocolClass = Protocol.from({
     modules: {
@@ -36,12 +31,22 @@ export function createAndInitTestingProtocol() {
     StateTransitionProver: {},
     LastStateRoot: {},
   });
-  protocol.create(() => container.createChildContainer());
 
-  protocol.registerValue({
-    StateTransitionWitnessProvider: new NoOpStateTransitionWitnessProvider(),
-    Runtime: new RuntimeMock(),
+  const appChain = container.createChildContainer();
+
+  appChain.register("Runtime", {
+    useClass: Runtime.from({
+      modules: {
+        Balance,
+        NoopRuntime,
+      },
+      config: {
+        Balance: {},
+        NoopRuntime: {},
+      },
+    }),
   });
+  protocol.create(() => appChain.createChildContainer());
 
   return protocol;
 }

package/test/compiling/types.ts

@@ -0,0 +1,28 @@
+import { Field, VerificationKey } from "o1js";
+
+import { CompileRegistry, InferDependencyArtifacts } from "../../src";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+type TestModule = {
+  compile(
+    registry: CompileRegistry
+  ): Promise<{ bar: { verificationKey: VerificationKey } }>;
+};
+
+type Inferred = InferDependencyArtifacts<{ foo: TestModule }>;
+const typeAssignmentTest: Inferred = {
+  foo: {
+    bar: {
+      verificationKey: {
+        data: "",
+        hash: Field(1),
+      },
+    },
+  },
+};
+
+const typePropertyTest: Inferred["foo"]["bar"]["verificationKey"] extends VerificationKey
+  ? true
+  : false = true;
+
+/* eslint-enable @typescript-eslint/no-unused-vars */

package/test/modularity/types.ts

@@ -0,0 +1,35 @@
+import { SmartContract } from "o1js";
+import { TypedClass } from "@proto-kit/common";
+
+import { GetContracts } from "../../src/settlement/modularity/types";
+import {
+  BridgeContractType,
+  MandatorySettlementModulesRecord,
+  SettlementContractType,
+} from "../../src";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+// Goal of this "test" is that it compiles. By compiling this file checks that
+// certain types are inferred correctly
+
+type Inferred = GetContracts<MandatorySettlementModulesRecord>;
+
+// Get inferred Bridge Type
+type Bridge = Inferred["BridgeContract"];
+// Get inferred Settlement Contract Type
+type Settlement = Inferred["SettlementContract"];
+
+// Check that the Bridge type is of the correct type
+const bridgeSuccessful: Bridge extends TypedClass<
+  SmartContract & BridgeContractType
+>
+  ? true
+  : false = true;
+
+const settlementSuccessful: Settlement extends TypedClass<
+  SmartContract & SettlementContractType
+>
+  ? true
+  : false = true;
+
+/* eslint-enable @typescript-eslint/no-unused-vars */

package/src/prover/statetransition/StateTransitionWitnessProvider.ts

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

package/src/prover/statetransition/StateTransitionWitnessProviderReference.ts

@@ -1,17 +0,0 @@
-import { injectable, Lifecycle, scoped } from "tsyringe";
-
-import { StateTransitionWitnessProvider } from "./StateTransitionWitnessProvider";
-
-@injectable()
-@scoped(Lifecycle.ContainerScoped)
-export class StateTransitionWitnessProviderReference {
-  private witnessProvider?: StateTransitionWitnessProvider;
-
-  public setWitnessProvider(provider: StateTransitionWitnessProvider) {
-    this.witnessProvider = provider;
-  }
-
-  public getWitnessProvider(): StateTransitionWitnessProvider | undefined {
-    return this.witnessProvider;
-  }
-}