@metamask/snaps-controllers 2.0.2 → 3.1.0

package/dist/esm/services/AbstractExecutionService.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/AbstractExecutionService.ts"],"sourcesContent":["import ObjectMultiplex from '@metamask/object-multiplex';\nimport type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport type { SnapRpcHook, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { SNAP_STREAM_NAMES, logError } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcNotification } from '@metamask/utils';\nimport { Duration, isJsonRpcNotification, isObject } from '@metamask/utils';\nimport type {\n  // TODO: Replace with @metamask/utils version after bumping json-rpc-engine\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from 'json-rpc-engine';\nimport { JsonRpcEngine } from 'json-rpc-engine';\nimport { createStreamMiddleware } from 'json-rpc-middleware-stream';\nimport { nanoid } from 'nanoid';\nimport { pipeline } from 'stream';\nimport type { Duplex } from 'stream';\n\nimport { log } from '../logging';\nimport { hasTimedOut, withTimeout } from '../utils';\nimport type {\n  ExecutionService,\n  ExecutionServiceMessenger,\n  SnapErrorJson,\n  SnapExecutionData,\n} from './ExecutionService';\n\nconst controllerName = 'ExecutionService';\n\nexport type SetupSnapProvider = (snapId: string, stream: Duplex) => void;\n\nexport type ExecutionServiceArgs = {\n  setupSnapProvider: SetupSnapProvider;\n  messenger: ExecutionServiceMessenger;\n  terminationTimeout?: number;\n};\n\nexport type JobStreams = {\n  command: Duplex;\n  rpc: Duplex;\n  _connection: BasePostMessageStream;\n};\n\nexport type Job<WorkerType> = {\n  id: string;\n  streams: JobStreams;\n  rpcEngine: JsonRpcEngine;\n  worker: WorkerType;\n};\n\nexport abstract class AbstractExecutionService<WorkerType>\n  implements ExecutionService\n{\n  #snapRpcHooks: Map<string, SnapRpcHook>;\n\n  // Cannot be hash private yet because of tests.\n  protected jobs: Map<string, Job<WorkerType>>;\n\n  // Cannot be hash private yet because of tests.\n  private readonly setupSnapProvider: SetupSnapProvider;\n\n  #snapToJobMap: Map<string, string>;\n\n  #jobToSnapMap: Map<string, string>;\n\n  #messenger: ExecutionServiceMessenger;\n\n  #terminationTimeout: number;\n\n  constructor({\n    setupSnapProvider,\n    messenger,\n    terminationTimeout = Duration.Second,\n  }: ExecutionServiceArgs) {\n    this.#snapRpcHooks = new Map();\n    this.jobs = new Map();\n    this.setupSnapProvider = setupSnapProvider;\n    this.#snapToJobMap = new Map();\n    this.#jobToSnapMap = new Map();\n    this.#messenger = messenger;\n    this.#terminationTimeout = terminationTimeout;\n\n    this.registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering the controller's messaging system\n   * actions.\n   */\n  private registerMessageHandlers(): void {\n    this.#messenger.registerActionHandler(\n      `${controllerName}:handleRpcRequest`,\n      async (snapId: string, options: SnapRpcHookArgs) =>\n        this.handleRpcRequest(snapId, options),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:executeSnap`,\n      async (snapData: SnapExecutionData) => this.executeSnap(snapData),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateSnap`,\n      async (snapId: string) => this.terminateSnap(snapId),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateAllSnaps`,\n      async () => this.terminateAllSnaps(),\n    );\n  }\n\n  /**\n   * Performs additional necessary work during job termination. **MUST** be\n   * implemented by concrete implementations. See\n   * {@link AbstractExecutionService.terminate} for details.\n   *\n   * @param job - The object corresponding to the job to be terminated.\n   */\n  protected abstract terminateJob(job: Job<WorkerType>): void;\n\n  /**\n   * Terminates the job with the specified ID and deletes all its associated\n   * data. Any subsequent messages targeting the job will fail with an error.\n   * Throws an error if the specified job does not exist, or if termination\n   * fails unexpectedly.\n   *\n   * @param jobId - The id of the job to be terminated.\n   */\n  public async terminate(jobId: string): Promise<void> {\n    const jobWrapper = this.jobs.get(jobId);\n    if (!jobWrapper) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    // Ping worker and tell it to run teardown, continue with termination if it takes too long\n    const result = await withTimeout(\n      this.command(jobId, {\n        jsonrpc: '2.0',\n        method: 'terminate',\n        params: [],\n        id: nanoid(),\n      }),\n      this.#terminationTimeout,\n    );\n\n    if (result === hasTimedOut || result !== 'OK') {\n      // We tried to shutdown gracefully but failed. This probably means the Snap is in infinite loop and\n      // hogging down the whole JS process.\n      // TODO(ritave): It might be doing weird things such as posting a lot of setTimeouts. Add a test to ensure that this behaviour\n      //               doesn't leak into other workers. Especially important in IframeExecutionEnvironment since they all share the same\n      //               JS process.\n      logError(`Job \"${jobId}\" failed to terminate gracefully.`, result);\n    }\n\n    Object.values(jobWrapper.streams).forEach((stream) => {\n      try {\n        !stream.destroyed && stream.destroy();\n        stream.removeAllListeners();\n      } catch (error) {\n        logError('Error while destroying stream', error);\n      }\n    });\n\n    this.terminateJob(jobWrapper);\n\n    this.#removeSnapAndJobMapping(jobId);\n    this.jobs.delete(jobId);\n    log(`Job \"${jobId}\" terminated.`);\n  }\n\n  /**\n   * Initiates a job for a snap.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @returns Information regarding the created job.\n   */\n  protected async initJob(): Promise<Job<WorkerType>> {\n    const jobId = nanoid();\n    const { streams, worker } = await this.initStreams(jobId);\n    const rpcEngine = new JsonRpcEngine();\n\n    const jsonRpcConnection = createStreamMiddleware();\n\n    pipeline(\n      jsonRpcConnection.stream,\n      streams.command,\n      jsonRpcConnection.stream,\n      (error) => {\n        if (error) {\n          logError(`Command stream failure.`, error);\n        }\n      },\n    );\n\n    rpcEngine.push(jsonRpcConnection.middleware);\n\n    const envMetadata = {\n      id: jobId,\n      streams,\n      rpcEngine,\n      worker,\n    };\n    this.jobs.set(jobId, envMetadata);\n\n    return envMetadata;\n  }\n\n  /**\n   * Sets up the streams for an initiated job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param jobId - The id of the job.\n   * @returns The streams to communicate with the worker and the worker itself.\n   */\n  protected async initStreams(\n    jobId: string,\n  ): Promise<{ streams: JobStreams; worker: WorkerType }> {\n    const { worker, stream: envStream } = await this.initEnvStream(jobId);\n    // Typecast justification: stream type mismatch\n    const mux = setupMultiplex(\n      envStream as unknown as Duplex,\n      `Job: \"${jobId}\"`,\n    );\n\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n\n    // Handle out-of-band errors, i.e. errors thrown from the snap outside of the req/res cycle.\n    // Also keep track of outbound request/responses\n    const notificationHandler = (\n      message:\n        | JsonRpcRequest<unknown>\n        | JsonRpcNotification<Json[] | Record<string, Json>>,\n    ) => {\n      if (!isJsonRpcNotification(message)) {\n        return;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      const snapId = this.#jobToSnapMap.get(jobId)!;\n      if (message.method === 'OutboundRequest') {\n        this.#messenger.publish('ExecutionService:outboundRequest', snapId);\n      } else if (message.method === 'OutboundResponse') {\n        this.#messenger.publish('ExecutionService:outboundResponse', snapId);\n      } else if (message.method === 'UnhandledError') {\n        if (isObject(message.params) && message.params.error) {\n          this.#messenger.publish(\n            'ExecutionService:unhandledError',\n            snapId,\n            message.params.error as SnapErrorJson,\n          );\n          commandStream.removeListener('data', notificationHandler);\n        } else {\n          logError(\n            new Error(\n              `Received malformed \"${message.method}\" command stream notification.`,\n            ),\n          );\n        }\n      } else {\n        logError(\n          new Error(\n            `Received unexpected command stream notification \"${message.method}\".`,\n          ),\n        );\n      }\n    };\n\n    commandStream.on('data', notificationHandler);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    // Typecast: stream type mismatch\n    return {\n      streams: {\n        command: commandStream as unknown as Duplex,\n        rpc: rpcStream,\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        _connection: envStream,\n      },\n      worker,\n    };\n  }\n\n  /**\n   * Abstract function implemented by implementing class that spins up a new worker for a job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   */\n  protected abstract initEnvStream(jobId: string): Promise<{\n    worker: WorkerType;\n    stream: BasePostMessageStream;\n  }>;\n\n  /**\n   * Terminates the Snap with the specified ID. May throw an error if\n   * termination unexpectedly fails, but will not fail if no job for the snap\n   * with the specified ID is found.\n   *\n   * @param snapId - The ID of the snap to terminate.\n   */\n  async terminateSnap(snapId: string) {\n    const jobId = this.#snapToJobMap.get(snapId);\n    if (jobId) {\n      await this.terminate(jobId);\n    }\n  }\n\n  async terminateAllSnaps() {\n    await Promise.all(\n      [...this.jobs.keys()].map(async (jobId) => this.terminate(jobId)),\n    );\n    this.#snapRpcHooks.clear();\n  }\n\n  /**\n   * Gets the RPC request handler for the given snap.\n   *\n   * @param snapId - The id of the Snap whose message handler to get.\n   * @returns The RPC request handler for the snap.\n   */\n  private getRpcRequestHandler(snapId: string) {\n    return this.#snapRpcHooks.get(snapId);\n  }\n\n  /**\n   * Initializes and executes a snap, setting up the communication channels to the snap etc.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param snapData - Data needed for Snap execution.\n   * @returns A string `OK` if execution succeeded.\n   * @throws If the execution service returns an error.\n   */\n  async executeSnap(snapData: SnapExecutionData): Promise<string> {\n    if (this.#snapToJobMap.has(snapData.snapId)) {\n      throw new Error(`Snap \"${snapData.snapId}\" is already being executed.`);\n    }\n\n    const job = await this.initJob();\n    this.#mapSnapAndJob(snapData.snapId, job.id);\n\n    // Ping the worker to ensure that it started up\n    await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'ping',\n      id: nanoid(),\n    });\n\n    const rpcStream = job.streams.rpc as unknown as Duplex;\n\n    this.setupSnapProvider(snapData.snapId, rpcStream);\n\n    const result = await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'executeSnap',\n      params: snapData,\n      id: nanoid(),\n    });\n    this.#createSnapHooks(snapData.snapId, job.id);\n    return result as string;\n  }\n\n  // Cannot be hash private yet because of tests.\n  private async command(\n    jobId: string,\n    message: JsonRpcRequest<unknown>,\n  ): Promise<unknown> {\n    if (typeof message !== 'object') {\n      throw new Error('Must send object.');\n    }\n\n    const job = this.jobs.get(jobId);\n    if (!job) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    log('Parent: Sending Command', message);\n    const response: PendingJsonRpcResponse<unknown> =\n      await job.rpcEngine.handle(message);\n    if (response.error) {\n      throw new Error(response.error.message);\n    }\n    return response.result;\n  }\n\n  #removeSnapHooks(snapId: string) {\n    this.#snapRpcHooks.delete(snapId);\n  }\n\n  #createSnapHooks(snapId: string, workerId: string) {\n    const rpcHook = async ({ origin, handler, request }: SnapRpcHookArgs) => {\n      return await this.command(workerId, {\n        id: nanoid(),\n        jsonrpc: '2.0',\n        method: 'snapRpc',\n        params: {\n          origin,\n          handler,\n          request,\n          target: snapId,\n        },\n      });\n    };\n\n    this.#snapRpcHooks.set(snapId, rpcHook);\n  }\n\n  #mapSnapAndJob(snapId: string, jobId: string): void {\n    this.#snapToJobMap.set(snapId, jobId);\n    this.#jobToSnapMap.set(jobId, snapId);\n  }\n\n  #removeSnapAndJobMapping(jobId: string): void {\n    const snapId = this.#jobToSnapMap.get(jobId);\n    if (!snapId) {\n      throw new Error(`job: \"${jobId}\" has no mapped snap.`);\n    }\n\n    this.#jobToSnapMap.delete(jobId);\n    this.#snapToJobMap.delete(snapId);\n    this.#removeSnapHooks(snapId);\n  }\n\n  /**\n   * Handle RPC request.\n   *\n   * @param snapId - The ID of the recipient snap.\n   * @param options - Bag of options to pass to the RPC handler.\n   * @returns Promise that can handle the request.\n   */\n  public async handleRpcRequest(\n    snapId: string,\n    options: SnapRpcHookArgs,\n  ): Promise<unknown> {\n    const rpcRequestHandler = await this.getRpcRequestHandler(snapId);\n\n    if (!rpcRequestHandler) {\n      throw new Error(\n        `Snap execution service returned no RPC handler for running snap \"${snapId}\".`,\n      );\n    }\n\n    return rpcRequestHandler(options);\n  }\n}\n\n/**\n * Sets up stream multiplexing for the given stream.\n *\n * @param connectionStream - The stream to mux.\n * @param streamName - The name of the stream, for identification in errors.\n * @returns The multiplexed stream.\n */\nexport function setupMultiplex(\n  connectionStream: Duplex,\n  streamName: string,\n): ObjectMultiplex {\n  const mux = new ObjectMultiplex();\n  pipeline(\n    connectionStream,\n    // Typecast: stream type mismatch\n    mux as unknown as Duplex,\n    connectionStream,\n    (error) => {\n      if (error) {\n        streamName\n          ? logError(`\"${streamName}\" stream failure.`, error)\n          : logError(error);\n      }\n    },\n  );\n  return mux;\n}\n"],"names":["ObjectMultiplex","SNAP_STREAM_NAMES","logError","Duration","isJsonRpcNotification","isObject","JsonRpcEngine","createStreamMiddleware","nanoid","pipeline","log","hasTimedOut","withTimeout","controllerName","AbstractExecutionService","registerMessageHandlers","messenger","registerActionHandler","snapId","options","handleRpcRequest","snapData","executeSnap","terminateSnap","terminateAllSnaps","terminate","jobId","jobWrapper","jobs","get","Error","result","command","jsonrpc","method","params","id","terminationTimeout","Object","values","streams","forEach","stream","destroyed","destroy","removeAllListeners","error","terminateJob","removeSnapAndJobMapping","delete","initJob","worker","initStreams","rpcEngine","jsonRpcConnection","push","middleware","envMetadata","set","envStream","initEnvStream","mux","setupMultiplex","commandStream","createStream","COMMAND","notificationHandler","message","jobToSnapMap","publish","removeListener","on","rpcStream","JSON_RPC","rpc","_connection","snapToJobMap","Promise","all","keys","map","snapRpcHooks","clear","getRpcRequestHandler","has","job","mapSnapAndJob","setupSnapProvider","createSnapHooks","response","handle","rpcRequestHandler","constructor","Second","Map","workerId","rpcHook","origin","handler","request","target","removeSnapHooks","connectionStream","streamName"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAOA,qBAAqB,6BAA6B;AAGzD,SAASC,iBAAiB,EAAEC,QAAQ,QAAQ,wBAAwB;AAEpE,SAASC,QAAQ,EAAEC,qBAAqB,EAAEC,QAAQ,QAAQ,kBAAkB;AAM5E,SAASC,aAAa,QAAQ,kBAAkB;AAChD,SAASC,sBAAsB,QAAQ,6BAA6B;AACpE,SAASC,MAAM,QAAQ,SAAS;AAChC,SAASC,QAAQ,QAAQ,SAAS;AAGlC,SAASC,GAAG,QAAQ,aAAa;AACjC,SAASC,WAAW,EAAEC,WAAW,QAAQ,WAAW;AAQpD,MAAMC,iBAAiB;IA0BrB,6CAQA,6CAEA,6CAEA,0CAEA,mDAgUA,gDAIA,gDAkBA,8CAKA;AA5WF,OAAO,MAAeC;IAmCpB;;;GAGC,GACD,AAAQC,0BAAgC;QACtC,yBAAA,IAAI,EAAEC,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,iBAAiB,CAAC,EACpC,OAAOK,QAAgBC,UACrB,IAAI,CAACC,gBAAgB,CAACF,QAAQC;QAGlC,yBAAA,IAAI,EAAEH,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,YAAY,CAAC,EAC/B,OAAOQ,WAAgC,IAAI,CAACC,WAAW,CAACD;QAG1D,yBAAA,IAAI,EAAEL,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,cAAc,CAAC,EACjC,OAAOK,SAAmB,IAAI,CAACK,aAAa,CAACL;QAG/C,yBAAA,IAAI,EAAEF,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,kBAAkB,CAAC,EACrC,UAAY,IAAI,CAACW,iBAAiB;IAEtC;IAWA;;;;;;;GAOC,GACD,MAAaC,UAAUC,KAAa,EAAiB;QACnD,MAAMC,aAAa,IAAI,CAACC,IAAI,CAACC,GAAG,CAACH;QACjC,IAAI,CAACC,YAAY;YACf,MAAM,IAAIG,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEA,0FAA0F;QAC1F,MAAMK,SAAS,MAAMnB,YACnB,IAAI,CAACoB,OAAO,CAACN,OAAO;YAClBO,SAAS;YACTC,QAAQ;YACRC,QAAQ,EAAE;YACVC,IAAI5B;QACN,6BACA,IAAI,EAAE6B;QAGR,IAAIN,WAAWpB,eAAeoB,WAAW,MAAM;YAC7C,mGAAmG;YACnG,qCAAqC;YACrC,8HAA8H;YAC9H,kIAAkI;YAClI,4BAA4B;YAC5B7B,SAAS,CAAC,KAAK,EAAEwB,MAAM,iCAAiC,CAAC,EAAEK;QAC7D;QAEAO,OAAOC,MAAM,CAACZ,WAAWa,OAAO,EAAEC,OAAO,CAAC,CAACC;YACzC,IAAI;gBACF,CAACA,OAAOC,SAAS,IAAID,OAAOE,OAAO;gBACnCF,OAAOG,kBAAkB;YAC3B,EAAE,OAAOC,OAAO;gBACd5C,SAAS,iCAAiC4C;YAC5C;QACF;QAEA,IAAI,CAACC,YAAY,CAACpB;QAElB,0BAAA,IAAI,EAAEqB,0BAAAA,8BAAN,IAAI,EAA0BtB;QAC9B,IAAI,CAACE,IAAI,CAACqB,MAAM,CAACvB;QACjBhB,IAAI,CAAC,KAAK,EAAEgB,MAAM,aAAa,CAAC;IAClC;IAEA;;;;;;GAMC,GACD,MAAgBwB,UAAoC;QAClD,MAAMxB,QAAQlB;QACd,MAAM,EAAEgC,OAAO,EAAEW,MAAM,EAAE,GAAG,MAAM,IAAI,CAACC,WAAW,CAAC1B;QACnD,MAAM2B,YAAY,IAAI/C;QAEtB,MAAMgD,oBAAoB/C;QAE1BE,SACE6C,kBAAkBZ,MAAM,EACxBF,QAAQR,OAAO,EACfsB,kBAAkBZ,MAAM,EACxB,CAACI;YACC,IAAIA,OAAO;gBACT5C,SAAS,CAAC,uBAAuB,CAAC,EAAE4C;YACtC;QACF;QAGFO,UAAUE,IAAI,CAACD,kBAAkBE,UAAU;QAE3C,MAAMC,cAAc;YAClBrB,IAAIV;YACJc;YACAa;YACAF;QACF;QACA,IAAI,CAACvB,IAAI,CAAC8B,GAAG,CAAChC,OAAO+B;QAErB,OAAOA;IACT;IAEA;;;;;;;GAOC,GACD,MAAgBL,YACd1B,KAAa,EACyC;QACtD,MAAM,EAAEyB,MAAM,EAAET,QAAQiB,SAAS,EAAE,GAAG,MAAM,IAAI,CAACC,aAAa,CAAClC;QAC/D,+CAA+C;QAC/C,MAAMmC,MAAMC,eACVH,WACA,CAAC,MAAM,EAAEjC,MAAM,CAAC,CAAC;QAGnB,MAAMqC,gBAAgBF,IAAIG,YAAY,CAAC/D,kBAAkBgE,OAAO;QAEhE,4FAA4F;QAC5F,gDAAgD;QAChD,MAAMC,sBAAsB,CAC1BC;YAIA,IAAI,CAAC/D,sBAAsB+D,UAAU;gBACnC;YACF;YAEA,oEAAoE;YACpE,MAAMjD,SAAS,yBAAA,IAAI,EAAEkD,eAAavC,GAAG,CAACH;YACtC,IAAIyC,QAAQjC,MAAM,KAAK,mBAAmB;gBACxC,yBAAA,IAAI,EAAElB,YAAUqD,OAAO,CAAC,oCAAoCnD;YAC9D,OAAO,IAAIiD,QAAQjC,MAAM,KAAK,oBAAoB;gBAChD,yBAAA,IAAI,EAAElB,YAAUqD,OAAO,CAAC,qCAAqCnD;YAC/D,OAAO,IAAIiD,QAAQjC,MAAM,KAAK,kBAAkB;gBAC9C,IAAI7B,SAAS8D,QAAQhC,MAAM,KAAKgC,QAAQhC,MAAM,CAACW,KAAK,EAAE;oBACpD,yBAAA,IAAI,EAAE9B,YAAUqD,OAAO,CACrB,mCACAnD,QACAiD,QAAQhC,MAAM,CAACW,KAAK;oBAEtBiB,cAAcO,cAAc,CAAC,QAAQJ;gBACvC,OAAO;oBACLhE,SACE,IAAI4B,MACF,CAAC,oBAAoB,EAAEqC,QAAQjC,MAAM,CAAC,8BAA8B,CAAC;gBAG3E;YACF,OAAO;gBACLhC,SACE,IAAI4B,MACF,CAAC,iDAAiD,EAAEqC,QAAQjC,MAAM,CAAC,EAAE,CAAC;YAG5E;QACF;QAEA6B,cAAcQ,EAAE,CAAC,QAAQL;QACzB,MAAMM,YAAYX,IAAIG,YAAY,CAAC/D,kBAAkBwE,QAAQ;QAE7D,iCAAiC;QACjC,OAAO;YACLjC,SAAS;gBACPR,SAAS+B;gBACTW,KAAKF;gBACL,gEAAgE;gBAChEG,aAAahB;YACf;YACAR;QACF;IACF;IAYA;;;;;;GAMC,GACD,MAAM5B,cAAcL,MAAc,EAAE;QAClC,MAAMQ,QAAQ,yBAAA,IAAI,EAAEkD,eAAa/C,GAAG,CAACX;QACrC,IAAIQ,OAAO;YACT,MAAM,IAAI,CAACD,SAAS,CAACC;QACvB;IACF;IAEA,MAAMF,oBAAoB;QACxB,MAAMqD,QAAQC,GAAG,CACf;eAAI,IAAI,CAAClD,IAAI,CAACmD,IAAI;SAAG,CAACC,GAAG,CAAC,OAAOtD,QAAU,IAAI,CAACD,SAAS,CAACC;QAE5D,yBAAA,IAAI,EAAEuD,eAAaC,KAAK;IAC1B;IAEA;;;;;GAKC,GACD,AAAQC,qBAAqBjE,MAAc,EAAE;QAC3C,OAAO,yBAAA,IAAI,EAAE+D,eAAapD,GAAG,CAACX;IAChC;IAEA;;;;;;;;GAQC,GACD,MAAMI,YAAYD,QAA2B,EAAmB;QAC9D,IAAI,yBAAA,IAAI,EAAEuD,eAAaQ,GAAG,CAAC/D,SAASH,MAAM,GAAG;YAC3C,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAET,SAASH,MAAM,CAAC,4BAA4B,CAAC;QACxE;QAEA,MAAMmE,MAAM,MAAM,IAAI,CAACnC,OAAO;QAC9B,0BAAA,IAAI,EAAEoC,gBAAAA,oBAAN,IAAI,EAAgBjE,SAASH,MAAM,EAAEmE,IAAIjD,EAAE;QAE3C,+CAA+C;QAC/C,MAAM,IAAI,CAACJ,OAAO,CAACqD,IAAIjD,EAAE,EAAE;YACzBH,SAAS;YACTC,QAAQ;YACRE,IAAI5B;QACN;QAEA,MAAMgE,YAAYa,IAAI7C,OAAO,CAACkC,GAAG;QAEjC,IAAI,CAACa,iBAAiB,CAAClE,SAASH,MAAM,EAAEsD;QAExC,MAAMzC,SAAS,MAAM,IAAI,CAACC,OAAO,CAACqD,IAAIjD,EAAE,EAAE;YACxCH,SAAS;YACTC,QAAQ;YACRC,QAAQd;YACRe,IAAI5B;QACN;QACA,0BAAA,IAAI,EAAEgF,kBAAAA,sBAAN,IAAI,EAAkBnE,SAASH,MAAM,EAAEmE,IAAIjD,EAAE;QAC7C,OAAOL;IACT;IAEA,+CAA+C;IAC/C,MAAcC,QACZN,KAAa,EACbyC,OAAgC,EACd;QAClB,IAAI,OAAOA,YAAY,UAAU;YAC/B,MAAM,IAAIrC,MAAM;QAClB;QAEA,MAAMuD,MAAM,IAAI,CAACzD,IAAI,CAACC,GAAG,CAACH;QAC1B,IAAI,CAAC2D,KAAK;YACR,MAAM,IAAIvD,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEAhB,IAAI,2BAA2ByD;QAC/B,MAAMsB,WACJ,MAAMJ,IAAIhC,SAAS,CAACqC,MAAM,CAACvB;QAC7B,IAAIsB,SAAS3C,KAAK,EAAE;YAClB,MAAM,IAAIhB,MAAM2D,SAAS3C,KAAK,CAACqB,OAAO;QACxC;QACA,OAAOsB,SAAS1D,MAAM;IACxB;IAwCA;;;;;;GAMC,GACD,MAAaX,iBACXF,MAAc,EACdC,OAAwB,EACN;QAClB,MAAMwE,oBAAoB,MAAM,IAAI,CAACR,oBAAoB,CAACjE;QAE1D,IAAI,CAACyE,mBAAmB;YACtB,MAAM,IAAI7D,MACR,CAAC,iEAAiE,EAAEZ,OAAO,EAAE,CAAC;QAElF;QAEA,OAAOyE,kBAAkBxE;IAC3B;IAxXAyE,YAAY,EACVL,iBAAiB,EACjBvE,SAAS,EACTqB,qBAAqBlC,SAAS0F,MAAM,EACf,CAAE;QA0TzB,iCAAA;QAIA,iCAAA;QAkBA,iCAAA;QAKA,iCAAA;QAzWA,gCAAA;;mBAAA,KAAA;;QAEA,+CAA+C;QAC/C,uBAAUjE,QAAV,KAAA;QAEA,+CAA+C;QAC/C,uBAAiB2D,qBAAjB,KAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAOQN,eAAe,IAAIa;QACzB,IAAI,CAAClE,IAAI,GAAG,IAAIkE;QAChB,IAAI,CAACP,iBAAiB,GAAGA;uCACnBX,eAAe,IAAIkB;uCACnB1B,eAAe,IAAI0B;uCACnB9E,YAAYA;uCACZqB,qBAAqBA;QAE3B,IAAI,CAACtB,uBAAuB;IAC9B;AA2WF;AA3DE,SAAA,gBAAiBG,MAAc;IAC7B,yBAAA,IAAI,EAAE+D,eAAahC,MAAM,CAAC/B;AAC5B;AAEA,SAAA,gBAAiBA,MAAc,EAAE6E,QAAgB;IAC/C,MAAMC,UAAU,OAAO,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAmB;QAClE,OAAO,MAAM,IAAI,CAACnE,OAAO,CAAC+D,UAAU;YAClC3D,IAAI5B;YACJyB,SAAS;YACTC,QAAQ;YACRC,QAAQ;gBACN8D;gBACAC;gBACAC;gBACAC,QAAQlF;YACV;QACF;IACF;IAEA,yBAAA,IAAI,EAAE+D,eAAavB,GAAG,CAACxC,QAAQ8E;AACjC;AAEA,SAAA,cAAe9E,MAAc,EAAEQ,KAAa;IAC1C,yBAAA,IAAI,EAAEkD,eAAalB,GAAG,CAACxC,QAAQQ;IAC/B,yBAAA,IAAI,EAAE0C,eAAaV,GAAG,CAAChC,OAAOR;AAChC;AAEA,SAAA,wBAAyBQ,KAAa;IACpC,MAAMR,SAAS,yBAAA,IAAI,EAAEkD,eAAavC,GAAG,CAACH;IACtC,IAAI,CAACR,QAAQ;QACX,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAEJ,MAAM,qBAAqB,CAAC;IACvD;IAEA,yBAAA,IAAI,EAAE0C,eAAanB,MAAM,CAACvB;IAC1B,yBAAA,IAAI,EAAEkD,eAAa3B,MAAM,CAAC/B;IAC1B,0BAAA,IAAI,EAAEmF,kBAAAA,sBAAN,IAAI,EAAkBnF;AACxB;AAyBF;;;;;;CAMC,GACD,OAAO,SAAS4C,eACdwC,gBAAwB,EACxBC,UAAkB;IAElB,MAAM1C,MAAM,IAAI7D;IAChBS,SACE6F,kBACA,iCAAiC;IACjCzC,KACAyC,kBACA,CAACxD;QACC,IAAIA,OAAO;YACTyD,aACIrG,SAAS,CAAC,CAAC,EAAEqG,WAAW,iBAAiB,CAAC,EAAEzD,SAC5C5C,SAAS4C;QACf;IACF;IAEF,OAAOe;AACT"}
+{"version":3,"sources":["../../../src/services/AbstractExecutionService.ts"],"sourcesContent":["import { JsonRpcEngine } from '@metamask/json-rpc-engine';\nimport ObjectMultiplex from '@metamask/object-multiplex';\nimport type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { JsonRpcError } from '@metamask/rpc-errors';\nimport type { SnapRpcHook, SnapRpcHookArgs } from '@metamask/snaps-utils';\nimport { SNAP_STREAM_NAMES, logError } from '@metamask/snaps-utils';\nimport type {\n  Json,\n  JsonRpcNotification,\n  JsonRpcRequest,\n  PendingJsonRpcResponse,\n} from '@metamask/utils';\nimport { Duration, isJsonRpcNotification, isObject } from '@metamask/utils';\nimport { createStreamMiddleware } from 'json-rpc-middleware-stream';\nimport { nanoid } from 'nanoid';\nimport { pipeline } from 'stream';\nimport type { Duplex } from 'stream';\n\nimport { log } from '../logging';\nimport { hasTimedOut, withTimeout } from '../utils';\nimport type {\n  ExecutionService,\n  ExecutionServiceMessenger,\n  SnapErrorJson,\n  SnapExecutionData,\n} from './ExecutionService';\n\nconst controllerName = 'ExecutionService';\n\nexport type SetupSnapProvider = (snapId: string, stream: Duplex) => void;\n\nexport type ExecutionServiceArgs = {\n  setupSnapProvider: SetupSnapProvider;\n  messenger: ExecutionServiceMessenger;\n  terminationTimeout?: number;\n};\n\nexport type JobStreams = {\n  command: Duplex;\n  rpc: Duplex;\n  _connection: BasePostMessageStream;\n};\n\nexport type Job<WorkerType> = {\n  id: string;\n  streams: JobStreams;\n  rpcEngine: JsonRpcEngine;\n  worker: WorkerType;\n};\n\nexport abstract class AbstractExecutionService<WorkerType>\n  implements ExecutionService\n{\n  #snapRpcHooks: Map<string, SnapRpcHook>;\n\n  // Cannot be hash private yet because of tests.\n  protected jobs: Map<string, Job<WorkerType>>;\n\n  // Cannot be hash private yet because of tests.\n  private readonly setupSnapProvider: SetupSnapProvider;\n\n  #snapToJobMap: Map<string, string>;\n\n  #jobToSnapMap: Map<string, string>;\n\n  #messenger: ExecutionServiceMessenger;\n\n  #terminationTimeout: number;\n\n  constructor({\n    setupSnapProvider,\n    messenger,\n    terminationTimeout = Duration.Second,\n  }: ExecutionServiceArgs) {\n    this.#snapRpcHooks = new Map();\n    this.jobs = new Map();\n    this.setupSnapProvider = setupSnapProvider;\n    this.#snapToJobMap = new Map();\n    this.#jobToSnapMap = new Map();\n    this.#messenger = messenger;\n    this.#terminationTimeout = terminationTimeout;\n\n    this.registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering the controller's messaging system\n   * actions.\n   */\n  private registerMessageHandlers(): void {\n    this.#messenger.registerActionHandler(\n      `${controllerName}:handleRpcRequest`,\n      async (snapId: string, options: SnapRpcHookArgs) =>\n        this.handleRpcRequest(snapId, options),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:executeSnap`,\n      async (snapData: SnapExecutionData) => this.executeSnap(snapData),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateSnap`,\n      async (snapId: string) => this.terminateSnap(snapId),\n    );\n\n    this.#messenger.registerActionHandler(\n      `${controllerName}:terminateAllSnaps`,\n      async () => this.terminateAllSnaps(),\n    );\n  }\n\n  /**\n   * Performs additional necessary work during job termination. **MUST** be\n   * implemented by concrete implementations. See\n   * {@link AbstractExecutionService.terminate} for details.\n   *\n   * @param job - The object corresponding to the job to be terminated.\n   */\n  protected abstract terminateJob(job: Job<WorkerType>): void;\n\n  /**\n   * Terminates the job with the specified ID and deletes all its associated\n   * data. Any subsequent messages targeting the job will fail with an error.\n   * Throws an error if the specified job does not exist, or if termination\n   * fails unexpectedly.\n   *\n   * @param jobId - The id of the job to be terminated.\n   */\n  public async terminate(jobId: string): Promise<void> {\n    const jobWrapper = this.jobs.get(jobId);\n    if (!jobWrapper) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    // Ping worker and tell it to run teardown, continue with termination if it takes too long\n    const result = await withTimeout(\n      this.command(jobId, {\n        jsonrpc: '2.0',\n        method: 'terminate',\n        params: [],\n        id: nanoid(),\n      }),\n      this.#terminationTimeout,\n    );\n\n    if (result === hasTimedOut || result !== 'OK') {\n      // We tried to shutdown gracefully but failed. This probably means the Snap is in infinite loop and\n      // hogging down the whole JS process.\n      // TODO(ritave): It might be doing weird things such as posting a lot of setTimeouts. Add a test to ensure that this behaviour\n      //               doesn't leak into other workers. Especially important in IframeExecutionEnvironment since they all share the same\n      //               JS process.\n      logError(`Job \"${jobId}\" failed to terminate gracefully.`, result);\n    }\n\n    Object.values(jobWrapper.streams).forEach((stream) => {\n      try {\n        !stream.destroyed && stream.destroy();\n        stream.removeAllListeners();\n      } catch (error) {\n        logError('Error while destroying stream', error);\n      }\n    });\n\n    this.terminateJob(jobWrapper);\n\n    this.#removeSnapAndJobMapping(jobId);\n    this.jobs.delete(jobId);\n    log(`Job \"${jobId}\" terminated.`);\n  }\n\n  /**\n   * Initiates a job for a snap.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @returns Information regarding the created job.\n   */\n  protected async initJob(): Promise<Job<WorkerType>> {\n    const jobId = nanoid();\n    const { streams, worker } = await this.initStreams(jobId);\n    const rpcEngine = new JsonRpcEngine();\n\n    const jsonRpcConnection = createStreamMiddleware();\n\n    pipeline(\n      jsonRpcConnection.stream,\n      streams.command,\n      jsonRpcConnection.stream,\n      (error) => {\n        if (error) {\n          logError(`Command stream failure.`, error);\n        }\n      },\n    );\n\n    rpcEngine.push(jsonRpcConnection.middleware);\n\n    const envMetadata = {\n      id: jobId,\n      streams,\n      rpcEngine,\n      worker,\n    };\n    this.jobs.set(jobId, envMetadata);\n\n    return envMetadata;\n  }\n\n  /**\n   * Sets up the streams for an initiated job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param jobId - The id of the job.\n   * @returns The streams to communicate with the worker and the worker itself.\n   */\n  protected async initStreams(\n    jobId: string,\n  ): Promise<{ streams: JobStreams; worker: WorkerType }> {\n    const { worker, stream: envStream } = await this.initEnvStream(jobId);\n    const mux = setupMultiplex(envStream, `Job: \"${jobId}\"`);\n    const commandStream = mux.createStream(SNAP_STREAM_NAMES.COMMAND);\n\n    // Handle out-of-band errors, i.e. errors thrown from the snap outside of the req/res cycle.\n    // Also keep track of outbound request/responses\n    const notificationHandler = (\n      message:\n        | JsonRpcRequest\n        | JsonRpcNotification<Json[] | Record<string, Json>>,\n    ) => {\n      if (!isJsonRpcNotification(message)) {\n        return;\n      }\n\n      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n      const snapId = this.#jobToSnapMap.get(jobId)!;\n      if (message.method === 'OutboundRequest') {\n        this.#messenger.publish('ExecutionService:outboundRequest', snapId);\n      } else if (message.method === 'OutboundResponse') {\n        this.#messenger.publish('ExecutionService:outboundResponse', snapId);\n      } else if (message.method === 'UnhandledError') {\n        if (isObject(message.params) && message.params.error) {\n          this.#messenger.publish(\n            'ExecutionService:unhandledError',\n            snapId,\n            message.params.error as SnapErrorJson,\n          );\n          commandStream.removeListener('data', notificationHandler);\n        } else {\n          logError(\n            new Error(\n              `Received malformed \"${message.method}\" command stream notification.`,\n            ),\n          );\n        }\n      } else {\n        logError(\n          new Error(\n            `Received unexpected command stream notification \"${message.method}\".`,\n          ),\n        );\n      }\n    };\n\n    commandStream.on('data', notificationHandler);\n    const rpcStream = mux.createStream(SNAP_STREAM_NAMES.JSON_RPC);\n\n    // Typecast: stream type mismatch\n    return {\n      streams: {\n        command: commandStream,\n        rpc: rpcStream,\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        _connection: envStream,\n      },\n      worker,\n    };\n  }\n\n  /**\n   * Abstract function implemented by implementing class that spins up a new worker for a job.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   */\n  protected abstract initEnvStream(jobId: string): Promise<{\n    worker: WorkerType;\n    stream: BasePostMessageStream;\n  }>;\n\n  /**\n   * Terminates the Snap with the specified ID. May throw an error if\n   * termination unexpectedly fails, but will not fail if no job for the snap\n   * with the specified ID is found.\n   *\n   * @param snapId - The ID of the snap to terminate.\n   */\n  async terminateSnap(snapId: string) {\n    const jobId = this.#snapToJobMap.get(snapId);\n    if (jobId) {\n      await this.terminate(jobId);\n    }\n  }\n\n  async terminateAllSnaps() {\n    await Promise.all(\n      [...this.jobs.keys()].map(async (jobId) => this.terminate(jobId)),\n    );\n    this.#snapRpcHooks.clear();\n  }\n\n  /**\n   * Gets the RPC request handler for the given snap.\n   *\n   * @param snapId - The id of the Snap whose message handler to get.\n   * @returns The RPC request handler for the snap.\n   */\n  private getRpcRequestHandler(snapId: string) {\n    return this.#snapRpcHooks.get(snapId);\n  }\n\n  /**\n   * Initializes and executes a snap, setting up the communication channels to the snap etc.\n   *\n   * Depending on the execution environment, this may run forever if the Snap fails to start up properly, therefore any call to this function should be wrapped in a timeout.\n   *\n   * @param snapData - Data needed for Snap execution.\n   * @returns A string `OK` if execution succeeded.\n   * @throws If the execution service returns an error.\n   */\n  async executeSnap(snapData: SnapExecutionData): Promise<string> {\n    if (this.#snapToJobMap.has(snapData.snapId)) {\n      throw new Error(`Snap \"${snapData.snapId}\" is already being executed.`);\n    }\n\n    const job = await this.initJob();\n    this.#mapSnapAndJob(snapData.snapId, job.id);\n\n    // Ping the worker to ensure that it started up\n    await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'ping',\n      id: nanoid(),\n    });\n\n    const rpcStream = job.streams.rpc;\n\n    this.setupSnapProvider(snapData.snapId, rpcStream);\n\n    const result = await this.command(job.id, {\n      jsonrpc: '2.0',\n      method: 'executeSnap',\n      params: snapData,\n      id: nanoid(),\n    });\n    this.#createSnapHooks(snapData.snapId, job.id);\n    return result as string;\n  }\n\n  // Cannot be hash private yet because of tests.\n  private async command(\n    jobId: string,\n    message: JsonRpcRequest,\n  ): Promise<Json | undefined> {\n    if (typeof message !== 'object') {\n      throw new Error('Must send object.');\n    }\n\n    const job = this.jobs.get(jobId);\n    if (!job) {\n      throw new Error(`Job with id \"${jobId}\" not found.`);\n    }\n\n    log('Parent: Sending Command', message);\n    const response: PendingJsonRpcResponse<Json> = await job.rpcEngine.handle(\n      message,\n    );\n\n    if (response.error) {\n      throw new JsonRpcError(\n        response.error.code,\n        response.error.message,\n        response.error.data,\n      );\n    }\n\n    return response.result;\n  }\n\n  #removeSnapHooks(snapId: string) {\n    this.#snapRpcHooks.delete(snapId);\n  }\n\n  #createSnapHooks(snapId: string, workerId: string) {\n    const rpcHook = async ({ origin, handler, request }: SnapRpcHookArgs) => {\n      return await this.command(workerId, {\n        id: nanoid(),\n        jsonrpc: '2.0',\n        method: 'snapRpc',\n        params: {\n          origin,\n          handler,\n          request: request as JsonRpcRequest,\n          target: snapId,\n        },\n      });\n    };\n\n    this.#snapRpcHooks.set(snapId, rpcHook);\n  }\n\n  #mapSnapAndJob(snapId: string, jobId: string): void {\n    this.#snapToJobMap.set(snapId, jobId);\n    this.#jobToSnapMap.set(jobId, snapId);\n  }\n\n  #removeSnapAndJobMapping(jobId: string): void {\n    const snapId = this.#jobToSnapMap.get(jobId);\n    if (!snapId) {\n      throw new Error(`job: \"${jobId}\" has no mapped snap.`);\n    }\n\n    this.#jobToSnapMap.delete(jobId);\n    this.#snapToJobMap.delete(snapId);\n    this.#removeSnapHooks(snapId);\n  }\n\n  /**\n   * Handle RPC request.\n   *\n   * @param snapId - The ID of the recipient snap.\n   * @param options - Bag of options to pass to the RPC handler.\n   * @returns Promise that can handle the request.\n   */\n  public async handleRpcRequest(\n    snapId: string,\n    options: SnapRpcHookArgs,\n  ): Promise<unknown> {\n    const rpcRequestHandler = this.getRpcRequestHandler(snapId);\n\n    if (!rpcRequestHandler) {\n      throw new Error(\n        `Snap execution service returned no RPC handler for running snap \"${snapId}\".`,\n      );\n    }\n\n    return rpcRequestHandler(options);\n  }\n}\n\n/**\n * Sets up stream multiplexing for the given stream.\n *\n * @param connectionStream - The stream to mux.\n * @param streamName - The name of the stream, for identification in errors.\n * @returns The multiplexed stream.\n */\nexport function setupMultiplex(\n  connectionStream: Duplex,\n  streamName: string,\n): ObjectMultiplex {\n  const mux = new ObjectMultiplex();\n  pipeline(connectionStream, mux, connectionStream, (error) => {\n    if (error) {\n      streamName\n        ? logError(`\"${streamName}\" stream failure.`, error)\n        : logError(error);\n    }\n  });\n  return mux;\n}\n"],"names":["JsonRpcEngine","ObjectMultiplex","JsonRpcError","SNAP_STREAM_NAMES","logError","Duration","isJsonRpcNotification","isObject","createStreamMiddleware","nanoid","pipeline","log","hasTimedOut","withTimeout","controllerName","AbstractExecutionService","registerMessageHandlers","messenger","registerActionHandler","snapId","options","handleRpcRequest","snapData","executeSnap","terminateSnap","terminateAllSnaps","terminate","jobId","jobWrapper","jobs","get","Error","result","command","jsonrpc","method","params","id","terminationTimeout","Object","values","streams","forEach","stream","destroyed","destroy","removeAllListeners","error","terminateJob","removeSnapAndJobMapping","delete","initJob","worker","initStreams","rpcEngine","jsonRpcConnection","push","middleware","envMetadata","set","envStream","initEnvStream","mux","setupMultiplex","commandStream","createStream","COMMAND","notificationHandler","message","jobToSnapMap","publish","removeListener","on","rpcStream","JSON_RPC","rpc","_connection","snapToJobMap","Promise","all","keys","map","snapRpcHooks","clear","getRpcRequestHandler","has","job","mapSnapAndJob","setupSnapProvider","createSnapHooks","response","handle","code","data","rpcRequestHandler","constructor","Second","Map","workerId","rpcHook","origin","handler","request","target","removeSnapHooks","connectionStream","streamName"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,SAASA,aAAa,QAAQ,4BAA4B;AAC1D,OAAOC,qBAAqB,6BAA6B;AAEzD,SAASC,YAAY,QAAQ,uBAAuB;AAEpD,SAASC,iBAAiB,EAAEC,QAAQ,QAAQ,wBAAwB;AAOpE,SAASC,QAAQ,EAAEC,qBAAqB,EAAEC,QAAQ,QAAQ,kBAAkB;AAC5E,SAASC,sBAAsB,QAAQ,6BAA6B;AACpE,SAASC,MAAM,QAAQ,SAAS;AAChC,SAASC,QAAQ,QAAQ,SAAS;AAGlC,SAASC,GAAG,QAAQ,aAAa;AACjC,SAASC,WAAW,EAAEC,WAAW,QAAQ,WAAW;AAQpD,MAAMC,iBAAiB;IA0BrB,6CAQA,6CAEA,6CAEA,0CAEA,mDAkUA,gDAIA,gDAkBA,8CAKA;AA9WF,OAAO,MAAeC;IAmCpB;;;GAGC,GACD,AAAQC,0BAAgC;QACtC,yBAAA,IAAI,EAAEC,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,iBAAiB,CAAC,EACpC,OAAOK,QAAgBC,UACrB,IAAI,CAACC,gBAAgB,CAACF,QAAQC;QAGlC,yBAAA,IAAI,EAAEH,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,YAAY,CAAC,EAC/B,OAAOQ,WAAgC,IAAI,CAACC,WAAW,CAACD;QAG1D,yBAAA,IAAI,EAAEL,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,cAAc,CAAC,EACjC,OAAOK,SAAmB,IAAI,CAACK,aAAa,CAACL;QAG/C,yBAAA,IAAI,EAAEF,YAAUC,qBAAqB,CACnC,CAAC,EAAEJ,eAAe,kBAAkB,CAAC,EACrC,UAAY,IAAI,CAACW,iBAAiB;IAEtC;IAWA;;;;;;;GAOC,GACD,MAAaC,UAAUC,KAAa,EAAiB;QACnD,MAAMC,aAAa,IAAI,CAACC,IAAI,CAACC,GAAG,CAACH;QACjC,IAAI,CAACC,YAAY;YACf,MAAM,IAAIG,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEA,0FAA0F;QAC1F,MAAMK,SAAS,MAAMnB,YACnB,IAAI,CAACoB,OAAO,CAACN,OAAO;YAClBO,SAAS;YACTC,QAAQ;YACRC,QAAQ,EAAE;YACVC,IAAI5B;QACN,6BACA,IAAI,EAAE6B;QAGR,IAAIN,WAAWpB,eAAeoB,WAAW,MAAM;YAC7C,mGAAmG;YACnG,qCAAqC;YACrC,8HAA8H;YAC9H,kIAAkI;YAClI,4BAA4B;YAC5B5B,SAAS,CAAC,KAAK,EAAEuB,MAAM,iCAAiC,CAAC,EAAEK;QAC7D;QAEAO,OAAOC,MAAM,CAACZ,WAAWa,OAAO,EAAEC,OAAO,CAAC,CAACC;YACzC,IAAI;gBACF,CAACA,OAAOC,SAAS,IAAID,OAAOE,OAAO;gBACnCF,OAAOG,kBAAkB;YAC3B,EAAE,OAAOC,OAAO;gBACd3C,SAAS,iCAAiC2C;YAC5C;QACF;QAEA,IAAI,CAACC,YAAY,CAACpB;QAElB,0BAAA,IAAI,EAAEqB,0BAAAA,8BAAN,IAAI,EAA0BtB;QAC9B,IAAI,CAACE,IAAI,CAACqB,MAAM,CAACvB;QACjBhB,IAAI,CAAC,KAAK,EAAEgB,MAAM,aAAa,CAAC;IAClC;IAEA;;;;;;GAMC,GACD,MAAgBwB,UAAoC;QAClD,MAAMxB,QAAQlB;QACd,MAAM,EAAEgC,OAAO,EAAEW,MAAM,EAAE,GAAG,MAAM,IAAI,CAACC,WAAW,CAAC1B;QACnD,MAAM2B,YAAY,IAAItD;QAEtB,MAAMuD,oBAAoB/C;QAE1BE,SACE6C,kBAAkBZ,MAAM,EACxBF,QAAQR,OAAO,EACfsB,kBAAkBZ,MAAM,EACxB,CAACI;YACC,IAAIA,OAAO;gBACT3C,SAAS,CAAC,uBAAuB,CAAC,EAAE2C;YACtC;QACF;QAGFO,UAAUE,IAAI,CAACD,kBAAkBE,UAAU;QAE3C,MAAMC,cAAc;YAClBrB,IAAIV;YACJc;YACAa;YACAF;QACF;QACA,IAAI,CAACvB,IAAI,CAAC8B,GAAG,CAAChC,OAAO+B;QAErB,OAAOA;IACT;IAEA;;;;;;;GAOC,GACD,MAAgBL,YACd1B,KAAa,EACyC;QACtD,MAAM,EAAEyB,MAAM,EAAET,QAAQiB,SAAS,EAAE,GAAG,MAAM,IAAI,CAACC,aAAa,CAAClC;QAC/D,MAAMmC,MAAMC,eAAeH,WAAW,CAAC,MAAM,EAAEjC,MAAM,CAAC,CAAC;QACvD,MAAMqC,gBAAgBF,IAAIG,YAAY,CAAC9D,kBAAkB+D,OAAO;QAEhE,4FAA4F;QAC5F,gDAAgD;QAChD,MAAMC,sBAAsB,CAC1BC;YAIA,IAAI,CAAC9D,sBAAsB8D,UAAU;gBACnC;YACF;YAEA,oEAAoE;YACpE,MAAMjD,SAAS,yBAAA,IAAI,EAAEkD,eAAavC,GAAG,CAACH;YACtC,IAAIyC,QAAQjC,MAAM,KAAK,mBAAmB;gBACxC,yBAAA,IAAI,EAAElB,YAAUqD,OAAO,CAAC,oCAAoCnD;YAC9D,OAAO,IAAIiD,QAAQjC,MAAM,KAAK,oBAAoB;gBAChD,yBAAA,IAAI,EAAElB,YAAUqD,OAAO,CAAC,qCAAqCnD;YAC/D,OAAO,IAAIiD,QAAQjC,MAAM,KAAK,kBAAkB;gBAC9C,IAAI5B,SAAS6D,QAAQhC,MAAM,KAAKgC,QAAQhC,MAAM,CAACW,KAAK,EAAE;oBACpD,yBAAA,IAAI,EAAE9B,YAAUqD,OAAO,CACrB,mCACAnD,QACAiD,QAAQhC,MAAM,CAACW,KAAK;oBAEtBiB,cAAcO,cAAc,CAAC,QAAQJ;gBACvC,OAAO;oBACL/D,SACE,IAAI2B,MACF,CAAC,oBAAoB,EAAEqC,QAAQjC,MAAM,CAAC,8BAA8B,CAAC;gBAG3E;YACF,OAAO;gBACL/B,SACE,IAAI2B,MACF,CAAC,iDAAiD,EAAEqC,QAAQjC,MAAM,CAAC,EAAE,CAAC;YAG5E;QACF;QAEA6B,cAAcQ,EAAE,CAAC,QAAQL;QACzB,MAAMM,YAAYX,IAAIG,YAAY,CAAC9D,kBAAkBuE,QAAQ;QAE7D,iCAAiC;QACjC,OAAO;YACLjC,SAAS;gBACPR,SAAS+B;gBACTW,KAAKF;gBACL,gEAAgE;gBAChEG,aAAahB;YACf;YACAR;QACF;IACF;IAYA;;;;;;GAMC,GACD,MAAM5B,cAAcL,MAAc,EAAE;QAClC,MAAMQ,QAAQ,yBAAA,IAAI,EAAEkD,eAAa/C,GAAG,CAACX;QACrC,IAAIQ,OAAO;YACT,MAAM,IAAI,CAACD,SAAS,CAACC;QACvB;IACF;IAEA,MAAMF,oBAAoB;QACxB,MAAMqD,QAAQC,GAAG,CACf;eAAI,IAAI,CAAClD,IAAI,CAACmD,IAAI;SAAG,CAACC,GAAG,CAAC,OAAOtD,QAAU,IAAI,CAACD,SAAS,CAACC;QAE5D,yBAAA,IAAI,EAAEuD,eAAaC,KAAK;IAC1B;IAEA;;;;;GAKC,GACD,AAAQC,qBAAqBjE,MAAc,EAAE;QAC3C,OAAO,yBAAA,IAAI,EAAE+D,eAAapD,GAAG,CAACX;IAChC;IAEA;;;;;;;;GAQC,GACD,MAAMI,YAAYD,QAA2B,EAAmB;QAC9D,IAAI,yBAAA,IAAI,EAAEuD,eAAaQ,GAAG,CAAC/D,SAASH,MAAM,GAAG;YAC3C,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAET,SAASH,MAAM,CAAC,4BAA4B,CAAC;QACxE;QAEA,MAAMmE,MAAM,MAAM,IAAI,CAACnC,OAAO;QAC9B,0BAAA,IAAI,EAAEoC,gBAAAA,oBAAN,IAAI,EAAgBjE,SAASH,MAAM,EAAEmE,IAAIjD,EAAE;QAE3C,+CAA+C;QAC/C,MAAM,IAAI,CAACJ,OAAO,CAACqD,IAAIjD,EAAE,EAAE;YACzBH,SAAS;YACTC,QAAQ;YACRE,IAAI5B;QACN;QAEA,MAAMgE,YAAYa,IAAI7C,OAAO,CAACkC,GAAG;QAEjC,IAAI,CAACa,iBAAiB,CAAClE,SAASH,MAAM,EAAEsD;QAExC,MAAMzC,SAAS,MAAM,IAAI,CAACC,OAAO,CAACqD,IAAIjD,EAAE,EAAE;YACxCH,SAAS;YACTC,QAAQ;YACRC,QAAQd;YACRe,IAAI5B;QACN;QACA,0BAAA,IAAI,EAAEgF,kBAAAA,sBAAN,IAAI,EAAkBnE,SAASH,MAAM,EAAEmE,IAAIjD,EAAE;QAC7C,OAAOL;IACT;IAEA,+CAA+C;IAC/C,MAAcC,QACZN,KAAa,EACbyC,OAAuB,EACI;QAC3B,IAAI,OAAOA,YAAY,UAAU;YAC/B,MAAM,IAAIrC,MAAM;QAClB;QAEA,MAAMuD,MAAM,IAAI,CAACzD,IAAI,CAACC,GAAG,CAACH;QAC1B,IAAI,CAAC2D,KAAK;YACR,MAAM,IAAIvD,MAAM,CAAC,aAAa,EAAEJ,MAAM,YAAY,CAAC;QACrD;QAEAhB,IAAI,2BAA2ByD;QAC/B,MAAMsB,WAAyC,MAAMJ,IAAIhC,SAAS,CAACqC,MAAM,CACvEvB;QAGF,IAAIsB,SAAS3C,KAAK,EAAE;YAClB,MAAM,IAAI7C,aACRwF,SAAS3C,KAAK,CAAC6C,IAAI,EACnBF,SAAS3C,KAAK,CAACqB,OAAO,EACtBsB,SAAS3C,KAAK,CAAC8C,IAAI;QAEvB;QAEA,OAAOH,SAAS1D,MAAM;IACxB;IAwCA;;;;;;GAMC,GACD,MAAaX,iBACXF,MAAc,EACdC,OAAwB,EACN;QAClB,MAAM0E,oBAAoB,IAAI,CAACV,oBAAoB,CAACjE;QAEpD,IAAI,CAAC2E,mBAAmB;YACtB,MAAM,IAAI/D,MACR,CAAC,iEAAiE,EAAEZ,OAAO,EAAE,CAAC;QAElF;QAEA,OAAO2E,kBAAkB1E;IAC3B;IA1XA2E,YAAY,EACVP,iBAAiB,EACjBvE,SAAS,EACTqB,qBAAqBjC,SAAS2F,MAAM,EACf,CAAE;QA4TzB,iCAAA;QAIA,iCAAA;QAkBA,iCAAA;QAKA,iCAAA;QA3WA,gCAAA;;mBAAA,KAAA;;QAEA,+CAA+C;QAC/C,uBAAUnE,QAAV,KAAA;QAEA,+CAA+C;QAC/C,uBAAiB2D,qBAAjB,KAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAOQN,eAAe,IAAIe;QACzB,IAAI,CAACpE,IAAI,GAAG,IAAIoE;QAChB,IAAI,CAACT,iBAAiB,GAAGA;uCACnBX,eAAe,IAAIoB;uCACnB5B,eAAe,IAAI4B;uCACnBhF,YAAYA;uCACZqB,qBAAqBA;QAE3B,IAAI,CAACtB,uBAAuB;IAC9B;AA6WF;AA3DE,SAAA,gBAAiBG,MAAc;IAC7B,yBAAA,IAAI,EAAE+D,eAAahC,MAAM,CAAC/B;AAC5B;AAEA,SAAA,gBAAiBA,MAAc,EAAE+E,QAAgB;IAC/C,MAAMC,UAAU,OAAO,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAmB;QAClE,OAAO,MAAM,IAAI,CAACrE,OAAO,CAACiE,UAAU;YAClC7D,IAAI5B;YACJyB,SAAS;YACTC,QAAQ;YACRC,QAAQ;gBACNgE;gBACAC;gBACAC,SAASA;gBACTC,QAAQpF;YACV;QACF;IACF;IAEA,yBAAA,IAAI,EAAE+D,eAAavB,GAAG,CAACxC,QAAQgF;AACjC;AAEA,SAAA,cAAehF,MAAc,EAAEQ,KAAa;IAC1C,yBAAA,IAAI,EAAEkD,eAAalB,GAAG,CAACxC,QAAQQ;IAC/B,yBAAA,IAAI,EAAE0C,eAAaV,GAAG,CAAChC,OAAOR;AAChC;AAEA,SAAA,wBAAyBQ,KAAa;IACpC,MAAMR,SAAS,yBAAA,IAAI,EAAEkD,eAAavC,GAAG,CAACH;IACtC,IAAI,CAACR,QAAQ;QACX,MAAM,IAAIY,MAAM,CAAC,MAAM,EAAEJ,MAAM,qBAAqB,CAAC;IACvD;IAEA,yBAAA,IAAI,EAAE0C,eAAanB,MAAM,CAACvB;IAC1B,yBAAA,IAAI,EAAEkD,eAAa3B,MAAM,CAAC/B;IAC1B,0BAAA,IAAI,EAAEqF,kBAAAA,sBAAN,IAAI,EAAkBrF;AACxB;AAyBF;;;;;;CAMC,GACD,OAAO,SAAS4C,eACd0C,gBAAwB,EACxBC,UAAkB;IAElB,MAAM5C,MAAM,IAAI7D;IAChBS,SAAS+F,kBAAkB3C,KAAK2C,kBAAkB,CAAC1D;QACjD,IAAIA,OAAO;YACT2D,aACItG,SAAS,CAAC,CAAC,EAAEsG,WAAW,iBAAiB,CAAC,EAAE3D,SAC5C3C,SAAS2C;QACf;IACF;IACA,OAAOe;AACT"}

package/dist/esm/snaps/SnapController.js

@@ -63,16 +63,17 @@ function _define_property(obj, key, value) {
 }
 import { BaseControllerV2 as BaseController } from '@metamask/base-controller';
 import { SubjectType } from '@metamask/permission-controller';
-import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/rpc-methods';
-import { assertIsSnapManifest, assertIsValidSnapId, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, getErrorMessage, HandlerType, logError, normalizeRelative, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, validateFetchedSnap } from '@metamask/snaps-utils';
+import { rpcErrors } from '@metamask/rpc-errors';
+import { WALLET_SNAP_PERMISSION_KEY } from '@metamask/snaps-rpc-methods';
+import { assertIsSnapManifest, assertIsValidSnapId, AuxiliaryFileEncoding, DEFAULT_ENDOWMENTS, DEFAULT_REQUESTED_SNAP_VERSION, encodeAuxiliaryFile, getErrorMessage, HandlerType, isOriginAllowed, logError, normalizeRelative, resolveVersionRange, SnapCaveatType, SnapStatus, SnapStatusEvents, validateFetchedSnap, unwrapError } from '@metamask/snaps-utils';
 import { assert, assertIsJsonRpcRequest, Duration, gtRange, gtVersion, hasProperty, inMilliseconds, isNonEmptyArray, isValidSemVerRange, satisfiesVersionRange, timeSince } from '@metamask/utils';
 import { createMachine, interpret } from '@xstate/fsm';
-import { ethErrors } from 'eth-rpc-errors';
 import { nanoid } from 'nanoid';
 import { forceStrict, validateMachine } from '../fsm';
 import { log } from '../logging';
 import { hasTimedOut, setDiff, withTimeout } from '../utils';
 import { handlerEndowments, SnapEndowments } from './endowments';
+import { getKeyringCaveatOrigins } from './endowments/keyring';
 import { getRpcCaveatOrigins } from './endowments/rpc';
 import { detectSnapLocation } from './location';
 import { processSnapPermissions } from './permissions';
@@ -92,7 +93,6 @@ const TRUNCATED_SNAP_PROPERTIES = new Set([
     'blocked'
 ]);
 const defaultState = {
-    snapErrors: {},
     snaps: {},
     snapStates: {}
 };
@@ -148,7 +148,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
    * Safely revokes all permissions granted to a Snap.
    *
    * @param snapId - The snap ID.
-   */ _revokeAllSnapPermissions = /*#__PURE__*/ new WeakSet(), _createApproval = /*#__PURE__*/ new WeakSet(), _updateApproval = /*#__PURE__*/ new WeakSet(), _add = /*#__PURE__*/ new WeakSet(), _startSnap = /*#__PURE__*/ new WeakSet(), _getEndowments = /*#__PURE__*/ new WeakSet(), /**
+   */ _revokeAllSnapPermissions = /*#__PURE__*/ new WeakSet(), _createApproval = /*#__PURE__*/ new WeakSet(), _updateApproval = /*#__PURE__*/ new WeakSet(), _resolveAllowlistVersion = /*#__PURE__*/ new WeakSet(), _add = /*#__PURE__*/ new WeakSet(), _startSnap = /*#__PURE__*/ new WeakSet(), _getEndowments = /*#__PURE__*/ new WeakSet(), /**
    * Sets a snap in state. Called when a snap is installed or updated. Performs
    * various validation checks on the received arguments, and will throw if
    * validation fails.
@@ -219,8 +219,8 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             return _class_private_method_get(this, _unblockSnap, unblockSnap).call(this, snapId);
         }));
     }
-    _onUnhandledSnapError(snapId, error) {
-        this.stopSnap(snapId, SnapStatusEvents.Crash).then(()=>this.addSnapError(error)).catch((stopSnapError)=>{
+    _onUnhandledSnapError(snapId, _error) {
+        this.stopSnap(snapId, SnapStatusEvents.Crash).catch((stopSnapError)=>{
             // TODO: Decide how to handle errors.
             logError(stopSnapError);
         });
@@ -396,35 +396,6 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         });
     }
     /**
-   * Adds error from a snap to the SnapController state.
-   *
-   * @param snapError - The error to store on the SnapController.
-   */ addSnapError(snapError) {
-        this.update((state)=>{
-            const id = nanoid();
-            state.snapErrors[id] = {
-                ...snapError,
-                internalID: id
-            };
-        });
-    }
-    /**
-   * Removes an error by internalID from the SnapControllers state.
-   *
-   * @param internalID - The internal error ID to remove on the SnapController.
-   */ removeSnapError(internalID) {
-        this.update((state)=>{
-            delete state.snapErrors[internalID];
-        });
-    }
-    /**
-   * Clears all errors from the SnapControllers state.
-   */ clearSnapErrors() {
-        this.update((state)=>{
-            state.snapErrors = {};
-        });
-    }
-    /**
    * Gets the own state of the snap with the given id.
    * This is distinct from the state MetaMask uses to manage snaps.
    *
@@ -436,6 +407,22 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         return state ?? null;
     }
     /**
+   * Gets a static auxiliary snap file in a chosen file encoding.
+   *
+   * @param snapId - The id of the Snap whose state to get.
+   * @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 = AuxiliaryFileEncoding.Base64) {
+        const snap = this.getExpect(snapId);
+        const normalizedPath = normalizeRelative(path);
+        const value = snap.auxiliaryFiles?.find((file)=>file.path === normalizedPath)?.value;
+        if (!value) {
+            return null;
+        }
+        return encodeAuxiliaryFile(value, encoding);
+    }
+    /**
    * Completely clear the controller's state: delete all associated data,
    * handlers, event listeners, and permissions; tear down all snap providers.
    */ async clearState() {
@@ -589,10 +576,12 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         try {
             for (const [snapId, { version: rawVersion }] of Object.entries(requestedSnaps)){
                 assertIsValidSnapId(snapId);
-                const [error, version] = resolveVersionRange(rawVersion);
+                const [error, resolvedVersion] = resolveVersionRange(rawVersion);
                 if (error) {
-                    throw ethErrors.rpc.invalidParams(`The "version" field must be a valid SemVer version range if specified. Received: "${rawVersion}".`);
+                    throw rpcErrors.invalidParams(`The "version" field must be a valid SemVer version range if specified. Received: "${rawVersion}".`);
                 }
+                // If we are running in allowlist mode, try to match the version with an allowlist version.
+                const version = _class_private_field_get(this, _featureFlags).requireAllowlist ? await _class_private_method_get(this, _resolveAllowlistVersion, resolveAllowlistVersion).call(this, snapId, resolvedVersion) : resolvedVersion;
                 const location = _class_private_field_get(this, _detectSnapLocation).call(this, snapId, {
                     versionRange: version,
                     fetch: _class_private_field_get(this, _fetchFunction),
@@ -620,8 +609,8 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
                 result[snapId] = await this.processRequestedSnap(origin, snapId, location, version);
             }
             // Once we finish all installs / updates, emit events.
-            pendingInstalls.forEach((snapId)=>this.messagingSystem.publish(`SnapController:snapInstalled`, this.getTruncatedExpect(snapId)));
-            pendingUpdates.forEach(({ snapId, oldVersion })=>this.messagingSystem.publish(`SnapController:snapUpdated`, this.getTruncatedExpect(snapId), oldVersion));
+            pendingInstalls.forEach((snapId)=>this.messagingSystem.publish(`SnapController:snapInstalled`, this.getTruncatedExpect(snapId), origin));
+            pendingUpdates.forEach(({ snapId, oldVersion })=>this.messagingSystem.publish(`SnapController:snapUpdated`, this.getTruncatedExpect(snapId), oldVersion, origin));
             snapIds.forEach((snapId)=>_class_private_field_get(this, _rollbackSnapshots).delete(snapId));
         } catch (error) {
             const installed = pendingInstalls.filter((snapId)=>this.has(snapId));
@@ -654,7 +643,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             return await this.updateSnap(origin, snapId, location, versionRange, // Since we are requesting an update from within processRequestedSnap,
             // we disable the emitting of the snapUpdated event and rely on the caller
             // to publish this event after the update is complete.
-            // This is necesary as installSnaps may be installing multiple snaps
+            // This is necessary as installSnaps may be installing multiple snaps
             // and we don't want to emit events prematurely.
             false);
         }
@@ -734,23 +723,25 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         try {
             const snap = this.getExpect(snapId);
             const newSnap = await _class_private_method_get(this, _fetchSnap, fetchSnap).call(this, snapId, location);
-            const newVersion = newSnap.manifest.result.version;
+            const { sourceCode: sourceCodeFile, manifest: manifestFile } = newSnap.files;
+            const manifest = manifestFile.result;
+            const newVersion = manifest.version;
             if (!gtVersion(newVersion, snap.version)) {
-                throw ethErrors.rpc.invalidParams(`Snap "${snapId}@${snap.version}" is already installed. Couldn't update to a version inside requested "${newVersionRange}" range.`);
+                throw rpcErrors.invalidParams(`Snap "${snapId}@${snap.version}" is already installed. Couldn't update to a version inside requested "${newVersionRange}" range.`);
             }
             if (!satisfiesVersionRange(newVersion, newVersionRange)) {
                 throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${newVersion}" which doesn't satisfy requested version range "${newVersionRange}".`);
             }
             await _class_private_method_get(this, _assertIsInstallAllowed, assertIsInstallAllowed).call(this, snapId, {
                 version: newVersion,
-                checksum: newSnap.manifest.result.source.shasum
+                checksum: manifest.source.shasum
             });
-            const processedPermissions = processSnapPermissions(newSnap.manifest.result.initialPermissions);
+            const processedPermissions = processSnapPermissions(manifest.initialPermissions);
             _class_private_method_get(this, _validateSnapPermissions, validateSnapPermissions).call(this, processedPermissions);
             const { newPermissions, unusedPermissions, approvedPermissions } = _class_private_method_get(this, _calculatePermissionsChange, calculatePermissionsChange).call(this, snapId, processedPermissions);
             _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
                 permissions: newPermissions,
-                newVersion: newSnap.manifest.result.version,
+                newVersion: manifest.version,
                 newPermissions,
                 approvedPermissions,
                 unusedPermissions,
@@ -769,7 +760,6 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             _class_private_method_get(this, _set, set).call(this, {
                 origin,
                 id: snapId,
-                manifest: newSnap.manifest,
                 files: newSnap.files,
                 isUpdate: true
             });
@@ -794,8 +784,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
                 rollbackSnapshot.permissions.granted = Object.keys(approvedNewPermissions);
                 rollbackSnapshot.permissions.requestData = requestData;
             }
-            const normalizedSourcePath = normalizeRelative(newSnap.manifest.result.source.location.npm.filePath);
-            const sourceCode = newSnap.files.find((file)=>file.path === normalizedSourcePath)?.toString();
+            const sourceCode = sourceCodeFile.toString();
             assert(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
             try {
                 await _class_private_method_get(this, _startSnap, startSnap).call(this, {
@@ -807,7 +796,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
             }
             const truncatedSnap = this.getTruncatedExpect(snapId);
             if (emitEvent) {
-                this.messagingSystem.publish('SnapController:snapUpdated', truncatedSnap, snap.version);
+                this.messagingSystem.publish('SnapController:snapUpdated', truncatedSnap, snap.version, origin);
             }
             _class_private_method_get(this, _updateApproval, updateApproval).call(this, pendingApproval.id, {
                 loading: false,
@@ -877,6 +866,8 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         /* eslint-disable @typescript-eslint/unbound-method */ this.messagingSystem.unsubscribe('ExecutionService:unhandledError', this._onUnhandledSnapError);
         this.messagingSystem.unsubscribe('ExecutionService:outboundRequest', this._onOutboundRequest);
         this.messagingSystem.unsubscribe('ExecutionService:outboundResponse', this._onOutboundResponse);
+        this.messagingSystem.clearEventSubscriptions('SnapController:snapInstalled');
+        this.messagingSystem.clearEventSubscriptions('SnapController:snapUpdated');
     /* eslint-enable @typescript-eslint/unbound-method */ }
     /**
    * Passes a JSON-RPC request object to the RPC handler function of a snap.
@@ -899,16 +890,15 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         if (!hasPermission) {
             throw new Error(`Snap "${snapId}" is not permitted to use "${permissionName}".`);
         }
-        if (permissionName === SnapEndowments.Rpc) {
+        if (permissionName === SnapEndowments.Rpc || permissionName === SnapEndowments.Keyring) {
             const subject = this.messagingSystem.call('SubjectMetadataController:getSubjectMetadata', origin);
-            const isSnap = subject?.subjectType === SubjectType.Snap;
             const permissions = this.messagingSystem.call('PermissionController:getPermissions', snapId);
-            const rpcPermission = permissions?.[SnapEndowments.Rpc];
-            assert(rpcPermission);
-            const origins = getRpcCaveatOrigins(rpcPermission);
+            const handlerPermissions = permissions?.[permissionName];
+            assert(handlerPermissions);
+            const origins = permissionName === SnapEndowments.Rpc ? getRpcCaveatOrigins(handlerPermissions) : getKeyringCaveatOrigins(handlerPermissions);
             assert(origins);
-            if (isSnap && !origins.snaps || !isSnap && !origins.dapps) {
-                throw new Error(`Snap "${snapId}" is not permitted to handle JSON-RPC requests from "${origin}".`);
+            if (!isOriginAllowed(origins, subject?.subjectType ?? SubjectType.Website, origin)) {
+                throw new Error(`Snap "${snapId}" is not permitted to handle requests from "${origin}".`);
             }
         }
         const handler = await _class_private_method_get(this, _getRpcRequestHandler, getRpcRequestHandler).call(this, snapId);
@@ -927,17 +917,15 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         super({
             messenger,
             metadata: {
-                snapErrors: {
-                    persist: false,
-                    anonymous: false
-                },
                 snapStates: {
                     persist: true,
                     anonymous: false
                 },
                 snaps: {
                     persist: (snaps)=>{
-                        return Object.values(snaps).map((snap)=>{
+                        return Object.values(snaps)// We should not persist snaps that are in the installing state,
+                        // since they haven't completed installation and would be unusable
+                        .filter((snap)=>snap.status !== SnapStatus.Installing).map((snap)=>{
                             return {
                                 ...snap,
                                 // At the time state is rehydrated, no snap will be running.
@@ -980,6 +968,7 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         _class_private_method_init(this, _revokeAllSnapPermissions);
         _class_private_method_init(this, _createApproval);
         _class_private_method_init(this, _updateApproval);
+        _class_private_method_init(this, _resolveAllowlistVersion);
         /**
    * Returns a promise representing the complete installation of the requested snap.
    * If the snap is already being installed, the previously pending promise will be returned.
@@ -1005,8 +994,6 @@ _initializeStateMachine = /*#__PURE__*/ new WeakSet(), /**
         /**
    * Fetches the manifest and source code of a snap.
    *
-   * This function is not hash private yet because of tests.
-   *
    * @param snapId - The id of the Snap.
    * @param location - Source from which snap will be fetched.
    * @returns A tuple of the Snap manifest object and the Snap source code.
@@ -1215,13 +1202,13 @@ function registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${controllerName}:remove`, async (...args)=>this.removeSnap(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:getPermitted`, (...args)=>this.getPermittedSnaps(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:install`, async (...args)=>this.installSnaps(...args));
-    this.messagingSystem.registerActionHandler(`${controllerName}:removeSnapError`, (...args)=>this.removeSnapError(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:getAll`, (...args)=>this.getAllSnaps(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:incrementActiveReferences`, (...args)=>this.incrementActiveReferences(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:decrementActiveReferences`, (...args)=>this.decrementActiveReferences(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:getRegistryMetadata`, async (...args)=>this.getRegistryMetadata(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:disconnectOrigin`, (...args)=>this.removeSnapFromSubject(...args));
     this.messagingSystem.registerActionHandler(`${controllerName}:revokeDynamicPermissions`, (...args)=>this.revokeDynamicSnapPermissions(...args));
+    this.messagingSystem.registerActionHandler(`${controllerName}:getFile`, (...args)=>this.getSnapFile(...args));
 }
 function pollForLastRequestStatus() {
     _class_private_field_set(this, _timeoutForLastRequestStatus, setTimeout(()=>{
@@ -1265,7 +1252,7 @@ async function assertIsInstallAllowed(snapId, snapInfo) {
     if (result.status === SnapsRegistryStatus.Blocked) {
         throw new Error(`Cannot install version "${snapInfo.version}" of snap "${snapId}": The version is blocked. ${result.reason?.explanation ?? ''}`);
     } else if (_class_private_field_get(this, _featureFlags).requireAllowlist && result.status !== SnapsRegistryStatus.Verified) {
-        throw new Error(`Cannot install version "${snapInfo.version}" of snap "${snapId}": The snap is not on the allow list.`);
+        throw new Error(`Cannot install version "${snapInfo.version}" of snap "${snapId}": The snap is not on the allowlist.`);
     }
 }
 async function stopSnapsLastRequestPastMax() {
@@ -1331,6 +1318,9 @@ function updateApproval(id, requestState) {
     // Do nothing
     }
 }
+async function resolveAllowlistVersion(snapId, versionRange) {
+    return await this.messagingSystem.call('SnapsRegistry:resolveVersion', snapId, versionRange);
+}
 async function add(args) {
     const { id: snapId, location, versionRange } = args;
     _class_private_method_get(this, _setupRuntime, setupRuntime).call(this, snapId, {
@@ -1344,7 +1334,7 @@ async function add(args) {
         // to null in the authorize() method.
         runtime.installPromise = (async ()=>{
             const fetchedSnap = await _class_private_method_get(this, _fetchSnap, fetchSnap).call(this, snapId, location);
-            const manifest = fetchedSnap.manifest.result;
+            const manifest = fetchedSnap.files.manifest.result;
             if (!satisfiesVersionRange(manifest.version, versionRange)) {
                 throw new Error(`Version mismatch. Manifest for "${snapId}" specifies version "${manifest.version}" which doesn't satisfy requested version range "${versionRange}".`);
             }
@@ -1414,15 +1404,16 @@ async function getEndowments(snapId) {
     return dedupedEndowments;
 }
 function set(args) {
-    const { id: snapId, origin, manifest, files, isUpdate = false } = args;
+    const { id: snapId, origin, files, isUpdate = false } = args;
+    const { manifest, sourceCode: sourceCodeFile, svgIcon, auxiliaryFiles: rawAuxiliaryFiles } = files;
     assertIsSnapManifest(manifest.result);
     const { version } = manifest.result;
-    const normalizedSourcePath = normalizeRelative(manifest.result.source.location.npm.filePath);
-    const { iconPath } = manifest.result.source.location.npm;
-    const normalizedIconPath = iconPath && normalizeRelative(iconPath);
-    const sourceCode = files.find((file)=>file.path === normalizedSourcePath)?.toString();
-    const svgIcon = normalizedIconPath ? files.find((file)=>file.path === normalizedIconPath) : undefined;
+    const sourceCode = sourceCodeFile.toString();
     assert(typeof sourceCode === 'string' && sourceCode.length > 0, `Invalid source code for snap "${snapId}".`);
+    const auxiliaryFiles = rawAuxiliaryFiles.map((file)=>({
+            path: file.path,
+            value: file.toString('base64')
+        }));
     const snapsState = this.state.snaps;
     const existingSnap = snapsState[snapId];
     const previousVersionHistory = existingSnap?.versionHistory ?? [];
@@ -1447,7 +1438,8 @@ function set(args) {
         status: _class_private_field_get(this, _statusMachine).config.initial,
         sourceCode,
         version,
-        versionHistory
+        versionHistory,
+        auxiliaryFiles
     };
     // If the snap was blocked, it isn't any longer
     delete snap.blockInformation;
@@ -1475,19 +1467,15 @@ 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 files = [
-            sourceCode
-        ];
-        if (svgIcon) {
-            files.push(svgIcon);
-        }
-        validateFetchedSnap({
+        const auxiliaryFiles = manifest.result.source.files ? await Promise.all(manifest.result.source.files.map(async (filePath)=>location.fetch(filePath))) : [];
+        const files = {
             manifest,
             sourceCode,
-            svgIcon
-        });
+            svgIcon,
+            auxiliaryFiles
+        };
+        validateFetchedSnap(files);
         return {
-            manifest,
             files,
             location
         };
@@ -1556,8 +1544,11 @@ function getRpcRequestHandler(snapId) {
             _class_private_method_get(this, _recordSnapRpcRequestFinish, recordSnapRpcRequestFinish).call(this, snapId, request.id);
             return result;
         } catch (error) {
-            await this.stopSnap(snapId, SnapStatusEvents.Crash);
-            throw error;
+            const [jsonRpcError, handled] = unwrapError(error);
+            if (!handled) {
+                await this.stopSnap(snapId, SnapStatusEvents.Crash);
+            }
+            throw jsonRpcError;
         }
     };
     runtime.rpcHandler = rpcHandler;