@metamask/shield-controller 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0]
+
+### Added
+
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#6504](https://github.com/MetaMask/core/pull/6504))
+- Add signature coverage checking ([#6501](https://github.com/MetaMask/core/pull/6501))
+- Add transaction and signature logging ([#6633](https://github.com/MetaMask/core/pull/6633))
+
+### Changed
+
+- Bump `@metamask/signature-controller` from `^33.0.0` to `^34.0.0` ([#6702](https://github.com/MetaMask/core/pull/6702))
+- Bump `@metamask/base-controller` from `^8.2.0` to `^8.4.0` ([#6465](https://github.com/MetaMask/core/pull/6465), [#6632](https://github.com/MetaMask/core/pull/6632))
+- Bump `@metamask/utils` from `^11.4.2` to `^11.8.0` ([#6588](https://github.com/MetaMask/core/pull/6588))
+
+## [0.1.2]
+
+### Fixed
+
+- Fixed backend URL paths ([#6433](https://github.com/MetaMask/core/pull/6433))
+
 ## [0.1.1]
 
 ### Fixed
@@ -19,6 +39,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release of the shield-controller package ([#6137](https://github.com/MetaMask/core/pull/6137)
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.2.0...HEAD
+[0.2.0]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.1.2...@metamask/shield-controller@0.2.0
+[0.1.2]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.1.1...@metamask/shield-controller@0.1.2
 [0.1.1]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.1.0...@metamask/shield-controller@0.1.1
 [0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/shield-controller@0.1.0

package/dist/ShieldController.cjs

@@ -10,10 +10,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_handleTransactionControllerStateChange, _ShieldController_fetchCoverageResult, _ShieldController_addCoverageResult;
+var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_signatureControllerStateChangeHandler, _ShieldController_handleSignatureControllerStateChange, _ShieldController_handleTransactionControllerStateChange, _ShieldController_addCoverageResult, _ShieldController_logSignature, _ShieldController_logTransaction, _ShieldController_getLatestCoverageId;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShieldController = exports.getDefaultShieldControllerState = void 0;
 const base_controller_1 = require("@metamask/base-controller");
+const signature_controller_1 = require("@metamask/signature-controller");
+const transaction_controller_1 = require("@metamask/transaction-controller");
 const constants_1 = require("./constants.cjs");
 const logger_1 = require("./logger.cjs");
 const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'ShieldController');
@@ -35,12 +37,16 @@ exports.getDefaultShieldControllerState = getDefaultShieldControllerState;
  */
 const metadata = {
     coverageResults: {
+        includeInStateLogs: true,
         persist: true,
         anonymous: false,
+        usedInUi: true,
     },
     orderedTransactionHistory: {
+        includeInStateLogs: true,
         persist: true,
         anonymous: false,
+        usedInUi: false,
     },
 };
 class ShieldController extends base_controller_1.BaseController {
@@ -60,16 +66,20 @@ class ShieldController extends base_controller_1.BaseController {
         _ShieldController_coverageHistoryLimit.set(this, void 0);
         _ShieldController_transactionHistoryLimit.set(this, void 0);
         _ShieldController_transactionControllerStateChangeHandler.set(this, void 0);
+        _ShieldController_signatureControllerStateChangeHandler.set(this, void 0);
         __classPrivateFieldSet(this, _ShieldController_backend, backend, "f");
         __classPrivateFieldSet(this, _ShieldController_coverageHistoryLimit, coverageHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionHistoryLimit, transactionHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleTransactionControllerStateChange).bind(this), "f");
+        __classPrivateFieldSet(this, _ShieldController_signatureControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleSignatureControllerStateChange).bind(this), "f");
     }
     start() {
         this.messagingSystem.subscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"), (state) => state.transactions);
+        this.messagingSystem.subscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"), (state) => state.signatureRequests);
     }
     stop() {
         this.messagingSystem.unsubscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"));
+        this.messagingSystem.unsubscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"));
     }
     /**
      * Checks the coverage of a transaction.
@@ -79,16 +89,53 @@ class ShieldController extends base_controller_1.BaseController {
      */
     async checkCoverage(txMeta) {
         // Check coverage
-        const coverageResult = await __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_fetchCoverageResult).call(this, txMeta);
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldController_backend, "f").checkCoverage(txMeta);
         // Publish coverage result
         this.messagingSystem.publish(`${constants_1.controllerName}:coverageResultReceived`, coverageResult);
         // Update state
         __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_addCoverageResult).call(this, txMeta.id, coverageResult);
         return coverageResult;
     }
+    /**
+     * Checks the coverage of a signature request.
+     *
+     * @param signatureRequest - The signature request to check coverage for.
+     * @returns The coverage result.
+     */
+    async checkSignatureCoverage(signatureRequest) {
+        // Check coverage
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldController_backend, "f").checkSignatureCoverage(signatureRequest);
+        // Publish coverage result
+        this.messagingSystem.publish(`${constants_1.controllerName}:coverageResultReceived`, coverageResult);
+        // Update state
+        __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_addCoverageResult).call(this, signatureRequest.id, coverageResult);
+        return coverageResult;
+    }
 }
 exports.ShieldController = ShieldController;
-_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleTransactionControllerStateChange = function _ShieldController_handleTransactionControllerStateChange(transactions, previousTransactions) {
+_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_signatureControllerStateChangeHandler = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleSignatureControllerStateChange = function _ShieldController_handleSignatureControllerStateChange(signatureRequests, previousSignatureRequests) {
+    const signatureRequestsArray = Object.values(signatureRequests);
+    const previousSignatureRequestsArray = Object.values(previousSignatureRequests ?? {});
+    const previousSignatureRequestsById = new Map(previousSignatureRequestsArray.map((request) => [request.id, request]));
+    for (const signatureRequest of signatureRequestsArray) {
+        const previousSignatureRequest = previousSignatureRequestsById.get(signatureRequest.id);
+        // Check coverage if the signature request is new and has type
+        // `personal_sign`.
+        if (!previousSignatureRequest &&
+            signatureRequest.type === signature_controller_1.SignatureRequestType.PersonalSign) {
+            this.checkSignatureCoverage(signatureRequest).catch(
+            // istanbul ignore next
+            (error) => log('Error checking coverage:', error));
+        }
+        // Log signature once the signature request has been fulfilled.
+        if (signatureRequest.status === signature_controller_1.SignatureRequestStatus.Signed &&
+            signatureRequest.status !== previousSignatureRequest?.status) {
+            __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_logSignature).call(this, signatureRequest).catch(
+            // istanbul ignore next
+            (error) => log('Error logging signature:', error));
+        }
+    }
+}, _ShieldController_handleTransactionControllerStateChange = function _ShieldController_handleTransactionControllerStateChange(transactions, previousTransactions) {
     const previousTransactionsById = new Map(previousTransactions?.map((tx) => [tx.id, tx]) ?? []);
     for (const transaction of transactions) {
         const previousTransaction = previousTransactionsById.get(transaction.id);
@@ -102,9 +149,14 @@ _ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimi
             // istanbul ignore next
             (error) => log('Error checking coverage:', error));
         }
+        // Log transaction once it has been submitted.
+        if (transaction.status === transaction_controller_1.TransactionStatus.submitted &&
+            transaction.status !== previousTransaction?.status) {
+            __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_logTransaction).call(this, transaction).catch(
+            // istanbul ignore next
+            (error) => log('Error logging transaction:', error));
+        }
     }
-}, _ShieldController_fetchCoverageResult = async function _ShieldController_fetchCoverageResult(txMeta) {
-    return __classPrivateFieldGet(this, _ShieldController_backend, "f").checkCoverage(txMeta);
 }, _ShieldController_addCoverageResult = function _ShieldController_addCoverageResult(txId, coverageResult) {
     this.update((draft) => {
         // Fetch coverage result entry.
@@ -140,5 +192,41 @@ _ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimi
             orderedTransactionHistory.unshift(txId);
         }
     });
+}, _ShieldController_logSignature = async function _ShieldController_logSignature(signatureRequest) {
+    const coverageId = __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_getLatestCoverageId).call(this, signatureRequest.id);
+    if (!coverageId) {
+        throw new Error('Coverage ID not found');
+    }
+    const sig = signatureRequest.rawSig;
+    if (!sig) {
+        throw new Error('Signature not found');
+    }
+    await __classPrivateFieldGet(this, _ShieldController_backend, "f").logSignature({
+        coverageId,
+        signature: sig,
+        // Status is 'shown' because the coverageId can only be retrieved after
+        // the result is in the state. If the result is in the state, we assume
+        // that it has been shown.
+        status: 'shown',
+    });
+}, _ShieldController_logTransaction = async function _ShieldController_logTransaction(txMeta) {
+    const coverageId = __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_getLatestCoverageId).call(this, txMeta.id);
+    if (!coverageId) {
+        throw new Error('Coverage ID not found');
+    }
+    const txHash = txMeta.hash;
+    if (!txHash) {
+        throw new Error('Transaction hash not found');
+    }
+    await __classPrivateFieldGet(this, _ShieldController_backend, "f").logTransaction({
+        coverageId,
+        transactionHash: txHash,
+        // Status is 'shown' because the coverageId can only be retrieved after
+        // the result is in the state. If the result is in the state, we assume
+        // that it has been shown.
+        status: 'shown',
+    });
+}, _ShieldController_getLatestCoverageId = function _ShieldController_getLatestCoverageId(itemId) {
+    return this.state.coverageResults[itemId]?.results[0]?.coverageId;
 };
 //# sourceMappingURL=ShieldController.cjs.map

package/dist/ShieldController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.cjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAU3D,+CAA6C;AAC7C,yCAA6D;AAG7D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AALD,0EAKC;AAkDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,yBAAyB,EAAE;QACzB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAUF,MAAa,gBAAiB,SAAQ,gCAIrC;IAYC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,0BAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA3BI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,4EAGC;QAoBR,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;IAC5D,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;IACJ,CAAC;IA4BD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,CAAC;QAE/D,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;CA8CF;AApJD,4CAoJC;mZA3FG,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,yEAAyE;QACzE,WAAW;QACX,IACE,CAAC,mBAAmB;YACpB,mEAAmE;YACnE,+CAA+C;YAC/C,mBAAmB,CAAC,cAAc,KAAK,WAAW,CAAC,cAAc,EACjE;YACA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,0CAwBD,KAAK,gDAAsB,MAAuB;IAChD,OAAO,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC,qFAEkB,IAAY,EAAE,cAA8B;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type {\n  TransactionControllerStateChangeEvent,\n  TransactionMeta,\n} from '@metamask/transaction-controller';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type { CoverageResult, ShieldBackend } from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents = TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    persist: true,\n    anonymous: false,\n  },\n  orderedTransactionHistory: {\n    persist: true,\n    anonymous: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n  }\n\n  start() {\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n  }\n\n  stop() {\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (\n        !previousTransaction ||\n        // Checking reference equality is sufficient because this object is\n        // replaced if the simulation data has changed.\n        previousTransaction.simulationData !== transaction.simulationData\n      ) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageResult = await this.#fetchCoverageResult(txMeta);\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  async #fetchCoverageResult(txMeta: TransactionMeta): Promise<CoverageResult> {\n    return this.#backend.checkCoverage(txMeta);\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n}\n"]}
+{"version":3,"file":"ShieldController.cjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAK3D,yEAKwC;AACxC,6EAI0C;AAE1C,+CAA6C;AAC7C,yCAA6D;AAG7D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AALD,0EAKC;AAoDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAUF,MAAa,gBAAiB,SAAQ,gCAIrC;IAiBC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,0BAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhCI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,4EAGC;QAED,0EAGC;QAoBR,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,2DACF,uBAAA,IAAI,2FAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;IAC1D,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,CAC5C,CAAC;IACJ,CAAC;IAgFD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAEjE,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,iBAAiB;QACjB,MAAM,cAAc,GAClB,MAAM,uBAAA,IAAI,iCAAS,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;QAE/D,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,0BAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;CAuFF;AA5RD,4CA4RC;wdAjNG,iBAAmD,EACnD,yBAAuE;IAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CACvE,CAAC;IACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE;QACrD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;QAEF,8DAA8D;QAC9D,mBAAmB;QACnB,IACE,CAAC,wBAAwB;YACzB,gBAAgB,CAAC,IAAI,KAAK,2CAAoB,CAAC,YAAY,EAC3D;YACA,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;YACjD,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,+DAA+D;QAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,6CAAsB,CAAC,MAAM;YACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D;YACA,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,gBAAgB,CAAC,CAAC,KAAK;YACxC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,+HAGC,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,yEAAyE;QACzE,WAAW;QACX,IACE,CAAC,mBAAmB;YACpB,mEAAmE;YACnE,+CAA+C;YAC/C,mBAAmB,CAAC,cAAc,KAAK,WAAW,CAAC,cAAc,EACjE;YACA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,8CAA8C;QAC9C,IACE,WAAW,CAAC,MAAM,KAAK,0CAAiB,CAAC,SAAS;YAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD;YACA,uBAAA,IAAI,qEAAgB,MAApB,IAAI,EAAiB,WAAW,CAAC,CAAC,KAAK;YACrC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;SACH;KACF;AACH,CAAC,qFAiDkB,IAAY,EAAE,cAA8B;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,mCAED,KAAK,yCAAe,gBAAkC;IACpD,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAClE,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,GAAG,GAAG,gBAAgB,CAAC,MAAM,CAAC;IACpC,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,MAAM,uBAAA,IAAI,iCAAS,CAAC,YAAY,CAAC;QAC/B,UAAU;QACV,SAAS,EAAE,GAAG;QACd,uEAAuE;QACvE,uEAAuE;QACvE,0BAA0B;QAC1B,MAAM,EAAE,OAAO;KAChB,CAAC,CAAC;AACL,CAAC,qCAED,KAAK,2CAAiB,MAAuB;IAC3C,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,EAAE,CAAC,CAAC;IACxD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;IAC3B,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IACD,MAAM,uBAAA,IAAI,iCAAS,CAAC,cAAc,CAAC;QACjC,UAAU;QACV,eAAe,EAAE,MAAM;QACvB,uEAAuE;QACvE,uEAAuE;QACvE,0BAA0B;QAC1B,MAAM,EAAE,OAAO;KAChB,CAAC,CAAC;AACL,CAAC,yFAEoB,MAAc;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AACpE,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport {\n  SignatureRequestStatus,\n  SignatureRequestType,\n  type SignatureRequest,\n  type SignatureStateChange,\n} from '@metamask/signature-controller';\nimport {\n  TransactionStatus,\n  type TransactionControllerStateChangeEvent,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type { CoverageResult, ShieldBackend } from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents =\n  | SignatureStateChange\n  | TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  readonly #signatureControllerStateChangeHandler: (\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) => void;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n    this.#signatureControllerStateChangeHandler =\n      this.#handleSignatureControllerStateChange.bind(this);\n  }\n\n  start() {\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  stop() {\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) {\n    const signatureRequestsArray = Object.values(signatureRequests);\n    const previousSignatureRequestsArray = Object.values(\n      previousSignatureRequests ?? {},\n    );\n    const previousSignatureRequestsById = new Map<string, SignatureRequest>(\n      previousSignatureRequestsArray.map((request) => [request.id, request]),\n    );\n    for (const signatureRequest of signatureRequestsArray) {\n      const previousSignatureRequest = previousSignatureRequestsById.get(\n        signatureRequest.id,\n      );\n\n      // Check coverage if the signature request is new and has type\n      // `personal_sign`.\n      if (\n        !previousSignatureRequest &&\n        signatureRequest.type === SignatureRequestType.PersonalSign\n      ) {\n        this.checkSignatureCoverage(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log signature once the signature request has been fulfilled.\n      if (\n        signatureRequest.status === SignatureRequestStatus.Signed &&\n        signatureRequest.status !== previousSignatureRequest?.status\n      ) {\n        this.#logSignature(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error logging signature:', error),\n        );\n      }\n    }\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (\n        !previousTransaction ||\n        // Checking reference equality is sufficient because this object is\n        // replaced if the simulation data has changed.\n        previousTransaction.simulationData !== transaction.simulationData\n      ) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log transaction once it has been submitted.\n      if (\n        transaction.status === TransactionStatus.submitted &&\n        transaction.status !== previousTransaction?.status\n      ) {\n        this.#logTransaction(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error logging transaction:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageResult = await this.#backend.checkCoverage(txMeta);\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  /**\n   * Checks the coverage of a signature request.\n   *\n   * @param signatureRequest - The signature request to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    // Check coverage\n    const coverageResult =\n      await this.#backend.checkSignatureCoverage(signatureRequest);\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(signatureRequest.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n\n  async #logSignature(signatureRequest: SignatureRequest) {\n    const coverageId = this.#getLatestCoverageId(signatureRequest.id);\n    if (!coverageId) {\n      throw new Error('Coverage ID not found');\n    }\n\n    const sig = signatureRequest.rawSig;\n    if (!sig) {\n      throw new Error('Signature not found');\n    }\n\n    await this.#backend.logSignature({\n      coverageId,\n      signature: sig,\n      // Status is 'shown' because the coverageId can only be retrieved after\n      // the result is in the state. If the result is in the state, we assume\n      // that it has been shown.\n      status: 'shown',\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta) {\n    const coverageId = this.#getLatestCoverageId(txMeta.id);\n    if (!coverageId) {\n      throw new Error('Coverage ID not found');\n    }\n\n    const txHash = txMeta.hash;\n    if (!txHash) {\n      throw new Error('Transaction hash not found');\n    }\n    await this.#backend.logTransaction({\n      coverageId,\n      transactionHash: txHash,\n      // Status is 'shown' because the coverageId can only be retrieved after\n      // the result is in the state. If the result is in the state, we assume\n      // that it has been shown.\n      status: 'shown',\n    });\n  }\n\n  #getLatestCoverageId(itemId: string) {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}

package/dist/ShieldController.d.cts

@@ -1,6 +1,7 @@
 import { BaseController } from "@metamask/base-controller";
 import type { ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
-import type { TransactionControllerStateChangeEvent, TransactionMeta } from "@metamask/transaction-controller";
+import { type SignatureRequest, type SignatureStateChange } from "@metamask/signature-controller";
+import { type TransactionControllerStateChangeEvent, type TransactionMeta } from "@metamask/transaction-controller";
 import { controllerName } from "./constants.cjs";
 import type { CoverageResult, ShieldBackend } from "./types.cjs";
 export type CoverageResultRecordEntry = {
@@ -50,7 +51,7 @@ type AllowedActions = never;
 /**
  * The external events available to the ShieldController.
  */
-type AllowedEvents = TransactionControllerStateChangeEvent;
+type AllowedEvents = SignatureStateChange | TransactionControllerStateChangeEvent;
 /**
  * The messenger of the {@link ShieldController}.
  */
@@ -74,6 +75,13 @@ export declare class ShieldController extends BaseController<typeof controllerNa
      * @returns The coverage result.
      */
     checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult>;
+    /**
+     * Checks the coverage of a signature request.
+     *
+     * @param signatureRequest - The signature request to check coverage for.
+     * @returns The coverage result.
+     */
+    checkSignatureCoverage(signatureRequest: SignatureRequest): Promise<CoverageResult>;
 }
 export {};
 //# sourceMappingURL=ShieldController.d.cts.map

package/dist/ShieldController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.d.cts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,KAAK,EACV,qCAAqC,EACrC,eAAe,EAChB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAI7D,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GAAG,qCAAqC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAiBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAYa,OAAO,EAAE,uBAAuB;IAyB5C,KAAK;IAQL,IAAI;IAiCJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;CA4DtE"}
+{"version":3,"file":"ShieldController.d.cts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAGL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAC1B,uCAAuC;AACxC,OAAO,EAEL,KAAK,qCAAqC,EAC1C,KAAK,eAAe,EACrB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAI7D,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAiBa,OAAO,EAAE,uBAAuB;IA2B5C,KAAK;IAcL,IAAI;IA0FJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAgBrE;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;CAsG3B"}

package/dist/ShieldController.d.mts

@@ -1,6 +1,7 @@
 import { BaseController } from "@metamask/base-controller";
 import type { ControllerStateChangeEvent, RestrictedMessenger } from "@metamask/base-controller";
-import type { TransactionControllerStateChangeEvent, TransactionMeta } from "@metamask/transaction-controller";
+import { type SignatureRequest, type SignatureStateChange } from "@metamask/signature-controller";
+import { type TransactionControllerStateChangeEvent, type TransactionMeta } from "@metamask/transaction-controller";
 import { controllerName } from "./constants.mjs";
 import type { CoverageResult, ShieldBackend } from "./types.mjs";
 export type CoverageResultRecordEntry = {
@@ -50,7 +51,7 @@ type AllowedActions = never;
 /**
  * The external events available to the ShieldController.
  */
-type AllowedEvents = TransactionControllerStateChangeEvent;
+type AllowedEvents = SignatureStateChange | TransactionControllerStateChangeEvent;
 /**
  * The messenger of the {@link ShieldController}.
  */
@@ -74,6 +75,13 @@ export declare class ShieldController extends BaseController<typeof controllerNa
      * @returns The coverage result.
      */
     checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult>;
+    /**
+     * Checks the coverage of a signature request.
+     *
+     * @param signatureRequest - The signature request to check coverage for.
+     * @returns The coverage result.
+     */
+    checkSignatureCoverage(signatureRequest: SignatureRequest): Promise<CoverageResult>;
 }
 export {};
 //# sourceMappingURL=ShieldController.d.mts.map

package/dist/ShieldController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.d.mts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,KAAK,EACV,qCAAqC,EACrC,eAAe,EAChB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAI7D,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GAAG,qCAAqC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAiBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAYa,OAAO,EAAE,uBAAuB;IAyB5C,KAAK;IAQL,IAAI;IAiCJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;CA4DtE"}
+{"version":3,"file":"ShieldController.d.mts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,0BAA0B,EAC1B,mBAAmB,EACpB,kCAAkC;AACnC,OAAO,EAGL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAC1B,uCAAuC;AACxC,OAAO,EAEL,KAAK,qCAAqC,EAC1C,KAAK,eAAe,EACrB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAI7D,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF;;OAEG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,cAAc,gBAAgB,CAAC;IAC/C,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,GAAG,OAAO,cAAc,yBAAyB,CAAC;IACxD,OAAO,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,2CAA2C,GAC3C,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,CACzD,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,EACtC,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;gBAiBa,OAAO,EAAE,uBAAuB;IA2B5C,KAAK;IAcL,IAAI;IA0FJ;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAgBrE;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;CAsG3B"}

package/dist/ShieldController.mjs

@@ -9,8 +9,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_handleTransactionControllerStateChange, _ShieldController_fetchCoverageResult, _ShieldController_addCoverageResult;
+var _ShieldController_instances, _ShieldController_backend, _ShieldController_coverageHistoryLimit, _ShieldController_transactionHistoryLimit, _ShieldController_transactionControllerStateChangeHandler, _ShieldController_signatureControllerStateChangeHandler, _ShieldController_handleSignatureControllerStateChange, _ShieldController_handleTransactionControllerStateChange, _ShieldController_addCoverageResult, _ShieldController_logSignature, _ShieldController_logTransaction, _ShieldController_getLatestCoverageId;
 import { BaseController } from "@metamask/base-controller";
+import { SignatureRequestStatus, SignatureRequestType } from "@metamask/signature-controller";
+import { TransactionStatus } from "@metamask/transaction-controller";
 import { controllerName } from "./constants.mjs";
 import { projectLogger, createModuleLogger } from "./logger.mjs";
 const log = createModuleLogger(projectLogger, 'ShieldController');
@@ -31,12 +33,16 @@ export function getDefaultShieldControllerState() {
  */
 const metadata = {
     coverageResults: {
+        includeInStateLogs: true,
         persist: true,
         anonymous: false,
+        usedInUi: true,
     },
     orderedTransactionHistory: {
+        includeInStateLogs: true,
         persist: true,
         anonymous: false,
+        usedInUi: false,
     },
 };
 export class ShieldController extends BaseController {
@@ -56,16 +62,20 @@ export class ShieldController extends BaseController {
         _ShieldController_coverageHistoryLimit.set(this, void 0);
         _ShieldController_transactionHistoryLimit.set(this, void 0);
         _ShieldController_transactionControllerStateChangeHandler.set(this, void 0);
+        _ShieldController_signatureControllerStateChangeHandler.set(this, void 0);
         __classPrivateFieldSet(this, _ShieldController_backend, backend, "f");
         __classPrivateFieldSet(this, _ShieldController_coverageHistoryLimit, coverageHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionHistoryLimit, transactionHistoryLimit, "f");
         __classPrivateFieldSet(this, _ShieldController_transactionControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleTransactionControllerStateChange).bind(this), "f");
+        __classPrivateFieldSet(this, _ShieldController_signatureControllerStateChangeHandler, __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_handleSignatureControllerStateChange).bind(this), "f");
     }
     start() {
         this.messagingSystem.subscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"), (state) => state.transactions);
+        this.messagingSystem.subscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"), (state) => state.signatureRequests);
     }
     stop() {
         this.messagingSystem.unsubscribe('TransactionController:stateChange', __classPrivateFieldGet(this, _ShieldController_transactionControllerStateChangeHandler, "f"));
+        this.messagingSystem.unsubscribe('SignatureController:stateChange', __classPrivateFieldGet(this, _ShieldController_signatureControllerStateChangeHandler, "f"));
     }
     /**
      * Checks the coverage of a transaction.
@@ -75,15 +85,52 @@ export class ShieldController extends BaseController {
      */
     async checkCoverage(txMeta) {
         // Check coverage
-        const coverageResult = await __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_fetchCoverageResult).call(this, txMeta);
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldController_backend, "f").checkCoverage(txMeta);
         // Publish coverage result
         this.messagingSystem.publish(`${controllerName}:coverageResultReceived`, coverageResult);
         // Update state
         __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_addCoverageResult).call(this, txMeta.id, coverageResult);
         return coverageResult;
     }
+    /**
+     * Checks the coverage of a signature request.
+     *
+     * @param signatureRequest - The signature request to check coverage for.
+     * @returns The coverage result.
+     */
+    async checkSignatureCoverage(signatureRequest) {
+        // Check coverage
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldController_backend, "f").checkSignatureCoverage(signatureRequest);
+        // Publish coverage result
+        this.messagingSystem.publish(`${controllerName}:coverageResultReceived`, coverageResult);
+        // Update state
+        __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_addCoverageResult).call(this, signatureRequest.id, coverageResult);
+        return coverageResult;
+    }
 }
