@proto-kit/protocol 0.1.1-develop.153

package/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2023] [Stove Labs]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,45 @@
+# YAB: Protocol
+
+Protocol contains to all circuit-aware data types and provers
+
+### StateTransitionProver
+
+The StateTransitionProver takes a list of StateTransitions, checks and proves their precondition and update to the respective merkletree represented by the state root public input.
+
+In the public input, the prover transitions from two fields:
+
+- state root
+- transitions hash
+
+The transitions hash is the commitment to a hash list where every state transition gets appended one-by-one.
+
+The StateTransitionsProver batches the application of multiple state transitions together.
+If the amount of state transitions if greater than the batch size, the seperate proofs can be merged together.
+
+In the end, the publicInput of the StateTransitionProof should contain the following content:
+
+- `fromTransitionsHash: 0` To prove that all STs have been applied, the transitionsHash must start at zero (i.e. a empty hash list)
+- `toTransitionsHash` This value must be the same as the transitionsHash in the AppChainProof to guarantee that all (and same) statetransitions that have been outputted by the AppChain have been applied
+- `from- and toStateRoot` These values represent the root of the state tree and will later be stitched together to arrive at the final stateroot for a bundle
+
+### BlockProver
+
+The BlockProver's responsibility is to verify and put together the AppChainProof and StateTransitionProof.
+It verifies that the transitionsHash is the same across both proofs and then takes the new state root proved by the STProof.
+
+In the end, the BlockProof proofs that:
+
+- the AppChain has been executed correctly
+- the resulting state changes have been applied correctly and fully to the state root
+
+Multiple BlockProofs will then be merged together, signed by the sequencer and published to the base layer.
+
+### RollupMerkleTree
+
+The RollupMerkleTree is a custom merkle tree implementation that supports the injection of a storage adapter.
+The interface for that adapter can be found as the interface `MerkleTreeStorage`.
+
+Adapters can implement any storage backend, like In-Memory and Database, and supports a process called "virtualization".
+Virtualization is the process of layering different Adapters on top of each other.
+For example if I want to simulate some transactions to a merkle tree, I can virtualize a database adapter into a MemoryAdapter.
+If I am happy with the result, I can merge the results into the database or, if not, discard them without writing the changes to the database.

package/dist/Constants.d.ts

@@ -0,0 +1,4 @@
+export declare const constants: {
+    stateTransitionProverBatchSize: number;
+};
+//# sourceMappingURL=Constants.d.ts.map

package/dist/Constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.d.ts","sourceRoot":"","sources":["../src/Constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;CAErB,CAAC"}

package/dist/Constants.js

@@ -0,0 +1,3 @@
+export const constants = {
+    stateTransitionProverBatchSize: 4,
+};

package/dist/config/ConfigurableModule.d.ts

@@ -0,0 +1,18 @@
+export type Preset<Config> = Config | ((...args: any[]) => Config);
+export type Presets<Config> = Record<string, Preset<Config>>;
+export interface Configurable<Config> {
+    config: Config;
+}
+/**
+ * Used by various module sub-types that may need to be configured
+ */
+export declare class ConfigurableModule<Config> implements Configurable<Config> {
+    protected currentConfig: Config | undefined;
+    constructor(...args: any[]);
+    get config(): Config;
+    set config(config: Config);
+}
+export interface StaticConfigurableModule<Config> {
+    presets: Presets<Config>;
+}
+//# sourceMappingURL=ConfigurableModule.d.ts.map

package/dist/config/ConfigurableModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurableModule.d.ts","sourceRoot":"","sources":["../../src/config/ConfigurableModule.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,MAAM,CAAC,MAAM,IAAI,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,CAAC;AACnE,MAAM,MAAM,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAG7D,MAAM,WAAW,YAAY,CAAC,MAAM;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,kBAAkB,CAAC,MAAM,CAAE,YAAW,YAAY,CAAC,MAAM,CAAC;IACrE,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;gBAIzB,GAAG,IAAI,EAAE,GAAG,EAAE;IAEjC,IAAW,MAAM,IAAI,MAAM,CAK1B;IAED,IAAW,MAAM,CAAC,MAAM,EAAE,MAAM,EAE/B;CACF;AAGD,MAAM,WAAW,wBAAwB,CAAC,MAAM;IAC9C,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1B"}

package/dist/config/ConfigurableModule.js

