@proto-kit/protocol 0.1.1-develop.1086

package/dist/model/transaction/SignedTransaction.d.ts

@@ -0,0 +1,107 @@
+import { Bool, Field, Signature, UInt64 } from "o1js";
+import { RuntimeTransaction } from "./RuntimeTransaction";
+declare const SignedTransaction_base: (new (value: {
+    transaction: RuntimeTransaction;
+    signature: Signature;
+}) => {
+    transaction: RuntimeTransaction;
+    signature: Signature;
+}) & {
+    _isStruct: true;
+} & import("o1js/dist/node/lib/provable/provable").Provable<{
+    transaction: RuntimeTransaction;
+    signature: Signature;
+}, {
+    transaction: {
+        methodId: bigint;
+        argsHash: bigint;
+        nonce: {
+            isSome: boolean;
+            value: any;
+        };
+        sender: {
+            isSome: boolean;
+            value: any;
+        };
+    };
+    signature: any;
+}> & {
+    fromValue: (value: {
+        transaction: RuntimeTransaction | {
+            methodId: string | number | bigint | import("o1js/dist/node/lib/provable/field").Field;
+            argsHash: string | number | bigint | import("o1js/dist/node/lib/provable/field").Field;
+            nonce: import("./ValueOption").UInt64Option | {
+                isSome: boolean | import("o1js/dist/node/lib/provable/bool").Bool;
+                value: any;
+            };
+            sender: import("./ValueOption").PublicKeyOption | {
+                isSome: boolean | import("o1js/dist/node/lib/provable/bool").Bool;
+                value: any;
+            };
+        };
+        signature: any;
+    }) => {
+        transaction: RuntimeTransaction;
+        signature: Signature;
+    };
+    toInput: (x: {
+        transaction: RuntimeTransaction;
+        signature: Signature;
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        transaction: RuntimeTransaction;
+        signature: Signature;
+    }) => {
+        transaction: {
+            methodId: string;
+            argsHash: string;
+            nonce: {
+                isSome: boolean;
+                value: any;
+            };
+            sender: {
+                isSome: boolean;
+                value: any;
+            };
+        };
+        signature: any;
+    };
+    fromJSON: (x: {
+        transaction: {
+            methodId: string;
+            argsHash: string;
+            nonce: {
+                isSome: boolean;
+                value: any;
+            };
+            sender: {
+                isSome: boolean;
+                value: any;
+            };
+        };
+        signature: any;
+    }) => {
+        transaction: RuntimeTransaction;
+        signature: Signature;
+    };
+    empty: () => {
+        transaction: RuntimeTransaction;
+        signature: Signature;
+    };
+};
+export declare class SignedTransaction extends SignedTransaction_base {
+    static getSignatureData(args: {
+        methodId: Field;
+        nonce: UInt64;
+        argsHash: Field;
+    }): Field[];
+    static dummy(): SignedTransaction;
+    hash(): Field;
+    getSignatureData(): Field[];
+    validateSignature(): Bool;
+}
+export {};
+//# sourceMappingURL=SignedTransaction.d.ts.map

package/dist/model/transaction/SignedTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SignedTransaction.d.ts","sourceRoot":"","sources":["../../../src/model/transaction/SignedTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAU,SAAS,EAAU,MAAM,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE1D,qBAAa,iBAAkB,SAAQ,sBAGrC;WACc,gBAAgB,CAAC,IAAI,EAAE;QACnC,QAAQ,EAAE,KAAK,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,KAAK,CAAC;KACjB,GAAG,KAAK,EAAE;WAIG,KAAK,IAAI,iBAAiB;IAWjC,IAAI,IAAI,KAAK;IAIb,gBAAgB,IAAI,KAAK,EAAE;IAS3B,iBAAiB,IAAI,IAAI;CAMjC"}

package/dist/model/transaction/SignedTransaction.js