-_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleTransactionControllerStateChange = function _ShieldController_handleTransactionControllerStateChange(transactions, previousTransactions) {
+_ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimit = new WeakMap(), _ShieldController_transactionHistoryLimit = new WeakMap(), _ShieldController_transactionControllerStateChangeHandler = new WeakMap(), _ShieldController_signatureControllerStateChangeHandler = new WeakMap(), _ShieldController_instances = new WeakSet(), _ShieldController_handleSignatureControllerStateChange = function _ShieldController_handleSignatureControllerStateChange(signatureRequests, previousSignatureRequests) {
+    const signatureRequestsArray = Object.values(signatureRequests);
+    const previousSignatureRequestsArray = Object.values(previousSignatureRequests ?? {});
+    const previousSignatureRequestsById = new Map(previousSignatureRequestsArray.map((request) => [request.id, request]));
+    for (const signatureRequest of signatureRequestsArray) {
+        const previousSignatureRequest = previousSignatureRequestsById.get(signatureRequest.id);
+        // Check coverage if the signature request is new and has type
+        // `personal_sign`.
+        if (!previousSignatureRequest &&
+            signatureRequest.type === SignatureRequestType.PersonalSign) {
+            this.checkSignatureCoverage(signatureRequest).catch(
+            // istanbul ignore next
+            (error) => log('Error checking coverage:', error));
+        }
+        // Log signature once the signature request has been fulfilled.
+        if (signatureRequest.status === SignatureRequestStatus.Signed &&
+            signatureRequest.status !== previousSignatureRequest?.status) {
+            __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_logSignature).call(this, signatureRequest).catch(
+            // istanbul ignore next
+            (error) => log('Error logging signature:', error));
+        }
+    }
+}, _ShieldController_handleTransactionControllerStateChange = function _ShieldController_handleTransactionControllerStateChange(transactions, previousTransactions) {
     const previousTransactionsById = new Map(previousTransactions?.map((tx) => [tx.id, tx]) ?? []);
     for (const transaction of transactions) {
         const previousTransaction = previousTransactionsById.get(transaction.id);
@@ -97,9 +144,14 @@ _ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimi
             // istanbul ignore next
             (error) => log('Error checking coverage:', error));
         }
