@metamask-previews/shield-controller 6.0.2-preview-6eff555ee → 7.0.0-preview-97d6b86c0

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.0.0]
+
+### Changed
+
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
+- Bump `@metamask/base-controller` from `^9.1.0` to `^10.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/base-data-service` from `^1.0.0` to `^2.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/controller-utils` from `^12.3.0` to `^13.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/messenger` from `^2.0.0` to `^3.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/profile-sync-controller` from `^30.0.0` to `^31.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/signature-controller` from `^39.2.10` to `^40.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+- Bump `@metamask/transaction-controller` from `^69.8.1` to `^70.0.0` ([#10160](https://github.com/MetaMask/core/pull/10160))
+
 ## [6.0.2]
 
 ### Changed
@@ -295,7 +312,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@6.0.2...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@7.0.0...HEAD
+[7.0.0]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@6.0.2...@metamask/shield-controller@7.0.0
 [6.0.2]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@6.0.1...@metamask/shield-controller@6.0.2
 [6.0.1]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@6.0.0...@metamask/shield-controller@6.0.1
 [6.0.0]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@5.1.3...@metamask/shield-controller@6.0.0

package/dist/{ShieldController-method-action-types.d.mts → ShieldController-method-action-types.d.ts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { ShieldController } from "./ShieldController.mjs";
+import type { ShieldController } from './ShieldController.js';
 /**
  * Start the ShieldController and subscribe to the transaction and signature controller state changes.
  */
@@ -48,4 +48,4 @@ export type ShieldControllerCheckSignatureCoverageAction = {
  * Union of all ShieldController action types.
  */
 export type ShieldControllerMethodActions = ShieldControllerStartAction | ShieldControllerStopAction | ShieldControllerClearStateAction | ShieldControllerCheckCoverageAction | ShieldControllerCheckSignatureCoverageAction;
-//# sourceMappingURL=ShieldController-method-action-types.d.mts.map
+//# sourceMappingURL=ShieldController-method-action-types.d.ts.map

package/dist/ShieldController-method-action-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShieldController-method-action-types.d.ts","sourceRoot":"","sources":["../src/ShieldController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,2BAA2B,GAC3B,0BAA0B,GAC1B,gCAAgC,GAChC,mCAAmC,GACnC,4CAA4C,CAAC"}

package/dist/{ShieldController-method-action-types.mjs → ShieldController-method-action-types.js}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=ShieldController-method-action-types.mjs.map
+//# sourceMappingURL=ShieldController-method-action-types.js.map

package/dist/ShieldController-method-action-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShieldController-method-action-types.js","sourceRoot":"","sources":["../src/ShieldController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { ShieldController } from './ShieldController.js';\n\n/**\n * Start the ShieldController and subscribe to the transaction and signature controller state changes.\n */\nexport type ShieldControllerStartAction = {\n  type: `ShieldController:start`;\n  handler: ShieldController['start'];\n};\n\n/**\n * Stop the ShieldController and unsubscribe from the transaction and signature controller state changes.\n */\nexport type ShieldControllerStopAction = {\n  type: `ShieldController:stop`;\n  handler: ShieldController['stop'];\n};\n\n/**\n * Clears the shield state and resets to default values.\n */\nexport type ShieldControllerClearStateAction = {\n  type: `ShieldController:clearState`;\n  handler: ShieldController['clearState'];\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 */\nexport type ShieldControllerCheckCoverageAction = {\n  type: `ShieldController:checkCoverage`;\n  handler: ShieldController['checkCoverage'];\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 */\nexport type ShieldControllerCheckSignatureCoverageAction = {\n  type: `ShieldController:checkSignatureCoverage`;\n  handler: ShieldController['checkSignatureCoverage'];\n};\n\n/**\n * Union of all ShieldController action types.\n */\nexport type ShieldControllerMethodActions =\n  | ShieldControllerStartAction\n  | ShieldControllerStopAction\n  | ShieldControllerClearStateAction\n  | ShieldControllerCheckCoverageAction\n  | ShieldControllerCheckSignatureCoverageAction;\n"]}

package/dist/{ShieldController.d.cts → ShieldController.d.ts}

@@ -1,12 +1,12 @@
-import { BaseController } from "@metamask/base-controller";
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { SignatureRequest, SignatureStateChange } from "@metamask/signature-controller";
-import type { TransactionControllerStateChangeEvent, TransactionMeta } from "@metamask/transaction-controller";
-import { controllerName } from "./constants.cjs";
-import type { ShieldApiServiceMethodActions } from "./shield-api-service-method-action-types.cjs";
-import type { ShieldControllerMethodActions } from "./ShieldController-method-action-types.cjs";
-import type { CoverageResult, NormalizeSignatureRequestFn } from "./types.cjs";
+import { BaseController } from '@metamask/base-controller';
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from '@metamask/base-controller';
+import type { Messenger } from '@metamask/messenger';
+import type { SignatureRequest, SignatureStateChange } from '@metamask/signature-controller';
+import type { TransactionControllerStateChangeEvent, TransactionMeta } from '@metamask/transaction-controller';
+import { controllerName } from './constants.js';
+import type { ShieldApiServiceMethodActions } from './shield-api-service-method-action-types.js';
+import type { ShieldControllerMethodActions } from './ShieldController-method-action-types.js';
+import type { CoverageResult, NormalizeSignatureRequestFn } from './types.js';
 export type CoverageResultRecordEntry = {
     /**
      * History of coverage results, latest first.
@@ -103,4 +103,4 @@ export declare class ShieldController extends BaseController<typeof controllerNa
     checkSignatureCoverage(signatureRequest: SignatureRequest): Promise<CoverageResult>;
 }
 export {};
-//# sourceMappingURL=ShieldController.d.cts.map
+//# sourceMappingURL=ShieldController.d.ts.map

package/dist/ShieldController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShieldController.d.ts","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,KAAK,EACV,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AAExC,OAAO,KAAK,EACV,qCAAqC,EACrC,eAAe,EAChB,MAAM,kCAAkC,CAAC;AAG1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,6CAA6C,CAAC;AACjG,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC/F,OAAO,KAAK,EAAE,cAAc,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAY9E,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,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,CAAC;AAElC,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,6BAA6B,CAAC;AAEpD;;GAEG;AACH,KAAK,aAAa,GACd,oBAAoB,GACpB,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,CACvC,CAAC;AAqBF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;;OAQG;IACH,yBAAyB,CAAC,EAAE,2BAA2B,CAAC;CACzD,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;;IAmBC,YAAY,OAAO,EAAE,uBAAuB,EA+B3C;IAED;;OAEG;IACH,KAAK,IAAI,IAAI,CAiBZ;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,CAeX;IAED;;OAEG;IACH,UAAU,IAAI,IAAI,CAIjB;IAwFD;;;;;OAKG;IACG,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAqBpE;IAED;;;;;OAKG;IACG,sBAAsB,CAC1B,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,cAAc,CAAC,CA4BzB;CA2GF"}

package/dist/ShieldController.js

@@ -0,0 +1,290 @@
+import { BaseController } from '@metamask/base-controller';
+import { SignatureRequestStatus } from '@metamask/signature-controller';
+import { TransactionStatus } from '@metamask/transaction-controller';
+import { cloneDeep, isEqual } from 'lodash-es';
+import { controllerName } from './constants.js';
+import { projectLogger, createModuleLogger } from './logger.js';
+const log = createModuleLogger(projectLogger, 'ShieldController');
+const MESSENGER_EXPOSED_METHODS = [
+    'start',
+    'stop',
+    'clearState',
+    'checkCoverage',
+    'checkSignatureCoverage',
+];
+/**
+ * Get the default state for the ShieldController.
+ *
+ * @returns The default state for the ShieldController.
+ */
+export function getDefaultShieldControllerState() {
+    return {
+        coverageResults: {},
+        orderedTransactionHistory: [],
+    };
+}
+/**
+ * Metadata for the ShieldController state, describing how to "anonymize"
+ * the state and which parts should be persisted.
+ */
+const metadata = {
+    coverageResults: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+    orderedTransactionHistory: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: false,
+    },
+};
+export class ShieldController extends BaseController {
+    #coverageHistoryLimit;
+    #transactionHistoryLimit;
+    #normalizeSignatureRequest;
+    #transactionControllerStateChangeHandler;
+    #signatureControllerStateChangeHandler;
+    #started;
+    constructor(options) {
+        const { messenger, state, transactionHistoryLimit = 100, coverageHistoryLimit = 10, normalizeSignatureRequest, } = options;
+        super({
+            name: controllerName,
+            metadata,
+            messenger,
+            state: {
+                ...getDefaultShieldControllerState(),
+                ...state,
+            },
+        });
+        this.#coverageHistoryLimit = coverageHistoryLimit;
+        this.#transactionHistoryLimit = transactionHistoryLimit;
+        this.#transactionControllerStateChangeHandler =
+            this.#handleTransactionControllerStateChange.bind(this);
+        this.#signatureControllerStateChangeHandler =
+            this.#handleSignatureControllerStateChange.bind(this);
+        this.#started = false;
+        this.#normalizeSignatureRequest = normalizeSignatureRequest;
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Start the ShieldController and subscribe to the transaction and signature controller state changes.
+     */
+    start() {
+        if (this.#started) {
+            return;
+        }
+        this.#started = true;
+        this.messenger.subscribe('TransactionController:stateChange', this.#transactionControllerStateChangeHandler, (state) => state.transactions);
+        this.messenger.subscribe('SignatureController:stateChange', this.#signatureControllerStateChangeHandler, (state) => state.signatureRequests);
+    }
+    /**
+     * Stop the ShieldController and unsubscribe from the transaction and signature controller state changes.
+     */
+    stop() {
+        if (!this.#started) {
+            return;
+        }
+        this.#started = false;
+        this.messenger.unsubscribe('TransactionController:stateChange', this.#transactionControllerStateChangeHandler);
+        this.messenger.unsubscribe('SignatureController:stateChange', this.#signatureControllerStateChangeHandler);
+    }
+    /**
+     * Clears the shield state and resets to default values.
+     */
+    clearState() {
+        this.update(() => {
+            return getDefaultShieldControllerState();
+        });
+    }
+    #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.
+            if (!previousSignatureRequest) {
+                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) {
+                this.#logSignature(signatureRequest).catch(
+                // istanbul ignore next
+                (error) => log('Error logging signature:', error));
+            }
+        }
+    }
+    #handleTransactionControllerStateChange(transactions, previousTransactions) {
+        const previousTransactionsById = new Map(previousTransactions?.map((tx) => [tx.id, tx]) ?? []);
+        for (const transaction of transactions) {
+            const previousTransaction = previousTransactionsById.get(transaction.id);
+            if (
+            // We don't need to check coverage for submitted or confirmed transactions.
+            transaction.status !== TransactionStatus.submitted &&
+                transaction.status !== TransactionStatus.confirmed) {
+                // Check if the simulation data has changed.
+                const simulationDataChanged = 
+                // only check if the previous transaction has simulation data and if it has changed
+                // this is to avoid checking coverage for the `TWICE` (once when it's added to the state and once when it's simulated for the first time).
+                // we only need to update the coverage result when the simulation data has changed.
+                previousTransaction?.simulationData &&
+                    !isEqual(transaction.simulationData, previousTransaction.simulationData);
+                // Check coverage if the transaction is new or if the simulation data has
+                // changed.
+                if (!previousTransaction || simulationDataChanged) {
+                    this.checkCoverage(transaction).catch(
+                    // 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) {
+                this.#logTransaction(transaction).catch(
+                // istanbul ignore next
+                (error) => log('Error logging transaction:', error));
+            }
+        }
+    }
+    /**
+     * Checks the coverage of a transaction.
+     *
+     * @param txMeta - The transaction to check coverage for.
+     * @returns The coverage result.
+     */
+    async checkCoverage(txMeta) {
+        // Check coverage
+        const coverageId = this.#getLatestCoverageId(txMeta.id);
+        const coverageResult = await this.messenger.call('ShieldApiService:checkCoverage', {
+            txMeta,
+            coverageId,
+        });
+        // Publish coverage result
+        this.messenger.publish(`${controllerName}:coverageResultReceived`, coverageResult);
+        // Update state
+        this.#addCoverageResult(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 coverageId = this.#getLatestCoverageId(signatureRequest.id);
+        // Normalize the signature request before sending it to the backend.
+        // This is to ensure that the signature data is normalized and consistent as the security alerts api calls.
+        const clonedSignatureRequest = cloneDeep(signatureRequest);
+        const normalizedSignatureRequest = this.#normalizeSignatureRequest?.(clonedSignatureRequest) ??
+            clonedSignatureRequest;
+        const coverageResult = await this.messenger.call('ShieldApiService:checkSignatureCoverage', {
+            signatureRequest: normalizedSignatureRequest,
+            coverageId,
+        });
+        // Publish coverage result
+        this.messenger.publish(`${controllerName}:coverageResultReceived`, coverageResult);
+        // Update state
+        this.#addCoverageResult(signatureRequest.id, coverageResult);
+        return coverageResult;
+    }
+    #addCoverageResult(txId, coverageResult) {
+        // Assert the coverageId hasn't changed.
+        const latestCoverageId = this.#getLatestCoverageId(txId);
+        if (latestCoverageId && coverageResult.coverageId !== latestCoverageId) {
+            throw new Error('Coverage ID has changed');
+        }
+        this.update((draft) => {
+            // Fetch coverage result entry.
+            let newEntry = false;
+            let coverageResultEntry = draft.coverageResults[txId];
+            // Create new entry if necessary.
+            if (!coverageResultEntry) {
+                newEntry = true;
+                coverageResultEntry = {
+                    results: [],
+                };
+                draft.coverageResults[txId] = coverageResultEntry;
+            }
+            // Trim coverage history if necessary.
+            if (coverageResultEntry.results.length >= this.#coverageHistoryLimit) {
+                coverageResultEntry.results.pop();
+            }
+            // Add new result.
+            coverageResultEntry.results.unshift(coverageResult);
+            // Add to history if new entry.
+            const { orderedTransactionHistory } = draft;
+            let removedTxId;
+            if (newEntry) {
+                // Trim transaction history if necessary.
+                if (orderedTransactionHistory.length >= this.#transactionHistoryLimit) {
+                    removedTxId = orderedTransactionHistory.pop();
+                    // Delete corresponding coverage result entry.
+                    if (removedTxId) {
+                        delete draft.coverageResults[removedTxId];
+                    }
+                }
+                // Add to history.
+                orderedTransactionHistory.unshift(txId);
+            }
+        });
+    }
+    async #logSignature(signatureRequest) {
+        const signature = signatureRequest.rawSig;
+        if (!signature) {
+            throw new Error('Signature not found');
+        }
+        const { status } = this.#getCoverageShownStatus(signatureRequest.id);
+        await this.messenger.call('ShieldApiService:logSignature', {
+            signatureRequest,
+            signature,
+            status,
+        });
+    }
+    async #logTransaction(txMeta) {
+        const transactionHash = txMeta.hash;
+        if (!transactionHash) {
+            throw new Error('Transaction hash not found');
+        }
+        const rawTransactionHex = txMeta.rawTx;
+        if (!rawTransactionHex) {
+            throw new Error('Raw transaction hex not found');
+        }
+        const { status } = this.#getCoverageShownStatus(txMeta.id);
+        await this.messenger.call('ShieldApiService:logTransaction', {
+            txMeta,
+            transactionHash,
+            rawTransactionHex,
+            status,
+        });
+    }
+    /**
+     * Get the coverage shown status for a given item ID.
+     *
+     * @param itemId - The item ID to get the coverage status for.
+     * @returns The coverage status.
+     */
+    #getCoverageShownStatus(itemId) {
+        // The status is assigned as follows:
+        // - 'shown' if we have a result
+        // - 'not_shown' if we don't have a result
+        const coverageId = this.#getLatestCoverageId(itemId);
+        let status = 'shown';
+        if (!coverageId) {
+            log('Coverage ID not found for', itemId);
+            status = 'not_shown';
+        }
+        return { status };
+    }
+    #getLatestCoverageId(itemId) {
+        return this.state.coverageResults[itemId]?.results[0]?.coverageId;
+    }
+}
+//# sourceMappingURL=ShieldController.js.map

package/dist/ShieldController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShieldController.js","sourceRoot":"","sources":["../src/ShieldController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAM3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAKxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAKrE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAKhE,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AAElE,MAAM,yBAAyB,GAAG;IAChC,OAAO;IACP,MAAM;IACN,YAAY;IACZ,eAAe;IACf,wBAAwB;CAChB,CAAC;AAuBX;;;;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,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAmBF,MAAM,OAAO,gBAAiB,SAAQ,cAIrC;IACU,qBAAqB,CAAS;IAE9B,wBAAwB,CAAS;IAEjC,0BAA0B,CAA+B;IAEzD,wCAAwC,CAGvC;IAED,sCAAsC,CAGrC;IAEV,QAAQ,CAAU;IAElB,YAAY,OAAgC;QAC1C,MAAM,EACJ,SAAS,EACT,KAAK,EACL,uBAAuB,GAAG,GAAG,EAC7B,oBAAoB,GAAG,EAAE,EACzB,yBAAyB,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;QAEH,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;QAClD,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,wCAAwC;YAC3C,IAAI,CAAC,uCAAuC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,sCAAsC;YACzC,IAAI,CAAC,qCAAqC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,0BAA0B,GAAG,yBAAyB,CAAC;QAE5D,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,mCAAmC,EACnC,IAAI,CAAC,wCAAwC,EAC7C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,iCAAiC,EACjC,IAAI,CAAC,sCAAsC,EAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAEtB,IAAI,CAAC,SAAS,CAAC,WAAW,CACxB,mCAAmC,EACnC,IAAI,CAAC,wCAAwC,CAC9C,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,WAAW,CACxB,iCAAiC,EACjC,IAAI,CAAC,sCAAsC,CAC5C,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,OAAO,+BAA+B,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC,CACnC,iBAAmD,EACnD,yBAAuE;QAEvE,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QAChE,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAClD,yBAAyB,IAAI,EAAE,CAChC,CAAC;QACF,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;QACF,KAAK,MAAM,gBAAgB,IAAI,sBAAsB,EAAE,CAAC;YACtD,MAAM,wBAAwB,GAAG,6BAA6B,CAAC,GAAG,CAChE,gBAAgB,CAAC,EAAE,CACpB,CAAC;YAEF,kDAAkD;YAClD,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAC9B,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC,KAAK;gBACjD,uBAAuB;gBACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;YACJ,CAAC;YAED,+DAA+D;YAC/D,IACE,gBAAgB,CAAC,MAAM,KAAK,sBAAsB,CAAC,MAAM;gBACzD,gBAAgB,CAAC,MAAM,KAAK,wBAAwB,EAAE,MAAM,EAC5D,CAAC;gBACD,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,KAAK;gBACxC,uBAAuB;gBACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,uCAAuC,CACrC,YAA+B,EAC/B,oBAAmD;QAEnD,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;QACF,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,MAAM,mBAAmB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAEzE;YACE,2EAA2E;YAC3E,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,SAAS;gBAClD,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,SAAS,EAClD,CAAC;gBACD,4CAA4C;gBAC5C,MAAM,qBAAqB;gBACzB,mFAAmF;gBACnF,0IAA0I;gBAC1I,mFAAmF;gBACnF,mBAAmB,EAAE,cAAc;oBACnC,CAAC,OAAO,CACN,WAAW,CAAC,cAAc,EAC1B,mBAAmB,CAAC,cAAc,CACnC,CAAC;gBAEJ,yEAAyE;gBACzE,WAAW;gBACX,IAAI,CAAC,mBAAmB,IAAI,qBAAqB,EAAE,CAAC;oBAClD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,KAAK;oBACnC,uBAAuB;oBACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAClD,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,8CAA8C;YAC9C,IACE,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,SAAS;gBAClD,WAAW,CAAC,MAAM,KAAK,mBAAmB,EAAE,MAAM,EAClD,CAAC;gBACD,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,KAAK;gBACrC,uBAAuB;gBACvB,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CACpD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,MAAuB;QACzC,iBAAiB;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,gCAAgC,EAChC;YACE,MAAM;YACN,UAAU;SACX,CACF,CAAC;QAEF,0BAA0B;QAC1B,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,IAAI,CAAC,kBAAkB,CAAC,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,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAElE,oEAAoE;QACpE,2GAA2G;QAC3G,MAAM,sBAAsB,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC3D,MAAM,0BAA0B,GAC9B,IAAI,CAAC,0BAA0B,EAAE,CAAC,sBAAsB,CAAC;YACzD,sBAAsB,CAAC;QACzB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,yCAAyC,EACzC;YACE,gBAAgB,EAAE,0BAA0B;YAC5C,UAAU;SACX,CACF,CAAC;QAEF,0BAA0B;QAC1B,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,cAAc,yBAAyB,EAC1C,cAAc,CACf,CAAC;QAEF,eAAe;QACf,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,kBAAkB,CAAC,IAAY,EAAE,cAA8B;QAC7D,wCAAwC;QACxC,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,gBAAgB,IAAI,cAAc,CAAC,UAAU,KAAK,gBAAgB,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,+BAA+B;YAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,IAAI,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAEtD,iCAAiC;YACjC,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,QAAQ,GAAG,IAAI,CAAC;gBAChB,mBAAmB,GAAG;oBACpB,OAAO,EAAE,EAAE;iBACZ,CAAC;gBACF,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC;YACpD,CAAC;YAED,sCAAsC;YACtC,IAAI,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBACrE,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACpC,CAAC;YAED,kBAAkB;YAClB,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAEpD,+BAA+B;YAC/B,MAAM,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;YAC5C,IAAI,WAA+B,CAAC;YACpC,IAAI,QAAQ,EAAE,CAAC;gBACb,yCAAyC;gBACzC,IAAI,yBAAyB,CAAC,MAAM,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;oBACtE,WAAW,GAAG,yBAAyB,CAAC,GAAG,EAAE,CAAC;oBAC9C,8CAA8C;oBAC9C,IAAI,WAAW,EAAE,CAAC;wBAChB,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;oBAC5C,CAAC;gBACH,CAAC;gBACD,kBAAkB;gBAClB,yBAAyB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,gBAAkC;QACpD,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAErE,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,+BAA+B,EAAE;YACzD,gBAAgB;YAChB,SAAS;YACT,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,MAAuB;QAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;QACpC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC;QACvC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAE3D,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAC3D,MAAM;YACN,eAAe;YACf,iBAAiB;YACjB,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,uBAAuB,CAAC,MAAc;QACpC,qCAAqC;QACrC,gCAAgC;QAChC,0CAA0C;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,MAAM,GAAG,OAAO,CAAC;QACrB,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;YACzC,MAAM,GAAG,WAAW,CAAC;QACvB,CAAC;QACD,OAAO,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC;IAED,oBAAoB,CAAC,MAAc;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;IACpE,CAAC;CACF","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { SignatureRequestStatus } from '@metamask/signature-controller';\nimport type {\n  SignatureRequest,\n  SignatureStateChange,\n} from '@metamask/signature-controller';\nimport { TransactionStatus } from '@metamask/transaction-controller';\nimport type {\n  TransactionControllerStateChangeEvent,\n  TransactionMeta,\n} from '@metamask/transaction-controller';\nimport { cloneDeep, isEqual } from 'lodash-es';\n\nimport { controllerName } from './constants.js';\nimport { projectLogger, createModuleLogger } from './logger.js';\nimport type { ShieldApiServiceMethodActions } from './shield-api-service-method-action-types.js';\nimport type { ShieldControllerMethodActions } from './ShieldController-method-action-types.js';\nimport type { CoverageResult, NormalizeSignatureRequestFn } from './types.js';\n\nconst log = createModuleLogger(projectLogger, 'ShieldController');\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'start',\n  'stop',\n  'clearState',\n  'checkCoverage',\n  'checkSignatureCoverage',\n] as const;\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 ShieldControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ShieldControllerState\n>;\n\n/**\n * The internal actions available to the ShieldController.\n */\nexport type ShieldControllerActions =\n  | ShieldControllerGetStateAction\n  | ShieldControllerMethodActions;\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 = ShieldApiServiceMethodActions;\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 = Messenger<\n  typeof controllerName,\n  ShieldControllerActions | AllowedActions,\n  ShieldControllerEvents | AllowedEvents\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    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n  orderedTransactionHistory: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: false,\n  },\n};\n\nexport type ShieldControllerOptions = {\n  messenger: ShieldControllerMessenger;\n  state?: Partial<ShieldControllerState>;\n  transactionHistoryLimit?: number;\n  coverageHistoryLimit?: number;\n  /**\n   * Normalize the signature request before sending it to the backend.\n   * Please note that the reason this is not being done internally is to\n   * align the request body (data & params) with the security-alerts API.\n   * The same normalization function which is used to normalize security-alerts request should be used here.\n   *\n   * @param signatureRequest - The signature request to normalize.\n   * @returns The normalized signature request.\n   */\n  normalizeSignatureRequest?: NormalizeSignatureRequestFn;\n};\n\nexport class ShieldController extends BaseController<\n  typeof controllerName,\n  ShieldControllerState,\n  ShieldControllerMessenger\n> {\n  readonly #coverageHistoryLimit: number;\n\n  readonly #transactionHistoryLimit: number;\n\n  readonly #normalizeSignatureRequest?: NormalizeSignatureRequestFn;\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  #started: boolean;\n\n  constructor(options: ShieldControllerOptions) {\n    const {\n      messenger,\n      state,\n      transactionHistoryLimit = 100,\n      coverageHistoryLimit = 10,\n      normalizeSignatureRequest,\n    } = options;\n    super({\n      name: controllerName,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultShieldControllerState(),\n        ...state,\n      },\n    });\n\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    this.#started = false;\n    this.#normalizeSignatureRequest = normalizeSignatureRequest;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Start the ShieldController and subscribe to the transaction and signature controller state changes.\n   */\n  start(): void {\n    if (this.#started) {\n      return;\n    }\n    this.#started = true;\n\n    this.messenger.subscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n      (state) => state.transactions,\n    );\n\n    this.messenger.subscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n      (state) => state.signatureRequests,\n    );\n  }\n\n  /**\n   * Stop the ShieldController and unsubscribe from the transaction and signature controller state changes.\n   */\n  stop(): void {\n    if (!this.#started) {\n      return;\n    }\n    this.#started = false;\n\n    this.messenger.unsubscribe(\n      'TransactionController:stateChange',\n      this.#transactionControllerStateChangeHandler,\n    );\n\n    this.messenger.unsubscribe(\n      'SignatureController:stateChange',\n      this.#signatureControllerStateChangeHandler,\n    );\n  }\n\n  /**\n   * Clears the shield state and resets to default values.\n   */\n  clearState(): void {\n    this.update(() => {\n      return getDefaultShieldControllerState();\n    });\n  }\n\n  #handleSignatureControllerStateChange(\n    signatureRequests: Record<string, SignatureRequest>,\n    previousSignatureRequests: Record<string, SignatureRequest> | undefined,\n  ): void {\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.\n      if (!previousSignatureRequest) {\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  ): void {\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      if (\n        // We don't need to check coverage for submitted or confirmed transactions.\n        transaction.status !== TransactionStatus.submitted &&\n        transaction.status !== TransactionStatus.confirmed\n      ) {\n        // Check if the simulation data has changed.\n        const simulationDataChanged =\n          // only check if the previous transaction has simulation data and if it has changed\n          // this is to avoid checking coverage for the `TWICE` (once when it's added to the state and once when it's simulated for the first time).\n          // we only need to update the coverage result when the simulation data has changed.\n          previousTransaction?.simulationData &&\n          !isEqual(\n            transaction.simulationData,\n            previousTransaction.simulationData,\n          );\n\n        // Check coverage if the transaction is new or if the simulation data has\n        // changed.\n        if (!previousTransaction || simulationDataChanged) {\n          this.checkCoverage(transaction).catch(\n            // istanbul ignore next\n            (error) => log('Error checking coverage:', error),\n          );\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 coverageId = this.#getLatestCoverageId(txMeta.id);\n    const coverageResult = await this.messenger.call(\n      'ShieldApiService:checkCoverage',\n      {\n        txMeta,\n        coverageId,\n      },\n    );\n\n    // Publish coverage result\n    this.messenger.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 coverageId = this.#getLatestCoverageId(signatureRequest.id);\n\n    // Normalize the signature request before sending it to the backend.\n    // This is to ensure that the signature data is normalized and consistent as the security alerts api calls.\n    const clonedSignatureRequest = cloneDeep(signatureRequest);\n    const normalizedSignatureRequest =\n      this.#normalizeSignatureRequest?.(clonedSignatureRequest) ??\n      clonedSignatureRequest;\n    const coverageResult = await this.messenger.call(\n      'ShieldApiService:checkSignatureCoverage',\n      {\n        signatureRequest: normalizedSignatureRequest,\n        coverageId,\n      },\n    );\n\n    // Publish coverage result\n    this.messenger.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): void {\n    // Assert the coverageId hasn't changed.\n    const latestCoverageId = this.#getLatestCoverageId(txId);\n    if (latestCoverageId && coverageResult.coverageId !== latestCoverageId) {\n      throw new Error('Coverage ID has changed');\n    }\n\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): Promise<void> {\n    const signature = signatureRequest.rawSig;\n    if (!signature) {\n      throw new Error('Signature not found');\n    }\n\n    const { status } = this.#getCoverageShownStatus(signatureRequest.id);\n\n    await this.messenger.call('ShieldApiService:logSignature', {\n      signatureRequest,\n      signature,\n      status,\n    });\n  }\n\n  async #logTransaction(txMeta: TransactionMeta): Promise<void> {\n    const transactionHash = txMeta.hash;\n    if (!transactionHash) {\n      throw new Error('Transaction hash not found');\n    }\n\n    const rawTransactionHex = txMeta.rawTx;\n    if (!rawTransactionHex) {\n      throw new Error('Raw transaction hex not found');\n    }\n\n    const { status } = this.#getCoverageShownStatus(txMeta.id);\n\n    await this.messenger.call('ShieldApiService:logTransaction', {\n      txMeta,\n      transactionHash,\n      rawTransactionHex,\n      status,\n    });\n  }\n\n  /**\n   * Get the coverage shown status for a given item ID.\n   *\n   * @param itemId - The item ID to get the coverage status for.\n   * @returns The coverage status.\n   */\n  #getCoverageShownStatus(itemId: string): { status: string } {\n    // The status is assigned as follows:\n    // - 'shown' if we have a result\n    // - 'not_shown' if we don't have a result\n    const coverageId = this.#getLatestCoverageId(itemId);\n    let status = 'shown';\n    if (!coverageId) {\n      log('Coverage ID not found for', itemId);\n      status = 'not_shown';\n    }\n    return { status };\n  }\n\n  #getLatestCoverageId(itemId: string): string | undefined {\n    return this.state.coverageResults[itemId]?.results[0]?.coverageId;\n  }\n}\n"]}

package/dist/{constants.d.cts → constants.d.ts}

@@ -32,4 +32,4 @@ export declare enum SignTypedDataVersion {
     V3 = "V3",
     V4 = "V4"
 }
-//# sourceMappingURL=constants.d.cts.map
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,cAAc,qBAAqB,CAAC;AAEjD;;GAEG;AACH,oBAAY,GAAG;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,CAIlD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAMpD;AAED;;;;GAIG;AACH,oBAAY,oBAAoB;IAC9B,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;CACV"}

package/dist/{constants.mjs → constants.js}

@@ -44,4 +44,4 @@ export var SignTypedDataVersion;
     SignTypedDataVersion["V3"] = "V3";
     SignTypedDataVersion["V4"] = "V4";
 })(SignTypedDataVersion || (SignTypedDataVersion = {}));
-//# sourceMappingURL=constants.mjs.map
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAN,IAAY,GAIX;AAJD,WAAY,GAAG;IACb,kBAAW,CAAA;IACX,kBAAW,CAAA;IACX,kBAAW,CAAA;AACb,CAAC,EAJW,GAAG,KAAH,GAAG,QAId;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAwB;IACrD,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,+CAA+C;IAC1D,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,+CAA+C;IAC1D,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,2CAA2C;CACvD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IAC1C,MAAM,OAAO,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,iCAAS,CAAA;IACT,iCAAS,CAAA;IACT,iCAAS,CAAA;AACX,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B","sourcesContent":["/**\n * The name of the {@link ShieldController}.\n */\nexport const controllerName = 'ShieldController';\n\n/**\n * The environment for the shield backend API.\n */\nexport enum Env {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prd',\n}\n\n/**\n * The shield backend API URL for each environment.\n */\nexport const SHIELD_API_URL_MAP: Record<Env, string> = {\n  [Env.DEV]: 'https://ruleset-engine.dev-api.cx.metamask.io',\n  [Env.UAT]: 'https://ruleset-engine.uat-api.cx.metamask.io',\n  [Env.PRD]: 'https://ruleset-engine.api.cx.metamask.io',\n};\n\n/**\n * Get the shield backend API URL for the given environment.\n *\n * @param env - The environment.\n * @returns The base URL for the given environment.\n * @throws If the environment is invalid.\n */\nexport function getShieldApiBaseUrl(env: Env): string {\n  const baseUrl = SHIELD_API_URL_MAP[env];\n  if (!baseUrl) {\n    throw new Error('invalid environment configuration');\n  }\n  return baseUrl;\n}\n\n/**\n * The `signTypedMessage` version\n *\n * @see https://docs.metamask.io/guide/signing-data.html\n */\nexport enum SignTypedDataVersion {\n  V1 = 'V1',\n  V3 = 'V3',\n  V4 = 'V4',\n}\n"]}

package/dist/{index.d.cts → index.d.ts}

@@ -1,9 +1,9 @@
-export type { CoverageStatus, LogSignatureRequest, LogTransactionRequest, NormalizeSignatureRequestFn, CheckCoverageRequest, CheckSignatureCoverageRequest, CoverageResult, } from "./types.cjs";
-export type { ShieldControllerActions, ShieldControllerEvents, ShieldControllerMessenger, ShieldControllerState, ShieldControllerGetStateAction, ShieldControllerCoverageResultReceivedEvent, ShieldControllerStateChangeEvent, } from "./ShieldController.cjs";
-export type { ShieldControllerStartAction, ShieldControllerStopAction, ShieldControllerClearStateAction, ShieldControllerCheckCoverageAction, ShieldControllerCheckSignatureCoverageAction, } from "./ShieldController-method-action-types.cjs";
-export { ShieldController, getDefaultShieldControllerState, } from "./ShieldController.cjs";
-export { ShieldApiService, serviceName, makeInitCoverageCheckBody, parseSignatureRequestMethod, } from "./shield-api-service.cjs";
-export type { ShieldApiServiceMessenger, ShieldApiServiceActions, ShieldApiServiceEvents, ShieldApiServiceInvalidateQueriesAction, ShieldApiServiceCacheUpdatedEvent, ShieldApiServiceGranularCacheUpdatedEvent, } from "./shield-api-service.cjs";
-export type { ShieldApiServiceCheckCoverageAction, ShieldApiServiceCheckSignatureCoverageAction, ShieldApiServiceLogSignatureAction, ShieldApiServiceLogTransactionAction, } from "./shield-api-service-method-action-types.cjs";
-export { Env, SHIELD_API_URL_MAP, getShieldApiBaseUrl } from "./constants.cjs";
-//# sourceMappingURL=index.d.cts.map
+export type { CoverageStatus, LogSignatureRequest, LogTransactionRequest, NormalizeSignatureRequestFn, CheckCoverageRequest, CheckSignatureCoverageRequest, CoverageResult, } from './types.js';
+export type { ShieldControllerActions, ShieldControllerEvents, ShieldControllerMessenger, ShieldControllerState, ShieldControllerGetStateAction, ShieldControllerCoverageResultReceivedEvent, ShieldControllerStateChangeEvent, } from './ShieldController.js';
+export type { ShieldControllerStartAction, ShieldControllerStopAction, ShieldControllerClearStateAction, ShieldControllerCheckCoverageAction, ShieldControllerCheckSignatureCoverageAction, } from './ShieldController-method-action-types.js';
+export { ShieldController, getDefaultShieldControllerState, } from './ShieldController.js';
+export { ShieldApiService, serviceName, makeInitCoverageCheckBody, parseSignatureRequestMethod, } from './shield-api-service.js';
+export type { ShieldApiServiceMessenger, ShieldApiServiceActions, ShieldApiServiceEvents, ShieldApiServiceInvalidateQueriesAction, ShieldApiServiceCacheUpdatedEvent, ShieldApiServiceGranularCacheUpdatedEvent, } from './shield-api-service.js';
+export type { ShieldApiServiceCheckCoverageAction, ShieldApiServiceCheckSignatureCoverageAction, ShieldApiServiceLogSignatureAction, ShieldApiServiceLogTransactionAction, } from './shield-api-service-method-action-types.js';
+export { Env, SHIELD_API_URL_MAP, getShieldApiBaseUrl } from './constants.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC3B,oBAAoB,EACpB,6BAA6B,EAC7B,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,EACrB,8BAA8B,EAC9B,2CAA2C,EAC3C,gCAAgC,GACjC,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,gCAAgC,EAChC,mCAAmC,EACnC,4CAA4C,GAC7C,MAAM,2CAA2C,CAAC;AACnD,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,yBAAyB,EACzB,uBAAuB,EACvB,sBAAsB,EACtB,uCAAuC,EACvC,iCAAiC,EACjC,yCAAyC,GAC1C,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,mCAAmC,EACnC,4CAA4C,EAC5C,kCAAkC,EAClC,oCAAoC,GACrC,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,GAAG,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { ShieldController, getDefaultShieldControllerState, } from './ShieldController.js';
+export { ShieldApiService, serviceName, makeInitCoverageCheckBody, parseSignatureRequestMethod, } from './shield-api-service.js';
+export { Env, SHIELD_API_URL_MAP, getShieldApiBaseUrl } from './constants.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,OAAO,EACL,gBAAgB,EAChB,+BAA+B,GAChC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,yBAAyB,CAAC;AAejC,OAAO,EAAE,GAAG,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["export type {\n  CoverageStatus,\n  LogSignatureRequest,\n  LogTransactionRequest,\n  NormalizeSignatureRequestFn,\n  CheckCoverageRequest,\n  CheckSignatureCoverageRequest,\n  CoverageResult,\n} from './types.js';\nexport type {\n  ShieldControllerActions,\n  ShieldControllerEvents,\n  ShieldControllerMessenger,\n  ShieldControllerState,\n  ShieldControllerGetStateAction,\n  ShieldControllerCoverageResultReceivedEvent,\n  ShieldControllerStateChangeEvent,\n} from './ShieldController.js';\nexport type {\n  ShieldControllerStartAction,\n  ShieldControllerStopAction,\n  ShieldControllerClearStateAction,\n  ShieldControllerCheckCoverageAction,\n  ShieldControllerCheckSignatureCoverageAction,\n} from './ShieldController-method-action-types.js';\nexport {\n  ShieldController,\n  getDefaultShieldControllerState,\n} from './ShieldController.js';\nexport {\n  ShieldApiService,\n  serviceName,\n  makeInitCoverageCheckBody,\n  parseSignatureRequestMethod,\n} from './shield-api-service.js';\nexport type {\n  ShieldApiServiceMessenger,\n  ShieldApiServiceActions,\n  ShieldApiServiceEvents,\n  ShieldApiServiceInvalidateQueriesAction,\n  ShieldApiServiceCacheUpdatedEvent,\n  ShieldApiServiceGranularCacheUpdatedEvent,\n} from './shield-api-service.js';\nexport type {\n  ShieldApiServiceCheckCoverageAction,\n  ShieldApiServiceCheckSignatureCoverageAction,\n  ShieldApiServiceLogSignatureAction,\n  ShieldApiServiceLogTransactionAction,\n} from './shield-api-service-method-action-types.js';\nexport { Env, SHIELD_API_URL_MAP, getShieldApiBaseUrl } from './constants.js';\n"]}

package/dist/logger.d.ts

@@ -0,0 +1,4 @@
+import { createModuleLogger } from '@metamask/utils';
+export declare const projectLogger: import("debug").Debugger;
+export { createModuleLogger };
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAI1E,eAAO,MAAM,aAAa,0BAAsC,CAAC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/logger.js

@@ -0,0 +1,5 @@
+import { createProjectLogger, createModuleLogger } from '@metamask/utils';
+import { controllerName } from './constants.js';
+export const projectLogger = createProjectLogger(controllerName);
+export { createModuleLogger };
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1E,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;AAEjE,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nimport { controllerName } from './constants.js';\n\nexport const projectLogger = createProjectLogger(controllerName);\n\nexport { createModuleLogger };\n"]}

package/dist/{polling-with-policy.d.cts → polling-with-policy.d.ts}

@@ -1,4 +1,4 @@
-import type { CreateServicePolicyOptions } from "@metamask/controller-utils";
+import type { CreateServicePolicyOptions } from '@metamask/controller-utils';
 export type RequestFn<ReturnType> = (signal: AbortSignal) => Promise<ReturnType>;
 export declare class PollingWithCockatielPolicy {
     #private;
@@ -6,4 +6,4 @@ export declare class PollingWithCockatielPolicy {
     start<ReturnType>(requestId: string, requestFn: RequestFn<ReturnType>): Promise<ReturnType>;
     abortPendingRequest(requestId: string): void;
 }
-//# sourceMappingURL=polling-with-policy.d.cts.map
+//# sourceMappingURL=polling-with-policy.d.ts.map

package/dist/polling-with-policy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling-with-policy.d.ts","sourceRoot":"","sources":["../src/polling-with-policy.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,0BAA0B,EAE3B,MAAM,4BAA4B,CAAC;AAGpC,MAAM,MAAM,SAAS,CAAC,UAAU,IAAI,CAClC,MAAM,EAAE,WAAW,KAChB,OAAO,CAAC,UAAU,CAAC,CAAC;AAEzB,qBAAa,0BAA0B;;IAKrC,YAAY,aAAa,GAAE,0BAA+B,EAOzD;IAEK,KAAK,CAAC,UAAU,EACpB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,GAC/B,OAAO,CAAC,UAAU,CAAC,CAqBrB;IAED,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAI3C;CAwBF"}

package/dist/polling-with-policy.js

@@ -0,0 +1,62 @@
+import { createServicePolicy, HttpError } from '@metamask/controller-utils';
+import { handleWhen } from 'cockatiel';
+export class PollingWithCockatielPolicy {
+    #policy;
+    #requestEntry = new Map();
+    constructor(policyOptions = {}) {
+        const shouldRetryFunc = this.#shouldRetry.bind(this);
+        const retryFilterPolicy = handleWhen(shouldRetryFunc);
+        this.#policy = createServicePolicy({
+            ...policyOptions,
+            retryFilterPolicy,
+        });
+    }
+    async start(requestId, requestFn) {
+        const abortController = this.#addNewRequestEntry(requestId);
+        try {
+            const result = await this.#policy.execute(async ({ signal }) => {
+                return requestFn(signal);
+            }, abortController.signal);
+            return result;
+        }
+        catch (error) {
+            if (abortController.signal.aborted) {
+                throw new Error('Request cancelled');
+            }
+            throw error;
+        }
+        finally {
+            // Only cleanup if this abort controller is still active. If a new request with the same
+            // requestId started while this one was running, it would have replaced with a new abort controller.
+            // We must not delete the new request's controller when this older request finishes.
+            if (abortController === this.#requestEntry.get(requestId)) {
+                this.#cleanup(requestId);
+            }
+        }
+    }
+    abortPendingRequest(requestId) {
+        const abortController = this.#requestEntry.get(requestId);
+        abortController?.abort();
+        this.#cleanup(requestId);
+    }
+    #addNewRequestEntry(requestId) {
+        // abort the previous request if it exists
+        this.abortPendingRequest(requestId);
+        // create a new abort controller for the new request
+        const abortController = new AbortController();
+        this.#requestEntry.set(requestId, abortController);
+        return abortController;
+    }
+    #cleanup(requestId) {
+        this.#requestEntry.delete(requestId);
+    }
+    #shouldRetry(error) {
+        if (error instanceof HttpError) {
+            // Note: we don't retry on 5xx errors, only on 4xx errors.
+            // but we won't retry on 400 coz it means that the request body is invalid.
+            return error.httpStatus > 400 && error.httpStatus < 500;
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=polling-with-policy.js.map