@metamask/snaps-controllers 3.2.0 → 3.4.0

package/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.4.0]
+### Changed
+- Use `SubtleCrypto` for checksum calculation if available ([#1953](https://github.com/MetaMask/snaps/pull/1953))
+  - This reduces the time of the checksum calculation by up to 95% in some
+    environments.
+- Use `@metamask/snaps-sdk` package ([#1930](https://github.com/MetaMask/snaps/pull/1930), [#1949](https://github.com/MetaMask/snaps/pull/1949))
+  - This package replaces the `@metamask/snaps-types` and
+  - `@metamask/snaps-ui` packages.
+
+### Fixed
+- Fix support for transaction insight Snaps returning `null` ([#1952](https://github.com/MetaMask/snaps/pull/1952))
+
+## [3.3.0]
+### Added
+- Add manifest localization functionality ([#1889](https://github.com/MetaMask/snaps/pull/1889))
+- Add support for unencrypted storage using `snap_manageState` ([#1902](https://github.com/MetaMask/snaps/pull/1902))
+- Add `OnHomePage` export ([#1896](https://github.com/MetaMask/snaps/pull/1896))
+
 ## [3.2.0]
 ### Added
 - Add support for links in custom UI and notifications ([#1814](https://github.com/MetaMask/snaps/pull/1814))
@@ -101,7 +119,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.4.0...HEAD
+[3.4.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.3.0...@metamask/snaps-controllers@3.4.0
+[3.3.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.2.0...@metamask/snaps-controllers@3.3.0
 [3.2.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.1.1...@metamask/snaps-controllers@3.2.0
 [3.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.1.0...@metamask/snaps-controllers@3.1.1
 [3.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.0.0...@metamask/snaps-controllers@3.1.0

package/dist/cjs/cronjob/CronjobController.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/cronjob/CronjobController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 as BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport type {\n  SnapId,\n  ValidatedSnapId,\n  TruncatedSnap,\n  CronjobSpecification,\n} from '@metamask/snaps-utils';\nimport {\n  HandlerType,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n  GetAllSnaps,\n  HandleSnapRequest,\n  SnapDisabled,\n  SnapEnabled,\n  SnapInstalled,\n  SnapRemoved,\n  SnapUpdated,\n} from '..';\nimport { getRunnableSnaps, SnapEndowments } from '..';\nimport { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents =\n  | SnapInstalled\n  | SnapRemoved\n  | SnapUpdated\n  | SnapEnabled\n  | SnapDisabled;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  'CronjobController',\n  CronjobControllerActions,\n  CronjobControllerEvents,\n  CronjobControllerActions['type'],\n  CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n  messenger: CronjobControllerMessenger;\n  /**\n   * Persisted state that will be used for rehydration.\n   */\n  state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n  timer?: Timer;\n  id: string;\n  snapId: ValidatedSnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n  lastRun: number;\n};\n\nexport type CronjobControllerState = {\n  jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n  typeof controllerName,\n  CronjobControllerState,\n  CronjobControllerMessenger\n> {\n  #messenger: CronjobControllerMessenger;\n\n  #dailyTimer!: Timer;\n\n  #timers: Map<string, Timer>;\n\n  // Mapping from jobId to snapId\n  #snapIds: Map<string, string>;\n\n  constructor({ messenger, state }: CronjobControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        jobs: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        jobs: {},\n        ...state,\n      },\n    });\n    this.#timers = new Map();\n    this.#snapIds = new Map();\n    this.#messenger = messenger;\n\n    this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);\n    this._handleSnapUnregisterEvent =\n      this._handleSnapUnregisterEvent.bind(this);\n    this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n    // Subscribe to Snap events\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.subscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapRemoved',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.dailyCheckIn().catch((error) => {\n      logError(error);\n    });\n  }\n\n  /**\n   * Retrieve all cronjob specifications for all runnable snaps.\n   *\n   * @returns Array of Cronjob specifications.\n   */\n  private getAllJobs(): Cronjob[] {\n    const snaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(snaps);\n\n    const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n  }\n\n  /**\n   * Retrieve all Cronjob specifications for a Snap.\n   *\n   * @param snapId - ID of a Snap.\n   * @returns Array of Cronjob specifications.\n   */\n  private getSnapJobs(snapId: ValidatedSnapId): Cronjob[] | undefined {\n    const permissions = this.#messenger.call(\n      'PermissionController:getPermissions',\n      snapId,\n    );\n\n    const permission = permissions?.[SnapEndowments.Cronjob];\n    const definitions = getCronjobCaveatJobs(permission);\n\n    return definitions?.map((definition, idx) => {\n      return { ...definition, id: `${snapId}-${idx}`, snapId };\n    });\n  }\n\n  /**\n   * Register cron jobs for a given snap by getting specification from a permission caveats.\n   * Once registered, each job will be scheduled.\n   *\n   * @param snapId - ID of a snap.\n   */\n  register(snapId: ValidatedSnapId) {\n    const jobs = this.getSnapJobs(snapId);\n    jobs?.forEach((job) => this.schedule(job));\n  }\n\n  /**\n   * Schedule a new job.\n   * This will interpret the cron expression and tell the timer to execute the job\n   * at the next suitable point in time.\n   * Job last run state will be initialized afterwards.\n   *\n   * Note: Schedule will be skipped if the job's execution time is too far in the future and\n   * will be revisited on a daily check.\n   *\n   * @param job - Cronjob specification.\n   */\n  private schedule(job: Cronjob) {\n    if (this.#timers.has(job.id)) {\n      return;\n    }\n\n    const parsed = parseCronExpression(job.expression);\n    const next = parsed.next();\n    const now = new Date();\n    const ms = next.getTime() - now.getTime();\n\n    // Don't schedule this job yet as it is too far in the future\n    if (ms > DAILY_TIMEOUT) {\n      return;\n    }\n\n    const timer = new Timer(ms);\n    timer.start(() => {\n      this.executeCronjob(job).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n\n      this.#timers.delete(job.id);\n      this.schedule(job);\n    });\n\n    if (!this.state.jobs[job.id]?.lastRun) {\n      this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n    }\n\n    this.#timers.set(job.id, timer);\n    this.#snapIds.set(job.id, job.snapId);\n  }\n\n  /**\n   * Execute job.\n   *\n   * @param job - Cronjob specification.\n   */\n  private async executeCronjob(job: Cronjob) {\n    this.updateJobLastRunState(job.id, Date.now());\n    await this.#messenger.call('SnapController:handleRequest', {\n      snapId: job.snapId,\n      origin: '',\n      handler: HandlerType.OnCronjob,\n      request: job.request,\n    });\n  }\n\n  /**\n   * Unregister all jobs related to the given snapId.\n   *\n   * @param snapId - ID of a snap.\n   */\n  unregister(snapId: SnapId) {\n    const jobs = [...this.#snapIds.entries()].filter(\n      ([_, jobSnapId]) => jobSnapId === snapId,\n    );\n\n    if (jobs.length) {\n      jobs.forEach(([id]) => {\n        const timer = this.#timers.get(id);\n        if (timer) {\n          timer.cancel();\n          this.#timers.delete(id);\n          this.#snapIds.delete(id);\n        }\n      });\n    }\n  }\n\n  /**\n   * Update time of a last run for the Cronjob specified by ID.\n   *\n   * @param jobId - ID of a cron job.\n   * @param lastRun - Unix timestamp when the job was last ran.\n   */\n  private updateJobLastRunState(jobId: string, lastRun: number) {\n    this.update((state) => {\n      state.jobs[jobId] = {\n        lastRun,\n      };\n    });\n  }\n\n  /**\n   * Runs every 24 hours to check if new jobs need to be scheduled.\n   *\n   * This is necessary for longer running jobs that execute with more than 24 hours between them.\n   */\n  async dailyCheckIn() {\n    const jobs = this.getAllJobs();\n\n    for (const job of jobs) {\n      const parsed = parseCronExpression(job.expression);\n      const lastRun = this.state.jobs[job.id]?.lastRun;\n      // If a job was supposed to run while we were shut down but wasn't we run it now\n      if (\n        lastRun !== undefined &&\n        parsed.hasPrev() &&\n        parsed.prev().getTime() > lastRun\n      ) {\n        await this.executeCronjob(job);\n      }\n\n      // Try scheduling, will fail if an existing scheduled job is found\n      this.schedule(job);\n    }\n\n    this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n    this.#dailyTimer.start(() => {\n      this.dailyCheckIn().catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n  }\n\n  /**\n   * Run controller teardown process and unsubscribe from Snap events.\n   */\n  destroy() {\n    super.destroy();\n\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapRemoved',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.#snapIds.forEach((snapId) => {\n      this.unregister(snapId);\n    });\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be registered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapRegisterEvent(snap: TruncatedSnap) {\n    this.register(snap.id);\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be unregistered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapUnregisterEvent(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapUpdated' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapUpdated(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n    this.register(snap.id);\n  }\n}\n"],"names":["DAILY_TIMEOUT","CronjobController","inMilliseconds","Duration","Hour","controllerName","BaseController","getAllJobs","snaps","messagingSystem","call","filteredSnaps","getRunnableSnaps","jobs","map","snap","getSnapJobs","id","flat","filter","job","undefined","snapId","permissions","messenger","permission","SnapEndowments","Cronjob","definitions","getCronjobCaveatJobs","definition","idx","register","forEach","schedule","timers","has","parsed","parseCronExpression","expression","next","now","Date","ms","getTime","timer","Timer","start","executeCronjob","catch","error","logError","delete","state","lastRun","updateJobLastRunState","set","snapIds","origin","handler","HandlerType","OnCronjob","request","unregister","entries","_","jobSnapId","length","get","cancel","jobId","update","dailyCheckIn","hasPrev","prev","dailyTimer","destroy","unsubscribe","_handleSnapRegisterEvent","_handleSnapUnregisterEvent","_handleEventSnapUpdated","constructor","metadata","persist","anonymous","name","Map","bind","subscribe"],"mappings":";;;;;;;;;;;IAiDaA,aAAa;eAAbA;;IA8BAC,iBAAiB;eAAjBA;;;gCA9EsC;4BAY5C;uBACkC;kBAWQ;yBACZ;uBACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBf,MAAMD,gBAAgBE,IAAAA,qBAAc,EAAC,IAAIC,eAAQ,CAACC,IAAI;AAwB7D,MAAMC,iBAAiB;IAWrB,0CAEA,2CAEA,uCAEA,+BAA+B;AAC/B;AAZK,MAAMJ,0BAA0BK,gCAAc;IAoEnD;;;;GAIC,GACD,AAAQC,aAAwB;QAC9B,MAAMC,QAAQ,IAAI,CAACC,eAAe,CAACC,IAAI,CAAC;QACxC,MAAMC,gBAAgBC,IAAAA,kBAAgB,EAACJ;QAEvC,MAAMK,OAAOF,cAAcG,GAAG,CAAC,CAACC,OAAS,IAAI,CAACC,WAAW,CAACD,KAAKE,EAAE;QACjE,4EAA4E;QAC5E,OAAOJ,KAAKK,IAAI,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC;IAC7C;IAEA;;;;;GAKC,GACD,AAAQL,YAAYM,MAAuB,EAAyB;QAClE,MAAMC,cAAc,yBAAA,IAAI,EAAEC,YAAUd,IAAI,CACtC,uCACAY;QAGF,MAAMG,aAAaF,aAAa,CAACG,gBAAc,CAACC,OAAO,CAAC;QACxD,MAAMC,cAAcC,IAAAA,6BAAoB,EAACJ;QAEzC,OAAOG,aAAad,IAAI,CAACgB,YAAYC;YACnC,OAAO;gBAAE,GAAGD,UAAU;gBAAEb,IAAI,CAAC,EAAEK,OAAO,CAAC,EAAES,IAAI,CAAC;gBAAET;YAAO;QACzD;IACF;IAEA;;;;;GAKC,GACDU,SAASV,MAAuB,EAAE;QAChC,MAAMT,OAAO,IAAI,CAACG,WAAW,CAACM;QAC9BT,MAAMoB,QAAQ,CAACb,MAAQ,IAAI,CAACc,QAAQ,CAACd;IACvC;IAEA;;;;;;;;;;GAUC,GACD,AAAQc,SAASd,GAAY,EAAE;QAC7B,IAAI,yBAAA,IAAI,EAAEe,SAAOC,GAAG,CAAChB,IAAIH,EAAE,GAAG;YAC5B;QACF;QAEA,MAAMoB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;QACjD,MAAMC,OAAOH,OAAOG,IAAI;QACxB,MAAMC,MAAM,IAAIC;QAChB,MAAMC,KAAKH,KAAKI,OAAO,KAAKH,IAAIG,OAAO;QAEvC,6DAA6D;QAC7D,IAAID,KAAK3C,eAAe;YACtB;QACF;QAEA,MAAM6C,QAAQ,IAAIC,YAAK,CAACH;QACxBE,MAAME,KAAK,CAAC;YACV,IAAI,CAACC,cAAc,CAAC5B,KAAK6B,KAAK,CAAC,CAACC;gBAC9B,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;YAEA,yBAAA,IAAI,EAAEf,SAAOiB,MAAM,CAAChC,IAAIH,EAAE;YAC1B,IAAI,CAACiB,QAAQ,CAACd;QAChB;QAEA,IAAI,CAAC,IAAI,CAACiC,KAAK,CAACxC,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEqC,SAAS;YACrC,IAAI,CAACC,qBAAqB,CAACnC,IAAIH,EAAE,EAAE,IAAI,iCAAiC;QAC1E;QAEA,yBAAA,IAAI,EAAEkB,SAAOqB,GAAG,CAACpC,IAAIH,EAAE,EAAE4B;QACzB,yBAAA,IAAI,EAAEY,UAAQD,GAAG,CAACpC,IAAIH,EAAE,EAAEG,IAAIE,MAAM;IACtC;IAEA;;;;GAIC,GACD,MAAc0B,eAAe5B,GAAY,EAAE;QACzC,IAAI,CAACmC,qBAAqB,CAACnC,IAAIH,EAAE,EAAEyB,KAAKD,GAAG;QAC3C,MAAM,yBAAA,IAAI,EAAEjB,YAAUd,IAAI,CAAC,gCAAgC;YACzDY,QAAQF,IAAIE,MAAM;YAClBoC,QAAQ;YACRC,SAASC,uBAAW,CAACC,SAAS;YAC9BC,SAAS1C,IAAI0C,OAAO;QACtB;IACF;IAEA;;;;GAIC,GACDC,WAAWzC,MAAc,EAAE;QACzB,MAAMT,OAAO;eAAI,yBAAA,IAAI,EAAE4C,UAAQO,OAAO;SAAG,CAAC7C,MAAM,CAC9C,CAAC,CAAC8C,GAAGC,UAAU,GAAKA,cAAc5C;QAGpC,IAAIT,KAAKsD,MAAM,EAAE;YACftD,KAAKoB,OAAO,CAAC,CAAC,CAAChB,GAAG;gBAChB,MAAM4B,QAAQ,yBAAA,IAAI,EAAEV,SAAOiC,GAAG,CAACnD;gBAC/B,IAAI4B,OAAO;oBACTA,MAAMwB,MAAM;oBACZ,yBAAA,IAAI,EAAElC,SAAOiB,MAAM,CAACnC;oBACpB,yBAAA,IAAI,EAAEwC,UAAQL,MAAM,CAACnC;gBACvB;YACF;QACF;IACF;IAEA;;;;;GAKC,GACD,AAAQsC,sBAAsBe,KAAa,EAAEhB,OAAe,EAAE;QAC5D,IAAI,CAACiB,MAAM,CAAC,CAAClB;YACXA,MAAMxC,IAAI,CAACyD,MAAM,GAAG;gBAClBhB;YACF;QACF;IACF;IAEA;;;;GAIC,GACD,MAAMkB,eAAe;QACnB,MAAM3D,OAAO,IAAI,CAACN,UAAU;QAE5B,KAAK,MAAMa,OAAOP,KAAM;YACtB,MAAMwB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;YACjD,MAAMe,UAAU,IAAI,CAACD,KAAK,CAACxC,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEqC;YACzC,gFAAgF;YAChF,IACEA,YAAYjC,aACZgB,OAAOoC,OAAO,MACdpC,OAAOqC,IAAI,GAAG9B,OAAO,KAAKU,SAC1B;gBACA,MAAM,IAAI,CAACN,cAAc,CAAC5B;YAC5B;YAEA,kEAAkE;YAClE,IAAI,CAACc,QAAQ,CAACd;QAChB;uCAEMuD,aAAa,IAAI7B,YAAK,CAAC9C;QAC7B,yBAAA,IAAI,EAAE2E,aAAW5B,KAAK,CAAC;YACrB,IAAI,CAACyB,YAAY,GAAGvB,KAAK,CAAC,CAACC;gBACzB,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;QACF;IACF;IAEA;;GAEC,GACD0B,UAAU;QACR,KAAK,CAACA;QAEN,oDAAoD,GACpD,IAAI,CAACnE,eAAe,CAACoE,WAAW,CAC9B,gCACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,+BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACG,uBAAuB;QAE9B,mDAAmD,GAEnD,yBAAA,IAAI,EAAEvB,UAAQxB,OAAO,CAAC,CAACX;YACrB,IAAI,CAACyC,UAAU,CAACzC;QAClB;IACF;IAEA;;;;GAIC,GACD,AAAQwD,yBAAyB/D,IAAmB,EAAE;QACpD,IAAI,CAACiB,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IAEA;;;;GAIC,GACD,AAAQ8D,2BAA2BhE,IAAmB,EAAE;QACtD,IAAI,CAACgD,UAAU,CAAChD,KAAKE,EAAE;IACzB;IAEA;;;;GAIC,GACD,AAAQ+D,wBAAwBjE,IAAmB,EAAE;QACnD,IAAI,CAACgD,UAAU,CAAChD,KAAKE,EAAE;QACvB,IAAI,CAACe,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IApSAgE,YAAY,EAAEzD,SAAS,EAAE6B,KAAK,EAAyB,CAAE;QACvD,KAAK,CAAC;YACJ7B;YACA0D,UAAU;gBACRrE,MAAM;oBAAEsE,SAAS;oBAAMC,WAAW;gBAAM;YAC1C;YACAC,MAAMhF;YACNgD,OAAO;gBACLxC,MAAM,CAAC;gBACP,GAAGwC,KAAK;YACV;QACF;QApBF,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAGA,gCAAA;;mBAAA,KAAA;;uCAcQlB,SAAS,IAAImD;uCACb7B,UAAU,IAAI6B;uCACd9D,YAAYA;QAElB,IAAI,CAACsD,wBAAwB,GAAG,IAAI,CAACA,wBAAwB,CAACS,IAAI,CAAC,IAAI;QACvE,IAAI,CAACR,0BAA0B,GAC7B,IAAI,CAACA,0BAA0B,CAACQ,IAAI,CAAC,IAAI;QAC3C,IAAI,CAACP,uBAAuB,GAAG,IAAI,CAACA,uBAAuB,CAACO,IAAI,CAAC,IAAI;QAErE,2BAA2B;QAC3B,oDAAoD,GACpD,IAAI,CAAC9E,eAAe,CAAC+E,SAAS,CAC5B,gCACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,+BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACR,uBAAuB;QAE9B,mDAAmD,GAEnD,IAAI,CAACR,YAAY,GAAGvB,KAAK,CAAC,CAACC;YACzBC,IAAAA,oBAAQ,EAACD;QACX;IACF;AAiPF"}
+{"version":3,"sources":["../../../src/cronjob/CronjobController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 as BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type {\n  TruncatedSnap,\n  CronjobSpecification,\n} from '@metamask/snaps-utils';\nimport {\n  HandlerType,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n  GetAllSnaps,\n  HandleSnapRequest,\n  SnapDisabled,\n  SnapEnabled,\n  SnapInstalled,\n  SnapRemoved,\n  SnapUpdated,\n} from '..';\nimport { getRunnableSnaps, SnapEndowments } from '..';\nimport { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents =\n  | SnapInstalled\n  | SnapRemoved\n  | SnapUpdated\n  | SnapEnabled\n  | SnapDisabled;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  'CronjobController',\n  CronjobControllerActions,\n  CronjobControllerEvents,\n  CronjobControllerActions['type'],\n  CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n  messenger: CronjobControllerMessenger;\n  /**\n   * Persisted state that will be used for rehydration.\n   */\n  state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n  timer?: Timer;\n  id: string;\n  snapId: SnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n  lastRun: number;\n};\n\nexport type CronjobControllerState = {\n  jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n  typeof controllerName,\n  CronjobControllerState,\n  CronjobControllerMessenger\n> {\n  #messenger: CronjobControllerMessenger;\n\n  #dailyTimer!: Timer;\n\n  #timers: Map<string, Timer>;\n\n  // Mapping from jobId to snapId\n  #snapIds: Map<string, string>;\n\n  constructor({ messenger, state }: CronjobControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        jobs: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        jobs: {},\n        ...state,\n      },\n    });\n    this.#timers = new Map();\n    this.#snapIds = new Map();\n    this.#messenger = messenger;\n\n    this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);\n    this._handleSnapUnregisterEvent =\n      this._handleSnapUnregisterEvent.bind(this);\n    this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n    // Subscribe to Snap events\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.subscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapRemoved',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.dailyCheckIn().catch((error) => {\n      logError(error);\n    });\n  }\n\n  /**\n   * Retrieve all cronjob specifications for all runnable snaps.\n   *\n   * @returns Array of Cronjob specifications.\n   */\n  private getAllJobs(): Cronjob[] {\n    const snaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(snaps);\n\n    const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n  }\n\n  /**\n   * Retrieve all Cronjob specifications for a Snap.\n   *\n   * @param snapId - ID of a Snap.\n   * @returns Array of Cronjob specifications.\n   */\n  private getSnapJobs(snapId: SnapId): Cronjob[] | undefined {\n    const permissions = this.#messenger.call(\n      'PermissionController:getPermissions',\n      snapId,\n    );\n\n    const permission = permissions?.[SnapEndowments.Cronjob];\n    const definitions = getCronjobCaveatJobs(permission);\n\n    return definitions?.map((definition, idx) => {\n      return { ...definition, id: `${snapId}-${idx}`, snapId };\n    });\n  }\n\n  /**\n   * Register cron jobs for a given snap by getting specification from a permission caveats.\n   * Once registered, each job will be scheduled.\n   *\n   * @param snapId - ID of a snap.\n   */\n  register(snapId: SnapId) {\n    const jobs = this.getSnapJobs(snapId);\n    jobs?.forEach((job) => this.schedule(job));\n  }\n\n  /**\n   * Schedule a new job.\n   * This will interpret the cron expression and tell the timer to execute the job\n   * at the next suitable point in time.\n   * Job last run state will be initialized afterwards.\n   *\n   * Note: Schedule will be skipped if the job's execution time is too far in the future and\n   * will be revisited on a daily check.\n   *\n   * @param job - Cronjob specification.\n   */\n  private schedule(job: Cronjob) {\n    if (this.#timers.has(job.id)) {\n      return;\n    }\n\n    const parsed = parseCronExpression(job.expression);\n    const next = parsed.next();\n    const now = new Date();\n    const ms = next.getTime() - now.getTime();\n\n    // Don't schedule this job yet as it is too far in the future\n    if (ms > DAILY_TIMEOUT) {\n      return;\n    }\n\n    const timer = new Timer(ms);\n    timer.start(() => {\n      this.executeCronjob(job).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n\n      this.#timers.delete(job.id);\n      this.schedule(job);\n    });\n\n    if (!this.state.jobs[job.id]?.lastRun) {\n      this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n    }\n\n    this.#timers.set(job.id, timer);\n    this.#snapIds.set(job.id, job.snapId);\n  }\n\n  /**\n   * Execute job.\n   *\n   * @param job - Cronjob specification.\n   */\n  private async executeCronjob(job: Cronjob) {\n    this.updateJobLastRunState(job.id, Date.now());\n    await this.#messenger.call('SnapController:handleRequest', {\n      snapId: job.snapId,\n      origin: '',\n      handler: HandlerType.OnCronjob,\n      request: job.request,\n    });\n  }\n\n  /**\n   * Unregister all jobs related to the given snapId.\n   *\n   * @param snapId - ID of a snap.\n   */\n  unregister(snapId: string) {\n    const jobs = [...this.#snapIds.entries()].filter(\n      ([_, jobSnapId]) => jobSnapId === snapId,\n    );\n\n    if (jobs.length) {\n      jobs.forEach(([id]) => {\n        const timer = this.#timers.get(id);\n        if (timer) {\n          timer.cancel();\n          this.#timers.delete(id);\n          this.#snapIds.delete(id);\n        }\n      });\n    }\n  }\n\n  /**\n   * Update time of a last run for the Cronjob specified by ID.\n   *\n   * @param jobId - ID of a cron job.\n   * @param lastRun - Unix timestamp when the job was last ran.\n   */\n  private updateJobLastRunState(jobId: string, lastRun: number) {\n    this.update((state) => {\n      state.jobs[jobId] = {\n        lastRun,\n      };\n    });\n  }\n\n  /**\n   * Runs every 24 hours to check if new jobs need to be scheduled.\n   *\n   * This is necessary for longer running jobs that execute with more than 24 hours between them.\n   */\n  async dailyCheckIn() {\n    const jobs = this.getAllJobs();\n\n    for (const job of jobs) {\n      const parsed = parseCronExpression(job.expression);\n      const lastRun = this.state.jobs[job.id]?.lastRun;\n      // If a job was supposed to run while we were shut down but wasn't we run it now\n      if (\n        lastRun !== undefined &&\n        parsed.hasPrev() &&\n        parsed.prev().getTime() > lastRun\n      ) {\n        await this.executeCronjob(job);\n      }\n\n      // Try scheduling, will fail if an existing scheduled job is found\n      this.schedule(job);\n    }\n\n    this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n    this.#dailyTimer.start(() => {\n      this.dailyCheckIn().catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n  }\n\n  /**\n   * Run controller teardown process and unsubscribe from Snap events.\n   */\n  destroy() {\n    super.destroy();\n\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapRemoved',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.#snapIds.forEach((snapId) => {\n      this.unregister(snapId);\n    });\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be registered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapRegisterEvent(snap: TruncatedSnap) {\n    this.register(snap.id);\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be unregistered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapUnregisterEvent(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapUpdated' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapUpdated(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n    this.register(snap.id);\n  }\n}\n"],"names":["DAILY_TIMEOUT","CronjobController","inMilliseconds","Duration","Hour","controllerName","BaseController","getAllJobs","snaps","messagingSystem","call","filteredSnaps","getRunnableSnaps","jobs","map","snap","getSnapJobs","id","flat","filter","job","undefined","snapId","permissions","messenger","permission","SnapEndowments","Cronjob","definitions","getCronjobCaveatJobs","definition","idx","register","forEach","schedule","timers","has","parsed","parseCronExpression","expression","next","now","Date","ms","getTime","timer","Timer","start","executeCronjob","catch","error","logError","delete","state","lastRun","updateJobLastRunState","set","snapIds","origin","handler","HandlerType","OnCronjob","request","unregister","entries","_","jobSnapId","length","get","cancel","jobId","update","dailyCheckIn","hasPrev","prev","dailyTimer","destroy","unsubscribe","_handleSnapRegisterEvent","_handleSnapUnregisterEvent","_handleEventSnapUpdated","constructor","metadata","persist","anonymous","name","Map","bind","subscribe"],"mappings":";;;;;;;;;;;IAgDaA,aAAa;eAAbA;;IA8BAC,iBAAiB;eAAjBA;;;gCA7EsC;4BAW5C;uBACkC;kBAWQ;yBACZ;uBACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBf,MAAMD,gBAAgBE,IAAAA,qBAAc,EAAC,IAAIC,eAAQ,CAACC,IAAI;AAwB7D,MAAMC,iBAAiB;IAWrB,0CAEA,2CAEA,uCAEA,+BAA+B;AAC/B;AAZK,MAAMJ,0BAA0BK,gCAAc;IAoEnD;;;;GAIC,GACD,AAAQC,aAAwB;QAC9B,MAAMC,QAAQ,IAAI,CAACC,eAAe,CAACC,IAAI,CAAC;QACxC,MAAMC,gBAAgBC,IAAAA,kBAAgB,EAACJ;QAEvC,MAAMK,OAAOF,cAAcG,GAAG,CAAC,CAACC,OAAS,IAAI,CAACC,WAAW,CAACD,KAAKE,EAAE;QACjE,4EAA4E;QAC5E,OAAOJ,KAAKK,IAAI,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC;IAC7C;IAEA;;;;;GAKC,GACD,AAAQL,YAAYM,MAAc,EAAyB;QACzD,MAAMC,cAAc,yBAAA,IAAI,EAAEC,YAAUd,IAAI,CACtC,uCACAY;QAGF,MAAMG,aAAaF,aAAa,CAACG,gBAAc,CAACC,OAAO,CAAC;QACxD,MAAMC,cAAcC,IAAAA,6BAAoB,EAACJ;QAEzC,OAAOG,aAAad,IAAI,CAACgB,YAAYC;YACnC,OAAO;gBAAE,GAAGD,UAAU;gBAAEb,IAAI,CAAC,EAAEK,OAAO,CAAC,EAAES,IAAI,CAAC;gBAAET;YAAO;QACzD;IACF;IAEA;;;;;GAKC,GACDU,SAASV,MAAc,EAAE;QACvB,MAAMT,OAAO,IAAI,CAACG,WAAW,CAACM;QAC9BT,MAAMoB,QAAQ,CAACb,MAAQ,IAAI,CAACc,QAAQ,CAACd;IACvC;IAEA;;;;;;;;;;GAUC,GACD,AAAQc,SAASd,GAAY,EAAE;QAC7B,IAAI,yBAAA,IAAI,EAAEe,SAAOC,GAAG,CAAChB,IAAIH,EAAE,GAAG;YAC5B;QACF;QAEA,MAAMoB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;QACjD,MAAMC,OAAOH,OAAOG,IAAI;QACxB,MAAMC,MAAM,IAAIC;QAChB,MAAMC,KAAKH,KAAKI,OAAO,KAAKH,IAAIG,OAAO;QAEvC,6DAA6D;QAC7D,IAAID,KAAK3C,eAAe;YACtB;QACF;QAEA,MAAM6C,QAAQ,IAAIC,YAAK,CAACH;QACxBE,MAAME,KAAK,CAAC;YACV,IAAI,CAACC,cAAc,CAAC5B,KAAK6B,KAAK,CAAC,CAACC;gBAC9B,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;YAEA,yBAAA,IAAI,EAAEf,SAAOiB,MAAM,CAAChC,IAAIH,EAAE;YAC1B,IAAI,CAACiB,QAAQ,CAACd;QAChB;QAEA,IAAI,CAAC,IAAI,CAACiC,KAAK,CAACxC,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEqC,SAAS;YACrC,IAAI,CAACC,qBAAqB,CAACnC,IAAIH,EAAE,EAAE,IAAI,iCAAiC;QAC1E;QAEA,yBAAA,IAAI,EAAEkB,SAAOqB,GAAG,CAACpC,IAAIH,EAAE,EAAE4B;QACzB,yBAAA,IAAI,EAAEY,UAAQD,GAAG,CAACpC,IAAIH,EAAE,EAAEG,IAAIE,MAAM;IACtC;IAEA;;;;GAIC,GACD,MAAc0B,eAAe5B,GAAY,EAAE;QACzC,IAAI,CAACmC,qBAAqB,CAACnC,IAAIH,EAAE,EAAEyB,KAAKD,GAAG;QAC3C,MAAM,yBAAA,IAAI,EAAEjB,YAAUd,IAAI,CAAC,gCAAgC;YACzDY,QAAQF,IAAIE,MAAM;YAClBoC,QAAQ;YACRC,SAASC,uBAAW,CAACC,SAAS;YAC9BC,SAAS1C,IAAI0C,OAAO;QACtB;IACF;IAEA;;;;GAIC,GACDC,WAAWzC,MAAc,EAAE;QACzB,MAAMT,OAAO;eAAI,yBAAA,IAAI,EAAE4C,UAAQO,OAAO;SAAG,CAAC7C,MAAM,CAC9C,CAAC,CAAC8C,GAAGC,UAAU,GAAKA,cAAc5C;QAGpC,IAAIT,KAAKsD,MAAM,EAAE;YACftD,KAAKoB,OAAO,CAAC,CAAC,CAAChB,GAAG;gBAChB,MAAM4B,QAAQ,yBAAA,IAAI,EAAEV,SAAOiC,GAAG,CAACnD;gBAC/B,IAAI4B,OAAO;oBACTA,MAAMwB,MAAM;oBACZ,yBAAA,IAAI,EAAElC,SAAOiB,MAAM,CAACnC;oBACpB,yBAAA,IAAI,EAAEwC,UAAQL,MAAM,CAACnC;gBACvB;YACF;QACF;IACF;IAEA;;;;;GAKC,GACD,AAAQsC,sBAAsBe,KAAa,EAAEhB,OAAe,EAAE;QAC5D,IAAI,CAACiB,MAAM,CAAC,CAAClB;YACXA,MAAMxC,IAAI,CAACyD,MAAM,GAAG;gBAClBhB;YACF;QACF;IACF;IAEA;;;;GAIC,GACD,MAAMkB,eAAe;QACnB,MAAM3D,OAAO,IAAI,CAACN,UAAU;QAE5B,KAAK,MAAMa,OAAOP,KAAM;YACtB,MAAMwB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;YACjD,MAAMe,UAAU,IAAI,CAACD,KAAK,CAACxC,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEqC;YACzC,gFAAgF;YAChF,IACEA,YAAYjC,aACZgB,OAAOoC,OAAO,MACdpC,OAAOqC,IAAI,GAAG9B,OAAO,KAAKU,SAC1B;gBACA,MAAM,IAAI,CAACN,cAAc,CAAC5B;YAC5B;YAEA,kEAAkE;YAClE,IAAI,CAACc,QAAQ,CAACd;QAChB;uCAEMuD,aAAa,IAAI7B,YAAK,CAAC9C;QAC7B,yBAAA,IAAI,EAAE2E,aAAW5B,KAAK,CAAC;YACrB,IAAI,CAACyB,YAAY,GAAGvB,KAAK,CAAC,CAACC;gBACzB,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;QACF;IACF;IAEA;;GAEC,GACD0B,UAAU;QACR,KAAK,CAACA;QAEN,oDAAoD,GACpD,IAAI,CAACnE,eAAe,CAACoE,WAAW,CAC9B,gCACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,+BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACG,uBAAuB;QAE9B,mDAAmD,GAEnD,yBAAA,IAAI,EAAEvB,UAAQxB,OAAO,CAAC,CAACX;YACrB,IAAI,CAACyC,UAAU,CAACzC;QAClB;IACF;IAEA;;;;GAIC,GACD,AAAQwD,yBAAyB/D,IAAmB,EAAE;QACpD,IAAI,CAACiB,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IAEA;;;;GAIC,GACD,AAAQ8D,2BAA2BhE,IAAmB,EAAE;QACtD,IAAI,CAACgD,UAAU,CAAChD,KAAKE,EAAE;IACzB;IAEA;;;;GAIC,GACD,AAAQ+D,wBAAwBjE,IAAmB,EAAE;QACnD,IAAI,CAACgD,UAAU,CAAChD,KAAKE,EAAE;QACvB,IAAI,CAACe,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IApSAgE,YAAY,EAAEzD,SAAS,EAAE6B,KAAK,EAAyB,CAAE;QACvD,KAAK,CAAC;YACJ7B;YACA0D,UAAU;gBACRrE,MAAM;oBAAEsE,SAAS;oBAAMC,WAAW;gBAAM;YAC1C;YACAC,MAAMhF;YACNgD,OAAO;gBACLxC,MAAM,CAAC;gBACP,GAAGwC,KAAK;YACV;QACF;QApBF,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAGA,gCAAA;;mBAAA,KAAA;;uCAcQlB,SAAS,IAAImD;uCACb7B,UAAU,IAAI6B;uCACd9D,YAAYA;QAElB,IAAI,CAACsD,wBAAwB,GAAG,IAAI,CAACA,wBAAwB,CAACS,IAAI,CAAC,IAAI;QACvE,IAAI,CAACR,0BAA0B,GAC7B,IAAI,CAACA,0BAA0B,CAACQ,IAAI,CAAC,IAAI;QAC3C,IAAI,CAACP,uBAAuB,GAAG,IAAI,CAACA,uBAAuB,CAACO,IAAI,CAAC,IAAI;QAErE,2BAA2B;QAC3B,oDAAoD,GACpD,IAAI,CAAC9E,eAAe,CAAC+E,SAAS,CAC5B,gCACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,+BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACR,uBAAuB;QAE9B,mDAAmD,GAEnD,IAAI,CAACR,YAAY,GAAGvB,KAAK,CAAC,CAACC;YACzBC,IAAAA,oBAAQ,EAACD;QACX;IACF;AAiPF"}

package/dist/cjs/services/ExecutionService.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/ExecutionService.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport type { SnapId, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\ntype TerminateSnap = (snapId: string) => Promise<void>;\ntype TerminateAll = () => Promise<void>;\ntype ExecuteSnap = (snapData: SnapExecutionData) => Promise<unknown>;\n\ntype HandleRpcRequest = (\n  snapId: string,\n  options: SnapRpcHookArgs,\n) => Promise<unknown>;\n\nexport interface ExecutionService {\n  terminateSnap: TerminateSnap;\n  terminateAllSnaps: TerminateAll;\n  executeSnap: ExecuteSnap;\n  handleRpcRequest: HandleRpcRequest;\n}\n\nexport type SnapExecutionData = {\n  snapId: string;\n  sourceCode: string;\n  endowments?: Json;\n};\n\nexport type SnapErrorJson = {\n  message: string;\n  code: number;\n  data?: Json;\n};\n\nconst controllerName = 'ExecutionService';\n\nexport type ErrorMessageEvent = {\n  type: 'ExecutionService:unhandledError';\n  payload: [SnapId, SnapErrorJson];\n};\n\nexport type OutboundRequest = {\n  type: 'ExecutionService:outboundRequest';\n  payload: [SnapId];\n};\n\nexport type OutboundResponse = {\n  type: 'ExecutionService:outboundResponse';\n  payload: [SnapId];\n};\n\nexport type ExecutionServiceEvents =\n  | ErrorMessageEvent\n  | OutboundRequest\n  | OutboundResponse;\n\n/**\n * Handles RPC request.\n */\nexport type HandleRpcRequestAction = {\n  type: `${typeof controllerName}:handleRpcRequest`;\n  handler: ExecutionService['handleRpcRequest'];\n};\n\n/**\n * Executes a given snap.\n */\nexport type ExecuteSnapAction = {\n  type: `${typeof controllerName}:executeSnap`;\n  handler: ExecutionService['executeSnap'];\n};\n\n/**\n * Terminates a given snap.\n */\nexport type TerminateSnapAction = {\n  type: `${typeof controllerName}:terminateSnap`;\n  handler: ExecutionService['terminateSnap'];\n};\n\n/**\n * Terminates all snaps.\n */\nexport type TerminateAllSnapsAction = {\n  type: `${typeof controllerName}:terminateAllSnaps`;\n  handler: ExecutionService['terminateAllSnaps'];\n};\n\nexport type ExecutionServiceActions =\n  | HandleRpcRequestAction\n  | ExecuteSnapAction\n  | TerminateSnapAction\n  | TerminateAllSnapsAction;\n\nexport type ExecutionServiceMessenger = RestrictedControllerMessenger<\n  'ExecutionService',\n  ExecutionServiceActions,\n  ExecutionServiceEvents,\n  ExecutionServiceActions['type'],\n  ExecutionServiceEvents['type']\n>;\n"],"names":["controllerName"],"mappings":";;;;AAgCA,MAAMA,iBAAiB"}
+{"version":3,"sources":["../../../src/services/ExecutionService.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport type { SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\ntype TerminateSnap = (snapId: string) => Promise<void>;\ntype TerminateAll = () => Promise<void>;\ntype ExecuteSnap = (snapData: SnapExecutionData) => Promise<unknown>;\n\ntype HandleRpcRequest = (\n  snapId: string,\n  options: SnapRpcHookArgs,\n) => Promise<unknown>;\n\nexport interface ExecutionService {\n  terminateSnap: TerminateSnap;\n  terminateAllSnaps: TerminateAll;\n  executeSnap: ExecuteSnap;\n  handleRpcRequest: HandleRpcRequest;\n}\n\nexport type SnapExecutionData = {\n  snapId: string;\n  sourceCode: string;\n  endowments?: Json;\n};\n\nexport type SnapErrorJson = {\n  message: string;\n  code: number;\n  data?: Json;\n};\n\nconst controllerName = 'ExecutionService';\n\nexport type ErrorMessageEvent = {\n  type: 'ExecutionService:unhandledError';\n  payload: [string, SnapErrorJson];\n};\n\nexport type OutboundRequest = {\n  type: 'ExecutionService:outboundRequest';\n  payload: [string];\n};\n\nexport type OutboundResponse = {\n  type: 'ExecutionService:outboundResponse';\n  payload: [string];\n};\n\nexport type ExecutionServiceEvents =\n  | ErrorMessageEvent\n  | OutboundRequest\n  | OutboundResponse;\n\n/**\n * Handles RPC request.\n */\nexport type HandleRpcRequestAction = {\n  type: `${typeof controllerName}:handleRpcRequest`;\n  handler: ExecutionService['handleRpcRequest'];\n};\n\n/**\n * Executes a given snap.\n */\nexport type ExecuteSnapAction = {\n  type: `${typeof controllerName}:executeSnap`;\n  handler: ExecutionService['executeSnap'];\n};\n\n/**\n * Terminates a given snap.\n */\nexport type TerminateSnapAction = {\n  type: `${typeof controllerName}:terminateSnap`;\n  handler: ExecutionService['terminateSnap'];\n};\n\n/**\n * Terminates all snaps.\n */\nexport type TerminateAllSnapsAction = {\n  type: `${typeof controllerName}:terminateAllSnaps`;\n  handler: ExecutionService['terminateAllSnaps'];\n};\n\nexport type ExecutionServiceActions =\n  | HandleRpcRequestAction\n  | ExecuteSnapAction\n  | TerminateSnapAction\n  | TerminateAllSnapsAction;\n\nexport type ExecutionServiceMessenger = RestrictedControllerMessenger<\n  'ExecutionService',\n  ExecutionServiceActions,\n  ExecutionServiceEvents,\n  ExecutionServiceActions['type'],\n  ExecutionServiceEvents['type']\n>;\n"],"names":["controllerName"],"mappings":";;;;AAgCA,MAAMA,iBAAiB"}

package/dist/cjs/snaps/SnapController.js

@@ -29,7 +29,7 @@ const _basecontroller = require("@metamask/base-controller");
 const _permissioncontroller = require("@metamask/permission-controller");
 const _rpcerrors = require("@metamask/rpc-errors");
 const _snapsrpcmethods = require("@metamask/snaps-rpc-methods");
-const _snapsui = require("@metamask/snaps-ui");
+const _snapssdk = require("@metamask/snaps-sdk");
 const _snapsutils = require("@metamask/snaps-utils");
 const _utils = require("@metamask/utils");
 const _fsm = require("@xstate/fsm");
@@ -121,7 +121,8 @@ const TRUNCATED_SNAP_PROPERTIES = new Set([
 ]);
 const defaultState = {
     snaps: {},
-    snapStates: {}
+    snapStates: {},
+    unencryptedSnapStates: {}
 };
 /**
  * Truncates the properties of a snap to only ones that are easily serializable.
@@ -193,7 +194,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    *
    * @param snapId - The id of the Snap whose message handler to get.
    * @returns The RPC handler for the given snap.
-   */ _getRpcRequestHandler = /*#__PURE__*/ new WeakSet(), _assertSnapRpcRequestResult = /*#__PURE__*/ new WeakSet(), _executeWithTimeout = /*#__PURE__*/ new WeakSet(), _recordSnapRpcRequestStart = /*#__PURE__*/ new WeakSet(), _recordSnapRpcRequestFinish = /*#__PURE__*/ new WeakSet(), /**
+   */ _getRpcRequestHandler = /*#__PURE__*/ new WeakSet(), _triggerPhishingListUpdate = /*#__PURE__*/ new WeakSet(), _checkPhishingList = /*#__PURE__*/ new WeakSet(), _assertSnapRpcRequestResult = /*#__PURE__*/ new WeakSet(), _executeWithTimeout = /*#__PURE__*/ new WeakSet(), _recordSnapRpcRequestStart = /*#__PURE__*/ new WeakSet(), _recordSnapRpcRequestFinish = /*#__PURE__*/ new WeakSet(), /**
    * Retrieves the rollback snapshot of a snap.
    *
    * @param snapId - The snap id.
@@ -402,9 +403,14 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    *
    * @param snapId - The id of the Snap whose state should be updated.
    * @param newSnapState - The new state of the snap.
-   */ async updateSnapState(snapId, newSnapState) {
+   * @param encrypted - A flag to indicate whether to use encrypted storage or not.
+   */ updateSnapState(snapId, newSnapState, encrypted) {
         this.update((state)=>{
-            state.snapStates[snapId] = newSnapState;
+            if (encrypted) {
+                state.snapStates[snapId] = newSnapState;
+            } else {
+                state.unencryptedSnapStates[snapId] = newSnapState;
+            }
         });
     }
     /**
@@ -412,9 +418,14 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    * This is distinct from the state MetaMask uses to manage snaps.
    *
    * @param snapId - The id of the Snap whose state should be cleared.
-   */ clearSnapState(snapId) {
+   * @param encrypted - A flag to indicate whether to use encrypted storage or not.
+   */ clearSnapState(snapId, encrypted) {
         this.update((state)=>{
-            state.snapStates[snapId] = null;
+            if (encrypted) {
+                state.snapStates[snapId] = null;
+            } else {
+                state.unencryptedSnapStates[snapId] = null;
+            }
         });
     }
     /**
@@ -422,10 +433,10 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    * This is distinct from the state MetaMask uses to manage snaps.
    *
    * @param snapId - The id of the Snap whose state to get.
-   * @returns A promise that resolves with the decrypted snap state or null if no state exists.
-   * @throws If the snap state decryption fails.
-   */ async getSnapState(snapId) {
-        const state = this.state.snapStates[snapId];
+   * @param encrypted - A flag to indicate whether to use encrypted storage or not.
+   * @returns The requested snap state or null if no state exists.
+   */ getSnapState(snapId, encrypted) {
+        const state = encrypted ? this.state.snapStates[snapId] : this.state.unencryptedSnapStates[snapId];
         return state ?? null;
     }
     /**
@@ -435,7 +446,7 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    * @param path - The path to the requested file.
    * @param encoding - An optional requested file encoding.
    * @returns The file requested in the chosen file encoding or null if the file is not found.
-   */ getSnapFile(snapId, path, encoding = _snapsutils.AuxiliaryFileEncoding.Base64) {
+   */ getSnapFile(snapId, path, encoding = _snapssdk.AuxiliaryFileEncoding.Base64) {
         const snap = this.getExpect(snapId);
         const normalizedPath = (0, _snapsutils.normalizeRelative)(path);
         const value = snap.auxiliaryFiles?.find((file)=>file.path === normalizedPath)?.value;
@@ -942,6 +953,10 @@ class SnapController extends _basecontroller.BaseControllerV2 {
                     persist: true,
                     anonymous: false
                 },
+                unencryptedSnapStates: {
+                    persist: true,
+                    anonymous: false
+                },
                 snaps: {
                     persist: (snaps)=>{
                         return Object.values(snaps)// We should not persist snaps that are in the installing state,
@@ -1021,6 +1036,8 @@ class SnapController extends _basecontroller.BaseControllerV2 {
    */ _class_private_method_init(this, _fetchSnap);
         _class_private_method_init(this, _validateSnapPermissions);
         _class_private_method_init(this, _getRpcRequestHandler);
+        _class_private_method_init(this, _triggerPhishingListUpdate);
+        _class_private_method_init(this, _checkPhishingList);
         /**
    * Asserts that the returned result of a Snap RPC call is the expected shape.
    *
@@ -1147,12 +1164,12 @@ class SnapController extends _basecontroller.BaseControllerV2 {
         this.messagingSystem.subscribe('ExecutionService:outboundResponse', this._onOutboundResponse);
         /* eslint-enable @typescript-eslint/unbound-method */ this.messagingSystem.subscribe('SnapController:snapInstalled', ({ id })=>{
             _class_private_method_get(this, _callLifecycleHook, callLifecycleHook).call(this, id, _snapsutils.HandlerType.OnInstall).catch((error)=>{
-                (0, _snapsutils.logError)(`Error when calling \`onInstall\` lifecycle hook for snap "${id}": ${(0, _snapsutils.getErrorMessage)(error)}`);
+                (0, _snapsutils.logError)(`Error when calling \`onInstall\` lifecycle hook for snap "${id}": ${(0, _snapssdk.getErrorMessage)(error)}`);
             });
         });
         this.messagingSystem.subscribe('SnapController:snapUpdated', ({ id })=>{
             _class_private_method_get(this, _callLifecycleHook, callLifecycleHook).call(this, id, _snapsutils.HandlerType.OnUpdate).catch((error)=>{
-                (0, _snapsutils.logError)(`Error when calling \`onUpdate\` lifecycle hook for snap "${id}": ${(0, _snapsutils.getErrorMessage)(error)}`);
+                (0, _snapsutils.logError)(`Error when calling \`onUpdate\` lifecycle hook for snap "${id}": ${(0, _snapssdk.getErrorMessage)(error)}`);
             });
         });
         _class_private_method_get(this, _initializeStateMachine, initializeStateMachine).call(this);
@@ -1219,11 +1236,11 @@ function initializeStateMachine() {
 function registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${controllerName}:clearSnapState`, (...args)=>this.clearSnapState(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:get`, (...args)=>this.get(...args));
-    this.messagingSystem.registerActionHandler(`${controllerName}:getSnapState`, async (...args)=>this.getSnapState(...args));
+    this.messagingSystem.registerActionHandler(`${controllerName}:getSnapState`, (...args)=>this.getSnapState(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:handleRequest`, async (...args)=>this.handleRequest(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:has`, (...args)=>this.has(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:updateBlockedSnaps`, async ()=>this.updateBlockedSnaps());
-    this.messagingSystem.registerActionHandler(`${controllerName}:updateSnapState`, async (...args)=>this.updateSnapState(...args));
+    this.messagingSystem.registerActionHandler(`${controllerName}:updateSnapState`, (...args)=>this.updateSnapState(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:enable`, (...args)=>this.enableSnap(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:disable`, async (...args)=>this.disableSnap(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:remove`, async (...args)=>this.removeSnap(...args));
@@ -1432,7 +1449,7 @@ async function getEndowments(snapId) {
 }
 function set(args) {
     const { id: snapId, origin, files, isUpdate = false } = args;
-    const { manifest, sourceCode: sourceCodeFile, svgIcon, auxiliaryFiles: rawAuxiliaryFiles } = files;
+    const { manifest, sourceCode: sourceCodeFile, svgIcon, auxiliaryFiles: rawAuxiliaryFiles, localizationFiles } = files;
     (0, _snapsutils.assertIsSnapManifest)(manifest.result);
     const { version } = manifest.result;
     const sourceCode = sourceCodeFile.toString();
@@ -1466,7 +1483,8 @@ function set(args) {
         sourceCode,
         version,
         versionHistory,
-        auxiliaryFiles
+        auxiliaryFiles,
+        localizationFiles: localizationFiles.map((file)=>file.result)
     };
     // If the snap was blocked, it isn't any longer
     delete snap.blockInformation;
@@ -1494,20 +1512,23 @@ async function fetchSnap(snapId, location) {
         const sourceCode = await location.fetch(manifest.result.source.location.npm.filePath);
         const { iconPath } = manifest.result.source.location.npm;
         const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;
-        const auxiliaryFiles = manifest.result.source.files ? await Promise.all(manifest.result.source.files.map(async (filePath)=>location.fetch(filePath))) : [];
+        const auxiliaryFiles = await (0, _utils1.getSnapFiles)(location, manifest.result.source.files);
+        const localizationFiles = await (0, _utils1.getSnapFiles)(location, manifest.result.source.locales);
+        const validatedLocalizationFiles = (0, _snapsutils.getValidatedLocalizationFiles)(localizationFiles);
         const files = {
             manifest,
             sourceCode,
             svgIcon,
-            auxiliaryFiles
+            auxiliaryFiles,
+            localizationFiles: validatedLocalizationFiles
         };
-        (0, _snapsutils.validateFetchedSnap)(files);
+        await (0, _snapsutils.validateFetchedSnap)(files);
         return {
             files,
             location
         };
     } catch (error) {
-        throw new Error(`Failed to fetch snap "${snapId}": ${(0, _snapsutils.getErrorMessage)(error)}.`);
+        throw new Error(`Failed to fetch snap "${snapId}": ${(0, _snapssdk.getErrorMessage)(error)}.`);
     }
 }
 function validateSnapPermissions(processedPermissions) {
@@ -1583,12 +1604,29 @@ function getRpcRequestHandler(snapId) {
     runtime.rpcHandler = rpcHandler;
     return rpcHandler;
 }
+async function triggerPhishingListUpdate() {
+    return this.messagingSystem.call('PhishingController:maybeUpdateState');
+}
+function checkPhishingList(origin) {
+    return this.messagingSystem.call('PhishingController:testOrigin', origin).result;
+}
 async function assertSnapRpcRequestResult(handlerType, result) {
     switch(handlerType){
         case _snapsutils.HandlerType.OnTransaction:
-            (0, _utils.assertStruct)(result, _snapsutils.OnTransactionResponseStruct);
-            await this.messagingSystem.call('PhishingController:maybeUpdateState');
-            await (0, _snapsui.assertUILinksAreSafe)(result.content, (url)=>this.messagingSystem.call('PhishingController:testOrigin', url).result);
+            {
+                (0, _utils.assertStruct)(result, _snapsutils.OnTransactionResponseStruct);
+                // Null is an allowed return value here
+                if (result === null) {
+                    return;
+                }
+                await _class_private_method_get(this, _triggerPhishingListUpdate, triggerPhishingListUpdate).call(this);
+                (0, _snapsutils.validateComponentLinks)(result.content, _class_private_method_get(this, _checkPhishingList, checkPhishingList).bind(this));
+                break;
+            }
+        case _snapsutils.HandlerType.OnHomePage:
+            (0, _utils.assertStruct)(result, _snapsutils.OnHomePageResponseStruct);
+            await _class_private_method_get(this, _triggerPhishingListUpdate, triggerPhishingListUpdate).call(this);
+            (0, _snapsutils.validateComponentLinks)(result.content, _class_private_method_get(this, _checkPhishingList, checkPhishingList).bind(this));
             break;
         default:
             break;