+        // Log transaction once it has been submitted.
+        if (transaction.status === TransactionStatus.submitted &&
+            transaction.status !== previousTransaction?.status) {
+            __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_logTransaction).call(this, transaction).catch(
+            // istanbul ignore next
+            (error) => log('Error logging transaction:', error));
+        }
     }
-}, _ShieldController_fetchCoverageResult = async function _ShieldController_fetchCoverageResult(txMeta) {
-    return __classPrivateFieldGet(this, _ShieldController_backend, "f").checkCoverage(txMeta);
 }, _ShieldController_addCoverageResult = function _ShieldController_addCoverageResult(txId, coverageResult) {
     this.update((draft) => {
         // Fetch coverage result entry.
@@ -135,5 +187,41 @@ _ShieldController_backend = new WeakMap(), _ShieldController_coverageHistoryLimi
             orderedTransactionHistory.unshift(txId);
         }
     });
+}, _ShieldController_logSignature = async function _ShieldController_logSignature(signatureRequest) {
+    const coverageId = __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_getLatestCoverageId).call(this, signatureRequest.id);
+    if (!coverageId) {
+        throw new Error('Coverage ID not found');
+    }
+    const sig = signatureRequest.rawSig;
+    if (!sig) {
+        throw new Error('Signature not found');
+    }
+    await __classPrivateFieldGet(this, _ShieldController_backend, "f").logSignature({
+        coverageId,
+        signature: sig,
+        // Status is 'shown' because the coverageId can only be retrieved after
+        // the result is in the state. If the result is in the state, we assume
+        // that it has been shown.
+        status: 'shown',
+    });
+}, _ShieldController_logTransaction = async function _ShieldController_logTransaction(txMeta) {
+    const coverageId = __classPrivateFieldGet(this, _ShieldController_instances, "m", _ShieldController_getLatestCoverageId).call(this, txMeta.id);
+    if (!coverageId) {
+        throw new Error('Coverage ID not found');
+    }
+    const txHash = txMeta.hash;
+    if (!txHash) {
+        throw new Error('Transaction hash not found');
+    }
+    await __classPrivateFieldGet(this, _ShieldController_backend, "f").logTransaction({
+        coverageId,
+        transactionHash: txHash,
+        // Status is 'shown' because the coverageId can only be retrieved after
+        // the result is in the state. If the result is in the state, we assume
+        // that it has been shown.
+        status: 'shown',
+    });
+}, _ShieldController_getLatestCoverageId = function _ShieldController_getLatestCoverageId(itemId) {
+    return this.state.coverageResults[itemId]?.results[0]?.coverageId;
 };
 //# sourceMappingURL=ShieldController.mjs.map

package/dist/ShieldController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ShieldController.mjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAU3D,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAC7C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,qBAAiB;AAG7D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AAkDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;IACD,yBAAyB,EAAE;QACzB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAUF,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IAYC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QA3BI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,4EAGC;QAoBR,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;IAC5D,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;IACJ,CAAC;IA4BD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,CAAC;QAE/D,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;CA8CF;mZA3FG,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,yEAAyE;QACzE,WAAW;QACX,IACE,CAAC,mBAAmB;YACpB,mEAAmE;YACnE,+CAA+C;YAC/C,mBAAmB,CAAC,cAAc,KAAK,WAAW,CAAC,cAAc,EACjE;YACA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,0CAwBD,KAAK,gDAAsB,MAAuB;IAChD,OAAO,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC,qFAEkB,IAAY,EAAE,cAA8B;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport type {\n  TransactionControllerStateChangeEvent,\n  TransactionMeta,\n} from '@metamask/transaction-controller';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type { CoverageResult, ShieldBackend } from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents = TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    persist: true,\n    anonymous: false,\n  },\n  orderedTransactionHistory: {\n    persist: true,\n    anonymous: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n  }\n\n  start() {\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n  }\n\n  stop() {\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (\n        !previousTransaction ||\n        // Checking reference equality is sufficient because this object is\n        // replaced if the simulation data has changed.\n        previousTransaction.simulationData !== transaction.simulationData\n      ) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageResult = await this.#fetchCoverageResult(txMeta);\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  async #fetchCoverageResult(txMeta: TransactionMeta): Promise<CoverageResult> {\n    return this.#backend.checkCoverage(txMeta);\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n}\n"]}
+{"version":3,"file":"ShieldController.mjs","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EAGrB,uCAAuC;AACxC,OAAO,EACL,iBAAiB,EAGlB,yCAAyC;AAE1C,OAAO,EAAE,cAAc,EAAE,wBAAoB;AAC7C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,qBAAiB;AAG7D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AAuBlE;;;;GAIG;AACH,MAAM,UAAU,+BAA+B;IAC7C,OAAO;QACL,eAAe,EAAE,EAAE;QACnB,yBAAyB,EAAE,EAAE;KAC9B,CAAC;AACJ,CAAC;AAoDD;;;GAGG;AACH,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE;QACf,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAUF,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IAiBC,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,OAAO,EACP,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,GAC1B,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAhCI,4CAAwB;QAExB,yDAA8B;QAE9B,4DAAiC;QAEjC,4EAGC;QAED,0EAGC;QAoBR,uBAAA,IAAI,6BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0CAAyB,oBAAoB,MAAA,CAAC;QAClD,uBAAA,IAAI,6CAA4B,uBAAuB,MAAA,CAAC;QACxD,uBAAA,IAAI,6DACF,uBAAA,IAAI,6FAAwC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;QAC1D,uBAAA,IAAI,2DACF,uBAAA,IAAI,2FAAsC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,CAAC;IAC1D,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,mCAAmC,EACnC,uBAAA,IAAI,iEAAyC,CAC9C,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,iCAAiC,EACjC,uBAAA,IAAI,+DAAuC,CAC5C,CAAC;IACJ,CAAC;IAgFD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAEjE,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,MAAM,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAEnD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,iBAAiB;QACjB,MAAM,cAAc,GAClB,MAAM,uBAAA,IAAI,iCAAS,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;QAE/D,0BAA0B;QAC1B,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,uBAAA,IAAI,wEAAmB,MAAvB,IAAI,EAAoB,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;CAuFF;wdAjNG,iBAAmD,EACnD,yBAAuE;IAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAC3C,8BAA8B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CACvE,CAAC;IACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE;QACrD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;QAEF,8DAA8D;QAC9D,mBAAmB;QACnB,IACE,CAAC,wBAAwB;YACzB,gBAAgB,CAAC,IAAI,KAAK,oBAAoB,CAAC,YAAY,EAC3D;YACA,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;YACjD,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,+DAA+D;QAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,sBAAsB,CAAC,MAAM;YACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D;YACA,uBAAA,IAAI,mEAAc,MAAlB,IAAI,EAAe,gBAAgB,CAAC,CAAC,KAAK;YACxC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;KACF;AACH,CAAC,+HAGC,YAA+B,EAC/B,oBAAmD;IAEnD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CACtC,oBAAoB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEzE,yEAAyE;QACzE,WAAW;QACX,IACE,CAAC,mBAAmB;YACpB,mEAAmE;YACnE,+CAA+C;YAC/C,mBAAmB,CAAC,cAAc,KAAK,WAAW,CAAC,cAAc,EACjE;YACA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;YACnC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;SACH;QAED,8CAA8C;QAC9C,IACE,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,SAAS;YAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD;YACA,uBAAA,IAAI,qEAAgB,MAApB,IAAI,EAAiB,WAAW,CAAC,CAAC,KAAK;YACrC,uBAAuB;YACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;SACH;KACF;AACH,CAAC,qFAiDkB,IAAY,EAAE,cAA8B;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,+BAA+B;QAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAEtD,iCAAiC;QACjC,IAAI,CAAC,mBAAmB,EAAE;YACxB,QAAQ,GAAG,IAAI,CAAC;YAChB,mBAAmB,GAAG;gBACpB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;SACnD;QAED,sCAAsC;QACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,8CAAsB,EAAE;YACpE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,kBAAkB;QAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEpD,+BAA+B;QAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;QAC5C,IAAI,WAA+B,CAAC;QACpC,IAAI,QAAQ,EAAE;YACZ,yCAAyC;YACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,uBAAA,IAAI,iDAAyB,EAAE;gBACrE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;gBAC9C,8CAA8C;gBAC9C,IAAI,WAAW,EAAE;oBACf,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;iBAC3C;aACF;YACD,kBAAkB;YAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,mCAED,KAAK,yCAAe,gBAAkC;IACpD,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAClE,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,GAAG,GAAG,gBAAgB,CAAC,MAAM,CAAC;IACpC,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,MAAM,uBAAA,IAAI,iCAAS,CAAC,YAAY,CAAC;QAC/B,UAAU;QACV,SAAS,EAAE,GAAG;QACd,uEAAuE;QACvE,uEAAuE;QACvE,0BAA0B;QAC1B,MAAM,EAAE,OAAO;KAChB,CAAC,CAAC;AACL,CAAC,qCAED,KAAK,2CAAiB,MAAuB;IAC3C,MAAM,UAAU,GAAG,uBAAA,IAAI,0EAAqB,MAAzB,IAAI,EAAsB,MAAM,CAAC,EAAE,CAAC,CAAC;IACxD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;IAC3B,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IACD,MAAM,uBAAA,IAAI,iCAAS,CAAC,cAAc,CAAC;QACjC,UAAU;QACV,eAAe,EAAE,MAAM;QACvB,uEAAuE;QACvE,uEAAuE;QACvE,0BAA0B;QAC1B,MAAM,EAAE,OAAO;KAChB,CAAC,CAAC;AACL,CAAC,yFAEoB,MAAc;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AACpE,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedMessenger,\n} from '@metamask/base-controller';\nimport {\n  SignatureRequestStatus,\n  SignatureRequestType,\n  type SignatureRequest,\n  type SignatureStateChange,\n} from '@metamask/signature-controller';\nimport {\n  TransactionStatus,\n  type TransactionControllerStateChangeEvent,\n  type TransactionMeta,\n} from '@metamask/transaction-controller';\n\nimport { controllerName } from './constants';\nimport { projectLogger, createModuleLogger } from './logger';\nimport type { CoverageResult, ShieldBackend } from './types';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nexport type CoverageResultRecordEntry = {\n  /**\n   * History of coverage results, latest first.\n   */\n  results: CoverageResult[];\n};\n\nexport type ShieldControllerState = {\n  /**\n   * Coverage results by transaction ID.\n   */\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  /**\n   * List of txIds ordered by time, latest first.\n   */\n  orderedTransactionHistory: string[];\n};\n\n/**\n * Get the default state for the ShieldController.\n *\n * @returns The default state for the ShieldController.\n */\nexport function getDefaultShieldControllerState(): ShieldControllerState {\n  return {\n    coverageResults: {},\n    orderedTransactionHistory: [],\n  };\n}\n\nexport type ShieldControllerCheckCoverageAction = {\n  type: `${typeof controllerName}:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\n};\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions = ShieldControllerCheckCoverageAction;\n\nexport type ShieldControllerCoverageResultReceivedEvent = {\n  type: `${typeof controllerName}:coverageResultReceived`;\n  payload: [coverageResult: CoverageResult];\n};\n\nexport type ShieldControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal events available to the ShieldController.\n */\nexport type ShieldControllerEvents =\n  | ShieldControllerCoverageResultReceivedEvent\n  | ShieldControllerStateChangeEvent;\n\n/**\n * The external actions available to the ShieldController.\n */\ntype AllowedActions = never;\n\n/**\n * The external events available to the ShieldController.\n */\ntype AllowedEvents =\n  | SignatureStateChange\n  | TransactionControllerStateChangeEvent;\n\n/**\n * The messenger of the {@link ShieldController}.\n */\nexport type ShieldControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Metadata for the ShieldController state, describing how to \"anonymize\"\n * the state and which parts should be persisted.\n */\nconst metadata = {\n  coverageResults: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    anonymous: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  backend: ShieldBackend;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #backend: ShieldBackend;\n\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #transactionControllerStateChangeHandler: (\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) => void;\n\n  readonly #signatureControllerStateChangeHandler: (\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) => void;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      backend,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\n    this.#backend = backend;\n    this.#coverageHistoryLimit = coverageHistoryLimit;\n    this.#transactionHistoryLimit = transactionHistoryLimit;\n    this.#transactionControllerStateChangeHandler =\n      this.#handleTransactionControllerStateChange.bind(this);\n    this.#signatureControllerStateChangeHandler =\n      this.#handleSignatureControllerStateChange.bind(this);\n  }\n\n  start() {\n    this.messagingSystem.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messagingSystem.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  stop() {\n    this.messagingSystem.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ) {\n    const signatureRequestsArray = Object.values(signatureRequests);\n    const previousSignatureRequestsArray = Object.values(\n      previousSignatureRequests ?? {},\n    );\n    const previousSignatureRequestsById = new Map<string, SignatureRequest>(\n      previousSignatureRequestsArray.map((request) => [request.id, request]),\n    );\n    for (const signatureRequest of signatureRequestsArray) {\n      const previousSignatureRequest = previousSignatureRequestsById.get(\n        signatureRequest.id,\n      );\n\n      // Check coverage if the signature request is new and has type\n      // `personal_sign`.\n      if (\n        !previousSignatureRequest &&\n        signatureRequest.type === SignatureRequestType.PersonalSign\n      ) {\n        this.checkSignatureCoverage(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log signature once the signature request has been fulfilled.\n      if (\n        signatureRequest.status === SignatureRequestStatus.Signed &&\n        signatureRequest.status !== previousSignatureRequest?.status\n      ) {\n        this.#logSignature(signatureRequest).catch(\n          // istanbul ignore next\n          (error) => log('Error logging signature:', error),\n        );\n      }\n    }\n  }\n\n  #handleTransactionControllerStateChange(\n    transactions: TransactionMeta[],\n    previousTransactions: TransactionMeta[] | undefined,\n  ) {\n    const previousTransactionsById = new Map<string, TransactionMeta>(\n      previousTransactions?.map((tx) => [tx.id, tx]) ?? [],\n    );\n    for (const transaction of transactions) {\n      const previousTransaction = previousTransactionsById.get(transaction.id);\n\n      // Check coverage if the transaction is new or if the simulation data has\n      // changed.\n      if (\n        !previousTransaction ||\n        // Checking reference equality is sufficient because this object is\n        // replaced if the simulation data has changed.\n        previousTransaction.simulationData !== transaction.simulationData\n      ) {\n        this.checkCoverage(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error checking coverage:', error),\n        );\n      }\n\n      // Log transaction once it has been submitted.\n      if (\n        transaction.status === TransactionStatus.submitted &&\n        transaction.status !== previousTransaction?.status\n      ) {\n        this.#logTransaction(transaction).catch(\n          // istanbul ignore next\n          (error) => log('Error logging transaction:', error),\n        );\n      }\n    }\n  }\n\n  /**\n   * Checks the coverage of a transaction.\n   *\n   * @param txMeta - The transaction to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    // Check coverage\n    const coverageResult = await this.#backend.checkCoverage(txMeta);\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(txMeta.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  /**\n   * Checks the coverage of a signature request.\n   *\n   * @param signatureRequest - The signature request to check coverage for.\n   * @returns The coverage result.\n   */\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    // Check coverage\n    const coverageResult =\n      await this.#backend.checkSignatureCoverage(signatureRequest);\n\n    // Publish coverage result\n    this.messagingSystem.publish(\n      `${controllerName}:coverageResultReceived`,\n      coverageResult,\n    );\n\n    // Update state\n    this.#addCoverageResult(signatureRequest.id, coverageResult);\n\n    return coverageResult;\n  }\n\n  #addCoverageResult(txId: string, coverageResult: CoverageResult) {\n    this.update((draft) => {\n      // Fetch coverage result entry.\n      let newEntry = false;\n      let coverageResultEntry = draft.coverageResults[txId];\n\n      // Create new entry if necessary.\n      if (!coverageResultEntry) {\n        newEntry = true;\n        coverageResultEntry = {\n          results: [],\n        };\n        draft.coverageResults[txId] = coverageResultEntry;\n      }\n\n      // Trim coverage history if necessary.\n      if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {\n        coverageResultEntry.results.pop();\n      }\n\n      // Add new result.\n      coverageResultEntry.results.unshift(coverageResult);\n\n      // Add to history if new entry.\n      const { orderedTransactionHistory } = draft;\n      let removedTxId: string | undefined;\n      if (newEntry) {\n        // Trim transaction history if necessary.\n        if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {\n          removedTxId = orderedTransactionHistory.pop();\n          // Delete corresponding coverage result entry.\n          if (removedTxId) {\n            delete draft.coverageResults[removedTxId];\n          }\n        }\n        // Add to history.\n        orderedTransactionHistory.unshift(txId);\n      }\n    });\n  }\n\n  async #logSignature(signatureRequest: SignatureRequest) {\n    const coverageId = this.#getLatestCoverageId(signatureRequest.id);\n    if (!coverageId) {\n      throw new Error('Coverage ID not found');\n    }\n\n    const sig = signatureRequest.rawSig;\n    if (!sig) {\n      throw new Error('Signature not found');\n    }\n\n    await this.#backend.logSignature({\n      coverageId,\n      signature: sig,\n      // Status is 'shown' because the coverageId can only be retrieved after\n      // the result is in the state. If the result is in the state, we assume\n      // that it has been shown.\n      status: 'shown',\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta) {\n    const coverageId = this.#getLatestCoverageId(txMeta.id);\n    if (!coverageId) {\n      throw new Error('Coverage ID not found');\n    }\n\n    const txHash = txMeta.hash;\n    if (!txHash) {\n      throw new Error('Transaction hash not found');\n    }\n    await this.#backend.logTransaction({\n      coverageId,\n      transactionHash: txHash,\n      // Status is 'shown' because the coverageId can only be retrieved after\n      // the result is in the state. If the result is in the state, we assume\n      // that it has been shown.\n      status: 'shown',\n    });\n  }\n\n  #getLatestCoverageId(itemId: string) {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}

package/dist/backend.cjs

@@ -12,45 +12,80 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _ShieldRemoteBackend_instances, _ShieldRemoteBackend_getAccessToken, _ShieldRemoteBackend_getCoverageResultTimeout, _ShieldRemoteBackend_getCoverageResultPollInterval, _ShieldRemoteBackend_baseUrl, _ShieldRemoteBackend_fetch, _ShieldRemoteBackend_initCoverageCheck, _ShieldRemoteBackend_getCoverageResult, _ShieldRemoteBackend_createHeaders;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShieldRemoteBackend = exports.BASE_URL = void 0;
-exports.BASE_URL = 'https://rule-engine.metamask.io';
+exports.ShieldRemoteBackend = void 0;
 class ShieldRemoteBackend {
     constructor({ getAccessToken, getCoverageResultTimeout = 5000, // milliseconds
     getCoverageResultPollInterval = 1000, // milliseconds
-    baseUrl = exports.BASE_URL, fetch: fetchFn, }) {
+    baseUrl, fetch: fetchFn, }) {
         _ShieldRemoteBackend_instances.add(this);
         _ShieldRemoteBackend_getAccessToken.set(this, void 0);
         _ShieldRemoteBackend_getCoverageResultTimeout.set(this, void 0);
         _ShieldRemoteBackend_getCoverageResultPollInterval.set(this, void 0);
         _ShieldRemoteBackend_baseUrl.set(this, void 0);
         _ShieldRemoteBackend_fetch.set(this, void 0);
-        this.checkCoverage = async (txMeta) => {
-            const reqBody = {
-                txParams: [
-                    {
-                        from: txMeta.txParams.from,
-                        to: txMeta.txParams.to,
-                        value: txMeta.txParams.value,
-                        data: txMeta.txParams.data,
-                        nonce: txMeta.txParams.nonce,
-                    },
-                ],
-                chainId: txMeta.chainId,
-                origin: txMeta.origin,
-            };
-            const { coverageId } = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_initCoverageCheck).call(this, reqBody);
-            return __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_getCoverageResult).call(this, coverageId);
-        };
         __classPrivateFieldSet(this, _ShieldRemoteBackend_getAccessToken, getAccessToken, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_getCoverageResultTimeout, getCoverageResultTimeout, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_getCoverageResultPollInterval, getCoverageResultPollInterval, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_baseUrl, baseUrl, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_fetch, fetchFn, "f");
     }
+    async checkCoverage(txMeta) {
+        const reqBody = {
+            txParams: [
+                {
+                    from: txMeta.txParams.from,
+                    to: txMeta.txParams.to,
+                    value: txMeta.txParams.value,
+                    data: txMeta.txParams.data,
+                    nonce: txMeta.txParams.nonce,
+                },
+            ],
+            chainId: txMeta.chainId,
+            origin: txMeta.origin,
+        };
+        const { coverageId } = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_initCoverageCheck).call(this, 'v1/transaction/coverage/init', reqBody);
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_getCoverageResult).call(this, coverageId);
+        return { coverageId, status: coverageResult.status };
+    }
+    async checkSignatureCoverage(signatureRequest) {
+        if (typeof signatureRequest.messageParams.data !== 'string') {
+            throw new Error('Signature data must be a string');
+        }
+        const reqBody = {
+            chainId: signatureRequest.chainId,
+            data: signatureRequest.messageParams.data,
+            from: signatureRequest.messageParams.from,
+            method: signatureRequest.type,
+            origin: signatureRequest.messageParams.origin,
+        };
+        const { coverageId } = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_initCoverageCheck).call(this, 'v1/signature/coverage/init', reqBody);
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_getCoverageResult).call(this, coverageId);
+        return { coverageId, status: coverageResult.status };
+    }
+    async logSignature(req) {
+        const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/v1/signature/coverage/log`, {
+            method: 'POST',
+            headers: await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_createHeaders).call(this),
+            body: JSON.stringify(req),
+        });
+        if (res.status !== 200) {
+            throw new Error(`Failed to log signature: ${res.status}`);
+        }
+    }
+    async logTransaction(req) {
+        const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/v1/transaction/coverage/log`, {
+            method: 'POST',
+            headers: await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_createHeaders).call(this),
+            body: JSON.stringify(req),
+        });
+        if (res.status !== 200) {
+            throw new Error(`Failed to log transaction: ${res.status}`);
+        }
+    }
 }
 exports.ShieldRemoteBackend = ShieldRemoteBackend;
