@proto-kit/protocol 0.1.1-develop.1088 → 0.1.1-develop.1313

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/dist/prover/statetransition/StateTransitionWitnessProvider.d.ts

@@ -1,16 +0,0 @@
-import type { Field } from "o1js";
-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;
-}
-export declare class NoOpStateTransitionWitnessProvider implements StateTransitionWitnessProvider {
-    getWitness(): RollupMerkleTreeWitness;
-}
-//# sourceMappingURL=StateTransitionWitnessProvider.d.ts.map

package/dist/prover/statetransition/StateTransitionWitnessProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StateTransitionWitnessProvider.d.ts","sourceRoot":"","sources":["../../../src/prover/statetransition/StateTransitionWitnessProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,UAAU,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,uBAAuB,CAAC;CACrD;AAED,qBACa,kCACX,YAAW,8BAA8B;IAElC,UAAU,IAAI,uBAAuB;CAG7C"}

package/dist/prover/statetransition/StateTransitionWitnessProvider.js

@@ -1,16 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { injectable } from "tsyringe";
-import { RollupMerkleTreeWitness } from "@proto-kit/common";
-export let NoOpStateTransitionWitnessProvider = class NoOpStateTransitionWitnessProvider {
-    getWitness() {
-        return new RollupMerkleTreeWitness({ path: [], isLeft: [] });
-    }
-};
-NoOpStateTransitionWitnessProvider = __decorate([
-    injectable()
-], NoOpStateTransitionWitnessProvider);

package/dist/prover/statetransition/StateTransitionWitnessProviderReference.d.ts

@@ -1,7 +0,0 @@
-import { StateTransitionWitnessProvider } from "./StateTransitionWitnessProvider";
-export declare class StateTransitionWitnessProviderReference {
-    private witnessProvider?;
-    setWitnessProvider(provider: StateTransitionWitnessProvider): void;
-    getWitnessProvider(): StateTransitionWitnessProvider | undefined;
-}
-//# sourceMappingURL=StateTransitionWitnessProviderReference.d.ts.map

package/dist/prover/statetransition/StateTransitionWitnessProviderReference.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StateTransitionWitnessProviderReference.d.ts","sourceRoot":"","sources":["../../../src/prover/statetransition/StateTransitionWitnessProviderReference.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF,qBAEa,uCAAuC;IAClD,OAAO,CAAC,eAAe,CAAC,CAAiC;IAElD,kBAAkB,CAAC,QAAQ,EAAE,8BAA8B;IAI3D,kBAAkB,IAAI,8BAA8B,GAAG,SAAS;CAGxE"}

package/dist/prover/statetransition/StateTransitionWitnessProviderReference.js

@@ -1,19 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { injectable, Lifecycle, scoped } from "tsyringe";
-export let StateTransitionWitnessProviderReference = class StateTransitionWitnessProviderReference {
-    setWitnessProvider(provider) {
-        this.witnessProvider = provider;
-    }
-    getWitnessProvider() {
-        return this.witnessProvider;
-    }
-};
-StateTransitionWitnessProviderReference = __decorate([
-    injectable(),
-    scoped(Lifecycle.ContainerScoped)
-], StateTransitionWitnessProviderReference);

package/dist/state/context/ProtocolMethodExecutionContext.d.ts

@@ -1,22 +0,0 @@
-import { StateTransition } from "../../model/StateTransition";
-import { TransitionMethodExecutionContext, TransitionMethodExecutionResult } from "./TransitionMethodExecutionContext";
-export declare class ProtocolMethodExecutionContext implements TransitionMethodExecutionContext {
-    result: TransitionMethodExecutionResult;
-    /**
-     * Adds an in-method generated state transition to the current context
-     * @param stateTransition - State transition to add to the context
-     */
-    addStateTransition<Value>(stateTransition: StateTransition<Value>): void;
-    /**
-     * Manually clears/resets the execution context
-     */
-    clear(): void;
-    /**
-     * Had to override current() otherwise it would not infer
-     * the type of result correctly (parent type would be reused)
-     */
-    current(): {
-        result: TransitionMethodExecutionResult;
-    };
-}
-//# sourceMappingURL=ProtocolMethodExecutionContext.d.ts.map

package/dist/state/context/ProtocolMethodExecutionContext.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ProtocolMethodExecutionContext.d.ts","sourceRoot":"","sources":["../../../src/state/context/ProtocolMethodExecutionContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAChC,MAAM,oCAAoC,CAAC;AAE5C,qBAAa,8BACX,YAAW,gCAAgC;IAEpC,MAAM,kCAAyC;IAEtD;;;OAGG;IACI,kBAAkB,CAAC,KAAK,EAAE,eAAe,EAAE,eAAe,CAAC,KAAK,CAAC;IAIxE;;OAEG;IACI,KAAK;IAIZ;;;OAGG;IACI,OAAO;;;CAKf"}

package/dist/state/context/ProtocolMethodExecutionContext.js

@@ -1,28 +0,0 @@
-import { TransitionMethodExecutionResult, } from "./TransitionMethodExecutionContext";
-export class ProtocolMethodExecutionContext {
-    constructor() {
-        this.result = new TransitionMethodExecutionResult();
-    }
-    /**
-     * Adds an in-method generated state transition to the current context
-     * @param stateTransition - State transition to add to the context
-     */
-    addStateTransition(stateTransition) {
-        this.result.stateTransitions.push(stateTransition);
-    }
-    /**
-     * Manually clears/resets the execution context
-     */
-    clear() {
-        this.result = new TransitionMethodExecutionResult();
-    }
-    /**
-     * Had to override current() otherwise it would not infer
-     * the type of result correctly (parent type would be reused)
-     */
-    current() {
-        return {
-            result: this.result,
-        };
-    }
-}

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