@ledgerhq/context-module 0.1.2-next.0 → 1.0.0

package/LICENSE.MD

@@ -0,0 +1,202 @@
+
+                                 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 2024-present Ledger
+
+   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,127 @@
+# Ledger Context Module Implementation
+
+> [!CAUTION]
+> This is still under development and we are free to make new interfaces which may lead to Device Management Kit breaking changes.
+
+## Introduction
+
+The purpose of the **Context Module** is to provide all the necessary context for the clear signing operation.
+This module includes the Ledger implementation of the context module and all the default context loaders used to fetch the context of a transaction.
+This open-source module can serve as an example for implementing custom context modules or loaders.
+
+## How does it work
+
+The Context Module features an interface utilized by the Signer module to retrieve the context of a transaction. This module comprises multiple loaders, each capable of being specified individually. Each loader attempts to fetch context from the backend relevant to its domain. For example, one loader retrieves information about tokens, another fetches information about NFTs, and so on.
+
+The following diagram illustrates the communication between the various modules when the context for a token transaction is successfully retrieved:
+
+```mermaid
+  flowchart LR;
+      Signer --Transaction--> ContextModule
+      ContextModule --Transaction--> TokenContextLoader
+      ContextModule --Transaction--> NftContextLoader
+      ContextModule --Transaction--> OtherContextLoader
+      TokenContextLoader --> Backend1(Backend)
+      NftContextLoader --> Backend2(Backend)
+      OtherContextLoader --> Backend3(Backend)
+      Backend1 --Context--> TokenContextLoader
+      TokenContextLoader --Context--> ContextModule
+      ContextModule --Context--> Signer
+```
+
+## Installation
+
+To install the context-module package, run the following command:
+
+```sh
+npm install @ledgerhq/context-module
+```
+
+## Usage
+
+### Main Features
+
+It currently supports the following features:
+
+- Tokens: provide information about tokens used in the transaction.
+- NFTs: provide information about NFTs used in the transaction.
+- Domain name: provide information about domain names.
+- Custom plugins: provide complex informations to external plugins such as the **1inch** or **paraswap** plugin.
+
+> [!NOTE]  
+> At the moment the context module is available only for Ethereum blockchain.
+
+### Setting up
+
+The context-module package exposes a builder `ContextModuleBuilder` which will be used to initialise the context module with your configuration.
+
+```ts
+const contextModule = new ContextModuleBuilder().build();
+```
+
+You can use a custom configuration for your context module.
+
+```ts
+const config: ContextModuleConfig = {
+  // config to use
+};
+const contextModule = new ContextModuleBuilder().withConfig(config).build();
+```
+
+It is also possible to instantiate the context module without the default loaders.
+
+```ts
+const contextModule = new ContextModuleBuilder()
+  .withoutDefaultLoaders()
+  .build();
+```
+
+> [!NOTE]
+> Without loaders, a transaction cannot be clear signed. Use it with caution.
+
+You can add a custom list of loader to the context module.
+
+```ts
+// Default Token Loader
+const tokenLoader = new TokenContextLoader(new TokenDataSource());
+
+// Custom Loader
+const myCustomLoader = new MyCustomLoader();
+
+// Custom datasource for a default Token Loader
+const myCustomTokenDataSource = new MyCustomTokenDataSource();
+const myTokenLoader = new TokenCOntextLoader();
+
+const contextModule = new ContextModuleBuilder()
+  .withoutDefaultLoaders()
+  .addLoader(tokenLoader)
+  .addLoader(myTokenLoader)
+  .addLoader(myCustomLoader)
+  .build();
+```
+
+### Create a custom loader
+
+A custom loader must implement the ContextLoader interface, defined as follows:
+
+```ts
+type ContextLoader = {
+  load: (transaction: TransactionContext) => Promise<ClearSignContext[]>;
+};
+```
+
+with ClearSignContextSuccess defined as follows:
+
+```ts
+type ClearSignContextSuccess = {
+  type: "token" | "nft" | "domainName" | "plugin" | "externalPlugin";
+  payload: string;
+};
+```
+
+The payload should represent the data sent to the device to provide information and must be signed by a trusted authority.
+
+### Errors handling
+
+> [!CAUTION]
+> To be defined