-_ShieldRemoteBackend_getAccessToken = new WeakMap(), _ShieldRemoteBackend_getCoverageResultTimeout = new WeakMap(), _ShieldRemoteBackend_getCoverageResultPollInterval = new WeakMap(), _ShieldRemoteBackend_baseUrl = new WeakMap(), _ShieldRemoteBackend_fetch = new WeakMap(), _ShieldRemoteBackend_instances = new WeakSet(), _ShieldRemoteBackend_initCoverageCheck = async function _ShieldRemoteBackend_initCoverageCheck(reqBody) {
-    const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/api/v1/coverage/init`, {
+_ShieldRemoteBackend_getAccessToken = new WeakMap(), _ShieldRemoteBackend_getCoverageResultTimeout = new WeakMap(), _ShieldRemoteBackend_getCoverageResultPollInterval = new WeakMap(), _ShieldRemoteBackend_baseUrl = new WeakMap(), _ShieldRemoteBackend_fetch = new WeakMap(), _ShieldRemoteBackend_instances = new WeakSet(), _ShieldRemoteBackend_initCoverageCheck = async function _ShieldRemoteBackend_initCoverageCheck(path, reqBody) {
+    const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/${path}`, {
         method: 'POST',
         headers: await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_createHeaders).call(this),
         body: JSON.stringify(reqBody),
@@ -75,7 +110,7 @@ _ShieldRemoteBackend_getAccessToken = new WeakMap(), _ShieldRemoteBackend_getCov
             // eslint-disable-next-line no-unmodified-loop-condition
             while (!timeoutReached) {
                 const startTime = Date.now();
-                const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/api/v1/coverage/result`, {
+                const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/v1/transaction/coverage/result`, {
                     method: 'POST',
                     headers,
                     body: JSON.stringify(reqBody),

package/dist/backend.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"backend.cjs","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIa,QAAA,QAAQ,GAAG,iCAAiC,CAAC;AA4B1D,MAAa,mBAAmB;IAW9B,YAAY,EACV,cAAc,EACd,wBAAwB,GAAG,IAAI,EAAE,eAAe;IAChD,6BAA6B,GAAG,IAAI,EAAE,eAAe;IACrD,OAAO,GAAG,gBAAQ,EAClB,KAAK,EAAE,OAAO,GAOf;;QAtBQ,sDAAuC;QAEvC,gEAAkC;QAElC,qEAAuC;QAEvC,+CAAiB;QAEjB,6CAAgC;QAsBzC,kBAAa,GAAyD,KAAK,EACzE,MAAM,EACN,EAAE;YACF,MAAM,OAAO,GAA6B;gBACxC,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;wBAC1B,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;wBACtB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;wBAC5B,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;wBAC1B,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;qBAC7B;iBACF;gBACD,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC;YAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC;YAE9D,OAAO,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAC;QA3BA,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,iDAA6B,wBAAwB,MAAA,CAAC;QAC1D,uBAAA,IAAI,sDAAkC,6BAA6B,MAAA,CAAC;QACpE,uBAAA,IAAI,gCAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,8BAAU,OAAO,MAAA,CAAC;IACxB,CAAC;CAyFF;AAtHD,kDAsHC;2WAjEC,KAAK,iDACH,OAAiC;IAEjC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EAAQ,GAAG,uBAAA,IAAI,oCAAS,uBAAuB,EAAE;QACrE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;QACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;KACjE;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;AACzD,CAAC,2CAED,KAAK,iDACH,UAAkB,EAClB,UAAkB,uBAAA,IAAI,qDAA0B,EAChD,eAAuB,uBAAA,IAAI,0DAA+B;IAE1D,MAAM,OAAO,GAA6B;QACxC,UAAU;KACX,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB,CAAC;IAC5C,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC;QAC3D,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,IAAI,GAAG,KAAK,IAAwC,EAAE;YAC1D,mEAAmE;YACnE,wDAAwD;YACxD,OAAO,CAAC,cAAc,EAAE;gBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,yBAAyB,EACzC;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO;oBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;iBAC9B,CACF,CAAC;gBACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;oBACtB,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;iBACxD;gBACD,MAAM,KAAK,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;aACtD;YACD,wEAAwE;YACxE,mCAAmC;YACnC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,uCAED,KAAK;IACH,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,2CAAgB,MAApB,IAAI,CAAkB,CAAC;IACjD,OAAO;QACL,cAAc,EAAE,kBAAkB;QAClC,aAAa,EAAE,UAAU,WAAW,EAAE;KACvC,CAAC;AACJ,CAAC;AAGH;;;;;GAKG;AACH,KAAK,UAAU,KAAK,CAAC,EAAU;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\n\nimport type { CoverageResult, CoverageStatus, ShieldBackend } from './types';\n\nexport const BASE_URL = 'https://rule-engine.metamask.io';\n\nexport type InitCoverageCheckRequest = {\n  txParams: [\n    {\n      from: string;\n      to?: string;\n      value?: string;\n      data?: string;\n      nonce?: string;\n    },\n  ];\n  chainId: string;\n  origin?: string;\n};\n\nexport type InitCoverageCheckResponse = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultRequest = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultResponse = {\n  status: CoverageStatus;\n};\n\nexport class ShieldRemoteBackend implements ShieldBackend {\n  readonly #getAccessToken: () => Promise<string>;\n\n  readonly #getCoverageResultTimeout: number;\n\n  readonly #getCoverageResultPollInterval: number;\n\n  readonly #baseUrl: string;\n\n  readonly #fetch: typeof globalThis.fetch;\n\n  constructor({\n    getAccessToken,\n    getCoverageResultTimeout = 5000, // milliseconds\n    getCoverageResultPollInterval = 1000, // milliseconds\n    baseUrl = BASE_URL,\n    fetch: fetchFn,\n  }: {\n    getAccessToken: () => Promise<string>;\n    getCoverageResultTimeout?: number;\n    getCoverageResultPollInterval?: number;\n    baseUrl?: string;\n    fetch: typeof globalThis.fetch;\n  }) {\n    this.#getAccessToken = getAccessToken;\n    this.#getCoverageResultTimeout = getCoverageResultTimeout;\n    this.#getCoverageResultPollInterval = getCoverageResultPollInterval;\n    this.#baseUrl = baseUrl;\n    this.#fetch = fetchFn;\n  }\n\n  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult> = async (\n    txMeta,\n  ) => {\n    const reqBody: InitCoverageCheckRequest = {\n      txParams: [\n        {\n          from: txMeta.txParams.from,\n          to: txMeta.txParams.to,\n          value: txMeta.txParams.value,\n          data: txMeta.txParams.data,\n          nonce: txMeta.txParams.nonce,\n        },\n      ],\n      chainId: txMeta.chainId,\n      origin: txMeta.origin,\n    };\n\n    const { coverageId } = await this.#initCoverageCheck(reqBody);\n\n    return this.#getCoverageResult(coverageId);\n  };\n\n  async #initCoverageCheck(\n    reqBody: InitCoverageCheckRequest,\n  ): Promise<InitCoverageCheckResponse> {\n    const res = await this.#fetch(`${this.#baseUrl}/api/v1/coverage/init`, {\n      method: 'POST',\n      headers: await this.#createHeaders(),\n      body: JSON.stringify(reqBody),\n    });\n    if (res.status !== 200) {\n      throw new Error(`Failed to init coverage check: ${res.status}`);\n    }\n    return (await res.json()) as InitCoverageCheckResponse;\n  }\n\n  async #getCoverageResult(\n    coverageId: string,\n    timeout: number = this.#getCoverageResultTimeout,\n    pollInterval: number = this.#getCoverageResultPollInterval,\n  ): Promise<GetCoverageResultResponse> {\n    const reqBody: GetCoverageResultRequest = {\n      coverageId,\n    };\n\n    const headers = await this.#createHeaders();\n    return await new Promise((resolve, reject) => {\n      let timeoutReached = false;\n      setTimeout(() => {\n        timeoutReached = true;\n        reject(new Error('Timeout waiting for coverage result'));\n      }, timeout);\n\n      const poll = async (): Promise<GetCoverageResultResponse> => {\n        // The timeoutReached variable is modified in the timeout callback.\n        // eslint-disable-next-line no-unmodified-loop-condition\n        while (!timeoutReached) {\n          const startTime = Date.now();\n          const res = await this.#fetch(\n            `${this.#baseUrl}/api/v1/coverage/result`,\n            {\n              method: 'POST',\n              headers,\n              body: JSON.stringify(reqBody),\n            },\n          );\n          if (res.status === 200) {\n            return (await res.json()) as GetCoverageResultResponse;\n          }\n          await sleep(pollInterval - (Date.now() - startTime));\n        }\n        // The following line will not have an effect as the upper level promise\n        // will already be rejected by now.\n        throw new Error('unexpected error');\n      };\n\n      poll().then(resolve).catch(reject);\n    });\n  }\n\n  async #createHeaders() {\n    const accessToken = await this.#getAccessToken();\n    return {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${accessToken}`,\n    };\n  }\n}\n\n/**\n * Sleep for a specified amount of time.\n *\n * @param ms - The number of milliseconds to sleep.\n * @returns A promise that resolves after the specified amount of time.\n */\nasync function sleep(ms: number) {\n  return new Promise((resolve) => setTimeout(resolve, ms));\n}\n"]}
+{"version":3,"file":"backend.cjs","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AA6CA,MAAa,mBAAmB;IAW9B,YAAY,EACV,cAAc,EACd,wBAAwB,GAAG,IAAI,EAAE,eAAe;IAChD,6BAA6B,GAAG,IAAI,EAAE,eAAe;IACrD,OAAO,EACP,KAAK,EAAE,OAAO,GAOf;;QAtBQ,sDAAuC;QAEvC,gEAAkC;QAElC,qEAAuC;QAEvC,+CAAiB;QAEjB,6CAAgC;QAevC,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,iDAA6B,wBAAwB,MAAA,CAAC;QAC1D,uBAAA,IAAI,sDAAkC,6BAA6B,MAAA,CAAC;QACpE,uBAAA,IAAI,gCAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,8BAAU,OAAO,MAAA,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,MAAM,OAAO,GAA6B;YACxC,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;oBAC1B,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;oBACtB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;oBAC5B,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;oBAC1B,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;iBAC7B;aACF;YACD,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;QAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAC/B,8BAA8B,EAC9B,OAAO,CACR,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,UAAU,CAAC,CAAC;QACjE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,IAAI,OAAO,gBAAgB,CAAC,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;QAED,MAAM,OAAO,GAAsC;YACjD,OAAO,EAAE,gBAAgB,CAAC,OAAO;YACjC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,IAAI;YACzC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,IAAI;YACzC,MAAM,EAAE,gBAAgB,CAAC,IAAI;YAC7B,MAAM,EAAE,gBAAgB,CAAC,aAAa,CAAC,MAAM;SAC9C,CAAC;QAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAC/B,4BAA4B,EAC5B,OAAO,CACR,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,UAAU,CAAC,CAAC;QACjE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,GAAwB;QACzC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,4BAA4B,EAC5C;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;YACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC1B,CACF,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;SAC3D;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,GAA0B;QAC7C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,8BAA8B,EAC9C;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;YACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC1B,CACF,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;SAC7D;IACH,CAAC;CAoEF;AA7KD,kDA6KC;2WAlEC,KAAK,iDACH,IAAY,EACZ,OAAgB;IAEhB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EAAQ,GAAG,uBAAA,IAAI,oCAAS,IAAI,IAAI,EAAE,EAAE;QACxD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;QACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;KACjE;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;AACzD,CAAC,2CAED,KAAK,iDACH,UAAkB,EAClB,UAAkB,uBAAA,IAAI,qDAA0B,EAChD,eAAuB,uBAAA,IAAI,0DAA+B;IAE1D,MAAM,OAAO,GAA6B;QACxC,UAAU;KACX,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB,CAAC;IAC5C,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC;QAC3D,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,IAAI,GAAG,KAAK,IAAwC,EAAE;YAC1D,mEAAmE;YACnE,wDAAwD;YACxD,OAAO,CAAC,cAAc,EAAE;gBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,iCAAiC,EACjD;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO;oBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;iBAC9B,CACF,CAAC;gBACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;oBACtB,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;iBACxD;gBACD,MAAM,KAAK,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;aACtD;YACD,wEAAwE;YACxE,mCAAmC;YACnC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,uCAED,KAAK;IACH,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,2CAAgB,MAApB,IAAI,CAAkB,CAAC;IACjD,OAAO;QACL,cAAc,EAAE,kBAAkB;QAClC,aAAa,EAAE,UAAU,WAAW,EAAE;KACvC,CAAC;AACJ,CAAC;AAGH;;;;;GAKG;AACH,KAAK,UAAU,KAAK,CAAC,EAAU;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import type { SignatureRequest } from '@metamask/signature-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\n\nimport type {\n  CoverageResult,\n  CoverageStatus,\n  LogSignatureRequest,\n  LogTransactionRequest,\n  ShieldBackend,\n} from './types';\n\nexport type InitCoverageCheckRequest = {\n  txParams: [\n    {\n      from: string;\n      to?: string;\n      value?: string;\n      data?: string;\n      nonce?: string;\n    },\n  ];\n  chainId: string;\n  origin?: string;\n};\n\nexport type InitSignatureCoverageCheckRequest = {\n  chainId: string;\n  data: string;\n  from: string;\n  method: string;\n  origin?: string;\n};\n\nexport type InitCoverageCheckResponse = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultRequest = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultResponse = {\n  status: CoverageStatus;\n};\n\nexport class ShieldRemoteBackend implements ShieldBackend {\n  readonly #getAccessToken: () => Promise<string>;\n\n  readonly #getCoverageResultTimeout: number;\n\n  readonly #getCoverageResultPollInterval: number;\n\n  readonly #baseUrl: string;\n\n  readonly #fetch: typeof globalThis.fetch;\n\n  constructor({\n    getAccessToken,\n    getCoverageResultTimeout = 5000, // milliseconds\n    getCoverageResultPollInterval = 1000, // milliseconds\n    baseUrl,\n    fetch: fetchFn,\n  }: {\n    getAccessToken: () => Promise<string>;\n    getCoverageResultTimeout?: number;\n    getCoverageResultPollInterval?: number;\n    baseUrl: string;\n    fetch: typeof globalThis.fetch;\n  }) {\n    this.#getAccessToken = getAccessToken;\n    this.#getCoverageResultTimeout = getCoverageResultTimeout;\n    this.#getCoverageResultPollInterval = getCoverageResultPollInterval;\n    this.#baseUrl = baseUrl;\n    this.#fetch = fetchFn;\n  }\n\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    const reqBody: InitCoverageCheckRequest = {\n      txParams: [\n        {\n          from: txMeta.txParams.from,\n          to: txMeta.txParams.to,\n          value: txMeta.txParams.value,\n          data: txMeta.txParams.data,\n          nonce: txMeta.txParams.nonce,\n        },\n      ],\n      chainId: txMeta.chainId,\n      origin: txMeta.origin,\n    };\n\n    const { coverageId } = await this.#initCoverageCheck(\n      'v1/transaction/coverage/init',\n      reqBody,\n    );\n\n    const coverageResult = await this.#getCoverageResult(coverageId);\n    return { coverageId, status: coverageResult.status };\n  }\n\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    if (typeof signatureRequest.messageParams.data !== 'string') {\n      throw new Error('Signature data must be a string');\n    }\n\n    const reqBody: InitSignatureCoverageCheckRequest = {\n      chainId: signatureRequest.chainId,\n      data: signatureRequest.messageParams.data,\n      from: signatureRequest.messageParams.from,\n      method: signatureRequest.type,\n      origin: signatureRequest.messageParams.origin,\n    };\n\n    const { coverageId } = await this.#initCoverageCheck(\n      'v1/signature/coverage/init',\n      reqBody,\n    );\n\n    const coverageResult = await this.#getCoverageResult(coverageId);\n    return { coverageId, status: coverageResult.status };\n  }\n\n  async logSignature(req: LogSignatureRequest): Promise<void> {\n    const res = await this.#fetch(\n      `${this.#baseUrl}/v1/signature/coverage/log`,\n      {\n        method: 'POST',\n        headers: await this.#createHeaders(),\n        body: JSON.stringify(req),\n      },\n    );\n    if (res.status !== 200) {\n      throw new Error(`Failed to log signature: ${res.status}`);\n    }\n  }\n\n  async logTransaction(req: LogTransactionRequest): Promise<void> {\n    const res = await this.#fetch(\n      `${this.#baseUrl}/v1/transaction/coverage/log`,\n      {\n        method: 'POST',\n        headers: await this.#createHeaders(),\n        body: JSON.stringify(req),\n      },\n    );\n    if (res.status !== 200) {\n      throw new Error(`Failed to log transaction: ${res.status}`);\n    }\n  }\n\n  async #initCoverageCheck(\n    path: string,\n    reqBody: unknown,\n  ): Promise<InitCoverageCheckResponse> {\n    const res = await this.#fetch(`${this.#baseUrl}/${path}`, {\n      method: 'POST',\n      headers: await this.#createHeaders(),\n      body: JSON.stringify(reqBody),\n    });\n    if (res.status !== 200) {\n      throw new Error(`Failed to init coverage check: ${res.status}`);\n    }\n    return (await res.json()) as InitCoverageCheckResponse;\n  }\n\n  async #getCoverageResult(\n    coverageId: string,\n    timeout: number = this.#getCoverageResultTimeout,\n    pollInterval: number = this.#getCoverageResultPollInterval,\n  ): Promise<GetCoverageResultResponse> {\n    const reqBody: GetCoverageResultRequest = {\n      coverageId,\n    };\n\n    const headers = await this.#createHeaders();\n    return await new Promise((resolve, reject) => {\n      let timeoutReached = false;\n      setTimeout(() => {\n        timeoutReached = true;\n        reject(new Error('Timeout waiting for coverage result'));\n      }, timeout);\n\n      const poll = async (): Promise<GetCoverageResultResponse> => {\n        // The timeoutReached variable is modified in the timeout callback.\n        // eslint-disable-next-line no-unmodified-loop-condition\n        while (!timeoutReached) {\n          const startTime = Date.now();\n          const res = await this.#fetch(\n            `${this.#baseUrl}/v1/transaction/coverage/result`,\n            {\n              method: 'POST',\n              headers,\n              body: JSON.stringify(reqBody),\n            },\n          );\n          if (res.status === 200) {\n            return (await res.json()) as GetCoverageResultResponse;\n          }\n          await sleep(pollInterval - (Date.now() - startTime));\n        }\n        // The following line will not have an effect as the upper level promise\n        // will already be rejected by now.\n        throw new Error('unexpected error');\n      };\n\n      poll().then(resolve).catch(reject);\n    });\n  }\n\n  async #createHeaders() {\n    const accessToken = await this.#getAccessToken();\n    return {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${accessToken}`,\n    };\n  }\n}\n\n/**\n * Sleep for a specified amount of time.\n *\n * @param ms - The number of milliseconds to sleep.\n * @returns A promise that resolves after the specified amount of time.\n */\nasync function sleep(ms: number) {\n  return new Promise((resolve) => setTimeout(resolve, ms));\n}\n"]}

