@metamask/shield-controller 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -7,11 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.1]
+
+### Fixed
+
+- Added missing exports and improved documentation ([#6412](https://github.com/MetaMask/core/pull/6412))
+
 ## [0.1.0]
 
 ### Added
 
 - 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.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/shield-controller@0.1.1...HEAD
+[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.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;AAclE;;;;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  results: CoverageResult[]; // history of coverage results, latest first\n};\n\nexport type ShieldControllerState = {\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  orderedTransactionHistory: string[]; // List of txIds ordered by time, latest first\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;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"]}

package/dist/ShieldController.d.cts

@@ -4,11 +4,20 @@ import type { TransactionControllerStateChangeEvent, TransactionMeta } from "@me
 import { controllerName } from "./constants.cjs";
 import type { CoverageResult, ShieldBackend } from "./types.cjs";
 export type CoverageResultRecordEntry = {
+    /**
+     * History of coverage results, latest first.
+     */
     results: CoverageResult[];
 };
 export type ShieldControllerState = {
+    /**
+     * Coverage results by transaction ID.
+     */
     coverageResults: Record<string, // txId
     CoverageResultRecordEntry>;
+    /**
+     * List of txIds ordered by time, latest first.
+     */
     orderedTransactionHistory: string[];
 };
 /**

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,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF,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,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"}

package/dist/ShieldController.d.mts

@@ -4,11 +4,20 @@ import type { TransactionControllerStateChangeEvent, TransactionMeta } from "@me
 import { controllerName } from "./constants.mjs";
 import type { CoverageResult, ShieldBackend } from "./types.mjs";
 export type CoverageResultRecordEntry = {
+    /**
+     * History of coverage results, latest first.
+     */
     results: CoverageResult[];
 };
 export type ShieldControllerState = {
+    /**
+     * Coverage results by transaction ID.
+     */
     coverageResults: Record<string, // txId
     CoverageResultRecordEntry>;
+    /**
+     * List of txIds ordered by time, latest first.
+     */
     orderedTransactionHistory: string[];
 };
 /**

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,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,eAAe,EAAE,MAAM,CACrB,MAAM,EAAE,OAAO;IACf,yBAAyB,CAC1B,CAAC;IACF,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,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"}

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;AAclE;;;;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  results: CoverageResult[]; // history of coverage results, latest first\n};\n\nexport type ShieldControllerState = {\n  coverageResults: Record<\n    string, // txId\n    CoverageResultRecordEntry\n  >;\n  orderedTransactionHistory: string[]; // List of txIds ordered by time, latest first\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;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"]}

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultShieldControllerState = exports.ShieldController = void 0;
+exports.ShieldRemoteBackend = exports.getDefaultShieldControllerState = exports.ShieldController = void 0;
 var ShieldController_1 = require("./ShieldController.cjs");
 Object.defineProperty(exports, "ShieldController", { enumerable: true, get: function () { return ShieldController_1.ShieldController; } });
 Object.defineProperty(exports, "getDefaultShieldControllerState", { enumerable: true, get: function () { return ShieldController_1.getDefaultShieldControllerState; } });
+var backend_1 = require("./backend.cjs");
+Object.defineProperty(exports, "ShieldRemoteBackend", { enumerable: true, get: function () { return backend_1.ShieldRemoteBackend; } });
 //# sourceMappingURL=index.cjs.map

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","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';\n"]}
+{"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"]}

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 export type { CoverageStatus } 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";
 //# sourceMappingURL=index.d.cts.map

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"}
+{"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"}

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 export type { CoverageStatus } 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";
 //# sourceMappingURL=index.d.mts.map

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"}
+{"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"}

package/dist/index.mjs

@@ -1,2 +1,3 @@
 export { ShieldController, getDefaultShieldControllerState } from "./ShieldController.mjs";
+export { ShieldRemoteBackend } from "./backend.mjs";
 //# sourceMappingURL=index.mjs.map

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","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';\n"]}
+{"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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/shield-controller",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Controller handling shield transaction coverage logic",
   "keywords": [
     "MetaMask",