package/lib/cjs/index.d.ts

@@ -0,0 +1,3 @@
+import "reflect-metadata";
+export * from "./src/index";
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,CAAC;AAE1B,cAAc,aAAa,CAAC"}

package/lib/cjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// inversify requirement
+require("reflect-metadata");
+__exportStar(require("./src/index"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wBAAwB;AACxB,4BAA0B;AAE1B,8CAA4B"}

package/lib/cjs/package.json

@@ -0,0 +1,63 @@
+{
+    "name": "@ledgerhq/context-module",
+    "version": "1.0.0",
+    "license": "MIT",
+    "exports": {
+        ".": {
+            "import": "./lib/esm/index.js",
+            "require": "./lib/cjs/index.js",
+            "default": "./index.ts",
+            "types": "./lib/esm/index.d.ts"
+        },
+        "./*.js": {
+            "import": "./lib/esm/*.js",
+            "require": "./lib/cjs/*.js",
+            "default": "./*.js",
+            "types": "./lib/esm/*.d.ts"
+        },
+        "./*": {
+            "import": "./lib/esm/*",
+            "require": "./lib/cjs/*",
+            "default": "./*",
+            "types": "./lib/esm/*"
+        }
+    },
+    "files": [
+        "./lib"
+    ],
+    "scripts": {
+        "build": "rimraf lib && zx scripts/build.mjs",
+        "dev": "concurrently \"pnpm dev:esm\" \"pnpm dev:cjs\"",
+        "dev:esm": "concurrently \"tsc --watch -p tsconfig.esm.json\" \"tsc-alias --watch -p tsconfig.esm.json\"",
+        "dev:cjs": "concurrently \"tsc --watch -p tsconfig.cjs.json\" \"tsc-alias --watch -p tsconfig.cjs.json\"",
+        "lint": "eslint",
+        "lint:fix": "pnpm lint --fix",
+        "postpack": "find . -name '*.tgz' -exec cp {} ../../../dist/ \\; ",
+        "prettier": "prettier . --check",
+        "prettier:fix": "prettier . --write",
+        "test": "jest",
+        "test:watch": "pnpm test -- --watch",
+        "test:coverage": "pnpm test -- --coverage",
+        "typecheck": "tsc --noEmit"
+    },
+    "devDependencies": {
+        "@ledgerhq/device-management-kit": "workspace:*",
+        "@ledgerhq/eslint-config-dsdk": "workspace:*",
+        "@ledgerhq/jest-config-dsdk": "workspace:*",
+        "@ledgerhq/prettier-config-dsdk": "workspace:*",
+        "@ledgerhq/tsconfig-dsdk": "workspace:*",
+        "@types/crypto-js": "^4.2.2",
+        "ts-node": "^10.9.2"
+    },
+    "dependencies": {
+        "axios": "^1.7.7",
+        "crypto-js": "^4.2.0",
+        "ethers": "^6.13.2",
+        "inversify": "^6.0.2",
+        "purify-ts": "^2.1.0",
+        "reflect-metadata": "^0.2.2"
+    },
+    "peerDependencies": {
+        "@ledgerhq/device-management-kit": "workspace:*"
+    }
+}

package/lib/cjs/src/ContextModule.d.ts

@@ -0,0 +1,9 @@
+import { ClearSignContext } from "./shared/model/ClearSignContext";
+import { TransactionContext } from "./shared/model/TransactionContext";
+import { type TypedDataClearSignContext } from "./shared/model/TypedDataClearSignContext";
+import { type TypedDataContext } from "./shared/model/TypedDataContext";
+export interface ContextModule {
+    getContexts(transaction: TransactionContext): Promise<ClearSignContext[]>;
+    getTypedDataFilters(typedData: TypedDataContext): Promise<TypedDataClearSignContext>;
+}
+//# sourceMappingURL=ContextModule.d.ts.map

package/lib/cjs/src/ContextModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextModule.d.ts","sourceRoot":"","sources":["../../../src/ContextModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,KAAK,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAC1F,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,WAAW,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC1E,mBAAmB,CACjB,SAAS,EAAE,gBAAgB,GAC1B,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACvC"}

package/lib/{ContextModule.js.map → cjs/src/ContextModule.js.map}

@@ -1 +1 @@
-{"version":3,"file":"ContextModule.js","sourceRoot":"","sources":["../src/ContextModule.ts"],"names":[],"mappings":""}
+{"version":3,"file":"ContextModule.js","sourceRoot":"","sources":["../../../src/ContextModule.ts"],"names":[],"mappings":""}

package/lib/cjs/src/ContextModuleBuilder.d.ts

@@ -0,0 +1,45 @@
+import { ContextModuleConfig } from "./config/model/ContextModuleConfig";
+import { ContextLoader } from "./shared/domain/ContextLoader";
+import { type TypedDataContextLoader } from "./typed-data/domain/TypedDataContextLoader";
+import { ContextModule } from "./ContextModule";
+export declare const DEFAULT_CONFIG: ContextModuleConfig;
+export declare class ContextModuleBuilder {
+    private config;
+    private customLoaders;
+    private defaultLoaders;
+    private customTypedDataLoader?;
+    constructor();
+    /**
+     * Remove default loaders from the list of loaders
+     *
+     * @returns this
+     */
+    withoutDefaultLoaders(): this;
+    /**
+     * Add a custom loader to the list of loaders
+     *
+     * @param loader loader to add to the list of loaders
+     * @returns this
+     */
+    addLoader(loader: ContextLoader): this;
+    /**
+     * Replace the default loader for typed data clear signing contexts
+     *
+     * @returns this
+     */
+    withTypedDataLoader(loader: TypedDataContextLoader): this;
+    /**
+     * Set the configuration for the context module
+     *
+     * @param config configuration for the context module
+     * @returns this
+     */
+    withConfig(config: Partial<ContextModuleConfig>): this;
+    /**
+     * Build the context module
+     *
+     * @returns the context module
+     */
+    build(): ContextModule;
+}
+//# sourceMappingURL=ContextModuleBuilder.d.ts.map

package/lib/cjs/src/ContextModuleBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextModuleBuilder.d.ts","sourceRoot":"","sources":["../../../src/ContextModuleBuilder.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAIzE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAMhD,eAAO,MAAM,cAAc,EAAE,mBAM5B,CAAC;AAEF,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,MAAM,CAAoC;IAClD,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,qBAAqB,CAAC,CAAyB;;IAIvD;;;;OAIG;IACH,qBAAqB;IAKrB;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,aAAa;IAK/B;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,sBAAsB;IAKlD;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC;IAK/C;;;;OAIG;IACH,KAAK,IAAI,aAAa;CAyBvB"}

package/lib/cjs/src/ContextModuleBuilder.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextModuleBuilder = exports.DEFAULT_CONFIG = void 0;
+const externalPluginTypes_1 = require("./external-plugin/di/externalPluginTypes");
+const forwardDomainTypes_1 = require("./forward-domain/di/forwardDomainTypes");
+const nftTypes_1 = require("./nft/di/nftTypes");
+const tokenTypes_1 = require("./token/di/tokenTypes");
+const typedDataTypes_1 = require("./typed-data/di/typedDataTypes");
+const DefaultContextModule_1 = require("./DefaultContextModule");
+const di_1 = require("./di");
+const DEFAULT_CAL_URL = "https://crypto-assets-service.api.ledger.com/v1";
+exports.DEFAULT_CONFIG = {
+    cal: {
+        url: DEFAULT_CAL_URL,
+        mode: "prod",
+        branch: "main",
+    },
+};
+class ContextModuleBuilder {
+    config = {};
+    customLoaders = [];
+    defaultLoaders = [];
+    customTypedDataLoader;
+    constructor() { }
+    /**
+     * Remove default loaders from the list of loaders
+     *
+     * @returns this
+     */
+    withoutDefaultLoaders() {
+        this.defaultLoaders = [];
+        return this;
+    }
+    /**
+     * Add a custom loader to the list of loaders
+     *
+     * @param loader loader to add to the list of loaders
+     * @returns this
+     */
+    addLoader(loader) {
+        this.customLoaders.push(loader);
+        return this;
+    }
+    /**
+     * Replace the default loader for typed data clear signing contexts
+     *
+     * @returns this
+     */
+    withTypedDataLoader(loader) {
+        this.customTypedDataLoader = loader;
+        return this;
+    }
+    /**
+     * Set the configuration for the context module
+     *
+     * @param config configuration for the context module
+     * @returns this
+     */
+    withConfig(config) {
+        this.config = config;
+        return this;
+    }
+    /**
+     * Build the context module
+     *
+     * @returns the context module
+     */
+    build() {
+        const container = (0, di_1.makeContainer)({
+            config: { ...exports.DEFAULT_CONFIG, ...this.config },
+        });
+        this.defaultLoaders = [
+            container.get(externalPluginTypes_1.externalPluginTypes.ExternalPluginContextLoader),
+            container.get(forwardDomainTypes_1.forwardDomainTypes.ForwardDomainContextLoader),
+            container.get(nftTypes_1.nftTypes.NftContextLoader),
+            container.get(tokenTypes_1.tokenTypes.TokenContextLoader),
+        ];
+        const defaultTypedDataLoader = container.get(typedDataTypes_1.typedDataTypes.TypedDataContextLoader);
+        const loaders = [...this.defaultLoaders, ...this.customLoaders];
+        return new DefaultContextModule_1.DefaultContextModule({
+            loaders,
+            typedDataLoader: this.customTypedDataLoader ?? defaultTypedDataLoader,
+        });
+    }
+}
+exports.ContextModuleBuilder = ContextModuleBuilder;
+//# sourceMappingURL=ContextModuleBuilder.js.map

package/lib/cjs/src/ContextModuleBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextModuleBuilder.js","sourceRoot":"","sources":["../../../src/ContextModuleBuilder.ts"],"names":[],"mappings":";;;AAAA,kFAA+E;AAC/E,+EAA4E;AAC5E,gDAA6C;AAC7C,sDAAmD;AACnD,mEAAgE;AAUhE,iEAA8D;AAC9D,6BAAqC;AAErC,MAAM,eAAe,GAAG,iDAAiD,CAAC;AAE7D,QAAA,cAAc,GAAwB;IACjD,GAAG,EAAE;QACH,GAAG,EAAE,eAAe;QACpB,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,MAAM;KACf;CACF,CAAC;AAEF,MAAa,oBAAoB;IACvB,MAAM,GAAiC,EAAE,CAAC;IAC1C,aAAa,GAAoB,EAAE,CAAC;IACpC,cAAc,GAAoB,EAAE,CAAC;IACrC,qBAAqB,CAA0B;IAEvD,gBAAe,CAAC;IAEhB;;;;OAIG;IACH,qBAAqB;QACnB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAqB;QAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,MAA8B;QAChD,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,MAAoC;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,MAAM,SAAS,GAAG,IAAA,kBAAa,EAAC;YAC9B,MAAM,EAAE,EAAE,GAAG,sBAAc,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;SAC9C,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,GAAG;YACpB,SAAS,CAAC,GAAG,CACX,yCAAmB,CAAC,2BAA2B,CAChD;YACD,SAAS,CAAC,GAAG,CACX,uCAAkB,CAAC,0BAA0B,CAC9C;YACD,SAAS,CAAC,GAAG,CAAmB,mBAAQ,CAAC,gBAAgB,CAAC;YAC1D,SAAS,CAAC,GAAG,CAAqB,uBAAU,CAAC,kBAAkB,CAAC;SACjE,CAAC;QACF,MAAM,sBAAsB,GAAG,SAAS,CAAC,GAAG,CAC1C,+BAAc,CAAC,sBAAsB,CACtC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAChE,OAAO,IAAI,2CAAoB,CAAC;YAC9B,OAAO;YACP,eAAe,EAAE,IAAI,CAAC,qBAAqB,IAAI,sBAAsB;SACtE,CAAC,CAAC;IACL,CAAC;CACF;AAhFD,oDAgFC"}

package/lib/{DefaultContextModule.d.ts → cjs/src/DefaultContextModule.d.ts}

@@ -1,14 +1,20 @@
-import { ContextModule } from "./ContextModule";
+import type { TypedDataClearSignContext } from "./shared/model/TypedDataClearSignContext";
+import type { TypedDataContext } from "./shared/model/TypedDataContext";
 import { ContextLoader } from "./shared/domain/ContextLoader";
 import { ClearSignContext } from "./shared/model/ClearSignContext";
 import { TransactionContext } from "./shared/model/TransactionContext";
+import type { TypedDataContextLoader } from "./typed-data/domain/TypedDataContextLoader";
+import { ContextModule } from "./ContextModule";
 type DefaultContextModuleConstructorArgs = {
     loaders: ContextLoader[];
+    typedDataLoader: TypedDataContextLoader;
 };
 export declare class DefaultContextModule implements ContextModule {
     private _loaders;
+    private _typedDataLoader;
     constructor(args: DefaultContextModuleConstructorArgs);
     getContexts(transaction: TransactionContext): Promise<ClearSignContext[]>;
+    getTypedDataFilters(typedData: TypedDataContext): Promise<TypedDataClearSignContext>;
 }
 export {};
 //# sourceMappingURL=DefaultContextModule.d.ts.map

package/lib/cjs/src/DefaultContextModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultContextModule.d.ts","sourceRoot":"","sources":["../../../src/DefaultContextModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,0CAA0C,CAAC;AAC1F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,KAAK,mCAAmC,GAAG;IACzC,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,eAAe,EAAE,sBAAsB,CAAC;CACzC,CAAC;AAEF,qBAAa,oBAAqB,YAAW,aAAa;IACxD,OAAO,CAAC,QAAQ,CAAkB;IAClC,OAAO,CAAC,gBAAgB,CAAyB;gBAErC,IAAI,EAAE,mCAAmC;IAKxC,WAAW,CACtB,WAAW,EAAE,kBAAkB,GAC9B,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAMjB,mBAAmB,CAC9B,SAAS,EAAE,gBAAgB,GAC1B,OAAO,CAAC,yBAAyB,CAAC;CAGtC"}

package/lib/cjs/src/DefaultContextModule.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultContextModule = void 0;
+class DefaultContextModule {
+    _loaders;
+    _typedDataLoader;
+    constructor(args) {
+        this._loaders = args.loaders;
+        this._typedDataLoader = args.typedDataLoader;
+    }
+    async getContexts(transaction) {
+        const promises = this._loaders.map((fetcher) => fetcher.load(transaction));
+        const responses = await Promise.all(promises);
+        return responses.flat();
+    }
+    async getTypedDataFilters(typedData) {
+        return this._typedDataLoader.load(typedData);
+    }
+}
+exports.DefaultContextModule = DefaultContextModule;
+//# sourceMappingURL=DefaultContextModule.js.map

package/lib/cjs/src/DefaultContextModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultContextModule.js","sourceRoot":"","sources":["../../../src/DefaultContextModule.ts"],"names":[],"mappings":";;;AAcA,MAAa,oBAAoB;IACvB,QAAQ,CAAkB;IAC1B,gBAAgB,CAAyB;IAEjD,YAAY,IAAyC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,WAAW,CACtB,WAA+B;QAE/B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9C,OAAO,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,SAA2B;QAE3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;CACF;AAtBD,oDAsBC"}

package/lib/cjs/src/config/di/configModuleFactory.d.ts

@@ -0,0 +1,4 @@
+import { ContainerModule } from "inversify";
+import { ContextModuleConfig } from "../../config/model/ContextModuleConfig";
+export declare const configModuleFactory: (config: ContextModuleConfig) => ContainerModule;
+//# sourceMappingURL=configModuleFactory.d.ts.map

package/lib/cjs/src/config/di/configModuleFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configModuleFactory.d.ts","sourceRoot":"","sources":["../../../../../src/config/di/configModuleFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAIzE,eAAO,MAAM,mBAAmB,WAAY,mBAAmB,oBAG3D,CAAC"}