package/dist/backend.d.cts

@@ -1,6 +1,6 @@
+import type { SignatureRequest } from "@metamask/signature-controller";
 import type { TransactionMeta } from "@metamask/transaction-controller";
-import type { CoverageResult, CoverageStatus, ShieldBackend } from "./types.cjs";
-export declare const BASE_URL = "https://rule-engine.metamask.io";
+import type { CoverageResult, CoverageStatus, LogSignatureRequest, LogTransactionRequest, ShieldBackend } from "./types.cjs";
 export type InitCoverageCheckRequest = {
     txParams: [
         {
@@ -14,6 +14,13 @@ export type InitCoverageCheckRequest = {
     chainId: string;
     origin?: string;
 };
+export type InitSignatureCoverageCheckRequest = {
+    chainId: string;
+    data: string;
+    from: string;
+    method: string;
+    origin?: string;
+};
 export type InitCoverageCheckResponse = {
     coverageId: string;
 };
@@ -31,9 +38,12 @@ export declare class ShieldRemoteBackend implements ShieldBackend {
         getAccessToken: () => Promise<string>;
         getCoverageResultTimeout?: number;
         getCoverageResultPollInterval?: number;
-        baseUrl?: string;
+        baseUrl: string;
         fetch: typeof globalThis.fetch;
     });
-    checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;
+    checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult>;
+    checkSignatureCoverage(signatureRequest: SignatureRequest): Promise<CoverageResult>;
+    logSignature(req: LogSignatureRequest): Promise<void>;
+    logTransaction(req: LogTransactionRequest): Promise<void>;
 }
 //# sourceMappingURL=backend.d.cts.map

package/dist/backend.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"backend.d.cts","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAE7E,eAAO,MAAM,QAAQ,oCAAoC,CAAC;AAE1D,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM,CAAC;YACb,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,qBAAa,mBAAoB,YAAW,aAAa;;gBAW3C,EACV,cAAc,EACd,wBAA+B,EAAE,eAAe;IAChD,6BAAoC,EAAE,eAAe;IACrD,OAAkB,EAClB,KAAK,EAAE,OAAO,GACf,EAAE;QACD,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,6BAA6B,CAAC,EAAE,MAAM,CAAC;QACvC,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;KAChC;IAQD,aAAa,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,cAAc,CAAC,CAoBjE;CAmEH"}
+{"version":3,"file":"backend.d.cts","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,uCAAuC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,aAAa,EACd,oBAAgB;AAEjB,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM,CAAC;YACb,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,qBAAa,mBAAoB,YAAW,aAAa;;gBAW3C,EACV,cAAc,EACd,wBAA+B,EAAE,eAAe;IAChD,6BAAoC,EAAE,eAAe;IACrD,OAAO,EACP,KAAK,EAAE,OAAO,GACf,EAAE;QACD,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,6BAA6B,CAAC,EAAE,MAAM,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;KAChC;IAQK,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAwB/D,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;IAsBpB,YAAY,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrD,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAgFhE"}

