@metamask/snaps-controllers 0.34.0-flask.1 → 0.35.0-flask.1

package/dist/esm/snaps/endowments/index.js

@@ -0,0 +1,37 @@
+import { HandlerType } from '@metamask/snaps-utils';
+import { cronjobCaveatSpecifications, cronjobEndowmentBuilder, getCronjobCaveatMapper } from './cronjob';
+import { ethereumProviderEndowmentBuilder } from './ethereum-provider';
+import { longRunningEndowmentBuilder } from './long-running';
+import { networkAccessEndowmentBuilder } from './network-access';
+import { getRpcCaveatMapper, rpcCaveatSpecifications, rpcEndowmentBuilder } from './rpc';
+import { getTransactionInsightCaveatMapper, transactionInsightCaveatSpecifications, transactionInsightEndowmentBuilder } from './transaction-insight';
+import { webAssemblyEndowmentBuilder } from './web-assembly';
+export const endowmentPermissionBuilders = {
+    [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,
+    [longRunningEndowmentBuilder.targetName]: longRunningEndowmentBuilder,
+    [transactionInsightEndowmentBuilder.targetName]: transactionInsightEndowmentBuilder,
+    [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,
+    [ethereumProviderEndowmentBuilder.targetName]: ethereumProviderEndowmentBuilder,
+    [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,
+    [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder
+};
+export const endowmentCaveatSpecifications = {
+    ...cronjobCaveatSpecifications,
+    ...transactionInsightCaveatSpecifications,
+    ...rpcCaveatSpecifications
+};
+export const endowmentCaveatMappers = {
+    [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,
+    [transactionInsightEndowmentBuilder.targetName]: getTransactionInsightCaveatMapper,
+    [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper
+};
+export const handlerEndowments = {
+    [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,
+    [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,
+    [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName
+};
+export * from './enum';
+export { getRpcCaveatOrigins } from './rpc';
+export { getTransactionOriginCaveat } from './transaction-insight';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/snaps/endowments/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/index.ts"],"sourcesContent":["import { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport { Json } from '@metamask/utils';\n\nimport {\n  cronjobCaveatSpecifications,\n  cronjobEndowmentBuilder,\n  getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport { longRunningEndowmentBuilder } from './long-running';\nimport { networkAccessEndowmentBuilder } from './network-access';\nimport {\n  getRpcCaveatMapper,\n  rpcCaveatSpecifications,\n  rpcEndowmentBuilder,\n} from './rpc';\nimport {\n  getTransactionInsightCaveatMapper,\n  transactionInsightCaveatSpecifications,\n  transactionInsightEndowmentBuilder,\n} from './transaction-insight';\nimport { webAssemblyEndowmentBuilder } from './web-assembly';\n\nexport const endowmentPermissionBuilders = {\n  [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,\n  [longRunningEndowmentBuilder.targetName]: longRunningEndowmentBuilder,\n  [transactionInsightEndowmentBuilder.targetName]:\n    transactionInsightEndowmentBuilder,\n  [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n  [ethereumProviderEndowmentBuilder.targetName]:\n    ethereumProviderEndowmentBuilder,\n  [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n  [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n  ...cronjobCaveatSpecifications,\n  ...transactionInsightCaveatSpecifications,\n  ...rpcCaveatSpecifications,\n};\n\nexport const endowmentCaveatMappers: Record<\n  string,\n  (value: Json) => Pick<PermissionConstraint, 'caveats'>\n> = {\n  [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,\n  [transactionInsightEndowmentBuilder.targetName]:\n    getTransactionInsightCaveatMapper,\n  [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n  [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n  [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n  [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getTransactionOriginCaveat } from './transaction-insight';\n"],"names":["HandlerType","cronjobCaveatSpecifications","cronjobEndowmentBuilder","getCronjobCaveatMapper","ethereumProviderEndowmentBuilder","longRunningEndowmentBuilder","networkAccessEndowmentBuilder","getRpcCaveatMapper","rpcCaveatSpecifications","rpcEndowmentBuilder","getTransactionInsightCaveatMapper","transactionInsightCaveatSpecifications","transactionInsightEndowmentBuilder","webAssemblyEndowmentBuilder","endowmentPermissionBuilders","targetName","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","OnRpcRequest","OnTransaction","OnCronjob","getRpcCaveatOrigins","getTransactionOriginCaveat"],"mappings":"AACA,SAASA,WAAW,QAAQ,wBAAwB;AAGpD,SACEC,2BAA2B,EAC3BC,uBAAuB,EACvBC,sBAAsB,QACjB,YAAY;AACnB,SAASC,gCAAgC,QAAQ,sBAAsB;AACvE,SAASC,2BAA2B,QAAQ,iBAAiB;AAC7D,SAASC,6BAA6B,QAAQ,mBAAmB;AACjE,SACEC,kBAAkB,EAClBC,uBAAuB,EACvBC,mBAAmB,QACd,QAAQ;AACf,SACEC,iCAAiC,EACjCC,sCAAsC,EACtCC,kCAAkC,QAC7B,wBAAwB;AAC/B,SAASC,2BAA2B,QAAQ,iBAAiB;AAE7D,OAAO,MAAMC,8BAA8B;IACzC,CAACR,8BAA8BS,UAAU,CAAC,EAAET;IAC5C,CAACD,4BAA4BU,UAAU,CAAC,EAAEV;IAC1C,CAACO,mCAAmCG,UAAU,CAAC,EAC7CH;IACF,CAACV,wBAAwBa,UAAU,CAAC,EAAEb;IACtC,CAACE,iCAAiCW,UAAU,CAAC,EAC3CX;IACF,CAACK,oBAAoBM,UAAU,CAAC,EAAEN;IAClC,CAACI,4BAA4BE,UAAU,CAAC,EAAEF;AAC5C,EAAW;AAEX,OAAO,MAAMG,gCAAgC;IAC3C,GAAGf,2BAA2B;IAC9B,GAAGU,sCAAsC;IACzC,GAAGH,uBAAuB;AAC5B,EAAE;AAEF,OAAO,MAAMS,yBAGT;IACF,CAACf,wBAAwBa,UAAU,CAAC,EAAEZ;IACtC,CAACS,mCAAmCG,UAAU,CAAC,EAC7CL;IACF,CAACD,oBAAoBM,UAAU,CAAC,EAAER;AACpC,EAAE;AAEF,OAAO,MAAMW,oBAAiD;IAC5D,CAAClB,YAAYmB,YAAY,CAAC,EAAEV,oBAAoBM,UAAU;IAC1D,CAACf,YAAYoB,aAAa,CAAC,EAAER,mCAAmCG,UAAU;IAC1E,CAACf,YAAYqB,SAAS,CAAC,EAAEnB,wBAAwBa,UAAU;AAC7D,EAAE;AAEF,cAAc,SAAS;AACvB,SAASO,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,0BAA0B,QAAQ,wBAAwB"}

package/dist/esm/snaps/endowments/long-running.js

@@ -0,0 +1,28 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { SnapEndowments } from './enum';
+const permissionName = SnapEndowments.LongRunning;
+/**
+ * `endowment:long-running` returns nothing; it is intended to be used as a flag
+ * by the `SnapController` to make it ignore the request processing timeout
+ * during snap lifecycle management. Essentially, it allows a snap to take an
+ * infinite amount of time to process a request.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the long-running endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>undefined,
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const longRunningEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=long-running.js.map

package/dist/esm/snaps/endowments/long-running.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/long-running.ts"],"sourcesContent":["import {\n  PermissionSpecificationBuilder,\n  PermissionType,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  SubjectType,\n} from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.LongRunning;\n\ntype LongRunningEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => undefined;\n  allowedCaveats: null;\n}>;\n\n/**\n * `endowment:long-running` returns nothing; it is intended to be used as a flag\n * by the `SnapController` to make it ignore the request processing timeout\n * during snap lifecycle management. Essentially, it allows a snap to take an\n * infinite amount of time to process a request.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the long-running endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  LongRunningEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const longRunningEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["PermissionType","SubjectType","SnapEndowments","permissionName","LongRunning","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","longRunningEndowmentBuilder","Object","freeze"],"mappings":"AAAA,SAEEA,cAAc,EAGdC,WAAW,QACN,kCAAkC;AAEzC,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,WAAW;AASjD;;;;;;;;CAQC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACb,YAAYc,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,8BAA8BC,OAAOC,MAAM,CAAC;IACvDT,YAAYN;IACZE;AACF,GAAY"}

package/dist/esm/snaps/endowments/network-access.js

@@ -0,0 +1,34 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { SnapEndowments } from './enum';
+const permissionName = SnapEndowments.NetworkAccess;
+/**
+ * `endowment:network-access` returns the name of global browser API(s) that
+ * enable network access. This is intended to populate the endowments of the
+ * SES Compartment in which a Snap executes.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the network endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>{
+            return [
+                'fetch',
+                'Request',
+                'Headers',
+                'Response'
+            ];
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const networkAccessEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=network-access.js.map

package/dist/esm/snaps/endowments/network-access.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/network-access.ts"],"sourcesContent":["import {\n  EndowmentGetterParams,\n  PermissionSpecificationBuilder,\n  PermissionType,\n  ValidPermissionSpecification,\n  SubjectType,\n} from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.NetworkAccess;\n\ntype NetworkAccessEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (\n    _options?: any,\n  ) => ['fetch', 'Request', 'Headers', 'Response'];\n  allowedCaveats: null;\n}>;\n\n/**\n * `endowment:network-access` returns the name of global browser API(s) that\n * enable network access. This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the network endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  NetworkAccessEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n      return ['fetch', 'Request', 'Headers', 'Response'];\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const networkAccessEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["PermissionType","SubjectType","SnapEndowments","permissionName","NetworkAccess","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","Snap","networkAccessEndowmentBuilder","Object","freeze"],"mappings":"AAAA,SAGEA,cAAc,EAEdC,WAAW,QACN,kCAAkC;AAEzC,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,aAAa;AAWnD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;gBAAS;gBAAW;gBAAW;aAAW;QACpD;QACAC,cAAc;YAACZ,YAAYa,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,gCAAgCC,OAAOC,MAAM,CAAC;IACzDR,YAAYN;IACZE;AACF,GAAY"}

package/dist/esm/snaps/endowments/rpc.js

@@ -0,0 +1,88 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { assertIsRpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';
+import { hasProperty, isPlainObject, assert } from '@metamask/utils';
+import { ethErrors } from 'eth-rpc-errors';
+import { SnapEndowments } from './enum';
+const targetName = SnapEndowments.Rpc;
+/**
+ * The specification builder for the JSON-RPC endowment permission.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the JSON-RPC endowment permission.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName,
+        allowedCaveats: [
+            SnapCaveatType.RpcOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.RpcOrigin) {
+                throw ethErrors.rpc.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.RpcOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const rpcEndowmentBuilder = Object.freeze({
+    targetName,
+    specificationBuilder
+});
+/**
+ * Validate the value of a caveat. This does not validate the type of the
+ * caveat itself, only the value of the caveat.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */ function validateCaveatOrigins(caveat) {
+    if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
+        throw ethErrors.rpc.invalidParams({
+            message: 'Invalid JSON-RPC origins: Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    assertIsRpcOrigins(value, ethErrors.rpc.invalidParams);
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */ export function getRpcCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.RpcOrigin,
+                value
+            }
+        ]
+    };
+}
+/**
+ * Getter function to get the {@link RpcOrigins} caveat value from a permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link RpcOrigins} caveat.
+ */ export function getRpcCaveatOrigins(permission) {
+    assert(permission?.caveats);
+    assert(permission.caveats.length === 1);
+    assert(permission.caveats[0].type === SnapCaveatType.RpcOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value;
+}
+export const rpcCaveatSpecifications = {
+    [SnapCaveatType.RpcOrigin]: Object.freeze({
+        type: SnapCaveatType.RpcOrigin,
+        validator: (caveat)=>validateCaveatOrigins(caveat)
+    })
+};
+
+//# sourceMappingURL=rpc.js.map

package/dist/esm/snaps/endowments/rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/rpc.ts"],"sourcesContent":["import {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionType,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport {\n  assertIsRpcOrigins,\n  RpcOrigins,\n  SnapCaveatType,\n} from '@metamask/snaps-utils';\nimport {\n  hasProperty,\n  isPlainObject,\n  Json,\n  NonEmptyArray,\n  assert,\n} from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst targetName = SnapEndowments.Rpc;\n\ntype RpcSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof targetName;\n  endowmentGetter: (_options?: any) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n  subjectTypes: readonly SubjectType[];\n}>;\n\ntype RpcSpecificationBuilderOptions = {\n  // Empty for now.\n};\n\n/**\n * The specification builder for the JSON-RPC endowment permission.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the JSON-RPC endowment permission.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  RpcSpecificationBuilderOptions,\n  RpcSpecification\n> = (_builderOptions?: any): RpcSpecification => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName,\n    allowedCaveats: [SnapCaveatType.RpcOrigin],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: ({ caveats }) => {\n      if (\n        caveats?.length !== 1 ||\n        caveats[0].type !== SnapCaveatType.RpcOrigin\n      ) {\n        throw ethErrors.rpc.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.RpcOrigin}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const rpcEndowmentBuilder = Object.freeze({\n  targetName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw ethErrors.rpc.invalidParams({\n      message: 'Invalid JSON-RPC origins: Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsRpcOrigins(value, ethErrors.rpc.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getRpcCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.RpcOrigin,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the {@link RpcOrigins} caveat value from a permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link RpcOrigins} caveat.\n */\nexport function getRpcCaveatOrigins(\n  permission?: PermissionConstraint,\n): RpcOrigins | null {\n  assert(permission?.caveats);\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.RpcOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, RpcOrigins>;\n  return caveat.value;\n}\n\nexport const rpcCaveatSpecifications: Record<\n  SnapCaveatType.RpcOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.RpcOrigin]: Object.freeze({\n    type: SnapCaveatType.RpcOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","assertIsRpcOrigins","SnapCaveatType","hasProperty","isPlainObject","assert","ethErrors","SnapEndowments","targetName","Rpc","specificationBuilder","_builderOptions","permissionType","Endowment","allowedCaveats","RpcOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpc","invalidParams","message","subjectTypes","Snap","rpcEndowmentBuilder","Object","freeze","validateCaveatOrigins","caveat","value","getRpcCaveatMapper","getRpcCaveatOrigins","permission","rpcCaveatSpecifications"],"mappings":"AAAA,SAMEA,cAAc,EAGdC,WAAW,QACN,kCAAkC;AACzC,SACEC,kBAAkB,EAElBC,cAAc,QACT,wBAAwB;AAC/B,SACEC,WAAW,EACXC,aAAa,EAGbC,MAAM,QACD,kBAAkB;AACzB,SAASC,SAAS,QAAQ,iBAAiB;AAE3C,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,aAAaD,eAAeE,GAAG;AAerC;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCL;QACAM,gBAAgB;YAACZ,eAAea,SAAS;SAAC;QAC1CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKpB,eAAea,SAAS,EAC5C;gBACA,MAAMT,UAAUiB,GAAG,CAACC,aAAa,CAAC;oBAChCC,SAAS,CAAC,mBAAmB,EAAEvB,eAAea,SAAS,CAAC,SAAS,CAAC;gBACpE;YACF;QACF;QACAW,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,sBAAsBC,OAAOC,MAAM,CAAC;IAC/CtB;IACAE;AACF,GAAY;AAEZ;;;;;;CAMC,GACD,SAASqB,sBAAsBC,MAA2B;IACxD,IAAI,CAAC7B,YAAY6B,QAAQ,YAAY,CAAC5B,cAAc4B,OAAOC,KAAK,GAAG;QACjE,MAAM3B,UAAUiB,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAClB/B,mBAAmBgC,OAAO3B,UAAUiB,GAAG,CAACC,aAAa;AACvD;AAEA;;;;;;;CAOC,GACD,OAAO,SAASU,mBACdD,KAAW;IAEX,OAAO;QACLb,SAAS;YACP;gBACEE,MAAMpB,eAAea,SAAS;gBAC9BkB;YACF;SACD;IACH;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,oBACdC,UAAiC;IAEjC/B,OAAO+B,YAAYhB;IACnBf,OAAO+B,WAAWhB,OAAO,CAACC,MAAM,KAAK;IACrChB,OAAO+B,WAAWhB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKpB,eAAea,SAAS;IAE9D,MAAMiB,SAASI,WAAWhB,OAAO,CAAC,EAAE;IACpC,OAAOY,OAAOC,KAAK;AACrB;AAEA,OAAO,MAAMI,0BAGT;IACF,CAACnC,eAAea,SAAS,CAAC,EAAEc,OAAOC,MAAM,CAAC;QACxCR,MAAMpB,eAAea,SAAS;QAC9BI,WAAW,CAACa,SAAgCD,sBAAsBC;IACpE;AACF,EAAE"}

package/dist/esm/snaps/endowments/transaction-insight.js

@@ -0,0 +1,99 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { SnapCaveatType } from '@metamask/snaps-utils';
+import { assert, hasProperty, isObject, isPlainObject } from '@metamask/utils';
+import { ethErrors } from 'eth-rpc-errors';
+import { SnapEndowments } from './enum';
+const permissionName = SnapEndowments.TransactionInsight;
+/**
+ * `endowment:transaction-insight` returns nothing; it is intended to be used as a flag
+ * by the extension to detect whether the snap has the capability to show information on the transaction confirmation screen.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the transaction-insight endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            SnapCaveatType.TransactionOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.TransactionOrigin) {
+                throw ethErrors.rpc.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.TransactionOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const transactionInsightEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+/**
+ * Validates the type of the caveat value.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */ function validateCaveat(caveat) {
+    if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
+        throw ethErrors.rpc.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    assert(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */ export function getTransactionInsightCaveatMapper(value) {
+    if (!value || !isObject(value) || isObject(value) && Object.keys(value).length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.TransactionOrigin,
+                value: hasProperty(value, 'allowTransactionOrigin') && value.allowTransactionOrigin
+            }
+        ]
+    };
+}
+/**
+ * Getter function to get the transaction origin caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the transaction origin caveat from.
+ * @returns The transaction origin, or `null` if the permission does not have a
+ * transaction origin caveat.
+ */ export function getTransactionOriginCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    assert(permission.caveats.length === 1);
+    assert(permission.caveats[0].type === SnapCaveatType.TransactionOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+export const transactionInsightCaveatSpecifications = {
+    [SnapCaveatType.TransactionOrigin]: Object.freeze({
+        type: SnapCaveatType.TransactionOrigin,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=transaction-insight.js.map

package/dist/esm/snaps/endowments/transaction-insight.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/transaction-insight.ts"],"sourcesContent":["import {\n  PermissionSpecificationBuilder,\n  PermissionType,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionConstraint,\n  CaveatSpecificationConstraint,\n  Caveat,\n  SubjectType,\n} from '@metamask/permission-controller';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport {\n  assert,\n  hasProperty,\n  isObject,\n  isPlainObject,\n  Json,\n  NonEmptyArray,\n} from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.TransactionInsight;\n\ntype TransactionInsightEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n}>;\n\n/**\n * `endowment:transaction-insight` returns nothing; it is intended to be used as a flag\n * by the extension to detect whether the snap has the capability to show information on the transaction confirmation screen.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the transaction-insight endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  TransactionInsightEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.TransactionOrigin],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: ({ caveats }) => {\n      if (\n        (caveats !== null && caveats?.length > 1) ||\n        (caveats?.length === 1 &&\n          caveats[0].type !== SnapCaveatType.TransactionOrigin)\n      ) {\n        throw ethErrors.rpc.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.TransactionOrigin}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const transactionInsightEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validates the type of the caveat value.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveat(caveat: Caveat<string, any>): void {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {\n    throw ethErrors.rpc.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  assert(\n    typeof value === 'boolean',\n    'Expected caveat value to have type \"boolean\"',\n  );\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getTransactionInsightCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  if (\n    !value ||\n    !isObject(value) ||\n    (isObject(value) && Object.keys(value).length === 0)\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.TransactionOrigin,\n        value:\n          hasProperty(value, 'allowTransactionOrigin') &&\n          (value.allowTransactionOrigin as boolean),\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the transaction origin caveat from a permission.\n *\n * This does basic validation of the caveat, but does not validate the type or\n * value of the namespaces object itself, as this is handled by the\n * `PermissionsController` when the permission is requested.\n *\n * @param permission - The permission to get the transaction origin caveat from.\n * @returns The transaction origin, or `null` if the permission does not have a\n * transaction origin caveat.\n */\nexport function getTransactionOriginCaveat(\n  permission?: PermissionConstraint,\n): boolean | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.TransactionOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, boolean>;\n\n  return caveat.value ?? null;\n}\n\nexport const transactionInsightCaveatSpecifications: Record<\n  SnapCaveatType.TransactionOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.TransactionOrigin]: Object.freeze({\n    type: SnapCaveatType.TransactionOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","SnapCaveatType","assert","hasProperty","isObject","isPlainObject","ethErrors","SnapEndowments","permissionName","TransactionInsight","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","TransactionOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpc","invalidParams","message","subjectTypes","Snap","transactionInsightEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","getTransactionInsightCaveatMapper","keys","allowTransactionOrigin","getTransactionOriginCaveat","permission","transactionInsightCaveatSpecifications"],"mappings":"AAAA,SAEEA,cAAc,EAOdC,WAAW,QACN,kCAAkC;AACzC,SAASC,cAAc,QAAQ,wBAAwB;AACvD,SACEC,MAAM,EACNC,WAAW,EACXC,QAAQ,EACRC,aAAa,QAGR,kBAAkB;AACzB,SAASC,SAAS,QAAQ,iBAAiB;AAE3C,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,kBAAkB;AAUxD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACd,eAAee,iBAAiB;SAAC;QAClDC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACE,AAACA,YAAY,QAAQA,SAASC,SAAS,KACtCD,SAASC,WAAW,KACnBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKtB,eAAee,iBAAiB,EACtD;gBACA,MAAMV,UAAUkB,GAAG,CAACC,aAAa,CAAC;oBAChCC,SAAS,CAAC,mBAAmB,EAAEzB,eAAee,iBAAiB,CAAC,SAAS,CAAC;gBAC5E;YACF;QACF;QACAW,cAAc;YAAC3B,YAAY4B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,qCAAqCC,OAAOC,MAAM,CAAC;IAC9DjB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASsB,eAAeC,MAA2B;IACjD,IAAI,CAAC9B,YAAY8B,QAAQ,YAAY,CAAC5B,cAAc4B,SAAS;QAC3D,MAAM3B,UAAUkB,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB/B,OACE,OAAOgC,UAAU,WACjB;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,kCACdD,KAAW;IAEX,IACE,CAACA,SACD,CAAC9B,SAAS8B,UACT9B,SAAS8B,UAAUJ,OAAOM,IAAI,CAACF,OAAOZ,MAAM,KAAK,GAClD;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMtB,eAAee,iBAAiB;gBACtCkB,OACE/B,YAAY+B,OAAO,6BAClBA,MAAMG,sBAAsB;YACjC;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,2BACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYlB,SAAS;QACxB,OAAO;IACT;IAEAnB,OAAOqC,WAAWlB,OAAO,CAACC,MAAM,KAAK;IACrCpB,OAAOqC,WAAWlB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKtB,eAAee,iBAAiB;IAEtE,MAAMiB,SAASM,WAAWlB,OAAO,CAAC,EAAE;IAEpC,OAAOY,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMM,yCAGT;IACF,CAACvC,eAAee,iBAAiB,CAAC,EAAEc,OAAOC,MAAM,CAAC;QAChDR,MAAMtB,eAAee,iBAAiB;QACtCI,WAAW,CAACa,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}

package/dist/esm/snaps/endowments/web-assembly.js

@@ -0,0 +1,32 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { SnapEndowments } from './enum';
+const permissionName = SnapEndowments.WebAssemblyAccess;
+/**
+ * `endowment:webassembly` returns the name of global browser API(s) that
+ * enable access to the WebAssembly API.
+ * This is intended to populate the endowments of the SES Compartment
+ * in which a Snap executes.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the WebAssembly endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>{
+            return [
+                'WebAssembly'
+            ];
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const webAssemblyEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=web-assembly.js.map

package/dist/esm/snaps/endowments/web-assembly.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/web-assembly.ts"],"sourcesContent":["import {\n  EndowmentGetterParams,\n  PermissionSpecificationBuilder,\n  PermissionType,\n  ValidPermissionSpecification,\n  SubjectType,\n} from '@metamask/permission-controller';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.WebAssemblyAccess;\n\ntype WebAssemblyEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => ['WebAssembly'];\n  allowedCaveats: null;\n}>;\n\n/**\n * `endowment:webassembly` returns the name of global browser API(s) that\n * enable access to the WebAssembly API.\n * This is intended to populate the endowments of the SES Compartment\n * in which a Snap executes.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the WebAssembly endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  WebAssemblyEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n      return ['WebAssembly'];\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const webAssemblyEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["PermissionType","SubjectType","SnapEndowments","permissionName","WebAssemblyAccess","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","Snap","webAssemblyEndowmentBuilder","Object","freeze"],"mappings":"AAAA,SAGEA,cAAc,EAEdC,WAAW,QACN,kCAAkC;AAEzC,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,iBAAiB;AASvD;;;;;;;;CAQC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAc;QACxB;QACAC,cAAc;YAACZ,YAAYa,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,8BAA8BC,OAAOC,MAAM,CAAC;IACvDR,YAAYN;IACZE;AACF,GAAY"}

package/dist/esm/snaps/index.js

@@ -0,0 +1,8 @@
+export * from './location';
+export * from './SnapController';
+export * from './endowments';
+export * from './selectors';
+export * from './registry';
+export * from './permissions';
+
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/snaps/index.ts"],"sourcesContent":["export * from './location';\nexport * from './SnapController';\nexport * from './endowments';\nexport * from './selectors';\nexport * from './registry';\nexport * from './permissions';\n"],"names":[],"mappings":"AAAA,cAAc,aAAa;AAC3B,cAAc,mBAAmB;AACjC,cAAc,eAAe;AAC7B,cAAc,cAAc;AAC5B,cAAc,aAAa;AAC3B,cAAc,gBAAgB"}

package/dist/{snaps → esm/snaps}/location/http.js

@@ -1,45 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpLocation = void 0;
-const snaps_utils_1 = require("@metamask/snaps-utils");
-const utils_1 = require("@metamask/utils");
-class HttpLocation {
-    constructor(url, opts = {}) {
-        // We keep contents separate because then we can use only one Blob in cache,
-        // which we convert to Uint8Array when actually returning the file.
-        //
-        // That avoids deepCloning file contents.
-        // I imagine ArrayBuffers are copy-on-write optimized, meaning
-        // in most often case we'll only have one file contents in common case.
-        this.cache = new Map();
-        (0, utils_1.assertStruct)(url.toString(), snaps_utils_1.HttpSnapIdStruct, 'Invalid Snap Id: ');
-        this.fetchFn = opts.fetch ?? globalThis.fetch.bind(globalThis);
-        this.fetchOptions = opts.fetchOptions;
-        this.url = url;
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
     }
+    return obj;
+}
+import { VirtualFile, HttpSnapIdStruct, NpmSnapFileNames, createSnapManifest, normalizeRelative, parseJson } from '@metamask/snaps-utils';
+import { assert, assertStruct } from '@metamask/utils';
+export class HttpLocation {
     async manifest() {
         if (this.validatedManifest) {
             return this.validatedManifest.clone();
         }
         // jest-fetch-mock doesn't handle new URL(), we need to convert .toString()
-        const canonicalPath = new URL(snaps_utils_1.NpmSnapFileNames.Manifest, this.url).toString();
+        const canonicalPath = new URL(NpmSnapFileNames.Manifest, this.url).toString();
         const response = await this.fetchFn(canonicalPath, this.fetchOptions);
         if (!response.ok) {
             throw new Error(`Failed to fetch "${canonicalPath}". Status code: ${response.status}.`);
         }
         const contents = await response.text();
-        const manifest = JSON.parse(contents);
-        const vfile = new snaps_utils_1.VirtualFile({
+        const manifest = parseJson(contents);
+        const vfile = new VirtualFile({
             value: contents,
-            result: (0, snaps_utils_1.createSnapManifest)(manifest),
-            path: snaps_utils_1.NpmSnapFileNames.Manifest,
-            data: { canonicalPath },
+            result: createSnapManifest(manifest),
+            path: NpmSnapFileNames.Manifest,
+            data: {
+                canonicalPath
+            }
         });
         this.validatedManifest = vfile;
         return this.manifest();
     }
     async fetch(path) {
-        const relativePath = (0, snaps_utils_1.normalizeRelative)(path);
+        const relativePath = normalizeRelative(path);
         const cached = this.cache.get(relativePath);
         if (cached !== undefined) {
             const { file, contents } = cached;
@@ -53,23 +52,45 @@ class HttpLocation {
         if (!response.ok) {
             throw new Error(`Failed to fetch "${canonicalPath}". Status code: ${response.status}.`);
         }
-        const vfile = new snaps_utils_1.VirtualFile({
+        const vfile = new VirtualFile({
             value: '',
             path: relativePath,
-            data: { canonicalPath },
+            data: {
+                canonicalPath
+            }
         });
         const blob = await response.blob();
-        (0, utils_1.assert)(!this.cache.has(relativePath), 'Corrupted cache, multiple files with same path.');
-        this.cache.set(relativePath, { file: vfile, contents: blob });
+        assert(!this.cache.has(relativePath), 'Corrupted cache, multiple files with same path.');
+        this.cache.set(relativePath, {
+            file: vfile,
+            contents: blob
+        });
         return this.fetch(relativePath);
     }
     get root() {
         return new URL(this.url);
     }
     toCanonical(path) {
-        (0, utils_1.assert)(!path.startsWith('/'), 'Tried to parse absolute path.');
+        assert(!path.startsWith('/'), 'Tried to parse absolute path.');
         return new URL(path, this.url);
     }
+    constructor(url, opts = {}){
+        // We keep contents separate because then we can use only one Blob in cache,
+        // which we convert to Uint8Array when actually returning the file.
+        //
+        // That avoids deepCloning file contents.
+        // I imagine ArrayBuffers are copy-on-write optimized, meaning
+        // in most often case we'll only have one file contents in common case.
+        _define_property(this, "cache", new Map());
+        _define_property(this, "validatedManifest", void 0);
+        _define_property(this, "url", void 0);
+        _define_property(this, "fetchFn", void 0);
+        _define_property(this, "fetchOptions", void 0);
+        assertStruct(url.toString(), HttpSnapIdStruct, 'Invalid Snap Id: ');
+        this.fetchFn = opts.fetch ?? globalThis.fetch.bind(globalThis);
+        this.fetchOptions = opts.fetchOptions;
+        this.url = url;
+    }
 }
-exports.HttpLocation = HttpLocation;
+
 //# sourceMappingURL=http.js.map

package/dist/esm/snaps/location/http.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/location/http.ts"],"sourcesContent":["import {\n  SnapManifest,\n  VirtualFile,\n  HttpSnapIdStruct,\n  NpmSnapFileNames,\n  createSnapManifest,\n  normalizeRelative,\n  parseJson,\n} from '@metamask/snaps-utils';\nimport { assert, assertStruct } from '@metamask/utils';\n\nimport { SnapLocation } from './location';\n\nexport interface HttpOptions {\n  /**\n   * @default fetch\n   */\n  fetch?: typeof fetch;\n  fetchOptions?: RequestInit;\n}\n\nexport class HttpLocation implements SnapLocation {\n  // We keep contents separate because then we can use only one Blob in cache,\n  // which we convert to Uint8Array when actually returning the file.\n  //\n  // That avoids deepCloning file contents.\n  // I imagine ArrayBuffers are copy-on-write optimized, meaning\n  // in most often case we'll only have one file contents in common case.\n  private readonly cache = new Map<\n    string,\n    { file: VirtualFile; contents: Blob }\n  >();\n\n  private validatedManifest?: VirtualFile<SnapManifest>;\n\n  private readonly url: URL;\n\n  private readonly fetchFn: typeof fetch;\n\n  private readonly fetchOptions?: RequestInit;\n\n  constructor(url: URL, opts: HttpOptions = {}) {\n    assertStruct(url.toString(), HttpSnapIdStruct, 'Invalid Snap Id: ');\n    this.fetchFn = opts.fetch ?? globalThis.fetch.bind(globalThis);\n    this.fetchOptions = opts.fetchOptions;\n    this.url = url;\n  }\n\n  async manifest(): Promise<VirtualFile<SnapManifest>> {\n    if (this.validatedManifest) {\n      return this.validatedManifest.clone();\n    }\n\n    // jest-fetch-mock doesn't handle new URL(), we need to convert .toString()\n    const canonicalPath = new URL(\n      NpmSnapFileNames.Manifest,\n      this.url,\n    ).toString();\n\n    const response = await this.fetchFn(canonicalPath, this.fetchOptions);\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch \"${canonicalPath}\". Status code: ${response.status}.`,\n      );\n    }\n    const contents = await response.text();\n    const manifest = parseJson(contents);\n    const vfile = new VirtualFile<SnapManifest>({\n      value: contents,\n      result: createSnapManifest(manifest),\n      path: NpmSnapFileNames.Manifest,\n      data: { canonicalPath },\n    });\n    this.validatedManifest = vfile;\n\n    return this.manifest();\n  }\n\n  async fetch(path: string): Promise<VirtualFile> {\n    const relativePath = normalizeRelative(path);\n    const cached = this.cache.get(relativePath);\n    if (cached !== undefined) {\n      const { file, contents } = cached;\n      const value = new Uint8Array(await contents.arrayBuffer());\n      const vfile = file.clone();\n      vfile.value = value;\n      return vfile;\n    }\n\n    const canonicalPath = this.toCanonical(relativePath).toString();\n    const response = await this.fetchFn(canonicalPath, this.fetchOptions);\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch \"${canonicalPath}\". Status code: ${response.status}.`,\n      );\n    }\n    const vfile = new VirtualFile({\n      value: '',\n      path: relativePath,\n      data: { canonicalPath },\n    });\n    const blob = await response.blob();\n    assert(\n      !this.cache.has(relativePath),\n      'Corrupted cache, multiple files with same path.',\n    );\n    this.cache.set(relativePath, { file: vfile, contents: blob });\n\n    return this.fetch(relativePath);\n  }\n\n  get root(): URL {\n    return new URL(this.url);\n  }\n\n  private toCanonical(path: string): URL {\n    assert(!path.startsWith('/'), 'Tried to parse absolute path.');\n    return new URL(path, this.url);\n  }\n}\n"],"names":["VirtualFile","HttpSnapIdStruct","NpmSnapFileNames","createSnapManifest","normalizeRelative","parseJson","assert","assertStruct","HttpLocation","manifest","validatedManifest","clone","canonicalPath","URL","Manifest","url","toString","response","fetchFn","fetchOptions","ok","Error","status","contents","text","vfile","value","result","path","data","fetch","relativePath","cached","cache","get","undefined","file","Uint8Array","arrayBuffer","toCanonical","blob","has","set","root","startsWith","constructor","opts","Map","globalThis","bind"],"mappings":";;;;;;;;;;;;;AAAA,SAEEA,WAAW,EACXC,gBAAgB,EAChBC,gBAAgB,EAChBC,kBAAkB,EAClBC,iBAAiB,EACjBC,SAAS,QACJ,wBAAwB;AAC/B,SAASC,MAAM,EAAEC,YAAY,QAAQ,kBAAkB;AAYvD,OAAO,MAAMC;IA2BX,MAAMC,WAA+C;QACnD,IAAI,IAAI,CAACC,iBAAiB,EAAE;YAC1B,OAAO,IAAI,CAACA,iBAAiB,CAACC,KAAK;QACrC;QAEA,2EAA2E;QAC3E,MAAMC,gBAAgB,IAAIC,IACxBX,iBAAiBY,QAAQ,EACzB,IAAI,CAACC,GAAG,EACRC,QAAQ;QAEV,MAAMC,WAAW,MAAM,IAAI,CAACC,OAAO,CAACN,eAAe,IAAI,CAACO,YAAY;QACpE,IAAI,CAACF,SAASG,EAAE,EAAE;YAChB,MAAM,IAAIC,MACR,CAAC,iBAAiB,EAAET,cAAc,gBAAgB,EAAEK,SAASK,MAAM,CAAC,CAAC,CAAC;QAE1E;QACA,MAAMC,WAAW,MAAMN,SAASO,IAAI;QACpC,MAAMf,WAAWJ,UAAUkB;QAC3B,MAAME,QAAQ,IAAIzB,YAA0B;YAC1C0B,OAAOH;YACPI,QAAQxB,mBAAmBM;YAC3BmB,MAAM1B,iBAAiBY,QAAQ;YAC/Be,MAAM;gBAAEjB;YAAc;QACxB;QACA,IAAI,CAACF,iBAAiB,GAAGe;QAEzB,OAAO,IAAI,CAAChB,QAAQ;IACtB;IAEA,MAAMqB,MAAMF,IAAY,EAAwB;QAC9C,MAAMG,eAAe3B,kBAAkBwB;QACvC,MAAMI,SAAS,IAAI,CAACC,KAAK,CAACC,GAAG,CAACH;QAC9B,IAAIC,WAAWG,WAAW;YACxB,MAAM,EAAEC,IAAI,EAAEb,QAAQ,EAAE,GAAGS;YAC3B,MAAMN,QAAQ,IAAIW,WAAW,MAAMd,SAASe,WAAW;YACvD,MAAMb,QAAQW,KAAKzB,KAAK;YACxBc,MAAMC,KAAK,GAAGA;YACd,OAAOD;QACT;QAEA,MAAMb,gBAAgB,IAAI,CAAC2B,WAAW,CAACR,cAAcf,QAAQ;QAC7D,MAAMC,WAAW,MAAM,IAAI,CAACC,OAAO,CAACN,eAAe,IAAI,CAACO,YAAY;QACpE,IAAI,CAACF,SAASG,EAAE,EAAE;YAChB,MAAM,IAAIC,MACR,CAAC,iBAAiB,EAAET,cAAc,gBAAgB,EAAEK,SAASK,MAAM,CAAC,CAAC,CAAC;QAE1E;QACA,MAAMG,QAAQ,IAAIzB,YAAY;YAC5B0B,OAAO;YACPE,MAAMG;YACNF,MAAM;gBAAEjB;YAAc;QACxB;QACA,MAAM4B,OAAO,MAAMvB,SAASuB,IAAI;QAChClC,OACE,CAAC,IAAI,CAAC2B,KAAK,CAACQ,GAAG,CAACV,eAChB;QAEF,IAAI,CAACE,KAAK,CAACS,GAAG,CAACX,cAAc;YAAEK,MAAMX;YAAOF,UAAUiB;QAAK;QAE3D,OAAO,IAAI,CAACV,KAAK,CAACC;IACpB;IAEA,IAAIY,OAAY;QACd,OAAO,IAAI9B,IAAI,IAAI,CAACE,GAAG;IACzB;IAEQwB,YAAYX,IAAY,EAAO;QACrCtB,OAAO,CAACsB,KAAKgB,UAAU,CAAC,MAAM;QAC9B,OAAO,IAAI/B,IAAIe,MAAM,IAAI,CAACb,GAAG;IAC/B;IA7EA8B,YAAY9B,GAAQ,EAAE+B,OAAoB,CAAC,CAAC,CAAE;QAnB9C,4EAA4E;QAC5E,mEAAmE;QACnE,EAAE;QACF,yCAAyC;QACzC,8DAA8D;QAC9D,uEAAuE;QACvE,uBAAiBb,SAAQ,IAAIc;QAK7B,uBAAQrC,qBAAR,KAAA;QAEA,uBAAiBK,OAAjB,KAAA;QAEA,uBAAiBG,WAAjB,KAAA;QAEA,uBAAiBC,gBAAjB,KAAA;QAGEZ,aAAaQ,IAAIC,QAAQ,IAAIf,kBAAkB;QAC/C,IAAI,CAACiB,OAAO,GAAG4B,KAAKhB,KAAK,IAAIkB,WAAWlB,KAAK,CAACmB,IAAI,CAACD;QACnD,IAAI,CAAC7B,YAAY,GAAG2B,KAAK3B,YAAY;QACrC,IAAI,CAACJ,GAAG,GAAGA;IACb;AAyEF"}

package/dist/esm/snaps/location/index.js

@@ -0,0 +1,6 @@
+export * from './location';
+export * from './npm';
+export * from './local';
+export * from './http';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/snaps/location/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/location/index.ts"],"sourcesContent":["export * from './location';\nexport * from './npm';\nexport * from './local';\nexport * from './http';\n"],"names":[],"mappings":"AAAA,cAAc,aAAa;AAC3B,cAAc,QAAQ;AACtB,cAAc,UAAU;AACxB,cAAc,SAAS"}

package/dist/esm/snaps/location/local.js

@@ -0,0 +1,83 @@
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+import { LocalSnapIdStruct, SnapIdPrefixes } from '@metamask/snaps-utils';
+import { assert, assertStruct } from '@metamask/utils';
+import { HttpLocation } from './http';
+var _http = /*#__PURE__*/ new WeakMap();
+export class LocalLocation {
+    async manifest() {
+        const vfile = await _class_private_field_get(this, _http).manifest();
+        return convertCanonical(vfile);
+    }
+    async fetch(path) {
+        return convertCanonical(await _class_private_field_get(this, _http).fetch(path));
+    }
+    get shouldAlwaysReload() {
+        return true;
+    }
+    constructor(url, opts = {}){
+        _class_private_field_init(this, _http, {
+            writable: true,
+            value: void 0
+        });
+        assertStruct(url.toString(), LocalSnapIdStruct, 'Invalid Snap Id');
+        // TODO(ritave): Write deepMerge() which merges fetchOptions.
+        assert(opts.fetchOptions === undefined, 'Currently adding fetch options to local: is unsupported.');
+        _class_private_field_set(this, _http, new HttpLocation(new URL(url.toString().slice(SnapIdPrefixes.local.length)), {
+            ...opts,
+            fetchOptions: {
+                cache: 'no-cache'
+            }
+        }));
+    }
+}
+/**
+ * Converts vfiles with canonical `http:` paths into `local:` paths.
+ *
+ * @param vfile - The {@link VirtualFile} to convert.
+ * @returns The same object with updated `.data.canonicalPath`.
+ */ function convertCanonical(vfile) {
+    assert(vfile.data.canonicalPath !== undefined);
+    vfile.data.canonicalPath = `local:${vfile.data.canonicalPath}`;
+    return vfile;
+}
+
+//# sourceMappingURL=local.js.map