@metamask/snaps-execution-environments 3.4.2 → 3.5.0

package/dist/cjs/common/commands.js

@@ -32,6 +32,15 @@ function getHandlerArguments(origin, handler, request) {
                     transactionOrigin
                 };
             }
+        case _snapsutils.HandlerType.OnSignature:
+            {
+                (0, _validation.assertIsOnSignatureRequestArguments)(request.params);
+                const { signature, signatureOrigin } = request.params;
+                return {
+                    signature,
+                    signatureOrigin
+                };
+            }
         case _snapsutils.HandlerType.OnNameLookup:
             {
                 (0, _validation.assertIsOnNameLookupRequestArguments)(request.params);

package/dist/cjs/common/commands.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/common/commands.ts"],"sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport type { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport type {\n  ExecuteSnap,\n  JsonRpcRequestWithoutId,\n  Ping,\n  PossibleLookupRequestArgs,\n  SnapRpc,\n  Terminate,\n} from './validation';\nimport {\n  assertIsOnTransactionRequestArguments,\n  assertIsOnNameLookupRequestArguments,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n  ping: Ping;\n  terminate: Terminate;\n  executeSnap: ExecuteSnap;\n  snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n  origin: string,\n  handler: HandlerType,\n  request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n  // `request` is already validated by the time this function is called.\n\n  switch (handler) {\n    case HandlerType.OnTransaction: {\n      assertIsOnTransactionRequestArguments(request.params);\n\n      const { transaction, chainId, transactionOrigin } = request.params;\n      return {\n        transaction,\n        chainId,\n        transactionOrigin,\n      };\n    }\n    case HandlerType.OnNameLookup: {\n      assertIsOnNameLookupRequestArguments(request.params);\n\n      // TS complains that domain/address are not part of the type\n      // casting here as we've already validated the request args in the above step.\n      const { chainId, domain, address } =\n        request.params as unknown as PossibleLookupRequestArgs;\n\n      return domain\n        ? {\n            chainId,\n            domain,\n          }\n        : {\n            chainId,\n            address,\n          };\n    }\n    case HandlerType.OnRpcRequest:\n    case HandlerType.OnKeyringRequest:\n      return { origin, request };\n\n    case HandlerType.OnCronjob:\n    case HandlerType.OnInstall:\n    case HandlerType.OnUpdate:\n      return { request };\n\n    case HandlerType.OnHomePage:\n      return {};\n\n    default:\n      return assertExhaustive(handler);\n  }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n  startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n  invokeSnap: InvokeSnap,\n  onTerminate: () => void,\n): CommandMethodsMapping {\n  return {\n    ping: async () => Promise.resolve('OK'),\n    terminate: async () => {\n      onTerminate();\n      return Promise.resolve('OK');\n    },\n\n    executeSnap: async (snapId, sourceCode, endowments) => {\n      await startSnap(snapId, sourceCode, endowments);\n      return 'OK';\n    },\n\n    snapRpc: async (target, handler, origin, request) => {\n      return (\n        (await invokeSnap(\n          target,\n          handler,\n          getHandlerArguments(origin, handler, request),\n        )) ?? null\n      );\n    },\n  };\n}\n"],"names":["getHandlerArguments","getCommandMethodImplementations","origin","handler","request","HandlerType","OnTransaction","assertIsOnTransactionRequestArguments","params","transaction","chainId","transactionOrigin","OnNameLookup","assertIsOnNameLookupRequestArguments","domain","address","OnRpcRequest","OnKeyringRequest","OnCronjob","OnInstall","OnUpdate","OnHomePage","assertExhaustive","startSnap","invokeSnap","onTerminate","ping","Promise","resolve","terminate","executeSnap","snapId","sourceCode","endowments","snapRpc","target"],"mappings":";;;;;;;;;;;IAgCgBA,mBAAmB;eAAnBA;;IAgEAC,+BAA+B;eAA/BA;;;4BAhGY;uBACK;4BAc1B;AAiBA,SAASD,oBACdE,MAAc,EACdC,OAAoB,EACpBC,OAAgC;IAEhC,sEAAsE;IAEtE,OAAQD;QACN,KAAKE,uBAAW,CAACC,aAAa;YAAE;gBAC9BC,IAAAA,iDAAqC,EAACH,QAAQI,MAAM;gBAEpD,MAAM,EAAEC,WAAW,EAAEC,OAAO,EAAEC,iBAAiB,EAAE,GAAGP,QAAQI,MAAM;gBAClE,OAAO;oBACLC;oBACAC;oBACAC;gBACF;YACF;QACA,KAAKN,uBAAW,CAACO,YAAY;YAAE;gBAC7BC,IAAAA,gDAAoC,EAACT,QAAQI,MAAM;gBAEnD,4DAA4D;gBAC5D,8EAA8E;gBAC9E,MAAM,EAAEE,OAAO,EAAEI,MAAM,EAAEC,OAAO,EAAE,GAChCX,QAAQI,MAAM;gBAEhB,OAAOM,SACH;oBACEJ;oBACAI;gBACF,IACA;oBACEJ;oBACAK;gBACF;YACN;QACA,KAAKV,uBAAW,CAACW,YAAY;QAC7B,KAAKX,uBAAW,CAACY,gBAAgB;YAC/B,OAAO;gBAAEf;gBAAQE;YAAQ;QAE3B,KAAKC,uBAAW,CAACa,SAAS;QAC1B,KAAKb,uBAAW,CAACc,SAAS;QAC1B,KAAKd,uBAAW,CAACe,QAAQ;YACvB,OAAO;gBAAEhB;YAAQ;QAEnB,KAAKC,uBAAW,CAACgB,UAAU;YACzB,OAAO,CAAC;QAEV;YACE,OAAOC,IAAAA,uBAAgB,EAACnB;IAC5B;AACF;AAaO,SAASF,gCACdsB,SAA8D,EAC9DC,UAAsB,EACtBC,WAAuB;IAEvB,OAAO;QACLC,MAAM,UAAYC,QAAQC,OAAO,CAAC;QAClCC,WAAW;YACTJ;YACA,OAAOE,QAAQC,OAAO,CAAC;QACzB;QAEAE,aAAa,OAAOC,QAAQC,YAAYC;YACtC,MAAMV,UAAUQ,QAAQC,YAAYC;YACpC,OAAO;QACT;QAEAC,SAAS,OAAOC,QAAQhC,SAASD,QAAQE;YACvC,OACE,AAAC,MAAMoB,WACLW,QACAhC,SACAH,oBAAoBE,QAAQC,SAASC,aACjC;QAEV;IACF;AACF"}
+{"version":3,"sources":["../../../src/common/commands.ts"],"sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport type { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport type {\n  ExecuteSnap,\n  JsonRpcRequestWithoutId,\n  Ping,\n  PossibleLookupRequestArgs,\n  SnapRpc,\n  Terminate,\n} from './validation';\nimport {\n  assertIsOnTransactionRequestArguments,\n  assertIsOnSignatureRequestArguments,\n  assertIsOnNameLookupRequestArguments,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n  ping: Ping;\n  terminate: Terminate;\n  executeSnap: ExecuteSnap;\n  snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n  origin: string,\n  handler: HandlerType,\n  request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n  // `request` is already validated by the time this function is called.\n\n  switch (handler) {\n    case HandlerType.OnTransaction: {\n      assertIsOnTransactionRequestArguments(request.params);\n\n      const { transaction, chainId, transactionOrigin } = request.params;\n      return {\n        transaction,\n        chainId,\n        transactionOrigin,\n      };\n    }\n    case HandlerType.OnSignature: {\n      assertIsOnSignatureRequestArguments(request.params);\n\n      const { signature, signatureOrigin } = request.params;\n      return { signature, signatureOrigin };\n    }\n    case HandlerType.OnNameLookup: {\n      assertIsOnNameLookupRequestArguments(request.params);\n\n      // TS complains that domain/address are not part of the type\n      // casting here as we've already validated the request args in the above step.\n      const { chainId, domain, address } =\n        request.params as unknown as PossibleLookupRequestArgs;\n\n      return domain\n        ? {\n            chainId,\n            domain,\n          }\n        : {\n            chainId,\n            address,\n          };\n    }\n    case HandlerType.OnRpcRequest:\n    case HandlerType.OnKeyringRequest:\n      return { origin, request };\n\n    case HandlerType.OnCronjob:\n    case HandlerType.OnInstall:\n    case HandlerType.OnUpdate:\n      return { request };\n\n    case HandlerType.OnHomePage:\n      return {};\n\n    default:\n      return assertExhaustive(handler);\n  }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n  startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n  invokeSnap: InvokeSnap,\n  onTerminate: () => void,\n): CommandMethodsMapping {\n  return {\n    ping: async () => Promise.resolve('OK'),\n    terminate: async () => {\n      onTerminate();\n      return Promise.resolve('OK');\n    },\n\n    executeSnap: async (snapId, sourceCode, endowments) => {\n      await startSnap(snapId, sourceCode, endowments);\n      return 'OK';\n    },\n\n    snapRpc: async (target, handler, origin, request) => {\n      return (\n        (await invokeSnap(\n          target,\n          handler,\n          getHandlerArguments(origin, handler, request),\n        )) ?? null\n      );\n    },\n  };\n}\n"],"names":["getHandlerArguments","getCommandMethodImplementations","origin","handler","request","HandlerType","OnTransaction","assertIsOnTransactionRequestArguments","params","transaction","chainId","transactionOrigin","OnSignature","assertIsOnSignatureRequestArguments","signature","signatureOrigin","OnNameLookup","assertIsOnNameLookupRequestArguments","domain","address","OnRpcRequest","OnKeyringRequest","OnCronjob","OnInstall","OnUpdate","OnHomePage","assertExhaustive","startSnap","invokeSnap","onTerminate","ping","Promise","resolve","terminate","executeSnap","snapId","sourceCode","endowments","snapRpc","target"],"mappings":";;;;;;;;;;;IAiCgBA,mBAAmB;eAAnBA;;IAsEAC,+BAA+B;eAA/BA;;;4BAvGY;uBACK;4BAe1B;AAiBA,SAASD,oBACdE,MAAc,EACdC,OAAoB,EACpBC,OAAgC;IAEhC,sEAAsE;IAEtE,OAAQD;QACN,KAAKE,uBAAW,CAACC,aAAa;YAAE;gBAC9BC,IAAAA,iDAAqC,EAACH,QAAQI,MAAM;gBAEpD,MAAM,EAAEC,WAAW,EAAEC,OAAO,EAAEC,iBAAiB,EAAE,GAAGP,QAAQI,MAAM;gBAClE,OAAO;oBACLC;oBACAC;oBACAC;gBACF;YACF;QACA,KAAKN,uBAAW,CAACO,WAAW;YAAE;gBAC5BC,IAAAA,+CAAmC,EAACT,QAAQI,MAAM;gBAElD,MAAM,EAAEM,SAAS,EAAEC,eAAe,EAAE,GAAGX,QAAQI,MAAM;gBACrD,OAAO;oBAAEM;oBAAWC;gBAAgB;YACtC;QACA,KAAKV,uBAAW,CAACW,YAAY;YAAE;gBAC7BC,IAAAA,gDAAoC,EAACb,QAAQI,MAAM;gBAEnD,4DAA4D;gBAC5D,8EAA8E;gBAC9E,MAAM,EAAEE,OAAO,EAAEQ,MAAM,EAAEC,OAAO,EAAE,GAChCf,QAAQI,MAAM;gBAEhB,OAAOU,SACH;oBACER;oBACAQ;gBACF,IACA;oBACER;oBACAS;gBACF;YACN;QACA,KAAKd,uBAAW,CAACe,YAAY;QAC7B,KAAKf,uBAAW,CAACgB,gBAAgB;YAC/B,OAAO;gBAAEnB;gBAAQE;YAAQ;QAE3B,KAAKC,uBAAW,CAACiB,SAAS;QAC1B,KAAKjB,uBAAW,CAACkB,SAAS;QAC1B,KAAKlB,uBAAW,CAACmB,QAAQ;YACvB,OAAO;gBAAEpB;YAAQ;QAEnB,KAAKC,uBAAW,CAACoB,UAAU;YACzB,OAAO,CAAC;QAEV;YACE,OAAOC,IAAAA,uBAAgB,EAACvB;IAC5B;AACF;AAaO,SAASF,gCACd0B,SAA8D,EAC9DC,UAAsB,EACtBC,WAAuB;IAEvB,OAAO;QACLC,MAAM,UAAYC,QAAQC,OAAO,CAAC;QAClCC,WAAW;YACTJ;YACA,OAAOE,QAAQC,OAAO,CAAC;QACzB;QAEAE,aAAa,OAAOC,QAAQC,YAAYC;YACtC,MAAMV,UAAUQ,QAAQC,YAAYC;YACpC,OAAO;QACT;QAEAC,SAAS,OAAOC,QAAQpC,SAASD,QAAQE;YACvC,OACE,AAAC,MAAMwB,WACLW,QACApC,SACAH,oBAAoBE,QAAQC,SAASC,aACjC;QAEV;IACF;AACF"}

package/dist/cjs/common/validation.js

@@ -39,6 +39,12 @@ _export(exports, {
     assertIsOnTransactionRequestArguments: function() {
         return assertIsOnTransactionRequestArguments;
     },
+    OnSignatureRequestArgumentsStruct: function() {
+        return OnSignatureRequestArgumentsStruct;
+    },
+    assertIsOnSignatureRequestArguments: function() {
+        return assertIsOnSignatureRequestArguments;
+    },
     OnNameLookupRequestArgumentsStruct: function() {
         return OnNameLookupRequestArgumentsStruct;
     },
@@ -94,6 +100,13 @@ const OnTransactionRequestArgumentsStruct = (0, _superstruct.object)({
 function assertIsOnTransactionRequestArguments(value) {
     (0, _utils.assertStruct)(value, OnTransactionRequestArgumentsStruct, 'Invalid request params', _rpcerrors.rpcErrors.invalidParams);
 }
+const OnSignatureRequestArgumentsStruct = (0, _superstruct.object)({
+    signature: (0, _superstruct.record)((0, _superstruct.string)(), _utils.JsonStruct),
+    signatureOrigin: (0, _superstruct.nullable)((0, _superstruct.string)())
+});
+function assertIsOnSignatureRequestArguments(value) {
+    (0, _utils.assertStruct)(value, OnSignatureRequestArgumentsStruct, 'Invalid request params', _rpcerrors.rpcErrors.invalidParams);
+}
 const baseNameLookupArgs = {
     chainId: _snapsutils.ChainIdStruct
 };

package/dist/cjs/common/validation.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/common/validation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n  assertStruct,\n  JsonRpcIdStruct,\n  JsonRpcParamsStruct,\n  JsonRpcSuccessStruct,\n  JsonRpcVersionStruct,\n  JsonStruct,\n} from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n  array,\n  assign,\n  enums,\n  is,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  tuple,\n  union,\n} from 'superstruct';\n\nexport const JsonRpcRequestWithoutIdStruct = object({\n  jsonrpc: optional(JsonRpcVersionStruct),\n  id: optional(JsonRpcIdStruct),\n  method: string(),\n  params: optional(JsonRpcParamsStruct),\n});\n\nexport type JsonRpcRequestWithoutId = Infer<\n  typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n  return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n  return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n  union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n  literal(undefined),\n  array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n  string(),\n  string(),\n  array(EndowmentStruct),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n  string(),\n  enums(Object.values(HandlerType)),\n  string(),\n  assign(\n    JsonRpcRequestWithoutIdStruct,\n    object({\n      params: optional(record(string(), JsonStruct)),\n    }),\n  ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n  typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n  typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n  typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n  | PingRequestArguments\n  | TerminateRequestArguments\n  | ExecuteSnapRequestArguments\n  | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n  // TODO: Improve `transaction` type.\n  transaction: record(string(), JsonStruct),\n  chainId: ChainIdStruct,\n  transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n  typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n  value: unknown,\n): asserts value is OnTransactionRequestArguments {\n  assertStruct(\n    value,\n    OnTransactionRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n  ...baseNameLookupArgs,\n  address: string(),\n});\nconst addressRequestStruct = object({\n  ...baseNameLookupArgs,\n  domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n  domainRequestStruct,\n  addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n  typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n  address?: string;\n  domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n  value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n  assertStruct(\n    value,\n    OnNameLookupRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst OkResponseStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: OkStruct,\n});\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n  Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n  Args extends RequestArguments,\n  ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n  ExecuteSnapRequestArguments,\n  OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"],"names":["JsonRpcRequestWithoutIdStruct","EndowmentStruct","isEndowment","isEndowmentsArray","PingRequestArgumentsStruct","TerminateRequestArgumentsStruct","ExecuteSnapRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","OnTransactionRequestArgumentsStruct","assertIsOnTransactionRequestArguments","OnNameLookupRequestArgumentsStruct","assertIsOnNameLookupRequestArguments","object","jsonrpc","optional","JsonRpcVersionStruct","id","JsonRpcIdStruct","method","string","params","JsonRpcParamsStruct","value","is","Array","isArray","every","OkStruct","literal","union","undefined","array","tuple","enums","Object","values","HandlerType","assign","record","JsonStruct","transaction","chainId","ChainIdStruct","transactionOrigin","nullable","assertStruct","rpcErrors","invalidParams","baseNameLookupArgs","domainRequestStruct","address","addressRequestStruct","domain","OkResponseStruct","result","SnapRpcResponse","JsonRpcSuccessStruct"],"mappings":";;;;;;;;;;;IA2BaA,6BAA6B;eAA7BA;;IAWAC,eAAe;eAAfA;;IASGC,WAAW;eAAXA;;IAUAC,iBAAiB;eAAjBA;;IAMHC,0BAA0B;eAA1BA;;IAIAC,+BAA+B;eAA/BA;;IAKAC,iCAAiC;eAAjCA;;IAMAC,6BAA6B;eAA7BA;;IA+BAC,mCAAmC;eAAnCA;;IAmBGC,qCAAqC;eAArCA;;IAqBHC,kCAAkC;eAAlCA;;IAsBGC,oCAAoC;eAApCA;;;2BA3KU;4BACiB;uBASpC;6BAeA;AAEA,MAAMX,gCAAgCY,IAAAA,mBAAM,EAAC;IAClDC,SAASC,IAAAA,qBAAQ,EAACC,2BAAoB;IACtCC,IAAIF,IAAAA,qBAAQ,EAACG,sBAAe;IAC5BC,QAAQC,IAAAA,mBAAM;IACdC,QAAQN,IAAAA,qBAAQ,EAACO,0BAAmB;AACtC;AAMO,MAAMpB,kBAAkBkB,IAAAA,mBAAM;AAS9B,SAASjB,YAAYoB,KAAc;IACxC,OAAOC,IAAAA,eAAE,EAACD,OAAOrB;AACnB;AAQO,SAASE,kBAAkBmB,KAAc;IAC9C,OAAOE,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAACxB;AAC7C;AAEA,MAAMyB,WAAWC,IAAAA,oBAAO,EAAC;AAElB,MAAMxB,6BAA6BU,IAAAA,qBAAQ,EAChDe,IAAAA,kBAAK,EAAC;IAACD,IAAAA,oBAAO,EAACE;IAAYC,IAAAA,kBAAK;CAAG;AAG9B,MAAM1B,kCAAkCwB,IAAAA,kBAAK,EAAC;IACnDD,IAAAA,oBAAO,EAACE;IACRC,IAAAA,kBAAK;CACN;AAEM,MAAMzB,oCAAoC0B,IAAAA,kBAAK,EAAC;IACrDb,IAAAA,mBAAM;IACNA,IAAAA,mBAAM;IACNY,IAAAA,kBAAK,EAAC9B;CACP;AAEM,MAAMM,gCAAgCyB,IAAAA,kBAAK,EAAC;IACjDb,IAAAA,mBAAM;IACNc,IAAAA,kBAAK,EAACC,OAAOC,MAAM,CAACC,uBAAW;IAC/BjB,IAAAA,mBAAM;IACNkB,IAAAA,mBAAM,EACJrC,+BACAY,IAAAA,mBAAM,EAAC;QACLQ,QAAQN,IAAAA,qBAAQ,EAACwB,IAAAA,mBAAM,EAACnB,IAAAA,mBAAM,KAAIoB,iBAAU;IAC9C;CAEH;AAqBM,MAAM/B,sCAAsCI,IAAAA,mBAAM,EAAC;IACxD,oCAAoC;IACpC4B,aAAaF,IAAAA,mBAAM,EAACnB,IAAAA,mBAAM,KAAIoB,iBAAU;IACxCE,SAASC,yBAAa;IACtBC,mBAAmBC,IAAAA,qBAAQ,EAACzB,IAAAA,mBAAM;AACpC;AAcO,SAASV,sCACda,KAAc;IAEduB,IAAAA,mBAAY,EACVvB,OACAd,qCACA,0BACAsC,oBAAS,CAACC,aAAa;AAE3B;AAEA,MAAMC,qBAAqB;IAAEP,SAASC,yBAAa;AAAC;AACpD,MAAMO,sBAAsBrC,IAAAA,mBAAM,EAAC;IACjC,GAAGoC,kBAAkB;IACrBE,SAAS/B,IAAAA,mBAAM;AACjB;AACA,MAAMgC,uBAAuBvC,IAAAA,mBAAM,EAAC;IAClC,GAAGoC,kBAAkB;IACrBI,QAAQjC,IAAAA,mBAAM;AAChB;AAEO,MAAMT,qCAAqCmB,IAAAA,kBAAK,EAAC;IACtDoB;IACAE;CACD;AAmBM,SAASxC,qCACdW,KAAc;IAEduB,IAAAA,mBAAY,EACVvB,OACAZ,oCACA,0BACAoC,oBAAS,CAACC,aAAa;AAE3B;AAEA,MAAMM,mBAAmBzC,IAAAA,mBAAM,EAAC;IAC9BI,IAAIC,sBAAe;IACnBJ,SAASE,2BAAoB;IAC7BuC,QAAQ3B;AACV;AAEA,MAAM4B,kBAAkBC,2BAAoB"}
+{"version":3,"sources":["../../../src/common/validation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n  assertStruct,\n  JsonRpcIdStruct,\n  JsonRpcParamsStruct,\n  JsonRpcSuccessStruct,\n  JsonRpcVersionStruct,\n  JsonStruct,\n} from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n  array,\n  assign,\n  enums,\n  is,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  tuple,\n  union,\n} from 'superstruct';\n\nexport const JsonRpcRequestWithoutIdStruct = object({\n  jsonrpc: optional(JsonRpcVersionStruct),\n  id: optional(JsonRpcIdStruct),\n  method: string(),\n  params: optional(JsonRpcParamsStruct),\n});\n\nexport type JsonRpcRequestWithoutId = Infer<\n  typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n  return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n  return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n  union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n  literal(undefined),\n  array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n  string(),\n  string(),\n  array(EndowmentStruct),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n  string(),\n  enums(Object.values(HandlerType)),\n  string(),\n  assign(\n    JsonRpcRequestWithoutIdStruct,\n    object({\n      params: optional(record(string(), JsonStruct)),\n    }),\n  ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n  typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n  typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n  typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n  | PingRequestArguments\n  | TerminateRequestArguments\n  | ExecuteSnapRequestArguments\n  | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n  // TODO: Improve `transaction` type.\n  transaction: record(string(), JsonStruct),\n  chainId: ChainIdStruct,\n  transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n  typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n  value: unknown,\n): asserts value is OnTransactionRequestArguments {\n  assertStruct(\n    value,\n    OnTransactionRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const OnSignatureRequestArgumentsStruct = object({\n  signature: record(string(), JsonStruct),\n  signatureOrigin: nullable(string()),\n});\n\nexport type OnSignatureRequestArguments = Infer<\n  typeof OnSignatureRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnSignatureRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnSignatureRequestArguments}\n * object.\n */\nexport function assertIsOnSignatureRequestArguments(\n  value: unknown,\n): asserts value is OnSignatureRequestArguments {\n  assertStruct(\n    value,\n    OnSignatureRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n  ...baseNameLookupArgs,\n  address: string(),\n});\nconst addressRequestStruct = object({\n  ...baseNameLookupArgs,\n  domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n  domainRequestStruct,\n  addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n  typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n  address?: string;\n  domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n  value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n  assertStruct(\n    value,\n    OnNameLookupRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst OkResponseStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: OkStruct,\n});\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n  Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n  Args extends RequestArguments,\n  ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n  ExecuteSnapRequestArguments,\n  OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"],"names":["JsonRpcRequestWithoutIdStruct","EndowmentStruct","isEndowment","isEndowmentsArray","PingRequestArgumentsStruct","TerminateRequestArgumentsStruct","ExecuteSnapRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","OnTransactionRequestArgumentsStruct","assertIsOnTransactionRequestArguments","OnSignatureRequestArgumentsStruct","assertIsOnSignatureRequestArguments","OnNameLookupRequestArgumentsStruct","assertIsOnNameLookupRequestArguments","object","jsonrpc","optional","JsonRpcVersionStruct","id","JsonRpcIdStruct","method","string","params","JsonRpcParamsStruct","value","is","Array","isArray","every","OkStruct","literal","union","undefined","array","tuple","enums","Object","values","HandlerType","assign","record","JsonStruct","transaction","chainId","ChainIdStruct","transactionOrigin","nullable","assertStruct","rpcErrors","invalidParams","signature","signatureOrigin","baseNameLookupArgs","domainRequestStruct","address","addressRequestStruct","domain","OkResponseStruct","result","SnapRpcResponse","JsonRpcSuccessStruct"],"mappings":";;;;;;;;;;;IA2BaA,6BAA6B;eAA7BA;;IAWAC,eAAe;eAAfA;;IASGC,WAAW;eAAXA;;IAUAC,iBAAiB;eAAjBA;;IAMHC,0BAA0B;eAA1BA;;IAIAC,+BAA+B;eAA/BA;;IAKAC,iCAAiC;eAAjCA;;IAMAC,6BAA6B;eAA7BA;;IA+BAC,mCAAmC;eAAnCA;;IAmBGC,qCAAqC;eAArCA;;IAWHC,iCAAiC;eAAjCA;;IAiBGC,mCAAmC;eAAnCA;;IAqBHC,kCAAkC;eAAlCA;;IAsBGC,oCAAoC;eAApCA;;;2BAvMU;4BACiB;uBASpC;6BAeA;AAEA,MAAMb,gCAAgCc,IAAAA,mBAAM,EAAC;IAClDC,SAASC,IAAAA,qBAAQ,EAACC,2BAAoB;IACtCC,IAAIF,IAAAA,qBAAQ,EAACG,sBAAe;IAC5BC,QAAQC,IAAAA,mBAAM;IACdC,QAAQN,IAAAA,qBAAQ,EAACO,0BAAmB;AACtC;AAMO,MAAMtB,kBAAkBoB,IAAAA,mBAAM;AAS9B,SAASnB,YAAYsB,KAAc;IACxC,OAAOC,IAAAA,eAAE,EAACD,OAAOvB;AACnB;AAQO,SAASE,kBAAkBqB,KAAc;IAC9C,OAAOE,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAAC1B;AAC7C;AAEA,MAAM2B,WAAWC,IAAAA,oBAAO,EAAC;AAElB,MAAM1B,6BAA6BY,IAAAA,qBAAQ,EAChDe,IAAAA,kBAAK,EAAC;IAACD,IAAAA,oBAAO,EAACE;IAAYC,IAAAA,kBAAK;CAAG;AAG9B,MAAM5B,kCAAkC0B,IAAAA,kBAAK,EAAC;IACnDD,IAAAA,oBAAO,EAACE;IACRC,IAAAA,kBAAK;CACN;AAEM,MAAM3B,oCAAoC4B,IAAAA,kBAAK,EAAC;IACrDb,IAAAA,mBAAM;IACNA,IAAAA,mBAAM;IACNY,IAAAA,kBAAK,EAAChC;CACP;AAEM,MAAMM,gCAAgC2B,IAAAA,kBAAK,EAAC;IACjDb,IAAAA,mBAAM;IACNc,IAAAA,kBAAK,EAACC,OAAOC,MAAM,CAACC,uBAAW;IAC/BjB,IAAAA,mBAAM;IACNkB,IAAAA,mBAAM,EACJvC,+BACAc,IAAAA,mBAAM,EAAC;QACLQ,QAAQN,IAAAA,qBAAQ,EAACwB,IAAAA,mBAAM,EAACnB,IAAAA,mBAAM,KAAIoB,iBAAU;IAC9C;CAEH;AAqBM,MAAMjC,sCAAsCM,IAAAA,mBAAM,EAAC;IACxD,oCAAoC;IACpC4B,aAAaF,IAAAA,mBAAM,EAACnB,IAAAA,mBAAM,KAAIoB,iBAAU;IACxCE,SAASC,yBAAa;IACtBC,mBAAmBC,IAAAA,qBAAQ,EAACzB,IAAAA,mBAAM;AACpC;AAcO,SAASZ,sCACde,KAAc;IAEduB,IAAAA,mBAAY,EACVvB,OACAhB,qCACA,0BACAwC,oBAAS,CAACC,aAAa;AAE3B;AAEO,MAAMvC,oCAAoCI,IAAAA,mBAAM,EAAC;IACtDoC,WAAWV,IAAAA,mBAAM,EAACnB,IAAAA,mBAAM,KAAIoB,iBAAU;IACtCU,iBAAiBL,IAAAA,qBAAQ,EAACzB,IAAAA,mBAAM;AAClC;AAcO,SAASV,oCACda,KAAc;IAEduB,IAAAA,mBAAY,EACVvB,OACAd,mCACA,0BACAsC,oBAAS,CAACC,aAAa;AAE3B;AAEA,MAAMG,qBAAqB;IAAET,SAASC,yBAAa;AAAC;AACpD,MAAMS,sBAAsBvC,IAAAA,mBAAM,EAAC;IACjC,GAAGsC,kBAAkB;IACrBE,SAASjC,IAAAA,mBAAM;AACjB;AACA,MAAMkC,uBAAuBzC,IAAAA,mBAAM,EAAC;IAClC,GAAGsC,kBAAkB;IACrBI,QAAQnC,IAAAA,mBAAM;AAChB;AAEO,MAAMT,qCAAqCmB,IAAAA,kBAAK,EAAC;IACtDsB;IACAE;CACD;AAmBM,SAAS1C,qCACdW,KAAc;IAEduB,IAAAA,mBAAY,EACVvB,OACAZ,oCACA,0BACAoC,oBAAS,CAACC,aAAa;AAE3B;AAEA,MAAMQ,mBAAmB3C,IAAAA,mBAAM,EAAC;IAC9BI,IAAIC,sBAAe;IACnBJ,SAASE,2BAAoB;IAC7ByC,QAAQ7B;AACV;AAEA,MAAM8B,kBAAkBC,2BAAoB"}

package/dist/cjs/offscreen/index.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 const _postmessagestream = require("@metamask/post-message-stream");
 const _lockdownevents = require("../common/lockdown/lockdown-events");
 const _lockdownmore = require("../common/lockdown/lockdown-more");
-const _OffscreenSnapExecutor = require("./OffscreenSnapExecutor");
+const _ProxySnapExecutor = require("../proxy/ProxySnapExecutor");
 // Lockdown is already applied in LavaMoat
 (0, _lockdownmore.executeLockdownMore)();
 (0, _lockdownevents.executeLockdownEvents)();
@@ -14,6 +14,6 @@ const parentStream = new _postmessagestream.BrowserRuntimePostMessageStream({
     name: 'child',
     target: 'parent'
 });
-_OffscreenSnapExecutor.OffscreenSnapExecutor.initialize(parentStream);
+_ProxySnapExecutor.ProxySnapExecutor.initialize(parentStream);
 
 //# sourceMappingURL=index.js.map

package/dist/cjs/offscreen/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/offscreen/index.ts"],"sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport { executeLockdownEvents } from '../common/lockdown/lockdown-events';\nimport { executeLockdownMore } from '../common/lockdown/lockdown-more';\nimport { OffscreenSnapExecutor } from './OffscreenSnapExecutor';\n\n// Lockdown is already applied in LavaMoat\nexecuteLockdownMore();\nexecuteLockdownEvents();\n\n// The stream from the offscreen document to the execution service.\nconst parentStream = new BrowserRuntimePostMessageStream({\n  name: 'child',\n  target: 'parent',\n});\n\nOffscreenSnapExecutor.initialize(parentStream);\n"],"names":["executeLockdownMore","executeLockdownEvents","parentStream","BrowserRuntimePostMessageStream","name","target","OffscreenSnapExecutor","initialize"],"mappings":";;;;mCAAgD;gCAEV;8BACF;uCACE;AAEtC,0CAA0C;AAC1CA,IAAAA,iCAAmB;AACnBC,IAAAA,qCAAqB;AAErB,mEAAmE;AACnE,MAAMC,eAAe,IAAIC,kDAA+B,CAAC;IACvDC,MAAM;IACNC,QAAQ;AACV;AAEAC,4CAAqB,CAACC,UAAU,CAACL"}
+{"version":3,"sources":["../../../src/offscreen/index.ts"],"sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport { executeLockdownEvents } from '../common/lockdown/lockdown-events';\nimport { executeLockdownMore } from '../common/lockdown/lockdown-more';\nimport { ProxySnapExecutor } from '../proxy/ProxySnapExecutor';\n\n// Lockdown is already applied in LavaMoat\nexecuteLockdownMore();\nexecuteLockdownEvents();\n\n// The stream from the offscreen document to the execution service.\nconst parentStream = new BrowserRuntimePostMessageStream({\n  name: 'child',\n  target: 'parent',\n});\n\nProxySnapExecutor.initialize(parentStream);\n"],"names":["executeLockdownMore","executeLockdownEvents","parentStream","BrowserRuntimePostMessageStream","name","target","ProxySnapExecutor","initialize"],"mappings":";;;;mCAAgD;gCAEV;8BACF;mCACF;AAElC,0CAA0C;AAC1CA,IAAAA,iCAAmB;AACnBC,IAAAA,qCAAqB;AAErB,mEAAmE;AACnE,MAAMC,eAAe,IAAIC,kDAA+B,CAAC;IACvDC,MAAM;IACNC,QAAQ;AACV;AAEAC,oCAAiB,CAACC,UAAU,CAACL"}

package/dist/cjs/{offscreen/OffscreenSnapExecutor.js → proxy/ProxySnapExecutor.js}

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-Object.defineProperty(exports, "OffscreenSnapExecutor", {
+Object.defineProperty(exports, "ProxySnapExecutor", {
     enumerable: true,
     get: function() {
-        return OffscreenSnapExecutor;
+        return ProxySnapExecutor;
     }
 });
 const _postmessagestream = require("@metamask/post-message-stream");
+const _packagejson = /*#__PURE__*/ _interop_require_default(require("@metamask/snaps-execution-environments/package.json"));
 const _snapsutils = require("@metamask/snaps-utils");
 const _utils = require("@metamask/utils");
 function _check_private_redeclaration(obj, privateCollection) {
@@ -74,7 +75,13 @@ function _define_property(obj, key, value) {
     }
     return obj;
 }
-var _stream = /*#__PURE__*/ new WeakMap(), /**
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const IFRAME_URL = `https://execution.metamask.io/${_packagejson.default.version}/index.html`;
+var _stream = /*#__PURE__*/ new WeakMap(), _frameUrl = /*#__PURE__*/ new WeakMap(), /**
    * Handle an incoming message from the `OffscreenExecutionService`. This
    * assumes that the message contains a `jobId` property, and a JSON-RPC
    * request in the `data` property.
@@ -82,49 +89,52 @@ var _stream = /*#__PURE__*/ new WeakMap(), /**
    * @param data - The message data.
    * @param data.data - The JSON-RPC request.
    * @param data.jobId - The job ID.
-   * @param data.extra - Extra data.
-   * @param data.extra.frameUrl - The URL to load in the iframe.
    */ _onData = /*#__PURE__*/ new WeakSet(), _initializeJob = /*#__PURE__*/ new WeakSet(), /**
    * Terminate the job with the given ID. This will close the iframe and delete
    * the job from the internal job map.
    *
    * @param jobId - The job ID.
    */ _terminateJob = /*#__PURE__*/ new WeakSet();
-class OffscreenSnapExecutor {
+class ProxySnapExecutor {
     /**
    * Initialize the executor with the given stream. This is a wrapper around the
    * constructor.
    *
    * @param stream - The stream to use for communication.
+   * @param frameUrl - An optional URL for the iframe to use.
    * @returns The initialized executor.
-   */ static initialize(stream) {
-        return new OffscreenSnapExecutor(stream);
+   */ static initialize(stream, frameUrl = IFRAME_URL) {
+        return new ProxySnapExecutor(stream, frameUrl);
     }
-    constructor(stream){
+    constructor(stream, frameUrl){
         _class_private_method_init(this, _onData);
         /**
    * Create a new iframe and set up a stream to communicate with it.
    *
    * @param jobId - The job ID.
-   * @param frameUrl - The URL to load in the iframe.
    */ _class_private_method_init(this, _initializeJob);
         _class_private_method_init(this, _terminateJob);
         _class_private_field_init(this, _stream, {
             writable: true,
             value: void 0
         });
+        _class_private_field_init(this, _frameUrl, {
+            writable: true,
+            value: void 0
+        });
         _define_property(this, "jobs", {});
         _class_private_field_set(this, _stream, stream);
         _class_private_field_get(this, _stream).on('data', _class_private_method_get(this, _onData, onData).bind(this));
+        _class_private_field_set(this, _frameUrl, frameUrl);
     }
 }
 function onData(data) {
-    const { jobId, extra: { frameUrl }, data: request } = data;
+    const { jobId, data: request } = data;
     if (!this.jobs[jobId]) {
         // This ensures that a job is initialized before it is used. To avoid
         // code duplication, we call the `#onData` method again, which will
         // run the rest of the logic after initialization.
-        _class_private_method_get(this, _initializeJob, initializeJob).call(this, jobId, frameUrl).then(()=>{
+        _class_private_method_get(this, _initializeJob, initializeJob).call(this, jobId).then(()=>{
             _class_private_method_get(this, _onData, onData).call(this, data);
         }).catch((error)=>{
             (0, _snapsutils.logError)('[Worker] Error initializing job:', error);
@@ -139,8 +149,8 @@ function onData(data) {
     }
     this.jobs[jobId].stream.write(request);
 }
-async function initializeJob(jobId, frameUrl) {
-    const window = await (0, _snapsutils.createWindow)(frameUrl, jobId);
+async function initializeJob(jobId) {
+    const window = await (0, _snapsutils.createWindow)(_class_private_field_get(this, _frameUrl), jobId);
     const jobStream = new _postmessagestream.WindowPostMessageStream({
         name: 'parent',
         target: 'child',
@@ -170,4 +180,4 @@ function terminateJob(jobId) {
     delete this.jobs[jobId];
 }
 
-//# sourceMappingURL=OffscreenSnapExecutor.js.map
+//# sourceMappingURL=ProxySnapExecutor.js.map

package/dist/cjs/proxy/ProxySnapExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/proxy/ProxySnapExecutor.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport packageJson from '@metamask/snaps-execution-environments/package.json';\nimport { createWindow, logError } from '@metamask/snaps-utils';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\n\ntype ExecutorJob = {\n  id: string;\n  window: Window;\n  stream: WindowPostMessageStream;\n};\n\nconst IFRAME_URL = `https://execution.metamask.io/${packageJson.version}/index.html`;\n\n/**\n * A \"proxy\" snap executor that uses a level of indirection to execute snaps.\n *\n * Useful for multiple execution environments.\n *\n * This is not a traditional snap executor, as it does not execute snaps itself.\n * Instead, it creates an iframe window for each snap execution, and sends the\n * snap execution request to the iframe window. The iframe window is responsible\n * for executing the snap.\n *\n * This executor is persisted between snap executions. The executor essentially\n * acts as a proxy between the client and the iframe execution environment.\n */\nexport class ProxySnapExecutor {\n  readonly #stream: BasePostMessageStream;\n\n  readonly #frameUrl: string;\n\n  readonly jobs: Record<string, ExecutorJob> = {};\n\n  /**\n   * Initialize the executor with the given stream. This is a wrapper around the\n   * constructor.\n   *\n   * @param stream - The stream to use for communication.\n   * @param frameUrl - An optional URL for the iframe to use.\n   * @returns The initialized executor.\n   */\n  static initialize(stream: BasePostMessageStream, frameUrl = IFRAME_URL) {\n    return new ProxySnapExecutor(stream, frameUrl);\n  }\n\n  constructor(stream: BasePostMessageStream, frameUrl: string) {\n    this.#stream = stream;\n    this.#stream.on('data', this.#onData.bind(this));\n    this.#frameUrl = frameUrl;\n  }\n\n  /**\n   * Handle an incoming message from the `OffscreenExecutionService`. This\n   * assumes that the message contains a `jobId` property, and a JSON-RPC\n   * request in the `data` property.\n   *\n   * @param data - The message data.\n   * @param data.data - The JSON-RPC request.\n   * @param data.jobId - The job ID.\n   */\n  #onData(data: { data: JsonRpcRequest; jobId: string }) {\n    const { jobId, data: request } = data;\n\n    if (!this.jobs[jobId]) {\n      // This ensures that a job is initialized before it is used. To avoid\n      // code duplication, we call the `#onData` method again, which will\n      // run the rest of the logic after initialization.\n      this.#initializeJob(jobId)\n        .then(() => {\n          this.#onData(data);\n        })\n        .catch((error) => {\n          logError('[Worker] Error initializing job:', error);\n        });\n\n      return;\n    }\n\n    // This is a method specific to the `OffscreenSnapExecutor`, as the service\n    // itself does not have access to the iframes directly.\n    if (request.method === 'terminateJob') {\n      this.#terminateJob(jobId);\n      return;\n    }\n\n    this.jobs[jobId].stream.write(request);\n  }\n\n  /**\n   * Create a new iframe and set up a stream to communicate with it.\n   *\n   * @param jobId - The job ID.\n   */\n  async #initializeJob(jobId: string): Promise<ExecutorJob> {\n    const window = await createWindow(this.#frameUrl, jobId);\n    const jobStream = new WindowPostMessageStream({\n      name: 'parent',\n      target: 'child',\n      targetWindow: window,\n      targetOrigin: '*',\n    });\n\n    // Write messages from the iframe to the parent, wrapped with the job ID.\n    jobStream.on('data', (data) => {\n      this.#stream.write({ data, jobId });\n    });\n\n    this.jobs[jobId] = { id: jobId, window, stream: jobStream };\n    return this.jobs[jobId];\n  }\n\n  /**\n   * Terminate the job with the given ID. This will close the iframe and delete\n   * the job from the internal job map.\n   *\n   * @param jobId - The job ID.\n   */\n  #terminateJob(jobId: string) {\n    assert(this.jobs[jobId], `Job \"${jobId}\" not found.`);\n\n    const iframe = document.getElementById(jobId);\n    assert(iframe, `Iframe with ID \"${jobId}\" not found.`);\n\n    iframe.remove();\n    this.jobs[jobId].stream.destroy();\n    delete this.jobs[jobId];\n  }\n}\n"],"names":["ProxySnapExecutor","IFRAME_URL","packageJson","version","initialize","stream","frameUrl","constructor","jobs","on","onData","bind","data","jobId","request","initializeJob","then","catch","error","logError","method","terminateJob","write","window","createWindow","jobStream","WindowPostMessageStream","name","target","targetWindow","targetOrigin","id","assert","iframe","document","getElementById","remove","destroy"],"mappings":";;;;+BA6BaA;;;eAAAA;;;mCA5B2B;oEAEhB;4BACe;uBAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQvB,MAAMC,aAAa,CAAC,8BAA8B,EAAEC,oBAAW,CAACC,OAAO,CAAC,WAAW,CAAC;IAgBzE,uCAEA,yCAsBT;;;;;;;;GAQC,GACD,uCAiCM,8CAkBN;;;;;GAKC,GACD;AA3FK,MAAMH;IAOX;;;;;;;GAOC,GACD,OAAOI,WAAWC,MAA6B,EAAEC,WAAWL,UAAU,EAAE;QACtE,OAAO,IAAID,kBAAkBK,QAAQC;IACvC;IAEAC,YAAYF,MAA6B,EAAEC,QAAgB,CAAE;QAe7D,iCAAA;QA4BA;;;;GAIC,GACD,iCAAM;QAwBN,iCAAA;QA1FA,gCAAS;;mBAAT,KAAA;;QAEA,gCAAS;;mBAAT,KAAA;;QAEA,uBAASE,QAAoC,CAAC;uCAetCH,SAASA;QACf,yBAAA,IAAI,EAAEA,SAAOI,EAAE,CAAC,QAAQ,0BAAA,IAAI,EAAEC,SAAAA,QAAOC,IAAI,CAAC,IAAI;uCACxCL,WAAWA;IACnB;AA8EF;AAnEE,SAAA,OAAQM,IAA6C;IACnD,MAAM,EAAEC,KAAK,EAAED,MAAME,OAAO,EAAE,GAAGF;IAEjC,IAAI,CAAC,IAAI,CAACJ,IAAI,CAACK,MAAM,EAAE;QACrB,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,0BAAA,IAAI,EAAEE,gBAAAA,oBAAN,IAAI,EAAgBF,OACjBG,IAAI,CAAC;YACJ,0BAAA,IAAI,EAAEN,SAAAA,aAAN,IAAI,EAASE;QACf,GACCK,KAAK,CAAC,CAACC;YACNC,IAAAA,oBAAQ,EAAC,oCAAoCD;QAC/C;QAEF;IACF;IAEA,2EAA2E;IAC3E,uDAAuD;IACvD,IAAIJ,QAAQM,MAAM,KAAK,gBAAgB;QACrC,0BAAA,IAAI,EAAEC,eAAAA,mBAAN,IAAI,EAAeR;QACnB;IACF;IAEA,IAAI,CAACL,IAAI,CAACK,MAAM,CAACR,MAAM,CAACiB,KAAK,CAACR;AAChC;AAOA,eAAA,cAAqBD,KAAa;IAChC,MAAMU,SAAS,MAAMC,IAAAA,wBAAY,2BAAC,IAAI,EAAElB,YAAUO;IAClD,MAAMY,YAAY,IAAIC,0CAAuB,CAAC;QAC5CC,MAAM;QACNC,QAAQ;QACRC,cAAcN;QACdO,cAAc;IAChB;IAEA,yEAAyE;IACzEL,UAAUhB,EAAE,CAAC,QAAQ,CAACG;QACpB,yBAAA,IAAI,EAAEP,SAAOiB,KAAK,CAAC;YAAEV;YAAMC;QAAM;IACnC;IAEA,IAAI,CAACL,IAAI,CAACK,MAAM,GAAG;QAAEkB,IAAIlB;QAAOU;QAAQlB,QAAQoB;IAAU;IAC1D,OAAO,IAAI,CAACjB,IAAI,CAACK,MAAM;AACzB;AAQA,SAAA,aAAcA,KAAa;IACzBmB,IAAAA,aAAM,EAAC,IAAI,CAACxB,IAAI,CAACK,MAAM,EAAE,CAAC,KAAK,EAAEA,MAAM,YAAY,CAAC;IAEpD,MAAMoB,SAASC,SAASC,cAAc,CAACtB;IACvCmB,IAAAA,aAAM,EAACC,QAAQ,CAAC,gBAAgB,EAAEpB,MAAM,YAAY,CAAC;IAErDoB,OAAOG,MAAM;IACb,IAAI,CAAC5B,IAAI,CAACK,MAAM,CAACR,MAAM,CAACgC,OAAO;IAC/B,OAAO,IAAI,CAAC7B,IAAI,CAACK,MAAM;AACzB"}

package/dist/esm/common/commands.js

@@ -1,6 +1,6 @@
 import { HandlerType } from '@metamask/snaps-utils';
 import { assertExhaustive } from '@metamask/utils';
-import { assertIsOnTransactionRequestArguments, assertIsOnNameLookupRequestArguments } from './validation';
+import { assertIsOnTransactionRequestArguments, assertIsOnSignatureRequestArguments, assertIsOnNameLookupRequestArguments } from './validation';
 /**
  * Formats the arguments for the given handler.
  *
@@ -21,6 +21,15 @@ import { assertIsOnTransactionRequestArguments, assertIsOnNameLookupRequestArgum
                     transactionOrigin
                 };
             }
+        case HandlerType.OnSignature:
+            {
+                assertIsOnSignatureRequestArguments(request.params);
+                const { signature, signatureOrigin } = request.params;
+                return {
+                    signature,
+                    signatureOrigin
+                };
+            }
         case HandlerType.OnNameLookup:
             {
                 assertIsOnNameLookupRequestArguments(request.params);

package/dist/esm/common/commands.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/common/commands.ts"],"sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport type { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport type {\n  ExecuteSnap,\n  JsonRpcRequestWithoutId,\n  Ping,\n  PossibleLookupRequestArgs,\n  SnapRpc,\n  Terminate,\n} from './validation';\nimport {\n  assertIsOnTransactionRequestArguments,\n  assertIsOnNameLookupRequestArguments,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n  ping: Ping;\n  terminate: Terminate;\n  executeSnap: ExecuteSnap;\n  snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n  origin: string,\n  handler: HandlerType,\n  request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n  // `request` is already validated by the time this function is called.\n\n  switch (handler) {\n    case HandlerType.OnTransaction: {\n      assertIsOnTransactionRequestArguments(request.params);\n\n      const { transaction, chainId, transactionOrigin } = request.params;\n      return {\n        transaction,\n        chainId,\n        transactionOrigin,\n      };\n    }\n    case HandlerType.OnNameLookup: {\n      assertIsOnNameLookupRequestArguments(request.params);\n\n      // TS complains that domain/address are not part of the type\n      // casting here as we've already validated the request args in the above step.\n      const { chainId, domain, address } =\n        request.params as unknown as PossibleLookupRequestArgs;\n\n      return domain\n        ? {\n            chainId,\n            domain,\n          }\n        : {\n            chainId,\n            address,\n          };\n    }\n    case HandlerType.OnRpcRequest:\n    case HandlerType.OnKeyringRequest:\n      return { origin, request };\n\n    case HandlerType.OnCronjob:\n    case HandlerType.OnInstall:\n    case HandlerType.OnUpdate:\n      return { request };\n\n    case HandlerType.OnHomePage:\n      return {};\n\n    default:\n      return assertExhaustive(handler);\n  }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n  startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n  invokeSnap: InvokeSnap,\n  onTerminate: () => void,\n): CommandMethodsMapping {\n  return {\n    ping: async () => Promise.resolve('OK'),\n    terminate: async () => {\n      onTerminate();\n      return Promise.resolve('OK');\n    },\n\n    executeSnap: async (snapId, sourceCode, endowments) => {\n      await startSnap(snapId, sourceCode, endowments);\n      return 'OK';\n    },\n\n    snapRpc: async (target, handler, origin, request) => {\n      return (\n        (await invokeSnap(\n          target,\n          handler,\n          getHandlerArguments(origin, handler, request),\n        )) ?? null\n      );\n    },\n  };\n}\n"],"names":["HandlerType","assertExhaustive","assertIsOnTransactionRequestArguments","assertIsOnNameLookupRequestArguments","getHandlerArguments","origin","handler","request","OnTransaction","params","transaction","chainId","transactionOrigin","OnNameLookup","domain","address","OnRpcRequest","OnKeyringRequest","OnCronjob","OnInstall","OnUpdate","OnHomePage","getCommandMethodImplementations","startSnap","invokeSnap","onTerminate","ping","Promise","resolve","terminate","executeSnap","snapId","sourceCode","endowments","snapRpc","target"],"mappings":"AAAA,SAASA,WAAW,QAAQ,wBAAwB;AACpD,SAASC,gBAAgB,QAAQ,kBAAkB;AAWnD,SACEC,qCAAqC,EACrCC,oCAAoC,QAC/B,eAAe;AAStB;;;;;;;CAOC,GACD,OAAO,SAASC,oBACdC,MAAc,EACdC,OAAoB,EACpBC,OAAgC;IAEhC,sEAAsE;IAEtE,OAAQD;QACN,KAAKN,YAAYQ,aAAa;YAAE;gBAC9BN,sCAAsCK,QAAQE,MAAM;gBAEpD,MAAM,EAAEC,WAAW,EAAEC,OAAO,EAAEC,iBAAiB,EAAE,GAAGL,QAAQE,MAAM;gBAClE,OAAO;oBACLC;oBACAC;oBACAC;gBACF;YACF;QACA,KAAKZ,YAAYa,YAAY;YAAE;gBAC7BV,qCAAqCI,QAAQE,MAAM;gBAEnD,4DAA4D;gBAC5D,8EAA8E;gBAC9E,MAAM,EAAEE,OAAO,EAAEG,MAAM,EAAEC,OAAO,EAAE,GAChCR,QAAQE,MAAM;gBAEhB,OAAOK,SACH;oBACEH;oBACAG;gBACF,IACA;oBACEH;oBACAI;gBACF;YACN;QACA,KAAKf,YAAYgB,YAAY;QAC7B,KAAKhB,YAAYiB,gBAAgB;YAC/B,OAAO;gBAAEZ;gBAAQE;YAAQ;QAE3B,KAAKP,YAAYkB,SAAS;QAC1B,KAAKlB,YAAYmB,SAAS;QAC1B,KAAKnB,YAAYoB,QAAQ;YACvB,OAAO;gBAAEb;YAAQ;QAEnB,KAAKP,YAAYqB,UAAU;YACzB,OAAO,CAAC;QAEV;YACE,OAAOpB,iBAAiBK;IAC5B;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASgB,gCACdC,SAA8D,EAC9DC,UAAsB,EACtBC,WAAuB;IAEvB,OAAO;QACLC,MAAM,UAAYC,QAAQC,OAAO,CAAC;QAClCC,WAAW;YACTJ;YACA,OAAOE,QAAQC,OAAO,CAAC;QACzB;QAEAE,aAAa,OAAOC,QAAQC,YAAYC;YACtC,MAAMV,UAAUQ,QAAQC,YAAYC;YACpC,OAAO;QACT;QAEAC,SAAS,OAAOC,QAAQ7B,SAASD,QAAQE;YACvC,OACE,AAAC,MAAMiB,WACLW,QACA7B,SACAF,oBAAoBC,QAAQC,SAASC,aACjC;QAEV;IACF;AACF"}
+{"version":3,"sources":["../../../src/common/commands.ts"],"sourcesContent":["import { HandlerType } from '@metamask/snaps-utils';\nimport { assertExhaustive } from '@metamask/utils';\n\nimport type { InvokeSnap, InvokeSnapArgs } from './BaseSnapExecutor';\nimport type {\n  ExecuteSnap,\n  JsonRpcRequestWithoutId,\n  Ping,\n  PossibleLookupRequestArgs,\n  SnapRpc,\n  Terminate,\n} from './validation';\nimport {\n  assertIsOnTransactionRequestArguments,\n  assertIsOnSignatureRequestArguments,\n  assertIsOnNameLookupRequestArguments,\n} from './validation';\n\nexport type CommandMethodsMapping = {\n  ping: Ping;\n  terminate: Terminate;\n  executeSnap: ExecuteSnap;\n  snapRpc: SnapRpc;\n};\n\n/**\n * Formats the arguments for the given handler.\n *\n * @param origin - The origin of the request.\n * @param handler - The handler to pass the request to.\n * @param request - The request object.\n * @returns The formatted arguments.\n */\nexport function getHandlerArguments(\n  origin: string,\n  handler: HandlerType,\n  request: JsonRpcRequestWithoutId,\n): InvokeSnapArgs {\n  // `request` is already validated by the time this function is called.\n\n  switch (handler) {\n    case HandlerType.OnTransaction: {\n      assertIsOnTransactionRequestArguments(request.params);\n\n      const { transaction, chainId, transactionOrigin } = request.params;\n      return {\n        transaction,\n        chainId,\n        transactionOrigin,\n      };\n    }\n    case HandlerType.OnSignature: {\n      assertIsOnSignatureRequestArguments(request.params);\n\n      const { signature, signatureOrigin } = request.params;\n      return { signature, signatureOrigin };\n    }\n    case HandlerType.OnNameLookup: {\n      assertIsOnNameLookupRequestArguments(request.params);\n\n      // TS complains that domain/address are not part of the type\n      // casting here as we've already validated the request args in the above step.\n      const { chainId, domain, address } =\n        request.params as unknown as PossibleLookupRequestArgs;\n\n      return domain\n        ? {\n            chainId,\n            domain,\n          }\n        : {\n            chainId,\n            address,\n          };\n    }\n    case HandlerType.OnRpcRequest:\n    case HandlerType.OnKeyringRequest:\n      return { origin, request };\n\n    case HandlerType.OnCronjob:\n    case HandlerType.OnInstall:\n    case HandlerType.OnUpdate:\n      return { request };\n\n    case HandlerType.OnHomePage:\n      return {};\n\n    default:\n      return assertExhaustive(handler);\n  }\n}\n\n/**\n * Gets an object mapping internal, \"command\" JSON-RPC method names to their\n * implementations.\n *\n * @param startSnap - A function that starts a snap.\n * @param invokeSnap - A function that invokes the RPC method handler of a\n * snap.\n * @param onTerminate - A function that will be called when this executor is\n * terminated in order to handle cleanup tasks.\n * @returns An object containing the \"command\" method implementations.\n */\nexport function getCommandMethodImplementations(\n  startSnap: (...args: Parameters<ExecuteSnap>) => Promise<void>,\n  invokeSnap: InvokeSnap,\n  onTerminate: () => void,\n): CommandMethodsMapping {\n  return {\n    ping: async () => Promise.resolve('OK'),\n    terminate: async () => {\n      onTerminate();\n      return Promise.resolve('OK');\n    },\n\n    executeSnap: async (snapId, sourceCode, endowments) => {\n      await startSnap(snapId, sourceCode, endowments);\n      return 'OK';\n    },\n\n    snapRpc: async (target, handler, origin, request) => {\n      return (\n        (await invokeSnap(\n          target,\n          handler,\n          getHandlerArguments(origin, handler, request),\n        )) ?? null\n      );\n    },\n  };\n}\n"],"names":["HandlerType","assertExhaustive","assertIsOnTransactionRequestArguments","assertIsOnSignatureRequestArguments","assertIsOnNameLookupRequestArguments","getHandlerArguments","origin","handler","request","OnTransaction","params","transaction","chainId","transactionOrigin","OnSignature","signature","signatureOrigin","OnNameLookup","domain","address","OnRpcRequest","OnKeyringRequest","OnCronjob","OnInstall","OnUpdate","OnHomePage","getCommandMethodImplementations","startSnap","invokeSnap","onTerminate","ping","Promise","resolve","terminate","executeSnap","snapId","sourceCode","endowments","snapRpc","target"],"mappings":"AAAA,SAASA,WAAW,QAAQ,wBAAwB;AACpD,SAASC,gBAAgB,QAAQ,kBAAkB;AAWnD,SACEC,qCAAqC,EACrCC,mCAAmC,EACnCC,oCAAoC,QAC/B,eAAe;AAStB;;;;;;;CAOC,GACD,OAAO,SAASC,oBACdC,MAAc,EACdC,OAAoB,EACpBC,OAAgC;IAEhC,sEAAsE;IAEtE,OAAQD;QACN,KAAKP,YAAYS,aAAa;YAAE;gBAC9BP,sCAAsCM,QAAQE,MAAM;gBAEpD,MAAM,EAAEC,WAAW,EAAEC,OAAO,EAAEC,iBAAiB,EAAE,GAAGL,QAAQE,MAAM;gBAClE,OAAO;oBACLC;oBACAC;oBACAC;gBACF;YACF;QACA,KAAKb,YAAYc,WAAW;YAAE;gBAC5BX,oCAAoCK,QAAQE,MAAM;gBAElD,MAAM,EAAEK,SAAS,EAAEC,eAAe,EAAE,GAAGR,QAAQE,MAAM;gBACrD,OAAO;oBAAEK;oBAAWC;gBAAgB;YACtC;QACA,KAAKhB,YAAYiB,YAAY;YAAE;gBAC7Bb,qCAAqCI,QAAQE,MAAM;gBAEnD,4DAA4D;gBAC5D,8EAA8E;gBAC9E,MAAM,EAAEE,OAAO,EAAEM,MAAM,EAAEC,OAAO,EAAE,GAChCX,QAAQE,MAAM;gBAEhB,OAAOQ,SACH;oBACEN;oBACAM;gBACF,IACA;oBACEN;oBACAO;gBACF;YACN;QACA,KAAKnB,YAAYoB,YAAY;QAC7B,KAAKpB,YAAYqB,gBAAgB;YAC/B,OAAO;gBAAEf;gBAAQE;YAAQ;QAE3B,KAAKR,YAAYsB,SAAS;QAC1B,KAAKtB,YAAYuB,SAAS;QAC1B,KAAKvB,YAAYwB,QAAQ;YACvB,OAAO;gBAAEhB;YAAQ;QAEnB,KAAKR,YAAYyB,UAAU;YACzB,OAAO,CAAC;QAEV;YACE,OAAOxB,iBAAiBM;IAC5B;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASmB,gCACdC,SAA8D,EAC9DC,UAAsB,EACtBC,WAAuB;IAEvB,OAAO;QACLC,MAAM,UAAYC,QAAQC,OAAO,CAAC;QAClCC,WAAW;YACTJ;YACA,OAAOE,QAAQC,OAAO,CAAC;QACzB;QAEAE,aAAa,OAAOC,QAAQC,YAAYC;YACtC,MAAMV,UAAUQ,QAAQC,YAAYC;YACpC,OAAO;QACT;QAEAC,SAAS,OAAOC,QAAQhC,SAASD,QAAQE;YACvC,OACE,AAAC,MAAMoB,WACLW,QACAhC,SACAF,oBAAoBC,QAAQC,SAASC,aACjC;QAEV;IACF;AACF"}

package/dist/esm/common/validation.js

@@ -63,6 +63,20 @@ export const OnTransactionRequestArgumentsStruct = object({
  */ export function assertIsOnTransactionRequestArguments(value) {
     assertStruct(value, OnTransactionRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
 }
+export const OnSignatureRequestArgumentsStruct = object({
+    signature: record(string(), JsonStruct),
+    signatureOrigin: nullable(string())
+});
+/**
+ * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnSignatureRequestArguments}
+ * object.
+ */ export function assertIsOnSignatureRequestArguments(value) {
+    assertStruct(value, OnSignatureRequestArgumentsStruct, 'Invalid request params', rpcErrors.invalidParams);
+}
 const baseNameLookupArgs = {
     chainId: ChainIdStruct
 };

package/dist/esm/common/validation.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/common/validation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n  assertStruct,\n  JsonRpcIdStruct,\n  JsonRpcParamsStruct,\n  JsonRpcSuccessStruct,\n  JsonRpcVersionStruct,\n  JsonStruct,\n} from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n  array,\n  assign,\n  enums,\n  is,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  tuple,\n  union,\n} from 'superstruct';\n\nexport const JsonRpcRequestWithoutIdStruct = object({\n  jsonrpc: optional(JsonRpcVersionStruct),\n  id: optional(JsonRpcIdStruct),\n  method: string(),\n  params: optional(JsonRpcParamsStruct),\n});\n\nexport type JsonRpcRequestWithoutId = Infer<\n  typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n  return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n  return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n  union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n  literal(undefined),\n  array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n  string(),\n  string(),\n  array(EndowmentStruct),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n  string(),\n  enums(Object.values(HandlerType)),\n  string(),\n  assign(\n    JsonRpcRequestWithoutIdStruct,\n    object({\n      params: optional(record(string(), JsonStruct)),\n    }),\n  ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n  typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n  typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n  typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n  | PingRequestArguments\n  | TerminateRequestArguments\n  | ExecuteSnapRequestArguments\n  | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n  // TODO: Improve `transaction` type.\n  transaction: record(string(), JsonStruct),\n  chainId: ChainIdStruct,\n  transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n  typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n  value: unknown,\n): asserts value is OnTransactionRequestArguments {\n  assertStruct(\n    value,\n    OnTransactionRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n  ...baseNameLookupArgs,\n  address: string(),\n});\nconst addressRequestStruct = object({\n  ...baseNameLookupArgs,\n  domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n  domainRequestStruct,\n  addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n  typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n  address?: string;\n  domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n  value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n  assertStruct(\n    value,\n    OnNameLookupRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst OkResponseStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: OkStruct,\n});\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n  Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n  Args extends RequestArguments,\n  ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n  ExecuteSnapRequestArguments,\n  OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"],"names":["rpcErrors","ChainIdStruct","HandlerType","assertStruct","JsonRpcIdStruct","JsonRpcParamsStruct","JsonRpcSuccessStruct","JsonRpcVersionStruct","JsonStruct","array","assign","enums","is","literal","nullable","object","optional","record","string","tuple","union","JsonRpcRequestWithoutIdStruct","jsonrpc","id","method","params","EndowmentStruct","isEndowment","value","isEndowmentsArray","Array","isArray","every","OkStruct","PingRequestArgumentsStruct","undefined","TerminateRequestArgumentsStruct","ExecuteSnapRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","Object","values","OnTransactionRequestArgumentsStruct","transaction","chainId","transactionOrigin","assertIsOnTransactionRequestArguments","invalidParams","baseNameLookupArgs","domainRequestStruct","address","addressRequestStruct","domain","OnNameLookupRequestArgumentsStruct","assertIsOnNameLookupRequestArguments","OkResponseStruct","result","SnapRpcResponse"],"mappings":"AAAA,SAASA,SAAS,QAAQ,uBAAuB;AACjD,SAASC,aAAa,EAAEC,WAAW,QAAQ,wBAAwB;AAEnE,SACEC,YAAY,EACZC,eAAe,EACfC,mBAAmB,EACnBC,oBAAoB,EACpBC,oBAAoB,EACpBC,UAAU,QACL,kBAAkB;AAEzB,SACEC,KAAK,EACLC,MAAM,EACNC,KAAK,EACLC,EAAE,EACFC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,KAAK,EACLC,KAAK,QACA,cAAc;AAErB,OAAO,MAAMC,gCAAgCN,OAAO;IAClDO,SAASN,SAAST;IAClBgB,IAAIP,SAASZ;IACboB,QAAQN;IACRO,QAAQT,SAASX;AACnB,GAAG;AAMH,OAAO,MAAMqB,kBAAkBR,SAAS;AAGxC;;;;;CAKC,GACD,OAAO,SAASS,YAAYC,KAAc;IACxC,OAAOhB,GAAGgB,OAAOF;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASG,kBAAkBD,KAAc;IAC9C,OAAOE,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAACL;AAC7C;AAEA,MAAMM,WAAWpB,QAAQ;AAEzB,OAAO,MAAMqB,6BAA6BlB,SACxCI,MAAM;IAACP,QAAQsB;IAAY1B;CAAQ,GACnC;AAEF,OAAO,MAAM2B,kCAAkChB,MAAM;IACnDP,QAAQsB;IACR1B;CACD,EAAE;AAEH,OAAO,MAAM4B,oCAAoClB,MAAM;IACrDD;IACAA;IACAT,MAAMiB;CACP,EAAE;AAEH,OAAO,MAAMY,gCAAgCnB,MAAM;IACjDD;IACAP,MAAM4B,OAAOC,MAAM,CAACtC;IACpBgB;IACAR,OACEW,+BACAN,OAAO;QACLU,QAAQT,SAASC,OAAOC,UAAUV;IACpC;CAEH,EAAE;AAqBH,OAAO,MAAMiC,sCAAsC1B,OAAO;IACxD,oCAAoC;IACpC2B,aAAazB,OAAOC,UAAUV;IAC9BmC,SAAS1C;IACT2C,mBAAmB9B,SAASI;AAC9B,GAAG;AAMH;;;;;;;CAOC,GACD,OAAO,SAAS2B,sCACdjB,KAAc;IAEdzB,aACEyB,OACAa,qCACA,0BACAzC,UAAU8C,aAAa;AAE3B;AAEA,MAAMC,qBAAqB;IAAEJ,SAAS1C;AAAc;AACpD,MAAM+C,sBAAsBjC,OAAO;IACjC,GAAGgC,kBAAkB;IACrBE,SAAS/B;AACX;AACA,MAAMgC,uBAAuBnC,OAAO;IAClC,GAAGgC,kBAAkB;IACrBI,QAAQjC;AACV;AAEA,OAAO,MAAMkC,qCAAqChC,MAAM;IACtD4B;IACAE;CACD,EAAE;AAWH;;;;;;;CAOC,GACD,OAAO,SAASG,qCACdzB,KAAc;IAEdzB,aACEyB,OACAwB,oCACA,0BACApD,UAAU8C,aAAa;AAE3B;AAEA,MAAMQ,mBAAmBvC,OAAO;IAC9BQ,IAAInB;IACJkB,SAASf;IACTgD,QAAQtB;AACV;AAEA,MAAMuB,kBAAkBlD"}
+{"version":3,"sources":["../../../src/common/validation.ts"],"sourcesContent":["import { rpcErrors } from '@metamask/rpc-errors';\nimport { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcSuccess } from '@metamask/utils';\nimport {\n  assertStruct,\n  JsonRpcIdStruct,\n  JsonRpcParamsStruct,\n  JsonRpcSuccessStruct,\n  JsonRpcVersionStruct,\n  JsonStruct,\n} from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport {\n  array,\n  assign,\n  enums,\n  is,\n  literal,\n  nullable,\n  object,\n  optional,\n  record,\n  string,\n  tuple,\n  union,\n} from 'superstruct';\n\nexport const JsonRpcRequestWithoutIdStruct = object({\n  jsonrpc: optional(JsonRpcVersionStruct),\n  id: optional(JsonRpcIdStruct),\n  method: string(),\n  params: optional(JsonRpcParamsStruct),\n});\n\nexport type JsonRpcRequestWithoutId = Infer<\n  typeof JsonRpcRequestWithoutIdStruct\n>;\n\nexport const EndowmentStruct = string();\nexport type Endowment = Infer<typeof EndowmentStruct>;\n\n/**\n * Check if the given value is an endowment.\n *\n * @param value - The value to check.\n * @returns Whether the value is an endowment.\n */\nexport function isEndowment(value: unknown): value is Endowment {\n  return is(value, EndowmentStruct);\n}\n\n/**\n * Check if the given value is an array of endowments.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of endowments.\n */\nexport function isEndowmentsArray(value: unknown): value is Endowment[] {\n  return Array.isArray(value) && value.every(isEndowment);\n}\n\nconst OkStruct = literal('OK');\n\nexport const PingRequestArgumentsStruct = optional(\n  union([literal(undefined), array()]),\n);\n\nexport const TerminateRequestArgumentsStruct = union([\n  literal(undefined),\n  array(),\n]);\n\nexport const ExecuteSnapRequestArgumentsStruct = tuple([\n  string(),\n  string(),\n  array(EndowmentStruct),\n]);\n\nexport const SnapRpcRequestArgumentsStruct = tuple([\n  string(),\n  enums(Object.values(HandlerType)),\n  string(),\n  assign(\n    JsonRpcRequestWithoutIdStruct,\n    object({\n      params: optional(record(string(), JsonStruct)),\n    }),\n  ),\n]);\n\nexport type PingRequestArguments = Infer<typeof PingRequestArgumentsStruct>;\nexport type TerminateRequestArguments = Infer<\n  typeof TerminateRequestArgumentsStruct\n>;\n\nexport type ExecuteSnapRequestArguments = Infer<\n  typeof ExecuteSnapRequestArgumentsStruct\n>;\n\nexport type SnapRpcRequestArguments = Infer<\n  typeof SnapRpcRequestArgumentsStruct\n>;\n\nexport type RequestArguments =\n  | PingRequestArguments\n  | TerminateRequestArguments\n  | ExecuteSnapRequestArguments\n  | SnapRpcRequestArguments;\n\nexport const OnTransactionRequestArgumentsStruct = object({\n  // TODO: Improve `transaction` type.\n  transaction: record(string(), JsonStruct),\n  chainId: ChainIdStruct,\n  transactionOrigin: nullable(string()),\n});\n\nexport type OnTransactionRequestArguments = Infer<\n  typeof OnTransactionRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnTransactionRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnTransactionRequestArguments}\n * object.\n */\nexport function assertIsOnTransactionRequestArguments(\n  value: unknown,\n): asserts value is OnTransactionRequestArguments {\n  assertStruct(\n    value,\n    OnTransactionRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nexport const OnSignatureRequestArgumentsStruct = object({\n  signature: record(string(), JsonStruct),\n  signatureOrigin: nullable(string()),\n});\n\nexport type OnSignatureRequestArguments = Infer<\n  typeof OnSignatureRequestArgumentsStruct\n>;\n\n/**\n * Asserts that the given value is a valid {@link OnSignatureRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnSignatureRequestArguments}\n * object.\n */\nexport function assertIsOnSignatureRequestArguments(\n  value: unknown,\n): asserts value is OnSignatureRequestArguments {\n  assertStruct(\n    value,\n    OnSignatureRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst baseNameLookupArgs = { chainId: ChainIdStruct };\nconst domainRequestStruct = object({\n  ...baseNameLookupArgs,\n  address: string(),\n});\nconst addressRequestStruct = object({\n  ...baseNameLookupArgs,\n  domain: string(),\n});\n\nexport const OnNameLookupRequestArgumentsStruct = union([\n  domainRequestStruct,\n  addressRequestStruct,\n]);\n\nexport type OnNameLookupRequestArguments = Infer<\n  typeof OnNameLookupRequestArgumentsStruct\n>;\n\nexport type PossibleLookupRequestArgs = typeof baseNameLookupArgs & {\n  address?: string;\n  domain?: string;\n};\n\n/**\n * Asserts that the given value is a valid {@link OnNameLookupRequestArguments}\n * object.\n *\n * @param value - The value to validate.\n * @throws If the value is not a valid {@link OnNameLookupRequestArguments}\n * object.\n */\nexport function assertIsOnNameLookupRequestArguments(\n  value: unknown,\n): asserts value is OnNameLookupRequestArguments {\n  assertStruct(\n    value,\n    OnNameLookupRequestArgumentsStruct,\n    'Invalid request params',\n    rpcErrors.invalidParams,\n  );\n}\n\nconst OkResponseStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: OkStruct,\n});\n\nconst SnapRpcResponse = JsonRpcSuccessStruct;\n\nexport type OkResponse = Infer<typeof OkResponseStruct>;\nexport type SnapRpcResponse = Infer<typeof SnapRpcResponse>;\n\nexport type Response = OkResponse | SnapRpcResponse;\n\ntype RequestParams<Params extends unknown[] | undefined> =\n  Params extends undefined ? [] : Params;\n\ntype RequestFunction<\n  Args extends RequestArguments,\n  ResponseType extends JsonRpcSuccess<Json>,\n> = (...args: RequestParams<Args>) => Promise<ResponseType['result']>;\n\nexport type Ping = RequestFunction<PingRequestArguments, OkResponse>;\nexport type Terminate = RequestFunction<TerminateRequestArguments, OkResponse>;\nexport type ExecuteSnap = RequestFunction<\n  ExecuteSnapRequestArguments,\n  OkResponse\n>;\nexport type SnapRpc = RequestFunction<SnapRpcRequestArguments, SnapRpcResponse>;\n"],"names":["rpcErrors","ChainIdStruct","HandlerType","assertStruct","JsonRpcIdStruct","JsonRpcParamsStruct","JsonRpcSuccessStruct","JsonRpcVersionStruct","JsonStruct","array","assign","enums","is","literal","nullable","object","optional","record","string","tuple","union","JsonRpcRequestWithoutIdStruct","jsonrpc","id","method","params","EndowmentStruct","isEndowment","value","isEndowmentsArray","Array","isArray","every","OkStruct","PingRequestArgumentsStruct","undefined","TerminateRequestArgumentsStruct","ExecuteSnapRequestArgumentsStruct","SnapRpcRequestArgumentsStruct","Object","values","OnTransactionRequestArgumentsStruct","transaction","chainId","transactionOrigin","assertIsOnTransactionRequestArguments","invalidParams","OnSignatureRequestArgumentsStruct","signature","signatureOrigin","assertIsOnSignatureRequestArguments","baseNameLookupArgs","domainRequestStruct","address","addressRequestStruct","domain","OnNameLookupRequestArgumentsStruct","assertIsOnNameLookupRequestArguments","OkResponseStruct","result","SnapRpcResponse"],"mappings":"AAAA,SAASA,SAAS,QAAQ,uBAAuB;AACjD,SAASC,aAAa,EAAEC,WAAW,QAAQ,wBAAwB;AAEnE,SACEC,YAAY,EACZC,eAAe,EACfC,mBAAmB,EACnBC,oBAAoB,EACpBC,oBAAoB,EACpBC,UAAU,QACL,kBAAkB;AAEzB,SACEC,KAAK,EACLC,MAAM,EACNC,KAAK,EACLC,EAAE,EACFC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,KAAK,EACLC,KAAK,QACA,cAAc;AAErB,OAAO,MAAMC,gCAAgCN,OAAO;IAClDO,SAASN,SAAST;IAClBgB,IAAIP,SAASZ;IACboB,QAAQN;IACRO,QAAQT,SAASX;AACnB,GAAG;AAMH,OAAO,MAAMqB,kBAAkBR,SAAS;AAGxC;;;;;CAKC,GACD,OAAO,SAASS,YAAYC,KAAc;IACxC,OAAOhB,GAAGgB,OAAOF;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASG,kBAAkBD,KAAc;IAC9C,OAAOE,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAACL;AAC7C;AAEA,MAAMM,WAAWpB,QAAQ;AAEzB,OAAO,MAAMqB,6BAA6BlB,SACxCI,MAAM;IAACP,QAAQsB;IAAY1B;CAAQ,GACnC;AAEF,OAAO,MAAM2B,kCAAkChB,MAAM;IACnDP,QAAQsB;IACR1B;CACD,EAAE;AAEH,OAAO,MAAM4B,oCAAoClB,MAAM;IACrDD;IACAA;IACAT,MAAMiB;CACP,EAAE;AAEH,OAAO,MAAMY,gCAAgCnB,MAAM;IACjDD;IACAP,MAAM4B,OAAOC,MAAM,CAACtC;IACpBgB;IACAR,OACEW,+BACAN,OAAO;QACLU,QAAQT,SAASC,OAAOC,UAAUV;IACpC;CAEH,EAAE;AAqBH,OAAO,MAAMiC,sCAAsC1B,OAAO;IACxD,oCAAoC;IACpC2B,aAAazB,OAAOC,UAAUV;IAC9BmC,SAAS1C;IACT2C,mBAAmB9B,SAASI;AAC9B,GAAG;AAMH;;;;;;;CAOC,GACD,OAAO,SAAS2B,sCACdjB,KAAc;IAEdzB,aACEyB,OACAa,qCACA,0BACAzC,UAAU8C,aAAa;AAE3B;AAEA,OAAO,MAAMC,oCAAoChC,OAAO;IACtDiC,WAAW/B,OAAOC,UAAUV;IAC5ByC,iBAAiBnC,SAASI;AAC5B,GAAG;AAMH;;;;;;;CAOC,GACD,OAAO,SAASgC,oCACdtB,KAAc;IAEdzB,aACEyB,OACAmB,mCACA,0BACA/C,UAAU8C,aAAa;AAE3B;AAEA,MAAMK,qBAAqB;IAAER,SAAS1C;AAAc;AACpD,MAAMmD,sBAAsBrC,OAAO;IACjC,GAAGoC,kBAAkB;IACrBE,SAASnC;AACX;AACA,MAAMoC,uBAAuBvC,OAAO;IAClC,GAAGoC,kBAAkB;IACrBI,QAAQrC;AACV;AAEA,OAAO,MAAMsC,qCAAqCpC,MAAM;IACtDgC;IACAE;CACD,EAAE;AAWH;;;;;;;CAOC,GACD,OAAO,SAASG,qCACd7B,KAAc;IAEdzB,aACEyB,OACA4B,oCACA,0BACAxD,UAAU8C,aAAa;AAE3B;AAEA,MAAMY,mBAAmB3C,OAAO;IAC9BQ,IAAInB;IACJkB,SAASf;IACToD,QAAQ1B;AACV;AAEA,MAAM2B,kBAAkBtD"}

package/dist/esm/offscreen/index.js

@@ -1,7 +1,7 @@
 import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';
 import { executeLockdownEvents } from '../common/lockdown/lockdown-events';
 import { executeLockdownMore } from '../common/lockdown/lockdown-more';
-import { OffscreenSnapExecutor } from './OffscreenSnapExecutor';
+import { ProxySnapExecutor } from '../proxy/ProxySnapExecutor';
 // Lockdown is already applied in LavaMoat
 executeLockdownMore();
 executeLockdownEvents();
@@ -10,6 +10,6 @@ const parentStream = new BrowserRuntimePostMessageStream({
     name: 'child',
     target: 'parent'
 });
-OffscreenSnapExecutor.initialize(parentStream);
+ProxySnapExecutor.initialize(parentStream);
 
 //# sourceMappingURL=index.js.map

package/dist/esm/offscreen/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/offscreen/index.ts"],"sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport { executeLockdownEvents } from '../common/lockdown/lockdown-events';\nimport { executeLockdownMore } from '../common/lockdown/lockdown-more';\nimport { OffscreenSnapExecutor } from './OffscreenSnapExecutor';\n\n// Lockdown is already applied in LavaMoat\nexecuteLockdownMore();\nexecuteLockdownEvents();\n\n// The stream from the offscreen document to the execution service.\nconst parentStream = new BrowserRuntimePostMessageStream({\n  name: 'child',\n  target: 'parent',\n});\n\nOffscreenSnapExecutor.initialize(parentStream);\n"],"names":["BrowserRuntimePostMessageStream","executeLockdownEvents","executeLockdownMore","OffscreenSnapExecutor","parentStream","name","target","initialize"],"mappings":"AAAA,SAASA,+BAA+B,QAAQ,gCAAgC;AAEhF,SAASC,qBAAqB,QAAQ,qCAAqC;AAC3E,SAASC,mBAAmB,QAAQ,mCAAmC;AACvE,SAASC,qBAAqB,QAAQ,0BAA0B;AAEhE,0CAA0C;AAC1CD;AACAD;AAEA,mEAAmE;AACnE,MAAMG,eAAe,IAAIJ,gCAAgC;IACvDK,MAAM;IACNC,QAAQ;AACV;AAEAH,sBAAsBI,UAAU,CAACH"}
+{"version":3,"sources":["../../../src/offscreen/index.ts"],"sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\n\nimport { executeLockdownEvents } from '../common/lockdown/lockdown-events';\nimport { executeLockdownMore } from '../common/lockdown/lockdown-more';\nimport { ProxySnapExecutor } from '../proxy/ProxySnapExecutor';\n\n// Lockdown is already applied in LavaMoat\nexecuteLockdownMore();\nexecuteLockdownEvents();\n\n// The stream from the offscreen document to the execution service.\nconst parentStream = new BrowserRuntimePostMessageStream({\n  name: 'child',\n  target: 'parent',\n});\n\nProxySnapExecutor.initialize(parentStream);\n"],"names":["BrowserRuntimePostMessageStream","executeLockdownEvents","executeLockdownMore","ProxySnapExecutor","parentStream","name","target","initialize"],"mappings":"AAAA,SAASA,+BAA+B,QAAQ,gCAAgC;AAEhF,SAASC,qBAAqB,QAAQ,qCAAqC;AAC3E,SAASC,mBAAmB,QAAQ,mCAAmC;AACvE,SAASC,iBAAiB,QAAQ,6BAA6B;AAE/D,0CAA0C;AAC1CD;AACAD;AAEA,mEAAmE;AACnE,MAAMG,eAAe,IAAIJ,gCAAgC;IACvDK,MAAM;IACNC,QAAQ;AACV;AAEAH,kBAAkBI,UAAU,CAACH"}

package/dist/esm/{offscreen/OffscreenSnapExecutor.js → proxy/ProxySnapExecutor.js}

@@ -62,9 +62,12 @@ function _define_property(obj, key, value) {
     return obj;
 }
 import { WindowPostMessageStream } from '@metamask/post-message-stream';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import packageJson from '@metamask/snaps-execution-environments/package.json';
 import { createWindow, logError } from '@metamask/snaps-utils';
 import { assert } from '@metamask/utils';
-var _stream = /*#__PURE__*/ new WeakMap(), /**
+const IFRAME_URL = `https://execution.metamask.io/${packageJson.version}/index.html`;
+var _stream = /*#__PURE__*/ new WeakMap(), _frameUrl = /*#__PURE__*/ new WeakMap(), /**
    * Handle an incoming message from the `OffscreenExecutionService`. This
    * assumes that the message contains a `jobId` property, and a JSON-RPC
    * request in the `data` property.
@@ -72,8 +75,6 @@ var _stream = /*#__PURE__*/ new WeakMap(), /**
    * @param data - The message data.
    * @param data.data - The JSON-RPC request.
    * @param data.jobId - The job ID.
-   * @param data.extra - Extra data.
-   * @param data.extra.frameUrl - The URL to load in the iframe.
    */ _onData = /*#__PURE__*/ new WeakSet(), _initializeJob = /*#__PURE__*/ new WeakSet(), /**
    * Terminate the job with the given ID. This will close the iframe and delete
    * the job from the internal job map.
@@ -81,53 +82,57 @@ var _stream = /*#__PURE__*/ new WeakMap(), /**
    * @param jobId - The job ID.
    */ _terminateJob = /*#__PURE__*/ new WeakSet();
 /**
- * A snap executor using the Offscreen Documents API.
+ * A "proxy" snap executor that uses a level of indirection to execute snaps.
+ *
+ * Useful for multiple execution environments.
  *
  * This is not a traditional snap executor, as it does not execute snaps itself.
  * Instead, it creates an iframe window for each snap execution, and sends the
  * snap execution request to the iframe window. The iframe window is responsible
  * for executing the snap.
  *
- * Extensions can only have a single offscreen document, so this executor is
- * persisted between snap executions. The offscreen snap executor essentially
- * acts as a proxy between the extension and the iframe execution environment.
- *
- * @see https://developer.chrome.com/docs/extensions/reference/offscreen/
- */ export class OffscreenSnapExecutor {
+ * This executor is persisted between snap executions. The executor essentially
+ * acts as a proxy between the client and the iframe execution environment.
+ */ export class ProxySnapExecutor {
     /**
    * Initialize the executor with the given stream. This is a wrapper around the
    * constructor.
    *
    * @param stream - The stream to use for communication.
+   * @param frameUrl - An optional URL for the iframe to use.
    * @returns The initialized executor.
-   */ static initialize(stream) {
-        return new OffscreenSnapExecutor(stream);
+   */ static initialize(stream, frameUrl = IFRAME_URL) {
+        return new ProxySnapExecutor(stream, frameUrl);
     }
-    constructor(stream){
+    constructor(stream, frameUrl){
         _class_private_method_init(this, _onData);
         /**
    * Create a new iframe and set up a stream to communicate with it.
    *
    * @param jobId - The job ID.
-   * @param frameUrl - The URL to load in the iframe.
    */ _class_private_method_init(this, _initializeJob);
         _class_private_method_init(this, _terminateJob);
         _class_private_field_init(this, _stream, {
             writable: true,
             value: void 0
         });
+        _class_private_field_init(this, _frameUrl, {
+            writable: true,
+            value: void 0
+        });
         _define_property(this, "jobs", {});
         _class_private_field_set(this, _stream, stream);
         _class_private_field_get(this, _stream).on('data', _class_private_method_get(this, _onData, onData).bind(this));
+        _class_private_field_set(this, _frameUrl, frameUrl);
     }
 }
 function onData(data) {
-    const { jobId, extra: { frameUrl }, data: request } = data;
+    const { jobId, data: request } = data;
     if (!this.jobs[jobId]) {
         // This ensures that a job is initialized before it is used. To avoid
         // code duplication, we call the `#onData` method again, which will
         // run the rest of the logic after initialization.
-        _class_private_method_get(this, _initializeJob, initializeJob).call(this, jobId, frameUrl).then(()=>{
+        _class_private_method_get(this, _initializeJob, initializeJob).call(this, jobId).then(()=>{
             _class_private_method_get(this, _onData, onData).call(this, data);
         }).catch((error)=>{
             logError('[Worker] Error initializing job:', error);
@@ -142,8 +147,8 @@ function onData(data) {
     }
     this.jobs[jobId].stream.write(request);
 }
-async function initializeJob(jobId, frameUrl) {
-    const window = await createWindow(frameUrl, jobId);
+async function initializeJob(jobId) {
+    const window = await createWindow(_class_private_field_get(this, _frameUrl), jobId);
     const jobStream = new WindowPostMessageStream({
         name: 'parent',
         target: 'child',
@@ -173,4 +178,4 @@ function terminateJob(jobId) {
     delete this.jobs[jobId];
 }
 
-//# sourceMappingURL=OffscreenSnapExecutor.js.map
+//# sourceMappingURL=ProxySnapExecutor.js.map

package/dist/esm/proxy/ProxySnapExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/proxy/ProxySnapExecutor.ts"],"sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\n// eslint-disable-next-line import/no-extraneous-dependencies\nimport packageJson from '@metamask/snaps-execution-environments/package.json';\nimport { createWindow, logError } from '@metamask/snaps-utils';\nimport type { JsonRpcRequest } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\n\ntype ExecutorJob = {\n  id: string;\n  window: Window;\n  stream: WindowPostMessageStream;\n};\n\nconst IFRAME_URL = `https://execution.metamask.io/${packageJson.version}/index.html`;\n\n/**\n * A \"proxy\" snap executor that uses a level of indirection to execute snaps.\n *\n * Useful for multiple execution environments.\n *\n * This is not a traditional snap executor, as it does not execute snaps itself.\n * Instead, it creates an iframe window for each snap execution, and sends the\n * snap execution request to the iframe window. The iframe window is responsible\n * for executing the snap.\n *\n * This executor is persisted between snap executions. The executor essentially\n * acts as a proxy between the client and the iframe execution environment.\n */\nexport class ProxySnapExecutor {\n  readonly #stream: BasePostMessageStream;\n\n  readonly #frameUrl: string;\n\n  readonly jobs: Record<string, ExecutorJob> = {};\n\n  /**\n   * Initialize the executor with the given stream. This is a wrapper around the\n   * constructor.\n   *\n   * @param stream - The stream to use for communication.\n   * @param frameUrl - An optional URL for the iframe to use.\n   * @returns The initialized executor.\n   */\n  static initialize(stream: BasePostMessageStream, frameUrl = IFRAME_URL) {\n    return new ProxySnapExecutor(stream, frameUrl);\n  }\n\n  constructor(stream: BasePostMessageStream, frameUrl: string) {\n    this.#stream = stream;\n    this.#stream.on('data', this.#onData.bind(this));\n    this.#frameUrl = frameUrl;\n  }\n\n  /**\n   * Handle an incoming message from the `OffscreenExecutionService`. This\n   * assumes that the message contains a `jobId` property, and a JSON-RPC\n   * request in the `data` property.\n   *\n   * @param data - The message data.\n   * @param data.data - The JSON-RPC request.\n   * @param data.jobId - The job ID.\n   */\n  #onData(data: { data: JsonRpcRequest; jobId: string }) {\n    const { jobId, data: request } = data;\n\n    if (!this.jobs[jobId]) {\n      // This ensures that a job is initialized before it is used. To avoid\n      // code duplication, we call the `#onData` method again, which will\n      // run the rest of the logic after initialization.\n      this.#initializeJob(jobId)\n        .then(() => {\n          this.#onData(data);\n        })\n        .catch((error) => {\n          logError('[Worker] Error initializing job:', error);\n        });\n\n      return;\n    }\n\n    // This is a method specific to the `OffscreenSnapExecutor`, as the service\n    // itself does not have access to the iframes directly.\n    if (request.method === 'terminateJob') {\n      this.#terminateJob(jobId);\n      return;\n    }\n\n    this.jobs[jobId].stream.write(request);\n  }\n\n  /**\n   * Create a new iframe and set up a stream to communicate with it.\n   *\n   * @param jobId - The job ID.\n   */\n  async #initializeJob(jobId: string): Promise<ExecutorJob> {\n    const window = await createWindow(this.#frameUrl, jobId);\n    const jobStream = new WindowPostMessageStream({\n      name: 'parent',\n      target: 'child',\n      targetWindow: window,\n      targetOrigin: '*',\n    });\n\n    // Write messages from the iframe to the parent, wrapped with the job ID.\n    jobStream.on('data', (data) => {\n      this.#stream.write({ data, jobId });\n    });\n\n    this.jobs[jobId] = { id: jobId, window, stream: jobStream };\n    return this.jobs[jobId];\n  }\n\n  /**\n   * Terminate the job with the given ID. This will close the iframe and delete\n   * the job from the internal job map.\n   *\n   * @param jobId - The job ID.\n   */\n  #terminateJob(jobId: string) {\n    assert(this.jobs[jobId], `Job \"${jobId}\" not found.`);\n\n    const iframe = document.getElementById(jobId);\n    assert(iframe, `Iframe with ID \"${jobId}\" not found.`);\n\n    iframe.remove();\n    this.jobs[jobId].stream.destroy();\n    delete this.jobs[jobId];\n  }\n}\n"],"names":["WindowPostMessageStream","packageJson","createWindow","logError","assert","IFRAME_URL","version","ProxySnapExecutor","initialize","stream","frameUrl","constructor","jobs","on","onData","bind","data","jobId","request","initializeJob","then","catch","error","method","terminateJob","write","window","jobStream","name","target","targetWindow","targetOrigin","id","iframe","document","getElementById","remove","destroy"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,uBAAuB,QAAQ,gCAAgC;AACxE,6DAA6D;AAC7D,OAAOC,iBAAiB,sDAAsD;AAC9E,SAASC,YAAY,EAAEC,QAAQ,QAAQ,wBAAwB;AAE/D,SAASC,MAAM,QAAQ,kBAAkB;AAQzC,MAAMC,aAAa,CAAC,8BAA8B,EAAEJ,YAAYK,OAAO,CAAC,WAAW,CAAC;IAgBzE,uCAEA,yCAsBT;;;;;;;;GAQC,GACD,uCAiCM,8CAkBN;;;;;GAKC,GACD;AAxGF;;;;;;;;;;;;CAYC,GACD,OAAO,MAAMC;IAOX;;;;;;;GAOC,GACD,OAAOC,WAAWC,MAA6B,EAAEC,WAAWL,UAAU,EAAE;QACtE,OAAO,IAAIE,kBAAkBE,QAAQC;IACvC;IAEAC,YAAYF,MAA6B,EAAEC,QAAgB,CAAE;QAe7D,iCAAA;QA4BA;;;;GAIC,GACD,iCAAM;QAwBN,iCAAA;QA1FA,gCAAS;;mBAAT,KAAA;;QAEA,gCAAS;;mBAAT,KAAA;;QAEA,uBAASE,QAAoC,CAAC;uCAetCH,SAASA;QACf,yBAAA,IAAI,EAAEA,SAAOI,EAAE,CAAC,QAAQ,0BAAA,IAAI,EAAEC,SAAAA,QAAOC,IAAI,CAAC,IAAI;uCACxCL,WAAWA;IACnB;AA8EF;AAnEE,SAAA,OAAQM,IAA6C;IACnD,MAAM,EAAEC,KAAK,EAAED,MAAME,OAAO,EAAE,GAAGF;IAEjC,IAAI,CAAC,IAAI,CAACJ,IAAI,CAACK,MAAM,EAAE;QACrB,qEAAqE;QACrE,mEAAmE;QACnE,kDAAkD;QAClD,0BAAA,IAAI,EAAEE,gBAAAA,oBAAN,IAAI,EAAgBF,OACjBG,IAAI,CAAC;YACJ,0BAAA,IAAI,EAAEN,SAAAA,aAAN,IAAI,EAASE;QACf,GACCK,KAAK,CAAC,CAACC;YACNnB,SAAS,oCAAoCmB;QAC/C;QAEF;IACF;IAEA,2EAA2E;IAC3E,uDAAuD;IACvD,IAAIJ,QAAQK,MAAM,KAAK,gBAAgB;QACrC,0BAAA,IAAI,EAAEC,eAAAA,mBAAN,IAAI,EAAeP;QACnB;IACF;IAEA,IAAI,CAACL,IAAI,CAACK,MAAM,CAACR,MAAM,CAACgB,KAAK,CAACP;AAChC;AAOA,eAAA,cAAqBD,KAAa;IAChC,MAAMS,SAAS,MAAMxB,sCAAa,IAAI,EAAEQ,YAAUO;IAClD,MAAMU,YAAY,IAAI3B,wBAAwB;QAC5C4B,MAAM;QACNC,QAAQ;QACRC,cAAcJ;QACdK,cAAc;IAChB;IAEA,yEAAyE;IACzEJ,UAAUd,EAAE,CAAC,QAAQ,CAACG;QACpB,yBAAA,IAAI,EAAEP,SAAOgB,KAAK,CAAC;YAAET;YAAMC;QAAM;IACnC;IAEA,IAAI,CAACL,IAAI,CAACK,MAAM,GAAG;QAAEe,IAAIf;QAAOS;QAAQjB,QAAQkB;IAAU;IAC1D,OAAO,IAAI,CAACf,IAAI,CAACK,MAAM;AACzB;AAQA,SAAA,aAAcA,KAAa;IACzBb,OAAO,IAAI,CAACQ,IAAI,CAACK,MAAM,EAAE,CAAC,KAAK,EAAEA,MAAM,YAAY,CAAC;IAEpD,MAAMgB,SAASC,SAASC,cAAc,CAAClB;IACvCb,OAAO6B,QAAQ,CAAC,gBAAgB,EAAEhB,MAAM,YAAY,CAAC;IAErDgB,OAAOG,MAAM;IACb,IAAI,CAACxB,IAAI,CAACK,MAAM,CAACR,MAAM,CAAC4B,OAAO;IAC/B,OAAO,IAAI,CAACzB,IAAI,CAACK,MAAM;AACzB"}

package/dist/types/common/validation.d.ts

@@ -62,6 +62,23 @@ export declare type OnTransactionRequestArguments = Infer<typeof OnTransactionRe
  * object.
  */
 export declare function assertIsOnTransactionRequestArguments(value: unknown): asserts value is OnTransactionRequestArguments;
+export declare const OnSignatureRequestArgumentsStruct: import("superstruct").Struct<{
+    signature: Record<string, Json>;
+    signatureOrigin: string | null;
+}, {
+    signature: import("superstruct").Struct<Record<string, Json>, null>;
+    signatureOrigin: import("superstruct").Struct<string | null, null>;
+}>;
+export declare type OnSignatureRequestArguments = Infer<typeof OnSignatureRequestArgumentsStruct>;
+/**
+ * Asserts that the given value is a valid {@link OnSignatureRequestArguments}
+ * object.
+ *
+ * @param value - The value to validate.
+ * @throws If the value is not a valid {@link OnSignatureRequestArguments}
+ * object.
+ */
+export declare function assertIsOnSignatureRequestArguments(value: unknown): asserts value is OnSignatureRequestArguments;
 declare const baseNameLookupArgs: {
     chainId: import("superstruct").Struct<`${string}:${string}`, null>;
 };