@@ -0,0 +1,20 @@
+const errors = {
+    configNotSet: (moduleName) => new Error(`Trying to retrieve config of ${moduleName}, which was not yet set`),
+};
+/**
+ * Used by various module sub-types that may need to be configured
+ */
+export class ConfigurableModule {
+    // eslint-disable-next-line max-len
+    // eslint-disable-next-line @typescript-eslint/no-useless-constructor, @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
+    constructor(...args) { }
+    get config() {
+        if (this.currentConfig === undefined) {
+            throw errors.configNotSet(this.constructor.name);
+        }
+        return this.currentConfig;
+    }
+    set config(config) {
+        this.currentConfig = config;
+    }
+}

package/dist/config/ConfigurationAggregator.d.ts

@@ -0,0 +1,10 @@
+import { ComponentConfig, Components, RemoveUndefinedKeys, UninitializedComponentConfig } from "./types";
+/**
+ * In this context, a "Component" is just a way of generalizing Modules,
+ * because they don't have to be modules, they can be any configurable unit
+ */
+export declare abstract class ConfigurationAggregator<Comps extends Components> {
+    protected applyConfig(modules: Comps, currentConfig: UninitializedComponentConfig<ComponentConfig<Comps>>, config: RemoveUndefinedKeys<ComponentConfig<Comps>>): ComponentConfig<Comps>;
+    abstract configure(config: RemoveUndefinedKeys<ComponentConfig<Comps>>): void;
+}
+//# sourceMappingURL=ConfigurationAggregator.d.ts.map

package/dist/config/ConfigurationAggregator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationAggregator.d.ts","sourceRoot":"","sources":["../../src/config/ConfigurationAggregator.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,4BAA4B,EAC7B,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,8BAAsB,uBAAuB,CAAC,KAAK,SAAS,UAAU;IACpE,SAAS,CAAC,WAAW,CACnB,OAAO,EAAE,KAAK,EACd,aAAa,EAAE,4BAA4B,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EACnE,MAAM,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAClD,eAAe,CAAC,KAAK,CAAC;aAgCT,SAAS,CACvB,MAAM,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAClD,IAAI;CACR"}

package/dist/config/ConfigurationAggregator.js

@@ -0,0 +1,35 @@
+/* eslint-disable @typescript-eslint/no-explicit-any,guard-for-in,@typescript-eslint/no-unsafe-member-access,max-len,@typescript-eslint/no-unsafe-assignment,@typescript-eslint/consistent-type-assertions */
+import merge from "lodash/merge";
+/**
+ * In this context, a "Component" is just a way of generalizing Modules,
+ * because they don't have to be modules, they can be any configurable unit
+ */
+export class ConfigurationAggregator {
+    applyConfig(modules, currentConfig, config) {
+        const nextConfig = {};
+        for (const key in config) {
+            // Set config to module
+            if (currentConfig[key] === undefined) {
+                // Initialize config with merge between config and defaultConfig
+                // eslint-disable-next-line prefer-destructuring,putout/putout
+                const defaultConfig = modules[key].defaultConfig;
+                const newConfig = config[key];
+                for (const configKey in newConfig) {
+                    defaultConfig[configKey] = newConfig[configKey];
+                }
+                // The result of that is always a valid Required<Config> since FlipOptional<Config> requires the exact opposite of Config
+                modules[key].config = defaultConfig;
+                nextConfig[key] = defaultConfig;
+            }
+            else {
+                // Append/overwrite to existing config
+                const newConfig = config[key];
+                const moduleConfig = currentConfig[key];
+                merge(moduleConfig, newConfig);
+                modules[key].config = moduleConfig;
+                nextConfig[key] = moduleConfig;
+            }
+        }
+        return nextConfig;
+    }
+}

package/dist/config/ConfigurationReceiver.d.ts

@@ -0,0 +1,25 @@
+import type { FlipOptional } from "./types";
+/**
+ * Configs:
+ *
+ * A property that accepts undefined, is an optional argument.
+ * That means that you will have to provide it via defaultConfig() and it will
+ * be non-undefined via this.config. This is used by devs to indicate
+ * configurability but not necessary explicit definition.
+ * I.e. when the default arguments will work most of the time
+ *
+ * If devs want a property that can be undefined, they should use null instead
+ *
+ */
+export declare abstract class ConfigurationReceiver<Config> {
+    private currentConfig?;
+    /**
+     * Retrieves the configured config object.
+     * This is only available in instance methods like start(), using this in
+     * the constructor will throw an Exception
+     */
+    get config(): Required<Config>;
+    set config(config: Required<Config>);
+    abstract get defaultConfig(): FlipOptional<Config>;
+}
+//# sourceMappingURL=ConfigurationReceiver.d.ts.map