@@ -0,0 +1,33 @@
+import { Field, Scalar, Signature, Struct } from "o1js";
+import { RuntimeTransaction } from "./RuntimeTransaction";
+export class SignedTransaction extends Struct({
+    transaction: RuntimeTransaction,
+    signature: Signature,
+}) {
+    static getSignatureData(args) {
+        return [args.methodId, ...args.nonce.value.toFields(), args.argsHash];
+    }
+    static dummy() {
+        return new SignedTransaction({
+            transaction: RuntimeTransaction.dummyTransaction(),
+            signature: Signature.fromObject({
+                s: Scalar.from(0),
+                r: Field(0),
+            }),
+        });
+    }
+    hash() {
+        return this.transaction.hash();
+    }
+    getSignatureData() {
+        const { methodId, argsHash, nonce } = this.transaction;
+        return SignedTransaction.getSignatureData({
+            nonce: nonce.value,
+            methodId,
+            argsHash,
+        });
+    }
+    validateSignature() {
+        return this.signature.verify(this.transaction.sender.value, this.getSignatureData());
+    }
+}

package/dist/model/transaction/ValueOption.d.ts

@@ -0,0 +1,173 @@
+import { PublicKey, UInt64 } from "o1js";
+declare const UInt64Option_base: {
+    new (value: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }): {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    };
+    fromSome(value: UInt64): {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    };
+    none(value: UInt64): {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    };
+    _isStruct: true;
+    toFields: (value: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }) => import("o1js/dist/node/lib/provable/field").Field[];
+    toAuxiliary: (value?: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    } | undefined) => any[];
+    fromFields: (fields: import("o1js/dist/node/lib/provable/field").Field[], aux: any[]) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    };
+    sizeInFields(): number;
+    check: (value: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }) => void;
+    toValue: (x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }) => {
+        isSome: boolean;
+        value: any;
+    };
+    fromValue: ((x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    } | {
+        isSome: boolean;
+        value: any;
+    }) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }) & ((value: {
+        isSome: boolean | import("o1js/dist/node/lib/provable/bool").Bool;
+        value: any;
+    }) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    });
+    toInput: (x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    }) => {
+        isSome: boolean;
+        value: any;
+    };
+    fromJSON: (x: {
+        isSome: boolean;
+        value: any;
+    }) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    };
+    empty: () => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: UInt64;
+    };
+};
+export declare class UInt64Option extends UInt64Option_base {
+}
+declare const PublicKeyOption_base: {
+    new (value: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }): {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    };
+    fromSome(value: PublicKey): {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    };
+    none(value: PublicKey): {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    };
+    _isStruct: true;
+    toFields: (value: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }) => import("o1js/dist/node/lib/provable/field").Field[];
+    toAuxiliary: (value?: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    } | undefined) => any[];
+    fromFields: (fields: import("o1js/dist/node/lib/provable/field").Field[], aux: any[]) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    };
+    sizeInFields(): number;
+    check: (value: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }) => void;
+    toValue: (x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }) => {
+        isSome: boolean;
+        value: any;
+    };
+    fromValue: ((x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    } | {
+        isSome: boolean;
+        value: any;
+    }) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }) & ((value: {
+        isSome: boolean | import("o1js/dist/node/lib/provable/bool").Bool;
+        value: any;
+    }) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    });
+    toInput: (x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }) => {
+        fields?: import("o1js/dist/node/lib/provable/field").Field[] | undefined;
+        packed?: [import("o1js/dist/node/lib/provable/field").Field, number][] | undefined;
+    };
+    toJSON: (x: {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    }) => {
+        isSome: boolean;
+        value: any;
+    };
+    fromJSON: (x: {
+        isSome: boolean;
+        value: any;
+    }) => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    };
+    empty: () => {
+        isSome: import("o1js/dist/node/lib/provable/bool").Bool;
+        value: PublicKey;
+    };
+};
+export declare class PublicKeyOption extends PublicKeyOption_base {
+}
+export {};
+//# sourceMappingURL=ValueOption.d.ts.map

package/dist/model/transaction/ValueOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValueOption.d.ts","sourceRoot":"","sources":["../../../src/model/transaction/ValueOption.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,SAAS,EAAU,MAAM,EAAE,MAAM,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBzE,qBAAa,YAAa,SAAQ,iBAAoC;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEzE,qBAAa,eAAgB,SAAQ,oBAEpC;CAAG"}

package/dist/model/transaction/ValueOption.js