package/dist/backend.d.mts

@@ -1,6 +1,6 @@
+import type { SignatureRequest } from "@metamask/signature-controller";
 import type { TransactionMeta } from "@metamask/transaction-controller";
-import type { CoverageResult, CoverageStatus, ShieldBackend } from "./types.mjs";
-export declare const BASE_URL = "https://rule-engine.metamask.io";
+import type { CoverageResult, CoverageStatus, LogSignatureRequest, LogTransactionRequest, ShieldBackend } from "./types.mjs";
 export type InitCoverageCheckRequest = {
     txParams: [
         {
@@ -14,6 +14,13 @@ export type InitCoverageCheckRequest = {
     chainId: string;
     origin?: string;
 };
+export type InitSignatureCoverageCheckRequest = {
+    chainId: string;
+    data: string;
+    from: string;
+    method: string;
+    origin?: string;
+};
 export type InitCoverageCheckResponse = {
     coverageId: string;
 };
@@ -31,9 +38,12 @@ export declare class ShieldRemoteBackend implements ShieldBackend {
         getAccessToken: () => Promise<string>;
         getCoverageResultTimeout?: number;
         getCoverageResultPollInterval?: number;
-        baseUrl?: string;
+        baseUrl: string;
         fetch: typeof globalThis.fetch;
     });
-    checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;
+    checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult>;
+    checkSignatureCoverage(signatureRequest: SignatureRequest): Promise<CoverageResult>;
+    logSignature(req: LogSignatureRequest): Promise<void>;
+    logTransaction(req: LogTransactionRequest): Promise<void>;
 }
 //# sourceMappingURL=backend.d.mts.map

package/dist/backend.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"backend.d.mts","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAgB;AAE7E,eAAO,MAAM,QAAQ,oCAAoC,CAAC;AAE1D,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM,CAAC;YACb,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,qBAAa,mBAAoB,YAAW,aAAa;;gBAW3C,EACV,cAAc,EACd,wBAA+B,EAAE,eAAe;IAChD,6BAAoC,EAAE,eAAe;IACrD,OAAkB,EAClB,KAAK,EAAE,OAAO,GACf,EAAE;QACD,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,6BAA6B,CAAC,EAAE,MAAM,CAAC;QACvC,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;KAChC;IAQD,aAAa,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,cAAc,CAAC,CAoBjE;CAmEH"}
+{"version":3,"file":"backend.d.mts","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,uCAAuC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,aAAa,EACd,oBAAgB;AAEjB,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM,CAAC;YACb,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,qBAAa,mBAAoB,YAAW,aAAa;;gBAW3C,EACV,cAAc,EACd,wBAA+B,EAAE,eAAe;IAChD,6BAAoC,EAAE,eAAe;IACrD,OAAO,EACP,KAAK,EAAE,OAAO,GACf,EAAE;QACD,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,6BAA6B,CAAC,EAAE,MAAM,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;KAChC;IAQK,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAwB/D,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC;IAsBpB,YAAY,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrD,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAgFhE"}

package/dist/backend.mjs

@@ -10,43 +10,78 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ShieldRemoteBackend_instances, _ShieldRemoteBackend_getAccessToken, _ShieldRemoteBackend_getCoverageResultTimeout, _ShieldRemoteBackend_getCoverageResultPollInterval, _ShieldRemoteBackend_baseUrl, _ShieldRemoteBackend_fetch, _ShieldRemoteBackend_initCoverageCheck, _ShieldRemoteBackend_getCoverageResult, _ShieldRemoteBackend_createHeaders;
-export const BASE_URL = 'https://rule-engine.metamask.io';
 export class ShieldRemoteBackend {
     constructor({ getAccessToken, getCoverageResultTimeout = 5000, // milliseconds
     getCoverageResultPollInterval = 1000, // milliseconds
-    baseUrl = BASE_URL, fetch: fetchFn, }) {
+    baseUrl, fetch: fetchFn, }) {
         _ShieldRemoteBackend_instances.add(this);
         _ShieldRemoteBackend_getAccessToken.set(this, void 0);
         _ShieldRemoteBackend_getCoverageResultTimeout.set(this, void 0);
         _ShieldRemoteBackend_getCoverageResultPollInterval.set(this, void 0);
         _ShieldRemoteBackend_baseUrl.set(this, void 0);
         _ShieldRemoteBackend_fetch.set(this, void 0);
-        this.checkCoverage = async (txMeta) => {
-            const reqBody = {
-                txParams: [
-                    {
-                        from: txMeta.txParams.from,
-                        to: txMeta.txParams.to,
-                        value: txMeta.txParams.value,
-                        data: txMeta.txParams.data,
-                        nonce: txMeta.txParams.nonce,
-                    },
-                ],
-                chainId: txMeta.chainId,
-                origin: txMeta.origin,
-            };
-            const { coverageId } = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_initCoverageCheck).call(this, reqBody);
-            return __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_getCoverageResult).call(this, coverageId);
-        };
         __classPrivateFieldSet(this, _ShieldRemoteBackend_getAccessToken, getAccessToken, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_getCoverageResultTimeout, getCoverageResultTimeout, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_getCoverageResultPollInterval, getCoverageResultPollInterval, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_baseUrl, baseUrl, "f");
         __classPrivateFieldSet(this, _ShieldRemoteBackend_fetch, fetchFn, "f");
     }
+    async checkCoverage(txMeta) {
+        const reqBody = {
+            txParams: [
+                {
+                    from: txMeta.txParams.from,
+                    to: txMeta.txParams.to,
+                    value: txMeta.txParams.value,
+                    data: txMeta.txParams.data,
+                    nonce: txMeta.txParams.nonce,
+                },
+            ],
+            chainId: txMeta.chainId,
+            origin: txMeta.origin,
+        };
+        const { coverageId } = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_initCoverageCheck).call(this, 'v1/transaction/coverage/init', reqBody);
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_getCoverageResult).call(this, coverageId);
+        return { coverageId, status: coverageResult.status };
+    }
+    async checkSignatureCoverage(signatureRequest) {
+        if (typeof signatureRequest.messageParams.data !== 'string') {
+            throw new Error('Signature data must be a string');
+        }
+        const reqBody = {
+            chainId: signatureRequest.chainId,
+            data: signatureRequest.messageParams.data,
+            from: signatureRequest.messageParams.from,
+            method: signatureRequest.type,
+            origin: signatureRequest.messageParams.origin,
+        };
+        const { coverageId } = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_initCoverageCheck).call(this, 'v1/signature/coverage/init', reqBody);
+        const coverageResult = await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_getCoverageResult).call(this, coverageId);
+        return { coverageId, status: coverageResult.status };
+    }
+    async logSignature(req) {
+        const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/v1/signature/coverage/log`, {
+            method: 'POST',
+            headers: await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_createHeaders).call(this),
+            body: JSON.stringify(req),
+        });
+        if (res.status !== 200) {
+            throw new Error(`Failed to log signature: ${res.status}`);
+        }
+    }
+    async logTransaction(req) {
+        const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/v1/transaction/coverage/log`, {
+            method: 'POST',
+            headers: await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_createHeaders).call(this),
+            body: JSON.stringify(req),
+        });
+        if (res.status !== 200) {
+            throw new Error(`Failed to log transaction: ${res.status}`);
+        }
+    }
 }