package/dist/config/ConfigurationReceiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationReceiver.d.ts","sourceRoot":"","sources":["../../src/config/ConfigurationReceiver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAO5C;;;;;;;;;;;GAWG;AACH,8BAAsB,qBAAqB,CAAC,MAAM;IAChD,OAAO,CAAC,aAAa,CAAC,CAA+B;IAErD;;;;OAIG;IACH,IAAW,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,CAOpC;IAED,IAAW,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EAEzC;IAED,aAAoB,aAAa,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;CAC3D"}

package/dist/config/ConfigurationReceiver.js

@@ -0,0 +1,36 @@
+const errors = {
+    configNotSet: (name) => new Error(`RuntimeModule (${name}) config has not been set!`),
+};
+/**
+ * Configs:
+ *
+ * A property that accepts undefined, is an optional argument.
+ * That means that you will have to provide it via defaultConfig() and it will
+ * be non-undefined via this.config. This is used by devs to indicate
+ * configurability but not necessary explicit definition.
+ * I.e. when the default arguments will work most of the time
+ *
+ * If devs want a property that can be undefined, they should use null instead
+ *
+ */
+export class ConfigurationReceiver {
+    constructor() {
+        this.currentConfig = undefined;
+    }
+    /**
+     * Retrieves the configured config object.
+     * This is only available in instance methods like start(), using this in
+     * the constructor will throw an Exception
+     */
+    get config() {
+        if (this.currentConfig === undefined) {
+            // eslint-disable-next-line no-warning-comments
+            // TODO Check properly, Config could also be void
+            throw errors.configNotSet(this.constructor.name);
+        }
+        return this.currentConfig;
+    }
+    set config(config) {
+        this.currentConfig = config;
+    }
+}

package/dist/config/ModuleContainer.d.ts

@@ -0,0 +1,44 @@
+import { Frequency, InjectionToken } from "tsyringe";
+import { TypedClassConstructor } from "../utils/utils";
+import { Configurable, ConfigurableModule } from "./ConfigurableModule";
+export declare const errors: {
+    configNotSet: (moduleName: string) => Error;
+    configNotSetInContainer: (moduleName: string) => Error;
+    onlyStringModuleNames: (moduleName: NonNullable<unknown>) => Error;
+    unableToDecorateModule: (moduleName: InjectionToken<unknown>) => Error;
+    nonModuleDependecy: (runtimeModuleName: string) => Error;
+    unknownDependency: (runtimeModuleName: string, name: string) => Error;
+};
+export type BaseModuleType = TypedClassConstructor<Configurable<unknown>>;
+export interface ModulesRecord<ModuleType extends BaseModuleType = BaseModuleType> {
+    [name: string]: ModuleType;
+}
+export type ModulesConfig<Modules extends ModulesRecord> = {
+    [ConfigKey in keyof Modules]: InstanceType<Modules[ConfigKey]>["config"];
+};
+export declare abstract class ModuleContainer<Modules extends ModulesRecord, Config extends ModulesConfig<Modules>> {
+    definition: {
+        modules: Modules;
+        config?: Config;
+    };
+    static moduleDecorationFrequency: Frequency;
+    container: import("tsyringe").DependencyContainer;
+    constructor(definition: {
+        modules: Modules;
+        config?: Config;
+    });
+    get moduleNames(): string[];
+    validateModule<ModuleName extends keyof Modules>(moduleName: ModuleName | string, containedModule: ConfigurableModule<unknown>): void;
+    registerModules(modules: Modules): void;
+    registerValue<Value>(modules: Record<string, Value>): void;
+    configure(config: Config): void;
+    resolve<ModuleName extends keyof Modules>(moduleName: ModuleName): InstanceType<Modules[ModuleName]>;
+    moduleNameToString<ModuleName extends keyof Modules>(moduleName: ModuleName | string): string;
+    /**
+     * Override this in the child class to provide custom
+     * features or module checks
+     */
+    decorateModule<ModuleName extends keyof Modules>(moduleName: ModuleName | string, containedModule: InstanceType<Modules[ModuleName]>): void;
+    onAfterModuleResolution<ModuleName extends keyof Modules>(moduleName: ModuleName | string): void;
+}
+//# sourceMappingURL=ModuleContainer.d.ts.map