@@ -0,0 +1,24 @@
+import { Bool, PublicKey, Struct, UInt64 } from "o1js";
+function genericOptionFactory(valueType) {
+    return class Generic extends Struct({
+        isSome: Bool,
+        value: valueType,
+    }) {
+        static fromSome(value) {
+            return new Generic({
+                isSome: Bool(true),
+                value,
+            });
+        }
+        static none(value) {
+            return new Generic({
+                isSome: Bool(false),
+                value,
+            });
+        }
+    };
+}
+export class UInt64Option extends genericOptionFactory(UInt64) {
+}
+export class PublicKeyOption extends genericOptionFactory(PublicKey) {
+}

package/dist/protocol/Protocol.d.ts

@@ -0,0 +1,43 @@
+import { AreProofsEnabled, ChildContainerProvider, ModuleContainer, ModulesConfig, ModulesRecord, StringKeyOf, TypedClass } from "@proto-kit/common";
+import { DependencyContainer } from "tsyringe";
+import { BlockProvable } from "../prover/block/BlockProvable";
+import { StateTransitionProvable } from "../prover/statetransition/StateTransitionProvable";
+import { StateServiceProvider } from "../state/StateServiceProvider";
+import { SimpleAsyncStateService } from "../state/StateService";
+import { BlockHeightHook } from "../hooks/BlockHeightHook";
+import { LastStateRootBlockHook } from "../hooks/LastStateRootBlockHook";
+import { AccountStateHook } from "../hooks/AccountStateHook";
+import { ProtocolModule } from "./ProtocolModule";
+import { ProtocolEnvironment } from "./ProtocolEnvironment";
+export type ProtocolModulesRecord = ModulesRecord<TypedClass<ProtocolModule<unknown>>>;
+export interface BlockProverType extends ProtocolModule, BlockProvable {
+}
+export interface StateTransitionProverType extends ProtocolModule, StateTransitionProvable {
+}
+export type MandatoryProtocolModulesRecord = {
+    BlockProver: TypedClass<BlockProverType>;
+    StateTransitionProver: TypedClass<StateTransitionProverType>;
+    AccountState: TypedClass<AccountStateHook>;
+    BlockHeight: TypedClass<BlockHeightHook>;
+    LastStateRoot: TypedClass<LastStateRootBlockHook>;
+};
+export interface ProtocolDefinition<Modules extends ProtocolModulesRecord> {
+    modules: Modules;
+    config?: ModulesConfig<Modules>;
+}
+export declare class Protocol<Modules extends ProtocolModulesRecord & MandatoryProtocolModulesRecord> extends ModuleContainer<Modules> implements ProtocolEnvironment {
+    static from<Modules extends ProtocolModulesRecord & MandatoryProtocolModulesRecord>(modules: ProtocolDefinition<Modules>): TypedClass<Protocol<Modules>>;
+    definition: ProtocolDefinition<Modules>;
+    constructor(definition: ProtocolDefinition<Modules>);
+    get stateService(): SimpleAsyncStateService;
+    get stateServiceProvider(): StateServiceProvider;
+    decorateModule(moduleName: StringKeyOf<Modules>, containedModule: InstanceType<Modules[StringKeyOf<Modules>]>): void;
+    get dependencyContainer(): DependencyContainer;
+    private isModule;
+    get blockProver(): BlockProvable;
+    get stateTransitionProver(): StateTransitionProvable;
+    getAreProofsEnabled(): AreProofsEnabled;
+    create(childContainerProvider: ChildContainerProvider): void;
+    start(): Promise<void>;
+}
+//# sourceMappingURL=Protocol.d.ts.map