-_ShieldRemoteBackend_getAccessToken = new WeakMap(), _ShieldRemoteBackend_getCoverageResultTimeout = new WeakMap(), _ShieldRemoteBackend_getCoverageResultPollInterval = new WeakMap(), _ShieldRemoteBackend_baseUrl = new WeakMap(), _ShieldRemoteBackend_fetch = new WeakMap(), _ShieldRemoteBackend_instances = new WeakSet(), _ShieldRemoteBackend_initCoverageCheck = async function _ShieldRemoteBackend_initCoverageCheck(reqBody) {
-    const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/api/v1/coverage/init`, {
+_ShieldRemoteBackend_getAccessToken = new WeakMap(), _ShieldRemoteBackend_getCoverageResultTimeout = new WeakMap(), _ShieldRemoteBackend_getCoverageResultPollInterval = new WeakMap(), _ShieldRemoteBackend_baseUrl = new WeakMap(), _ShieldRemoteBackend_fetch = new WeakMap(), _ShieldRemoteBackend_instances = new WeakSet(), _ShieldRemoteBackend_initCoverageCheck = async function _ShieldRemoteBackend_initCoverageCheck(path, reqBody) {
+    const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/${path}`, {
         method: 'POST',
         headers: await __classPrivateFieldGet(this, _ShieldRemoteBackend_instances, "m", _ShieldRemoteBackend_createHeaders).call(this),
         body: JSON.stringify(reqBody),
@@ -71,7 +106,7 @@ _ShieldRemoteBackend_getAccessToken = new WeakMap(), _ShieldRemoteBackend_getCov
             // eslint-disable-next-line no-unmodified-loop-condition
             while (!timeoutReached) {
                 const startTime = Date.now();
-                const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/api/v1/coverage/result`, {
+                const res = await __classPrivateFieldGet(this, _ShieldRemoteBackend_fetch, "f").call(this, `${__classPrivateFieldGet(this, _ShieldRemoteBackend_baseUrl, "f")}/v1/transaction/coverage/result`, {
                     method: 'POST',
                     headers,
                     body: JSON.stringify(reqBody),

package/dist/backend.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"backend.mjs","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,MAAM,CAAC,MAAM,QAAQ,GAAG,iCAAiC,CAAC;AA4B1D,MAAM,OAAO,mBAAmB;IAW9B,YAAY,EACV,cAAc,EACd,wBAAwB,GAAG,IAAI,EAAE,eAAe;IAChD,6BAA6B,GAAG,IAAI,EAAE,eAAe;IACrD,OAAO,GAAG,QAAQ,EAClB,KAAK,EAAE,OAAO,GAOf;;QAtBQ,sDAAuC;QAEvC,gEAAkC;QAElC,qEAAuC;QAEvC,+CAAiB;QAEjB,6CAAgC;QAsBzC,kBAAa,GAAyD,KAAK,EACzE,MAAM,EACN,EAAE;YACF,MAAM,OAAO,GAA6B;gBACxC,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;wBAC1B,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;wBACtB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;wBAC5B,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;wBAC1B,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;qBAC7B;iBACF;gBACD,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC;YAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,OAAO,CAAC,CAAC;YAE9D,OAAO,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAC;QA3BA,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,iDAA6B,wBAAwB,MAAA,CAAC;QAC1D,uBAAA,IAAI,sDAAkC,6BAA6B,MAAA,CAAC;QACpE,uBAAA,IAAI,gCAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,8BAAU,OAAO,MAAA,CAAC;IACxB,CAAC;CAyFF;2WAjEC,KAAK,iDACH,OAAiC;IAEjC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EAAQ,GAAG,uBAAA,IAAI,oCAAS,uBAAuB,EAAE;QACrE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;QACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;KACjE;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;AACzD,CAAC,2CAED,KAAK,iDACH,UAAkB,EAClB,UAAkB,uBAAA,IAAI,qDAA0B,EAChD,eAAuB,uBAAA,IAAI,0DAA+B;IAE1D,MAAM,OAAO,GAA6B;QACxC,UAAU;KACX,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB,CAAC;IAC5C,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC;QAC3D,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,IAAI,GAAG,KAAK,IAAwC,EAAE;YAC1D,mEAAmE;YACnE,wDAAwD;YACxD,OAAO,CAAC,cAAc,EAAE;gBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,yBAAyB,EACzC;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO;oBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;iBAC9B,CACF,CAAC;gBACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;oBACtB,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;iBACxD;gBACD,MAAM,KAAK,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;aACtD;YACD,wEAAwE;YACxE,mCAAmC;YACnC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,uCAED,KAAK;IACH,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,2CAAgB,MAApB,IAAI,CAAkB,CAAC;IACjD,OAAO;QACL,cAAc,EAAE,kBAAkB;QAClC,aAAa,EAAE,UAAU,WAAW,EAAE;KACvC,CAAC;AACJ,CAAC;AAGH;;;;;GAKG;AACH,KAAK,UAAU,KAAK,CAAC,EAAU;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\n\nimport type { CoverageResult, CoverageStatus, ShieldBackend } from './types';\n\nexport const BASE_URL = 'https://rule-engine.metamask.io';\n\nexport type InitCoverageCheckRequest = {\n  txParams: [\n    {\n      from: string;\n      to?: string;\n      value?: string;\n      data?: string;\n      nonce?: string;\n    },\n  ];\n  chainId: string;\n  origin?: string;\n};\n\nexport type InitCoverageCheckResponse = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultRequest = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultResponse = {\n  status: CoverageStatus;\n};\n\nexport class ShieldRemoteBackend implements ShieldBackend {\n  readonly #getAccessToken: () => Promise<string>;\n\n  readonly #getCoverageResultTimeout: number;\n\n  readonly #getCoverageResultPollInterval: number;\n\n  readonly #baseUrl: string;\n\n  readonly #fetch: typeof globalThis.fetch;\n\n  constructor({\n    getAccessToken,\n    getCoverageResultTimeout = 5000, // milliseconds\n    getCoverageResultPollInterval = 1000, // milliseconds\n    baseUrl = BASE_URL,\n    fetch: fetchFn,\n  }: {\n    getAccessToken: () => Promise<string>;\n    getCoverageResultTimeout?: number;\n    getCoverageResultPollInterval?: number;\n    baseUrl?: string;\n    fetch: typeof globalThis.fetch;\n  }) {\n    this.#getAccessToken = getAccessToken;\n    this.#getCoverageResultTimeout = getCoverageResultTimeout;\n    this.#getCoverageResultPollInterval = getCoverageResultPollInterval;\n    this.#baseUrl = baseUrl;\n    this.#fetch = fetchFn;\n  }\n\n  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult> = async (\n    txMeta,\n  ) => {\n    const reqBody: InitCoverageCheckRequest = {\n      txParams: [\n        {\n          from: txMeta.txParams.from,\n          to: txMeta.txParams.to,\n          value: txMeta.txParams.value,\n          data: txMeta.txParams.data,\n          nonce: txMeta.txParams.nonce,\n        },\n      ],\n      chainId: txMeta.chainId,\n      origin: txMeta.origin,\n    };\n\n    const { coverageId } = await this.#initCoverageCheck(reqBody);\n\n    return this.#getCoverageResult(coverageId);\n  };\n\n  async #initCoverageCheck(\n    reqBody: InitCoverageCheckRequest,\n  ): Promise<InitCoverageCheckResponse> {\n    const res = await this.#fetch(`${this.#baseUrl}/api/v1/coverage/init`, {\n      method: 'POST',\n      headers: await this.#createHeaders(),\n      body: JSON.stringify(reqBody),\n    });\n    if (res.status !== 200) {\n      throw new Error(`Failed to init coverage check: ${res.status}`);\n    }\n    return (await res.json()) as InitCoverageCheckResponse;\n  }\n\n  async #getCoverageResult(\n    coverageId: string,\n    timeout: number = this.#getCoverageResultTimeout,\n    pollInterval: number = this.#getCoverageResultPollInterval,\n  ): Promise<GetCoverageResultResponse> {\n    const reqBody: GetCoverageResultRequest = {\n      coverageId,\n    };\n\n    const headers = await this.#createHeaders();\n    return await new Promise((resolve, reject) => {\n      let timeoutReached = false;\n      setTimeout(() => {\n        timeoutReached = true;\n        reject(new Error('Timeout waiting for coverage result'));\n      }, timeout);\n\n      const poll = async (): Promise<GetCoverageResultResponse> => {\n        // The timeoutReached variable is modified in the timeout callback.\n        // eslint-disable-next-line no-unmodified-loop-condition\n        while (!timeoutReached) {\n          const startTime = Date.now();\n          const res = await this.#fetch(\n            `${this.#baseUrl}/api/v1/coverage/result`,\n            {\n              method: 'POST',\n              headers,\n              body: JSON.stringify(reqBody),\n            },\n          );\n          if (res.status === 200) {\n            return (await res.json()) as GetCoverageResultResponse;\n          }\n          await sleep(pollInterval - (Date.now() - startTime));\n        }\n        // The following line will not have an effect as the upper level promise\n        // will already be rejected by now.\n        throw new Error('unexpected error');\n      };\n\n      poll().then(resolve).catch(reject);\n    });\n  }\n\n  async #createHeaders() {\n    const accessToken = await this.#getAccessToken();\n    return {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${accessToken}`,\n    };\n  }\n}\n\n/**\n * Sleep for a specified amount of time.\n *\n * @param ms - The number of milliseconds to sleep.\n * @returns A promise that resolves after the specified amount of time.\n */\nasync function sleep(ms: number) {\n  return new Promise((resolve) => setTimeout(resolve, ms));\n}\n"]}
+{"version":3,"file":"backend.mjs","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":";;;;;;;;;;;;AA6CA,MAAM,OAAO,mBAAmB;IAW9B,YAAY,EACV,cAAc,EACd,wBAAwB,GAAG,IAAI,EAAE,eAAe;IAChD,6BAA6B,GAAG,IAAI,EAAE,eAAe;IACrD,OAAO,EACP,KAAK,EAAE,OAAO,GAOf;;QAtBQ,sDAAuC;QAEvC,gEAAkC;QAElC,qEAAuC;QAEvC,+CAAiB;QAEjB,6CAAgC;QAevC,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,iDAA6B,wBAAwB,MAAA,CAAC;QAC1D,uBAAA,IAAI,sDAAkC,6BAA6B,MAAA,CAAC;QACpE,uBAAA,IAAI,gCAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,8BAAU,OAAO,MAAA,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,MAAM,OAAO,GAA6B;YACxC,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;oBAC1B,EAAE,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;oBACtB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;oBAC5B,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;oBAC1B,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;iBAC7B;aACF;YACD,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;QAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAC/B,8BAA8B,EAC9B,OAAO,CACR,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,UAAU,CAAC,CAAC;QACjE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC1B,gBAAkC;QAElC,IAAI,OAAO,gBAAgB,CAAC,aAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC3D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;QAED,MAAM,OAAO,GAAsC;YACjD,OAAO,EAAE,gBAAgB,CAAC,OAAO;YACjC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,IAAI;YACzC,IAAI,EAAE,gBAAgB,CAAC,aAAa,CAAC,IAAI;YACzC,MAAM,EAAE,gBAAgB,CAAC,IAAI;YAC7B,MAAM,EAAE,gBAAgB,CAAC,aAAa,CAAC,MAAM;SAC9C,CAAC;QAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAC/B,4BAA4B,EAC5B,OAAO,CACR,CAAC;QAEF,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,8EAAmB,MAAvB,IAAI,EAAoB,UAAU,CAAC,CAAC;QACjE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,GAAwB;QACzC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,4BAA4B,EAC5C;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;YACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC1B,CACF,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;SAC3D;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,GAA0B;QAC7C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,8BAA8B,EAC9C;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;YACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SAC1B,CACF,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;SAC7D;IACH,CAAC;CAoEF;2WAlEC,KAAK,iDACH,IAAY,EACZ,OAAgB;IAEhB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EAAQ,GAAG,uBAAA,IAAI,oCAAS,IAAI,IAAI,EAAE,EAAE;QACxD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB;QACpC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;KACjE;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;AACzD,CAAC,2CAED,KAAK,iDACH,UAAkB,EAClB,UAAkB,uBAAA,IAAI,qDAA0B,EAChD,eAAuB,uBAAA,IAAI,0DAA+B;IAE1D,MAAM,OAAO,GAA6B;QACxC,UAAU;KACX,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,uBAAA,IAAI,0EAAe,MAAnB,IAAI,CAAiB,CAAC;IAC5C,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC;QAC3D,CAAC,EAAE,OAAO,CAAC,CAAC;QAEZ,MAAM,IAAI,GAAG,KAAK,IAAwC,EAAE;YAC1D,mEAAmE;YACnE,wDAAwD;YACxD,OAAO,CAAC,cAAc,EAAE;gBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAO,MAAX,IAAI,EACpB,GAAG,uBAAA,IAAI,oCAAS,iCAAiC,EACjD;oBACE,MAAM,EAAE,MAAM;oBACd,OAAO;oBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;iBAC9B,CACF,CAAC;gBACF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE;oBACtB,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAA8B,CAAC;iBACxD;gBACD,MAAM,KAAK,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;aACtD;YACD,wEAAwE;YACxE,mCAAmC;YACnC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC,CAAC;QAEF,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,uCAED,KAAK;IACH,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,2CAAgB,MAApB,IAAI,CAAkB,CAAC;IACjD,OAAO;QACL,cAAc,EAAE,kBAAkB;QAClC,aAAa,EAAE,UAAU,WAAW,EAAE;KACvC,CAAC;AACJ,CAAC;AAGH;;;;;GAKG;AACH,KAAK,UAAU,KAAK,CAAC,EAAU;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC","sourcesContent":["import type { SignatureRequest } from '@metamask/signature-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\n\nimport type {\n  CoverageResult,\n  CoverageStatus,\n  LogSignatureRequest,\n  LogTransactionRequest,\n  ShieldBackend,\n} from './types';\n\nexport type InitCoverageCheckRequest = {\n  txParams: [\n    {\n      from: string;\n      to?: string;\n      value?: string;\n      data?: string;\n      nonce?: string;\n    },\n  ];\n  chainId: string;\n  origin?: string;\n};\n\nexport type InitSignatureCoverageCheckRequest = {\n  chainId: string;\n  data: string;\n  from: string;\n  method: string;\n  origin?: string;\n};\n\nexport type InitCoverageCheckResponse = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultRequest = {\n  coverageId: string;\n};\n\nexport type GetCoverageResultResponse = {\n  status: CoverageStatus;\n};\n\nexport class ShieldRemoteBackend implements ShieldBackend {\n  readonly #getAccessToken: () => Promise<string>;\n\n  readonly #getCoverageResultTimeout: number;\n\n  readonly #getCoverageResultPollInterval: number;\n\n  readonly #baseUrl: string;\n\n  readonly #fetch: typeof globalThis.fetch;\n\n  constructor({\n    getAccessToken,\n    getCoverageResultTimeout = 5000, // milliseconds\n    getCoverageResultPollInterval = 1000, // milliseconds\n    baseUrl,\n    fetch: fetchFn,\n  }: {\n    getAccessToken: () => Promise<string>;\n    getCoverageResultTimeout?: number;\n    getCoverageResultPollInterval?: number;\n    baseUrl: string;\n    fetch: typeof globalThis.fetch;\n  }) {\n    this.#getAccessToken = getAccessToken;\n    this.#getCoverageResultTimeout = getCoverageResultTimeout;\n    this.#getCoverageResultPollInterval = getCoverageResultPollInterval;\n    this.#baseUrl = baseUrl;\n    this.#fetch = fetchFn;\n  }\n\n  async checkCoverage(txMeta: TransactionMeta): Promise<CoverageResult> {\n    const reqBody: InitCoverageCheckRequest = {\n      txParams: [\n        {\n          from: txMeta.txParams.from,\n          to: txMeta.txParams.to,\n          value: txMeta.txParams.value,\n          data: txMeta.txParams.data,\n          nonce: txMeta.txParams.nonce,\n        },\n      ],\n      chainId: txMeta.chainId,\n      origin: txMeta.origin,\n    };\n\n    const { coverageId } = await this.#initCoverageCheck(\n      'v1/transaction/coverage/init',\n      reqBody,\n    );\n\n    const coverageResult = await this.#getCoverageResult(coverageId);\n    return { coverageId, status: coverageResult.status };\n  }\n\n  async checkSignatureCoverage(\n    signatureRequest: SignatureRequest,\n  ): Promise<CoverageResult> {\n    if (typeof signatureRequest.messageParams.data !== 'string') {\n      throw new Error('Signature data must be a string');\n    }\n\n    const reqBody: InitSignatureCoverageCheckRequest = {\n      chainId: signatureRequest.chainId,\n      data: signatureRequest.messageParams.data,\n      from: signatureRequest.messageParams.from,\n      method: signatureRequest.type,\n      origin: signatureRequest.messageParams.origin,\n    };\n\n    const { coverageId } = await this.#initCoverageCheck(\n      'v1/signature/coverage/init',\n      reqBody,\n    );\n\n    const coverageResult = await this.#getCoverageResult(coverageId);\n    return { coverageId, status: coverageResult.status };\n  }\n\n  async logSignature(req: LogSignatureRequest): Promise<void> {\n    const res = await this.#fetch(\n      `${this.#baseUrl}/v1/signature/coverage/log`,\n      {\n        method: 'POST',\n        headers: await this.#createHeaders(),\n        body: JSON.stringify(req),\n      },\n    );\n    if (res.status !== 200) {\n      throw new Error(`Failed to log signature: ${res.status}`);\n    }\n  }\n\n  async logTransaction(req: LogTransactionRequest): Promise<void> {\n    const res = await this.#fetch(\n      `${this.#baseUrl}/v1/transaction/coverage/log`,\n      {\n        method: 'POST',\n        headers: await this.#createHeaders(),\n        body: JSON.stringify(req),\n      },\n    );\n    if (res.status !== 200) {\n      throw new Error(`Failed to log transaction: ${res.status}`);\n    }\n  }\n\n  async #initCoverageCheck(\n    path: string,\n    reqBody: unknown,\n  ): Promise<InitCoverageCheckResponse> {\n    const res = await this.#fetch(`${this.#baseUrl}/${path}`, {\n      method: 'POST',\n      headers: await this.#createHeaders(),\n      body: JSON.stringify(reqBody),\n    });\n    if (res.status !== 200) {\n      throw new Error(`Failed to init coverage check: ${res.status}`);\n    }\n    return (await res.json()) as InitCoverageCheckResponse;\n  }\n\n  async #getCoverageResult(\n    coverageId: string,\n    timeout: number = this.#getCoverageResultTimeout,\n    pollInterval: number = this.#getCoverageResultPollInterval,\n  ): Promise<GetCoverageResultResponse> {\n    const reqBody: GetCoverageResultRequest = {\n      coverageId,\n    };\n\n    const headers = await this.#createHeaders();\n    return await new Promise((resolve, reject) => {\n      let timeoutReached = false;\n      setTimeout(() => {\n        timeoutReached = true;\n        reject(new Error('Timeout waiting for coverage result'));\n      }, timeout);\n\n      const poll = async (): Promise<GetCoverageResultResponse> => {\n        // The timeoutReached variable is modified in the timeout callback.\n        // eslint-disable-next-line no-unmodified-loop-condition\n        while (!timeoutReached) {\n          const startTime = Date.now();\n          const res = await this.#fetch(\n            `${this.#baseUrl}/v1/transaction/coverage/result`,\n            {\n              method: 'POST',\n              headers,\n              body: JSON.stringify(reqBody),\n            },\n          );\n          if (res.status === 200) {\n            return (await res.json()) as GetCoverageResultResponse;\n          }\n          await sleep(pollInterval - (Date.now() - startTime));\n        }\n        // The following line will not have an effect as the upper level promise\n        // will already be rejected by now.\n        throw new Error('unexpected error');\n      };\n\n      poll().then(resolve).catch(reject);\n    });\n  }\n\n  async #createHeaders() {\n    const accessToken = await this.#getAccessToken();\n    return {\n      'Content-Type': 'application/json',\n      Authorization: `Bearer ${accessToken}`,\n    };\n  }\n}\n\n/**\n * Sleep for a specified amount of time.\n *\n * @param ms - The number of milliseconds to sleep.\n * @returns A promise that resolves after the specified amount of time.\n */\nasync function sleep(ms: number) {\n  return new Promise((resolve) => setTimeout(resolve, ms));\n}\n"]}

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAUA,2DAG4B;AAF1B,oHAAA,gBAAgB,OAAA;AAChB,mIAAA,+BAA+B,OAAA;AAEjC,yCAAgD;AAAvC,8GAAA,mBAAmB,OAAA","sourcesContent":["export type { CoverageStatus } from './types';\nexport type {\n  ShieldControllerActions,\n  ShieldControllerEvents,\n  ShieldControllerMessenger,\n  ShieldControllerState,\n  ShieldControllerCheckCoverageAction,\n  ShieldControllerCoverageResultReceivedEvent,\n  ShieldControllerStateChangeEvent,\n} from './ShieldController';\nexport {\n  ShieldController,\n  getDefaultShieldControllerState,\n} from './ShieldController';\nexport { ShieldRemoteBackend } from './backend';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAcA,2DAG4B;AAF1B,oHAAA,gBAAgB,OAAA;AAChB,mIAAA,+BAA+B,OAAA;AAEjC,yCAAgD;AAAvC,8GAAA,mBAAmB,OAAA","sourcesContent":["export type {\n  CoverageStatus,\n  LogSignatureRequest,\n  LogTransactionRequest,\n} from './types';\nexport type {\n  ShieldControllerActions,\n  ShieldControllerEvents,\n  ShieldControllerMessenger,\n  ShieldControllerState,\n  ShieldControllerCheckCoverageAction,\n  ShieldControllerCoverageResultReceivedEvent,\n  ShieldControllerStateChangeEvent,\n} from './ShieldController';\nexport {\n  ShieldController,\n  getDefaultShieldControllerState,\n} from './ShieldController';\nexport { ShieldRemoteBackend } from './backend';\n"]}

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export type { CoverageStatus } from "./types.cjs";
+export type { CoverageStatus, LogSignatureRequest, LogTransactionRequest, } from "./types.cjs";
 export type { ShieldControllerActions, ShieldControllerEvents, ShieldControllerMessenger, ShieldControllerState, ShieldControllerCheckCoverageAction, ShieldControllerCoverageResultReceivedEvent, ShieldControllerStateChangeEvent, } from "./ShieldController.cjs";
 export { ShieldController, getDefaultShieldControllerState, } from "./ShieldController.cjs";
 export { ShieldRemoteBackend } from "./backend.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAC9C,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,mCAAmC,EACnC,2CAA2C,EAC3C,gCAAgC,GACjC,+BAA2B;AAC5B,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,+BAA2B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,sBAAkB"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,qBAAqB,GACtB,oBAAgB;AACjB,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,mCAAmC,EACnC,2CAA2C,EAC3C,gCAAgC,GACjC,+BAA2B;AAC5B,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,+BAA2B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,sBAAkB"}

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-export type { CoverageStatus } from "./types.mjs";
+export type { CoverageStatus, LogSignatureRequest, LogTransactionRequest, } from "./types.mjs";
 export type { ShieldControllerActions, ShieldControllerEvents, ShieldControllerMessenger, ShieldControllerState, ShieldControllerCheckCoverageAction, ShieldControllerCoverageResultReceivedEvent, ShieldControllerStateChangeEvent, } from "./ShieldController.mjs";
 export { ShieldController, getDefaultShieldControllerState, } from "./ShieldController.mjs";
 export { ShieldRemoteBackend } from "./backend.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAC9C,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,mCAAmC,EACnC,2CAA2C,EAC3C,gCAAgC,GACjC,+BAA2B;AAC5B,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,+BAA2B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,sBAAkB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,qBAAqB,GACtB,oBAAgB;AACjB,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,mCAAmC,EACnC,2CAA2C,EAC3C,gCAAgC,GACjC,+BAA2B;AAC5B,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,+BAA2B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,sBAAkB"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,gBAAgB,EAChB,+BAA+B,EAChC,+BAA2B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,sBAAkB","sourcesContent":["export type { CoverageStatus } from './types';\nexport type {\n  ShieldControllerActions,\n  ShieldControllerEvents,\n  ShieldControllerMessenger,\n  ShieldControllerState,\n  ShieldControllerCheckCoverageAction,\n  ShieldControllerCoverageResultReceivedEvent,\n  ShieldControllerStateChangeEvent,\n} from './ShieldController';\nexport {\n  ShieldController,\n  getDefaultShieldControllerState,\n} from './ShieldController';\nexport { ShieldRemoteBackend } from './backend';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EACL,gBAAgB,EAChB,+BAA+B,EAChC,+BAA2B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,sBAAkB","sourcesContent":["export type {\n  CoverageStatus,\n  LogSignatureRequest,\n  LogTransactionRequest,\n} from './types';\nexport type {\n  ShieldControllerActions,\n  ShieldControllerEvents,\n  ShieldControllerMessenger,\n  ShieldControllerState,\n  ShieldControllerCheckCoverageAction,\n  ShieldControllerCoverageResultReceivedEvent,\n  ShieldControllerStateChangeEvent,\n} from './ShieldController';\nexport {\n  ShieldController,\n  getDefaultShieldControllerState,\n} from './ShieldController';\nexport { ShieldRemoteBackend } from './backend';\n"]}

package/dist/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAMa,QAAA,gBAAgB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAU,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\n\nexport type CoverageResult = {\n  status: CoverageStatus;\n};\n\nexport const coverageStatuses = ['covered', 'malicious', 'unknown'] as const;\nexport type CoverageStatus = (typeof coverageStatuses)[number];\n\nexport type ShieldBackend = {\n  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;\n};\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAQa,QAAA,gBAAgB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAU,CAAC","sourcesContent":["import type { SignatureRequest } from '@metamask/signature-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\n\nexport type CoverageResult = {\n  coverageId: string;\n  status: CoverageStatus;\n};\n\nexport const coverageStatuses = ['covered', 'malicious', 'unknown'] as const;\nexport type CoverageStatus = (typeof coverageStatuses)[number];\n\nexport type LogSignatureRequest = {\n  coverageId: string;\n  signature: string;\n  status: string;\n};\n\nexport type LogTransactionRequest = {\n  coverageId: string;\n  transactionHash: string;\n  status: string;\n};\n\nexport type ShieldBackend = {\n  logSignature: (req: LogSignatureRequest) => Promise<void>;\n  logTransaction: (req: LogTransactionRequest) => Promise<void>;\n  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;\n  checkSignatureCoverage: (\n    signatureRequest: SignatureRequest,\n  ) => Promise<CoverageResult>;\n};\n"]}

package/dist/types.d.cts

@@ -1,10 +1,25 @@
+import type { SignatureRequest } from "@metamask/signature-controller";
 import type { TransactionMeta } from "@metamask/transaction-controller";
 export type CoverageResult = {
+    coverageId: string;
     status: CoverageStatus;
 };
 export declare const coverageStatuses: readonly ["covered", "malicious", "unknown"];
 export type CoverageStatus = (typeof coverageStatuses)[number];
+export type LogSignatureRequest = {
+    coverageId: string;
+    signature: string;
+    status: string;
+};
+export type LogTransactionRequest = {
+    coverageId: string;
+    transactionHash: string;
+    status: string;
+};
 export type ShieldBackend = {
+    logSignature: (req: LogSignatureRequest) => Promise<void>;
+    logTransaction: (req: LogTransactionRequest) => Promise<void>;
     checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;
+    checkSignatureCoverage: (signatureRequest: SignatureRequest) => Promise<CoverageResult>;
 };
 //# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,8CAA+C,CAAC;AAC7E,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CACrE,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,uCAAuC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,8CAA+C,CAAC;AAC7E,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,cAAc,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,aAAa,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpE,sBAAsB,EAAE,CACtB,gBAAgB,EAAE,gBAAgB,KAC/B,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9B,CAAC"}

package/dist/types.d.mts

@@ -1,10 +1,25 @@
+import type { SignatureRequest } from "@metamask/signature-controller";
 import type { TransactionMeta } from "@metamask/transaction-controller";
 export type CoverageResult = {
+    coverageId: string;
     status: CoverageStatus;
 };
 export declare const coverageStatuses: readonly ["covered", "malicious", "unknown"];
 export type CoverageStatus = (typeof coverageStatuses)[number];
+export type LogSignatureRequest = {
+    coverageId: string;
+    signature: string;
+    status: string;
+};
+export type LogTransactionRequest = {
+    coverageId: string;
+    transactionHash: string;
+    status: string;
+};
 export type ShieldBackend = {
+    logSignature: (req: LogSignatureRequest) => Promise<void>;
+    logTransaction: (req: LogTransactionRequest) => Promise<void>;
     checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;
+    checkSignatureCoverage: (signatureRequest: SignatureRequest) => Promise<CoverageResult>;
 };
 //# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,8CAA+C,CAAC;AAC7E,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CACrE,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,uCAAuC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,yCAAyC;AAExE,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,gBAAgB,8CAA+C,CAAC;AAC7E,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,CAAC,GAAG,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,cAAc,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,aAAa,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACpE,sBAAsB,EAAE,CACtB,gBAAgB,EAAE,gBAAgB,KAC/B,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9B,CAAC"}

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAU,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\n\nexport type CoverageResult = {\n  status: CoverageStatus;\n};\n\nexport const coverageStatuses = ['covered', 'malicious', 'unknown'] as const;\nexport type CoverageStatus = (typeof coverageStatuses)[number];\n\nexport type ShieldBackend = {\n  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;\n};\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAU,CAAC","sourcesContent":["import type { SignatureRequest } from '@metamask/signature-controller';\nimport type { TransactionMeta } from '@metamask/transaction-controller';\n\nexport type CoverageResult = {\n  coverageId: string;\n  status: CoverageStatus;\n};\n\nexport const coverageStatuses = ['covered', 'malicious', 'unknown'] as const;\nexport type CoverageStatus = (typeof coverageStatuses)[number];\n\nexport type LogSignatureRequest = {\n  coverageId: string;\n  signature: string;\n  status: string;\n};\n\nexport type LogTransactionRequest = {\n  coverageId: string;\n  transactionHash: string;\n  status: string;\n};\n\nexport type ShieldBackend = {\n  logSignature: (req: LogSignatureRequest) => Promise<void>;\n  logTransaction: (req: LogTransactionRequest) => Promise<void>;\n  checkCoverage: (txMeta: TransactionMeta) => Promise<CoverageResult>;\n  checkSignatureCoverage: (\n    signatureRequest: SignatureRequest,\n  ) => Promise<CoverageResult>;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/shield-controller",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Controller handling shield transaction coverage logic",
   "keywords": [
     "MetaMask",
@@ -47,15 +47,16 @@
     "since-latest-release": "../../scripts/since-latest-release.sh"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.2.0",
-    "@metamask/utils": "^11.4.2"
+    "@metamask/base-controller": "^8.4.0",
+    "@metamask/utils": "^11.8.0"
   },
   "devDependencies": {
     "@babel/runtime": "^7.23.9",
     "@lavamoat/allow-scripts": "^3.0.4",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/transaction-controller": "^60.1.0",
+    "@metamask/signature-controller": "^34.0.0",
+    "@metamask/transaction-controller": "^60.4.0",
     "@ts-bridge/cli": "^0.6.1",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
@@ -67,6 +68,7 @@
     "uuid": "^8.3.2"
   },
   "peerDependencies": {
+    "@metamask/signature-controller": "^34.0.0",
     "@metamask/transaction-controller": "^60.0.0"
   },
   "engines": {