package/dist/config/ModuleContainer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleContainer.d.ts","sourceRoot":"","sources":["../../src/config/ModuleContainer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,SAAS,EAAE,cAAc,EAAa,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAExE,eAAO,MAAM,MAAM;+BACU,MAAM;0CAKK,MAAM;wCAKR,YAAY,OAAO,CAAC;yCAMnB,eAAe,OAAO,CAAC;4CAIpB,MAAM;2CAIP,MAAM,QAAQ,MAAM;CAM5D,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1E,MAAM,WAAW,aAAa,CAC5B,UAAU,SAAS,cAAc,GAAG,cAAc;IAElD,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;CAC5B;AAED,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,aAAa,IAAI;KACxD,SAAS,IAAI,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;CACzE,CAAC;AAEF,8BAAsB,eAAe,CACnC,OAAO,SAAS,aAAa,EAC7B,MAAM,SAAS,aAAa,CAAC,OAAO,CAAC;IAO5B,UAAU,EAAE;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IARH,OAAc,yBAAyB,EAAE,SAAS,CAAU;IAErD,SAAS,yCAAoC;gBAG3C,UAAU,EAAE;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAKH,IAAW,WAAW,aAErB;IAEM,cAAc,CAAC,UAAU,SAAS,MAAM,OAAO,EACpD,UAAU,EAAE,UAAU,GAAG,MAAM,EAC/B,eAAe,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAC3C,IAAI;IAsBA,eAAe,CAAC,OAAO,EAAE,OAAO;IAahC,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAMnD,SAAS,CAAC,MAAM,EAAE,MAAM;IAIxB,OAAO,CAAC,UAAU,SAAS,MAAM,OAAO,EAC7C,UAAU,EAAE,UAAU,GACrB,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAI7B,kBAAkB,CAAC,UAAU,SAAS,MAAM,OAAO,EACxD,UAAU,EAAE,UAAU,GAAG,MAAM,GAC9B,MAAM;IAQT;;;OAGG;IACI,cAAc,CAAC,UAAU,SAAS,MAAM,OAAO,EACpD,UAAU,EAAE,UAAU,GAAG,MAAM,EAC/B,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAa7C,uBAAuB,CAAC,UAAU,SAAS,MAAM,OAAO,EAC7D,UAAU,EAAE,UAAU,GAAG,MAAM;CAclC"}

package/dist/config/ModuleContainer.js

@@ -0,0 +1,89 @@
+import { container, Lifecycle } from "tsyringe";
+export const errors = {
+    configNotSet: (moduleName) => new Error(`Trying to retrieve config of ${moduleName}, which was not yet set`),
+    configNotSetInContainer: (moduleName) => new Error(`Trying to set config of ${moduleName}, but it was not yet set in the module container`),
+    onlyStringModuleNames: (moduleName) => new Error(
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    `Only string module names, using ${typeof moduleName} instead: ${moduleName.toString()}`),
+    unableToDecorateModule: (moduleName) => 
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    new Error(`Unable to decorate module ${moduleName.toString()}`),
+    nonModuleDependecy: (runtimeModuleName) => new Error(`
+  Unable to register module: ${runtimeModuleName}, attempting to inject a non-module dependency`),
+    unknownDependency: (runtimeModuleName, name) => new Error(`Unable to register module: ${runtimeModuleName}, 
+      attempting to inject a dependency that is not registred 
+      as a runtime module for this chain: ${name}`),
+};
+export class ModuleContainer {
+    constructor(definition) {
+        this.definition = definition;
+        this.container = container.createChildContainer();
+        this.registerModules(definition.modules);
+    }
+    get moduleNames() {
+        return Object.keys(this.definition.modules);
+    }
+    validateModule(moduleName, containedModule) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const dependencies = Reflect.getMetadata("design:paramtypes", containedModule);
+        dependencies?.forEach((dependency) => {
+            const name = typeof dependency === "string" ? dependency : dependency.name;
+            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+            if (!name) {
+                throw errors.nonModuleDependecy(this.moduleNameToString(moduleName));
+            }
+            if (!this.moduleNames.includes(name)) {
+                throw errors.unknownDependency(this.moduleNameToString(moduleName), name);
+            }
+        });
+    }
+    registerModules(modules) {
+        for (const moduleName in modules) {
+            if (Object.prototype.hasOwnProperty.call(modules, moduleName)) {
+                this.container.register(moduleName, { useClass: modules[moduleName] }, { lifecycle: Lifecycle.ContainerScoped });
+                this.onAfterModuleResolution(moduleName);
+            }
+        }
+    }
+    registerValue(modules) {
+        Object.entries(modules).forEach(([moduleName, useValue]) => {
+            this.container.register(moduleName, { useValue });
+        });
+    }
+    configure(config) {
+        this.definition.config = config;
+    }
+    resolve(moduleName) {
+        return this.container.resolve(this.moduleNameToString(moduleName));
+    }
+    moduleNameToString(moduleName) {
+        if (typeof moduleName !== "string") {
+            throw errors.onlyStringModuleNames(moduleName);
+        }
+        return moduleName;
+    }
+    /**
+     * Override this in the child class to provide custom
+     * features or module checks
+     */
+    decorateModule(moduleName, containedModule) {
+        const moduleNameString = this.moduleNameToString(moduleName);
+        const config = this.definition.config?.[moduleNameString];
+        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+        if (!config) {
+            throw errors.configNotSetInContainer(moduleNameString);
+        }
+        containedModule.config = config;
+    }
+    onAfterModuleResolution(moduleName) {
+        this.container.afterResolution(
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        moduleName, (containedModuleName, containedModule) => {
+            if (Array.isArray(containedModule)) {
+                throw errors.unableToDecorateModule(containedModuleName);
+            }
+            this.decorateModule(moduleName, containedModule);
+        }, { frequency: ModuleContainer.moduleDecorationFrequency });
+    }
+}
+ModuleContainer.moduleDecorationFrequency = "Once";