package/dist/protocol/Protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/Protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EAEtB,eAAe,EACf,aAAa,EACb,aAAa,EACb,WAAW,EACX,UAAU,EACX,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAa,MAAM,UAAU,CAAC;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,mDAAmD,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAGzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAG7D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAS5D,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAC/C,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CACpC,CAAC;AAEF,MAAM,WAAW,eAAgB,SAAQ,cAAc,EAAE,aAAa;CAAG;AAEzE,MAAM,WAAW,yBACf,SAAQ,cAAc,EACpB,uBAAuB;CAAG;AAE9B,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;IACzC,qBAAqB,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC;IAC7D,YAAY,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAC3C,WAAW,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;IACzC,aAAa,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,WAAW,kBAAkB,CAAC,OAAO,SAAS,qBAAqB;IACvE,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CACjC;AAED,qBAAa,QAAQ,CACjB,OAAO,SAAS,qBAAqB,GAAG,8BAA8B,CAExE,SAAQ,eAAe,CAAC,OAAO,CAC/B,YAAW,mBAAmB;WAEhB,IAAI,CAChB,OAAO,SAAS,qBAAqB,GAAG,8BAA8B,EACtE,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAQ/D,UAAU,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBAE5B,UAAU,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAK1D,IAAW,YAAY,IAAI,uBAAuB,CAEjD;IAED,IAAW,oBAAoB,IAAI,oBAAoB,CAEtD;IAEM,cAAc,CACnB,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,EAChC,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAY9D,IAAW,mBAAmB,IAAI,mBAAmB,CAEpD;IAED,OAAO,CAAC,QAAQ;IAMhB,IAAW,WAAW,IAAI,aAAa,CAMtC;IAED,IAAW,qBAAqB,IAAI,uBAAuB,CAI1D;IAEM,mBAAmB,IAAI,gBAAgB;IAIvC,MAAM,CAAC,sBAAsB,EAAE,sBAAsB;IAqD/C,KAAK;CAYnB"}

package/dist/protocol/Protocol.js

@@ -0,0 +1,95 @@
+import { log, ModuleContainer, } from "@proto-kit/common";
+import { Lifecycle } from "tsyringe";
+import { NoopBlockHook } from "../hooks/NoopBlockHook";
+import { ProvableSettlementHook } from "../settlement/modularity/ProvableSettlementHook";
+import { NoopSettlementHook } from "../hooks/NoopSettlementHook";
+import { NoopTransactionHook } from "../hooks/NoopTransactionHook";
+import { ProvableTransactionHook } from "./ProvableTransactionHook";
+import { ProvableBlockHook } from "./ProvableBlockHook";
+const PROTOCOL_INJECTION_TOKENS = {
+    ProvableTransactionHook: "ProvableTransactionHook",
+    ProvableBlockHook: "ProvableBlockHook",
+    ProvableSettlementHook: "ProvableSettlementHook",
+};
+export class Protocol extends ModuleContainer {
+    static from(modules) {
+        return class ScopedProtocol extends Protocol {
+            constructor() {
+                super(modules);
+            }
+        };
+    }
+    constructor(definition) {
+        super(definition);
+        this.definition = definition;
+    }
+    get stateService() {
+        return this.stateServiceProvider.stateService;
+    }
+    get stateServiceProvider() {
+        return this.container.resolve("StateServiceProvider");
+    }
+    decorateModule(moduleName, containedModule) {
+        log.debug(`Decorated ${moduleName}`);
+        containedModule.protocol = this;
+        if (containedModule instanceof ProvableTransactionHook) {
+            containedModule.name = moduleName;
+        }
+        super.decorateModule(moduleName, containedModule);
+    }
+    get dependencyContainer() {
+        return this.container;
+    }
+    isModule(moduleName) {
+        return this.definition.modules[moduleName] !== undefined;
+    }
+    get blockProver() {
+        // Why do I resolve directly here?
+        // I don't know exactly but generics don't let me use .resolve()
+        return this.container.resolve("BlockProver");
+    }
+    get stateTransitionProver() {
+        return this.container.resolve("StateTransitionProver");
+    }
+    getAreProofsEnabled() {
+        return this.container.resolve("AreProofsEnabled");
+    }
+    create(childContainerProvider) {
+        super.create(childContainerProvider);
+        // Register the BlockModules seperately since we need to
+        // inject them differently later
+        const ABSTRACT_MODULE_TYPES = [
+            { type: ProvableTransactionHook, defaultType: NoopTransactionHook },
+            { type: ProvableBlockHook, defaultType: NoopBlockHook },
+            { type: ProvableSettlementHook, defaultType: NoopSettlementHook },
+        ];
+        ABSTRACT_MODULE_TYPES.forEach((moduleTypeRegistration) => {
+            const abstractType = moduleTypeRegistration.type;
+            const implementingModules = Object.entries(this.definition.modules).filter(([, value]) => Object.prototype.isPrototypeOf.call(abstractType, value));
+            const newInjectionToken = PROTOCOL_INJECTION_TOKENS[abstractType.name];
+            if (newInjectionToken === undefined) {
+                log.error("Can't inject hook under the underlying hook token: Alias not found in mapping");
+                return;
+            }
+            implementingModules.forEach(([key]) => {
+                this.container.register(abstractType.name, { useToken: key }, { lifecycle: Lifecycle.ContainerScoped });
+            });
+            if (implementingModules.length === 0) {
+                // This type annotation shouldn't change anything but is necessary
+                // bcs tsyringe complains
+                const { defaultType } = moduleTypeRegistration;
+                // Register default (noop) version
+                this.container.register(abstractType.name, { useClass: defaultType }, { lifecycle: Lifecycle.ContainerScoped });
+            }
+        });
+    }
+    async start() {
+        // eslint-disable-next-line guard-for-in
+        for (const moduleName in this.definition.modules) {
+            const protocolModule = this.resolve(moduleName);
+            log.info(`Starting protocol module ${moduleName} (${protocolModule.constructor.name})`);
+            // eslint-disable-next-line no-await-in-loop
+            await protocolModule.start();
+        }
+    }
+}

package/dist/protocol/ProtocolEnvironment.d.ts

@@ -0,0 +1,9 @@
+import { AreProofsEnabled } from "@proto-kit/common";
+import { SimpleAsyncStateService } from "../state/StateService";
+import { StateServiceProvider } from "../state/StateServiceProvider";
+export interface ProtocolEnvironment {
+    get stateService(): SimpleAsyncStateService;
+    get stateServiceProvider(): StateServiceProvider;
+    getAreProofsEnabled(): AreProofsEnabled;
+}
+//# sourceMappingURL=ProtocolEnvironment.d.ts.map

package/dist/protocol/ProtocolEnvironment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtocolEnvironment.d.ts","sourceRoot":"","sources":["../../src/protocol/ProtocolEnvironment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAClC,IAAI,YAAY,IAAI,uBAAuB,CAAC;IAC5C,IAAI,oBAAoB,IAAI,oBAAoB,CAAC;IACjD,mBAAmB,IAAI,gBAAgB,CAAC;CACzC"}

package/dist/protocol/ProtocolEnvironment.js

@@ -0,0 +1 @@
+export {};

package/dist/protocol/ProtocolModule.d.ts

@@ -0,0 +1,9 @@
+import { AreProofsEnabled, ChildContainerProvider, ConfigurableModule, NoConfig } from "@proto-kit/common";
+import { ProtocolEnvironment } from "./ProtocolEnvironment";
+export declare abstract class ProtocolModule<Config = NoConfig> extends ConfigurableModule<Config> {
+    protocol?: ProtocolEnvironment;
+    get appChain(): AreProofsEnabled | undefined;
+    create(childContainerProvider: ChildContainerProvider): void;
+    start(): Promise<void>;
+}
+//# sourceMappingURL=ProtocolModule.d.ts.map

package/dist/protocol/ProtocolModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtocolModule.d.ts","sourceRoot":"","sources":["../../src/protocol/ProtocolModule.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,QAAQ,EAET,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,8BAAsB,cAAc,CAClC,MAAM,GAAG,QAAQ,CACjB,SAAQ,kBAAkB,CAAC,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAEtC,IAAW,QAAQ,IAAI,gBAAgB,GAAG,SAAS,CAElD;IAEM,MAAM,CAAC,sBAAsB,EAAE,sBAAsB,GAAG,IAAI;IAItD,KAAK;CAGnB"}

package/dist/protocol/ProtocolModule.js

@@ -0,0 +1,12 @@
+import { ConfigurableModule, noop, } from "@proto-kit/common";
+export class ProtocolModule extends ConfigurableModule {
+    get appChain() {
+        return this.protocol?.getAreProofsEnabled();
+    }
+    create(childContainerProvider) {
+        noop();
+    }
+    async start() {
+        noop();
+    }
+}

package/dist/protocol/ProvableBlockHook.d.ts