package/dist/config/types.d.ts

@@ -0,0 +1,2 @@
+export type TypedClassConstructor<Type> = new (...args: any[]) => Type;
+//# sourceMappingURL=types.d.ts.map

package/dist/config/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,CAAC,IAAI,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC"}

package/dist/config/types.js

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

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+export * from "./utils/ProvableHashList";
+export * from "./model/StateTransition";
+export * from "./model/StateTransitionProvableBatch";
+export * from "./model/Option";
+export * from "./model/Path";
+export * from "./model/network/NetworkState";
+export * from "./model/transaction/ProtocolTransaction";
+export * from "./model/transaction/RuntimeTransaction";
+export * from "./utils/PrefixedProvableHashList.js";
+export * from "./utils/utils";
+export * from "./prover/block/BlockProver";
+export * from "./prover/block/BlockProvable";
+export * from "./prover/statetransition/StateTransitionProver";
+export * from "./prover/statetransition/StateTransitionProvable";
+export * from "./prover/statetransition/StateTransitionWitnessProvider";
+export * from "./utils/merkletree/MerkleTreeStore";
+export * from "./utils/merkletree/InMemoryMerkleTreeStorage";
+export * from "./utils/merkletree/RollupMerkleTree";
+export * from "./model/MethodPublicOutput";
+export * from "./prover/statetransition/StateTransitionWitnessProviderReference";
+export * from "./protocol/Protocol";
+export * from "./protocol/ProtocolModule";
+export { constants as ProtocolConstants } from "./Constants";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sCAAsC,CAAC;AACrD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,qCAAqC,CAAC;AACpD,cAAc,eAAe,CAAC;AAC9B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gDAAgD,CAAC;AAC/D,cAAc,kDAAkD,CAAC;AACjE,cAAc,yDAAyD,CAAC;AACxE,cAAc,oCAAoC,CAAC;AACnD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,qCAAqC,CAAC;AACpD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kEAAkE,CAAC;AACjF,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,SAAS,IAAI,iBAAiB,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,23 @@
+export * from "./utils/ProvableHashList";
+export * from "./model/StateTransition";
+export * from "./model/StateTransitionProvableBatch";
+export * from "./model/Option";
+export * from "./model/Path";
+export * from "./model/network/NetworkState";
+export * from "./model/transaction/ProtocolTransaction";
+export * from "./model/transaction/RuntimeTransaction";
+export * from "./utils/PrefixedProvableHashList.js";
+export * from "./utils/utils";
+export * from "./prover/block/BlockProver";
+export * from "./prover/block/BlockProvable";
+export * from "./prover/statetransition/StateTransitionProver";
+export * from "./prover/statetransition/StateTransitionProvable";
+export * from "./prover/statetransition/StateTransitionWitnessProvider";
+export * from "./utils/merkletree/MerkleTreeStore";
+export * from "./utils/merkletree/InMemoryMerkleTreeStorage";
+export * from "./utils/merkletree/RollupMerkleTree";
+export * from "./model/MethodPublicOutput";
+export * from "./prover/statetransition/StateTransitionWitnessProviderReference";
+export * from "./protocol/Protocol";
+export * from "./protocol/ProtocolModule";
+export { constants as ProtocolConstants } from "./Constants";