@@ -0,0 +1,8 @@
+import type { BlockProverState } from "../prover/block/BlockProver";
+import { NetworkState } from "../model/network/NetworkState";
+import { TransitioningProtocolModule } from "./TransitioningProtocolModule";
+export declare abstract class ProvableBlockHook<Config> extends TransitioningProtocolModule<Config> {
+    abstract beforeBlock(networkState: NetworkState, state: BlockProverState): Promise<NetworkState>;
+    abstract afterBlock(networkState: NetworkState, state: BlockProverState): Promise<NetworkState>;
+}
+//# sourceMappingURL=ProvableBlockHook.d.ts.map

package/dist/protocol/ProvableBlockHook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvableBlockHook.d.ts","sourceRoot":"","sources":["../../src/protocol/ProvableBlockHook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAG5E,8BAAsB,iBAAiB,CACrC,MAAM,CACN,SAAQ,2BAA2B,CAAC,MAAM,CAAC;aAC3B,WAAW,CACzB,YAAY,EAAE,YAAY,EAC1B,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,YAAY,CAAC;aAER,UAAU,CACxB,YAAY,EAAE,YAAY,EAC1B,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,YAAY,CAAC;CACzB"}

package/dist/protocol/ProvableBlockHook.js

@@ -0,0 +1,4 @@
+import { TransitioningProtocolModule } from "./TransitioningProtocolModule";
+// Purpose is to build transition from -> to network state
+export class ProvableBlockHook extends TransitioningProtocolModule {
+}

package/dist/protocol/ProvableTransactionHook.d.ts

@@ -0,0 +1,7 @@
+import { NoConfig } from "@proto-kit/common";
+import { BlockProverExecutionData } from "../prover/block/BlockProvable";
+import { TransitioningProtocolModule } from "./TransitioningProtocolModule";
+export declare abstract class ProvableTransactionHook<Config = NoConfig> extends TransitioningProtocolModule<Config> {
+    abstract onTransaction(executionData: BlockProverExecutionData): Promise<void>;
+}
+//# sourceMappingURL=ProvableTransactionHook.d.ts.map

package/dist/protocol/ProvableTransactionHook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvableTransactionHook.d.ts","sourceRoot":"","sources":["../../src/protocol/ProvableTransactionHook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,8BAAsB,uBAAuB,CAC3C,MAAM,GAAG,QAAQ,CACjB,SAAQ,2BAA2B,CAAC,MAAM,CAAC;aAC3B,aAAa,CAC3B,aAAa,EAAE,wBAAwB,GACtC,OAAO,CAAC,IAAI,CAAC;CACjB"}

package/dist/protocol/ProvableTransactionHook.js

@@ -0,0 +1,3 @@
+import { TransitioningProtocolModule } from "./TransitioningProtocolModule";
+export class ProvableTransactionHook extends TransitioningProtocolModule {
+}

package/dist/protocol/TransitioningProtocolModule.d.ts

@@ -0,0 +1,10 @@
+import { ProtocolModule } from "./ProtocolModule";
+/**
+ * TransitioningProtocolModule is a base interface that allows inheriting
+ * classes to use State and StateMap since it requires the implementation
+ * of a `name: string` property, which those classes need to function.
+ */
+export declare abstract class TransitioningProtocolModule<Config> extends ProtocolModule<Config> {
+    name?: string;
+}
+//# sourceMappingURL=TransitioningProtocolModule.d.ts.map

package/dist/protocol/TransitioningProtocolModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransitioningProtocolModule.d.ts","sourceRoot":"","sources":["../../src/protocol/TransitioningProtocolModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;GAIG;AACH,8BAAsB,2BAA2B,CAC/C,MAAM,CACN,SAAQ,cAAc,CAAC,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/protocol/TransitioningProtocolModule.js

@@ -0,0 +1,8 @@
+import { ProtocolModule } from "./ProtocolModule";
+/**
+ * TransitioningProtocolModule is a base interface that allows inheriting
+ * classes to use State and StateMap since it requires the implementation
+ * of a `name: string` property, which those classes need to function.
+ */
+export class TransitioningProtocolModule extends ProtocolModule {
+}