@metamask/snaps-controllers 2.0.2 → 3.1.0

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

@@ -1,7 +1,7 @@
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { rpcErrors } from '@metamask/rpc-errors';
 import { SnapCaveatType, isCronjobSpecificationArray } from '@metamask/snaps-utils';
 import { assert, hasProperty, isPlainObject } from '@metamask/utils';
-import { ethErrors } from 'eth-rpc-errors';
 import { SnapEndowments } from './enum';
 const permissionName = SnapEndowments.Cronjob;
 /**
@@ -71,18 +71,18 @@ export const cronjobEndowmentBuilder = Object.freeze({
  * @throws If the value is invalid.
  */ export function validateCronjobCaveat(caveat) {
     if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
-        throw ethErrors.rpc.invalidParams({
+        throw rpcErrors.invalidParams({
             message: 'Expected a plain object.'
         });
     }
     const { value } = caveat;
     if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {
-        throw ethErrors.rpc.invalidParams({
+        throw rpcErrors.invalidParams({
             message: 'Expected a plain object.'
         });
     }
     if (!isCronjobSpecificationArray(value.jobs)) {
-        throw ethErrors.rpc.invalidParams({
+        throw rpcErrors.invalidParams({
             message: 'Expected a valid cronjob specification array.'
         });
     }

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/cronjob.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionConstraint,\n  Caveat,\n  CaveatSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport type { CronjobSpecification } from '@metamask/snaps-utils';\nimport {\n  SnapCaveatType,\n  isCronjobSpecificationArray,\n} from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Cronjob;\n\ntype CronjobEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the cronjob endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  CronjobEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.SnapCronjob],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const cronjobEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\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 getCronjobCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.SnapCronjob,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the cronjobs 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 keyring namespaces from.\n * @returns The cronjobs, or `null` if the permission does not have a\n * cronjob caveat.\n */\nexport function getCronjobCaveatJobs(\n  permission?: PermissionConstraint,\n): CronjobSpecification[] | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.SnapCronjob);\n\n  const caveat = permission.caveats[0] as Caveat<string, { jobs: Json[] }>;\n\n  return (caveat.value?.jobs as CronjobSpecification[]) ?? null;\n}\n\n/**\n * Validate the cronjob specification values associated with a caveat.\n * This validates that the value is a non-empty array with valid\n * cronjob expression and request object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the value is invalid.\n */\nexport function validateCronjobCaveat(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw ethErrors.rpc.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {\n    throw ethErrors.rpc.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  if (!isCronjobSpecificationArray(value.jobs)) {\n    throw ethErrors.rpc.invalidParams({\n      message: 'Expected a valid cronjob specification array.',\n    });\n  }\n}\n\n/**\n * Caveat specification for the Cronjob.\n */\nexport const cronjobCaveatSpecifications: Record<\n  SnapCaveatType.SnapCronjob,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SnapCronjob]: Object.freeze({\n    type: SnapCaveatType.SnapCronjob,\n    validator: (caveat) => validateCronjobCaveat(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","SnapCaveatType","isCronjobSpecificationArray","assert","hasProperty","isPlainObject","ethErrors","SnapEndowments","permissionName","Cronjob","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","SnapCronjob","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","cronjobEndowmentBuilder","Object","freeze","getCronjobCaveatMapper","value","caveats","type","getCronjobCaveatJobs","permission","length","caveat","jobs","validateCronjobCaveat","rpc","invalidParams","message","cronjobCaveatSpecifications","validator"],"mappings":"AAQA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAE9E,SACEC,cAAc,EACdC,2BAA2B,QACtB,wBAAwB;AAE/B,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AACrE,SAASC,SAAS,QAAQ,iBAAiB;AAE3C,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,OAAO;AAS7C;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACd,eAAee,WAAW;SAAC;QAC5CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACpB,YAAYqB,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,0BAA0BC,OAAOC,MAAM,CAAC;IACnDV,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;;;CAOC,GACD,OAAO,SAASe,uBACdC,KAAW;IAEX,OAAO;QACLC,SAAS;YACP;gBACEC,MAAM3B,eAAee,WAAW;gBAChCU;YACF;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASG,qBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYH,SAAS;QACxB,OAAO;IACT;IAEAxB,OAAO2B,WAAWH,OAAO,CAACI,MAAM,KAAK;IACrC5B,OAAO2B,WAAWH,OAAO,CAAC,EAAE,CAACC,IAAI,KAAK3B,eAAee,WAAW;IAEhE,MAAMgB,SAASF,WAAWH,OAAO,CAAC,EAAE;IAEpC,OAAO,CAACK,OAAON,KAAK,EAAEO,IAA8B,KAAK;AAC3D;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsBF,MAA2B;IAC/D,IAAI,CAAC5B,YAAY4B,QAAQ,YAAY,CAAC3B,cAAc2B,OAAON,KAAK,GAAG;QACjE,MAAMpB,UAAU6B,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEX,KAAK,EAAE,GAAGM;IAElB,IAAI,CAAC5B,YAAYsB,OAAO,WAAW,CAACrB,cAAcqB,QAAQ;QACxD,MAAMpB,UAAU6B,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,IAAI,CAACnC,4BAA4BwB,MAAMO,IAAI,GAAG;QAC5C,MAAM3B,UAAU6B,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAMC,8BAGT;IACF,CAACrC,eAAee,WAAW,CAAC,EAAEO,OAAOC,MAAM,CAAC;QAC1CI,MAAM3B,eAAee,WAAW;QAChCuB,WAAW,CAACP,SAAWE,sBAAsBF;IAC/C;AACF,EAAE"}
+{"version":3,"sources":["../../../../src/snaps/endowments/cronjob.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionConstraint,\n  Caveat,\n  CaveatSpecificationConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { CronjobSpecification } from '@metamask/snaps-utils';\nimport {\n  SnapCaveatType,\n  isCronjobSpecificationArray,\n} from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Cronjob;\n\ntype CronjobEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:cronjob` returns nothing; it is intended to be used as a flag to determine whether the snap wants to run cronjobs.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the cronjob endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  CronjobEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.SnapCronjob],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const cronjobEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\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 getCronjobCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.SnapCronjob,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the cronjobs 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 keyring namespaces from.\n * @returns The cronjobs, or `null` if the permission does not have a\n * cronjob caveat.\n */\nexport function getCronjobCaveatJobs(\n  permission?: PermissionConstraint,\n): CronjobSpecification[] | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.SnapCronjob);\n\n  const caveat = permission.caveats[0] as Caveat<string, { jobs: Json[] }>;\n\n  return (caveat.value?.jobs as CronjobSpecification[]) ?? null;\n}\n\n/**\n * Validate the cronjob specification values associated with a caveat.\n * This validates that the value is a non-empty array with valid\n * cronjob expression and request object.\n *\n * @param caveat - The caveat to validate.\n * @throws If the value is invalid.\n */\nexport function validateCronjobCaveat(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  if (!hasProperty(value, 'jobs') || !isPlainObject(value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  if (!isCronjobSpecificationArray(value.jobs)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a valid cronjob specification array.',\n    });\n  }\n}\n\n/**\n * Caveat specification for the Cronjob.\n */\nexport const cronjobCaveatSpecifications: Record<\n  SnapCaveatType.SnapCronjob,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SnapCronjob]: Object.freeze({\n    type: SnapCaveatType.SnapCronjob,\n    validator: (caveat) => validateCronjobCaveat(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","rpcErrors","SnapCaveatType","isCronjobSpecificationArray","assert","hasProperty","isPlainObject","SnapEndowments","permissionName","Cronjob","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","SnapCronjob","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","cronjobEndowmentBuilder","Object","freeze","getCronjobCaveatMapper","value","caveats","type","getCronjobCaveatJobs","permission","length","caveat","jobs","validateCronjobCaveat","invalidParams","message","cronjobCaveatSpecifications","validator"],"mappings":"AAQA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AAEjD,SACEC,cAAc,EACdC,2BAA2B,QACtB,wBAAwB;AAE/B,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,OAAO;AAS7C;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACb,eAAec,WAAW;SAAC;QAC5CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACpB,YAAYqB,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,0BAA0BC,OAAOC,MAAM,CAAC;IACnDV,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;;;CAOC,GACD,OAAO,SAASe,uBACdC,KAAW;IAEX,OAAO;QACLC,SAAS;YACP;gBACEC,MAAM1B,eAAec,WAAW;gBAChCU;YACF;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASG,qBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYH,SAAS;QACxB,OAAO;IACT;IAEAvB,OAAO0B,WAAWH,OAAO,CAACI,MAAM,KAAK;IACrC3B,OAAO0B,WAAWH,OAAO,CAAC,EAAE,CAACC,IAAI,KAAK1B,eAAec,WAAW;IAEhE,MAAMgB,SAASF,WAAWH,OAAO,CAAC,EAAE;IAEpC,OAAO,CAACK,OAAON,KAAK,EAAEO,IAA8B,KAAK;AAC3D;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,sBAAsBF,MAA2B;IAC/D,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,OAAON,KAAK,GAAG;QACjE,MAAMzB,UAAUkC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEV,KAAK,EAAE,GAAGM;IAElB,IAAI,CAAC3B,YAAYqB,OAAO,WAAW,CAACpB,cAAcoB,QAAQ;QACxD,MAAMzB,UAAUkC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,IAAI,CAACjC,4BAA4BuB,MAAMO,IAAI,GAAG;QAC5C,MAAMhC,UAAUkC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAMC,8BAGT;IACF,CAACnC,eAAec,WAAW,CAAC,EAAEO,OAAOC,MAAM,CAAC;QAC1CI,MAAM1B,eAAec,WAAW;QAChCsB,WAAW,CAACN,SAAWE,sBAAsBF;IAC/C;AACF,EAAE"}

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

@@ -8,6 +8,7 @@ export var SnapEndowments;
     SnapEndowments["WebAssemblyAccess"] = 'endowment:webassembly';
     SnapEndowments["NameLookup"] = 'endowment:name-lookup';
     SnapEndowments["LifecycleHooks"] = 'endowment:lifecycle-hooks';
+    SnapEndowments["Keyring"] = 'endowment:keyring';
 })(SnapEndowments || (SnapEndowments = {}));
 
 //# sourceMappingURL=enum.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/enum.ts"],"sourcesContent":["export enum SnapEndowments {\n  NetworkAccess = 'endowment:network-access',\n  TransactionInsight = 'endowment:transaction-insight',\n  Cronjob = 'endowment:cronjob',\n  EthereumProvider = 'endowment:ethereum-provider',\n  Rpc = 'endowment:rpc',\n  WebAssemblyAccess = 'endowment:webassembly',\n  NameLookup = 'endowment:name-lookup',\n  LifecycleHooks = 'endowment:lifecycle-hooks',\n}\n"],"names":["SnapEndowments","NetworkAccess","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks"],"mappings":"WAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,wBAAqB;IAFXF,eAGVG,aAAU;IAHAH,eAIVI,sBAAmB;IAJTJ,eAKVK,SAAM;IALIL,eAMVM,uBAAoB;IANVN,eAOVO,gBAAa;IAPHP,eAQVQ,oBAAiB;GARPR,mBAAAA"}
+{"version":3,"sources":["../../../../src/snaps/endowments/enum.ts"],"sourcesContent":["export enum SnapEndowments {\n  NetworkAccess = 'endowment:network-access',\n  TransactionInsight = 'endowment:transaction-insight',\n  Cronjob = 'endowment:cronjob',\n  EthereumProvider = 'endowment:ethereum-provider',\n  Rpc = 'endowment:rpc',\n  WebAssemblyAccess = 'endowment:webassembly',\n  NameLookup = 'endowment:name-lookup',\n  LifecycleHooks = 'endowment:lifecycle-hooks',\n  Keyring = 'endowment:keyring',\n}\n"],"names":["SnapEndowments","NetworkAccess","TransactionInsight","Cronjob","EthereumProvider","Rpc","WebAssemblyAccess","NameLookup","LifecycleHooks","Keyring"],"mappings":"WAAO;UAAKA,cAAc;IAAdA,eACVC,mBAAgB;IADND,eAEVE,wBAAqB;IAFXF,eAGVG,aAAU;IAHAH,eAIVI,sBAAmB;IAJTJ,eAKVK,SAAM;IALIL,eAMVM,uBAAoB;IANVN,eAOVO,gBAAa;IAPHP,eAQVQ,oBAAiB;IARPR,eASVS,aAAU;GATAT,mBAAAA"}

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

@@ -1,6 +1,7 @@
 import { HandlerType } from '@metamask/snaps-utils';
 import { cronjobCaveatSpecifications, cronjobEndowmentBuilder, getCronjobCaveatMapper } from './cronjob';
 import { ethereumProviderEndowmentBuilder } from './ethereum-provider';
+import { getKeyringCaveatMapper, keyringCaveatSpecifications, keyringEndowmentBuilder } from './keyring';
 import { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';
 import { getNameLookupCaveatMapper, nameLookupCaveatSpecifications, nameLookupEndowmentBuilder } from './name-lookup';
 import { networkAccessEndowmentBuilder } from './network-access';
@@ -15,19 +16,22 @@ export const endowmentPermissionBuilders = {
     [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,
     [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,
     [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,
-    [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder
+    [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,
+    [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder
 };
 export const endowmentCaveatSpecifications = {
     ...cronjobCaveatSpecifications,
     ...transactionInsightCaveatSpecifications,
     ...rpcCaveatSpecifications,
-    ...nameLookupCaveatSpecifications
+    ...nameLookupCaveatSpecifications,
+    ...keyringCaveatSpecifications
 };
 export const endowmentCaveatMappers = {
     [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,
     [transactionInsightEndowmentBuilder.targetName]: getTransactionInsightCaveatMapper,
     [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,
-    [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper
+    [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,
+    [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper
 };
 export const handlerEndowments = {
     [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,
@@ -35,11 +39,13 @@ export const handlerEndowments = {
     [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,
     [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,
     [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,
-    [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName
+    [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,
+    [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName
 };
 export * from './enum';
 export { getRpcCaveatOrigins } from './rpc';
 export { getTransactionOriginCaveat } from './transaction-insight';
 export { getChainIdsCaveat } from './name-lookup';
+export { getKeyringCaveatOrigins } from './keyring';
 
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/index.ts"],"sourcesContent":["import type { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  cronjobCaveatSpecifications,\n  cronjobEndowmentBuilder,\n  getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';\nimport {\n  getNameLookupCaveatMapper,\n  nameLookupCaveatSpecifications,\n  nameLookupEndowmentBuilder,\n} from './name-lookup';\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  [transactionInsightEndowmentBuilder.targetName]:\n    transactionInsightEndowmentBuilder,\n  [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n  [ethereumProviderEndowmentBuilder.targetName]:\n    ethereumProviderEndowmentBuilder,\n  [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n  [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n  [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,\n  [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n  ...cronjobCaveatSpecifications,\n  ...transactionInsightCaveatSpecifications,\n  ...rpcCaveatSpecifications,\n  ...nameLookupCaveatSpecifications,\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  [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n  [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n  [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n  [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n  [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,\n  [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getTransactionOriginCaveat } from './transaction-insight';\nexport { getChainIdsCaveat } from './name-lookup';\n"],"names":["HandlerType","cronjobCaveatSpecifications","cronjobEndowmentBuilder","getCronjobCaveatMapper","ethereumProviderEndowmentBuilder","lifecycleHooksEndowmentBuilder","getNameLookupCaveatMapper","nameLookupCaveatSpecifications","nameLookupEndowmentBuilder","networkAccessEndowmentBuilder","getRpcCaveatMapper","rpcCaveatSpecifications","rpcEndowmentBuilder","getTransactionInsightCaveatMapper","transactionInsightCaveatSpecifications","transactionInsightEndowmentBuilder","webAssemblyEndowmentBuilder","endowmentPermissionBuilders","targetName","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","getRpcCaveatOrigins","getTransactionOriginCaveat","getChainIdsCaveat"],"mappings":"AACA,SAASA,WAAW,QAAQ,wBAAwB;AAGpD,SACEC,2BAA2B,EAC3BC,uBAAuB,EACvBC,sBAAsB,QACjB,YAAY;AACnB,SAASC,gCAAgC,QAAQ,sBAAsB;AACvE,SAASC,8BAA8B,QAAQ,oBAAoB;AACnE,SACEC,yBAAyB,EACzBC,8BAA8B,EAC9BC,0BAA0B,QACrB,gBAAgB;AACvB,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,CAACM,mCAAmCG,UAAU,CAAC,EAC7CH;IACF,CAACb,wBAAwBgB,UAAU,CAAC,EAAEhB;IACtC,CAACE,iCAAiCc,UAAU,CAAC,EAC3Cd;IACF,CAACQ,oBAAoBM,UAAU,CAAC,EAAEN;IAClC,CAACI,4BAA4BE,UAAU,CAAC,EAAEF;IAC1C,CAACR,2BAA2BU,UAAU,CAAC,EAAEV;IACzC,CAACH,+BAA+Ba,UAAU,CAAC,EAAEb;AAC/C,EAAW;AAEX,OAAO,MAAMc,gCAAgC;IAC3C,GAAGlB,2BAA2B;IAC9B,GAAGa,sCAAsC;IACzC,GAAGH,uBAAuB;IAC1B,GAAGJ,8BAA8B;AACnC,EAAE;AAEF,OAAO,MAAMa,yBAGT;IACF,CAAClB,wBAAwBgB,UAAU,CAAC,EAAEf;IACtC,CAACY,mCAAmCG,UAAU,CAAC,EAC7CL;IACF,CAACD,oBAAoBM,UAAU,CAAC,EAAER;IAClC,CAACF,2BAA2BU,UAAU,CAAC,EAAEZ;AAC3C,EAAE;AAEF,OAAO,MAAMe,oBAAiD;IAC5D,CAACrB,YAAYsB,YAAY,CAAC,EAAEV,oBAAoBM,UAAU;IAC1D,CAAClB,YAAYuB,aAAa,CAAC,EAAER,mCAAmCG,UAAU;IAC1E,CAAClB,YAAYwB,SAAS,CAAC,EAAEtB,wBAAwBgB,UAAU;IAC3D,CAAClB,YAAYyB,YAAY,CAAC,EAAEjB,2BAA2BU,UAAU;IACjE,CAAClB,YAAY0B,SAAS,CAAC,EAAErB,+BAA+Ba,UAAU;IAClE,CAAClB,YAAY2B,QAAQ,CAAC,EAAEtB,+BAA+Ba,UAAU;AACnE,EAAE;AAEF,cAAc,SAAS;AACvB,SAASU,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,0BAA0B,QAAQ,wBAAwB;AACnE,SAASC,iBAAiB,QAAQ,gBAAgB"}
+{"version":3,"sources":["../../../../src/snaps/endowments/index.ts"],"sourcesContent":["import type { PermissionConstraint } from '@metamask/permission-controller';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\n\nimport {\n  cronjobCaveatSpecifications,\n  cronjobEndowmentBuilder,\n  getCronjobCaveatMapper,\n} from './cronjob';\nimport { ethereumProviderEndowmentBuilder } from './ethereum-provider';\nimport {\n  getKeyringCaveatMapper,\n  keyringCaveatSpecifications,\n  keyringEndowmentBuilder,\n} from './keyring';\nimport { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';\nimport {\n  getNameLookupCaveatMapper,\n  nameLookupCaveatSpecifications,\n  nameLookupEndowmentBuilder,\n} from './name-lookup';\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  [transactionInsightEndowmentBuilder.targetName]:\n    transactionInsightEndowmentBuilder,\n  [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,\n  [ethereumProviderEndowmentBuilder.targetName]:\n    ethereumProviderEndowmentBuilder,\n  [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,\n  [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,\n  [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,\n  [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder,\n  [keyringEndowmentBuilder.targetName]: keyringEndowmentBuilder,\n} as const;\n\nexport const endowmentCaveatSpecifications = {\n  ...cronjobCaveatSpecifications,\n  ...transactionInsightCaveatSpecifications,\n  ...rpcCaveatSpecifications,\n  ...nameLookupCaveatSpecifications,\n  ...keyringCaveatSpecifications,\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  [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper,\n  [keyringEndowmentBuilder.targetName]: getKeyringCaveatMapper,\n};\n\nexport const handlerEndowments: Record<HandlerType, string> = {\n  [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,\n  [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,\n  [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,\n  [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,\n  [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName,\n  [HandlerType.OnKeyringRequest]: keyringEndowmentBuilder.targetName,\n};\n\nexport * from './enum';\nexport { getRpcCaveatOrigins } from './rpc';\nexport { getTransactionOriginCaveat } from './transaction-insight';\nexport { getChainIdsCaveat } from './name-lookup';\nexport { getKeyringCaveatOrigins } from './keyring';\n"],"names":["HandlerType","cronjobCaveatSpecifications","cronjobEndowmentBuilder","getCronjobCaveatMapper","ethereumProviderEndowmentBuilder","getKeyringCaveatMapper","keyringCaveatSpecifications","keyringEndowmentBuilder","lifecycleHooksEndowmentBuilder","getNameLookupCaveatMapper","nameLookupCaveatSpecifications","nameLookupEndowmentBuilder","networkAccessEndowmentBuilder","getRpcCaveatMapper","rpcCaveatSpecifications","rpcEndowmentBuilder","getTransactionInsightCaveatMapper","transactionInsightCaveatSpecifications","transactionInsightEndowmentBuilder","webAssemblyEndowmentBuilder","endowmentPermissionBuilders","targetName","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","getRpcCaveatOrigins","getTransactionOriginCaveat","getChainIdsCaveat","getKeyringCaveatOrigins"],"mappings":"AACA,SAASA,WAAW,QAAQ,wBAAwB;AAGpD,SACEC,2BAA2B,EAC3BC,uBAAuB,EACvBC,sBAAsB,QACjB,YAAY;AACnB,SAASC,gCAAgC,QAAQ,sBAAsB;AACvE,SACEC,sBAAsB,EACtBC,2BAA2B,EAC3BC,uBAAuB,QAClB,YAAY;AACnB,SAASC,8BAA8B,QAAQ,oBAAoB;AACnE,SACEC,yBAAyB,EACzBC,8BAA8B,EAC9BC,0BAA0B,QACrB,gBAAgB;AACvB,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,CAACM,mCAAmCG,UAAU,CAAC,EAC7CH;IACF,CAAChB,wBAAwBmB,UAAU,CAAC,EAAEnB;IACtC,CAACE,iCAAiCiB,UAAU,CAAC,EAC3CjB;IACF,CAACW,oBAAoBM,UAAU,CAAC,EAAEN;IAClC,CAACI,4BAA4BE,UAAU,CAAC,EAAEF;IAC1C,CAACR,2BAA2BU,UAAU,CAAC,EAAEV;IACzC,CAACH,+BAA+Ba,UAAU,CAAC,EAAEb;IAC7C,CAACD,wBAAwBc,UAAU,CAAC,EAAEd;AACxC,EAAW;AAEX,OAAO,MAAMe,gCAAgC;IAC3C,GAAGrB,2BAA2B;IAC9B,GAAGgB,sCAAsC;IACzC,GAAGH,uBAAuB;IAC1B,GAAGJ,8BAA8B;IACjC,GAAGJ,2BAA2B;AAChC,EAAE;AAEF,OAAO,MAAMiB,yBAGT;IACF,CAACrB,wBAAwBmB,UAAU,CAAC,EAAElB;IACtC,CAACe,mCAAmCG,UAAU,CAAC,EAC7CL;IACF,CAACD,oBAAoBM,UAAU,CAAC,EAAER;IAClC,CAACF,2BAA2BU,UAAU,CAAC,EAAEZ;IACzC,CAACF,wBAAwBc,UAAU,CAAC,EAAEhB;AACxC,EAAE;AAEF,OAAO,MAAMmB,oBAAiD;IAC5D,CAACxB,YAAYyB,YAAY,CAAC,EAAEV,oBAAoBM,UAAU;IAC1D,CAACrB,YAAY0B,aAAa,CAAC,EAAER,mCAAmCG,UAAU;IAC1E,CAACrB,YAAY2B,SAAS,CAAC,EAAEzB,wBAAwBmB,UAAU;IAC3D,CAACrB,YAAY4B,YAAY,CAAC,EAAEjB,2BAA2BU,UAAU;IACjE,CAACrB,YAAY6B,SAAS,CAAC,EAAErB,+BAA+Ba,UAAU;IAClE,CAACrB,YAAY8B,QAAQ,CAAC,EAAEtB,+BAA+Ba,UAAU;IACjE,CAACrB,YAAY+B,gBAAgB,CAAC,EAAExB,wBAAwBc,UAAU;AACpE,EAAE;AAEF,cAAc,SAAS;AACvB,SAASW,mBAAmB,QAAQ,QAAQ;AAC5C,SAASC,0BAA0B,QAAQ,wBAAwB;AACnE,SAASC,iBAAiB,QAAQ,gBAAgB;AAClD,SAASC,uBAAuB,QAAQ,YAAY"}

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

@@ -0,0 +1,91 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { rpcErrors } from '@metamask/rpc-errors';
+import { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';
+import { assert, hasProperty, isPlainObject } from '@metamask/utils';
+import { SnapEndowments } from './enum';
+const permissionName = SnapEndowments.Keyring;
+/**
+ * `endowment:keyring` returns nothing; it is intended to be used as a flag
+ * by the client to detect whether the snap has keyring capabilities.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the keyring endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            SnapCaveatType.KeyringOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.KeyringOrigin) {
+                throw rpcErrors.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.KeyringOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const keyringEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    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 rpcErrors.invalidParams({
+            message: 'Invalid keyring origins: Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    assertIsKeyringOrigins(value, rpcErrors.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 getKeyringCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.KeyringOrigin,
+                value
+            }
+        ]
+    };
+}
+/**
+ * Getter function to get the {@link KeyringOrigins} 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 KeyringOrigins}
+ * caveat.
+ */ export function getKeyringCaveatOrigins(permission) {
+    assert(permission?.caveats);
+    assert(permission.caveats.length === 1);
+    assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value;
+}
+export const keyringCaveatSpecifications = {
+    [SnapCaveatType.KeyringOrigin]: Object.freeze({
+        type: SnapCaveatType.KeyringOrigin,
+        validator: (caveat)=>validateCaveatOrigins(caveat)
+    })
+};
+
+//# sourceMappingURL=keyring.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/keyring.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { KeyringOrigins } from '@metamask/snaps-utils';\nimport { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Keyring;\n\ntype KeyringEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n  subjectTypes: readonly SubjectType[];\n}>;\n\n/**\n * `endowment:keyring` returns nothing; it is intended to be used as a flag\n * by the client to detect whether the snap has keyring capabilities.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the keyring endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  KeyringEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.KeyringOrigin],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: ({ caveats }) => {\n      if (\n        caveats?.length !== 1 ||\n        caveats[0].type !== SnapCaveatType.KeyringOrigin\n      ) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.KeyringOrigin}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const keyringEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\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 rpcErrors.invalidParams({\n      message: 'Invalid keyring origins: Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsKeyringOrigins(value, rpcErrors.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 getKeyringCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.KeyringOrigin,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the {@link KeyringOrigins} caveat value from a\n * 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 KeyringOrigins}\n * caveat.\n */\nexport function getKeyringCaveatOrigins(\n  permission?: PermissionConstraint,\n): KeyringOrigins | null {\n  assert(permission?.caveats);\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, KeyringOrigins>;\n  return caveat.value;\n}\n\nexport const keyringCaveatSpecifications: Record<\n  SnapCaveatType.KeyringOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.KeyringOrigin]: Object.freeze({\n    type: SnapCaveatType.KeyringOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","rpcErrors","assertIsKeyringOrigins","SnapCaveatType","assert","hasProperty","isPlainObject","SnapEndowments","permissionName","Keyring","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","KeyringOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","keyringEndowmentBuilder","Object","freeze","validateCaveatOrigins","caveat","value","getKeyringCaveatMapper","getKeyringCaveatOrigins","permission","keyringCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AAEjD,SAASC,sBAAsB,EAAEC,cAAc,QAAQ,wBAAwB;AAE/E,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,OAAO;AAW7C;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACZ,eAAea,aAAa;SAAC;QAC9CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKpB,eAAea,aAAa,EAChD;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEtB,eAAea,aAAa,CAAC,SAAS,CAAC;gBACxE;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,0BAA0BC,OAAOC,MAAM,CAAC;IACnDhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;;CAMC,GACD,SAASqB,sBAAsBC,MAA2B;IACxD,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,OAAOC,KAAK,GAAG;QACjE,MAAMhC,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAClB9B,uBAAuB+B,OAAOhC,UAAUuB,aAAa;AACvD;AAEA;;;;;;;CAOC,GACD,OAAO,SAASU,uBACdD,KAAW;IAEX,OAAO;QACLZ,SAAS;YACP;gBACEE,MAAMpB,eAAea,aAAa;gBAClCiB;YACF;SACD;IACH;AACF;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASE,wBACdC,UAAiC;IAEjChC,OAAOgC,YAAYf;IACnBjB,OAAOgC,WAAWf,OAAO,CAACC,MAAM,KAAK;IACrClB,OAAOgC,WAAWf,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKpB,eAAea,aAAa;IAElE,MAAMgB,SAASI,WAAWf,OAAO,CAAC,EAAE;IACpC,OAAOW,OAAOC,KAAK;AACrB;AAEA,OAAO,MAAMI,8BAGT;IACF,CAAClC,eAAea,aAAa,CAAC,EAAEa,OAAOC,MAAM,CAAC;QAC5CP,MAAMpB,eAAea,aAAa;QAClCI,WAAW,CAACY,SAAgCD,sBAAsBC;IACpE;AACF,EAAE"}

package/dist/esm/snaps/endowments/name-lookup.js

@@ -1,7 +1,7 @@
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { rpcErrors } from '@metamask/rpc-errors';
 import { SnapCaveatType, isChainId } from '@metamask/snaps-utils';
 import { assert, hasProperty, isPlainObject } from '@metamask/utils';
-import { ethErrors } from 'eth-rpc-errors';
 import { SnapEndowments } from './enum';
 const permissionName = SnapEndowments.NameLookup;
 /**
@@ -20,7 +20,7 @@ const permissionName = SnapEndowments.NameLookup;
         endowmentGetter: (_getterOptions)=>undefined,
         validator: ({ caveats })=>{
             if (!caveats || caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.ChainIds) {
-                throw ethErrors.rpc.invalidParams({
+                throw rpcErrors.invalidParams({
                     message: `Expected a single "${SnapCaveatType.ChainIds}" caveat.`
                 });
             }
@@ -41,7 +41,7 @@ export const nameLookupEndowmentBuilder = Object.freeze({
  * @throws If the caveat value is invalid.
  */ function validateCaveat(caveat) {
     if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
-        throw ethErrors.rpc.invalidParams({
+        throw rpcErrors.invalidParams({
             message: 'Expected a plain object.'
         });
     }

package/dist/esm/snaps/endowments/name-lookup.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/name-lookup.ts"],"sourcesContent":["import type {\n  EndowmentGetterParams,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n  Caveat,\n  CaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { SnapCaveatType, isChainId } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\nimport { ethErrors } from 'eth-rpc-errors';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.NameLookup;\n\ntype NameLookupEndowmentSpecification = 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:name-lookup` returns nothing; it is intended to be used as a flag\n * by the extension to detect whether the snap has the capability to resolve a domain/address.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the name-lookup endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  NameLookupEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.ChainIds],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: ({ caveats }) => {\n      if (\n        !caveats ||\n        (caveats !== null && caveats?.length > 1) ||\n        (caveats?.length === 1 && caveats[0].type !== SnapCaveatType.ChainIds)\n      ) {\n        throw ethErrors.rpc.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.ChainIds}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const nameLookupEndowmentBuilder = 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    Array.isArray(value) && value.every((val) => isChainId(val)),\n    'Expected caveat value to have type \"string array\"',\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 getNameLookupCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  if (\n    !value ||\n    !Array.isArray(value) ||\n    (Array.isArray(value) && value.length === 0)\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.ChainIds,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the chainIds 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 `chainIds` caveat from.\n * @returns An array of `chainIds` that the snap supports.\n */\nexport function getChainIdsCaveat(\n  permission?: PermissionConstraint,\n): string[] | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.ChainIds);\n\n  const caveat = permission.caveats[0] as Caveat<string, string[]>;\n\n  return caveat.value ?? null;\n}\n\nexport const nameLookupCaveatSpecifications: Record<\n  SnapCaveatType.ChainIds,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.ChainIds]: Object.freeze({\n    type: SnapCaveatType.ChainIds,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","SnapCaveatType","isChainId","assert","hasProperty","isPlainObject","ethErrors","SnapEndowments","permissionName","NameLookup","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","ChainIds","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","rpc","invalidParams","message","subjectTypes","Snap","nameLookupEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","Array","isArray","every","val","getNameLookupCaveatMapper","getChainIdsCaveat","permission","nameLookupCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,cAAc,EAAEC,SAAS,QAAQ,wBAAwB;AAElE,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AACrE,SAASC,SAAS,QAAQ,iBAAiB;AAE3C,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,UAAU;AAUhD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACd,eAAee,QAAQ;SAAC;QACzCC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACE,CAACA,WACAA,YAAY,QAAQA,SAASC,SAAS,KACtCD,SAASC,WAAW,KAAKD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKtB,eAAee,QAAQ,EACrE;gBACA,MAAMV,UAAUkB,GAAG,CAACC,aAAa,CAAC;oBAChCC,SAAS,CAAC,mBAAmB,EAAEzB,eAAee,QAAQ,CAAC,SAAS,CAAC;gBACnE;YACF;QACF;QACAW,cAAc;YAAC3B,YAAY4B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,6BAA6BC,OAAOC,MAAM,CAAC;IACtDjB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASsB,eAAeC,MAA2B;IACjD,IAAI,CAAC7B,YAAY6B,QAAQ,YAAY,CAAC5B,cAAc4B,SAAS;QAC3D,MAAM3B,UAAUkB,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB9B,OACEgC,MAAMC,OAAO,CAACF,UAAUA,MAAMG,KAAK,CAAC,CAACC,MAAQpC,UAAUoC,OACvD;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,0BACdL,KAAW;IAEX,IACE,CAACA,SACD,CAACC,MAAMC,OAAO,CAACF,UACdC,MAAMC,OAAO,CAACF,UAAUA,MAAMZ,MAAM,KAAK,GAC1C;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMtB,eAAee,QAAQ;gBAC7BkB;YACF;SACD;IACH;AACF;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASM,kBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYpB,SAAS;QACxB,OAAO;IACT;IAEAlB,OAAOsC,WAAWpB,OAAO,CAACC,MAAM,KAAK;IACrCnB,OAAOsC,WAAWpB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKtB,eAAee,QAAQ;IAE7D,MAAMiB,SAASQ,WAAWpB,OAAO,CAAC,EAAE;IAEpC,OAAOY,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMQ,iCAGT;IACF,CAACzC,eAAee,QAAQ,CAAC,EAAEc,OAAOC,MAAM,CAAC;QACvCR,MAAMtB,eAAee,QAAQ;QAC7BI,WAAW,CAACa,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}
+{"version":3,"sources":["../../../../src/snaps/endowments/name-lookup.ts"],"sourcesContent":["import type {\n  EndowmentGetterParams,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n  Caveat,\n  CaveatSpecificationConstraint,\n  PermissionConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { SnapCaveatType, isChainId } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.NameLookup;\n\ntype NameLookupEndowmentSpecification = 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:name-lookup` returns nothing; it is intended to be used as a flag\n * by the extension to detect whether the snap has the capability to resolve a domain/address.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the name-lookup endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  NameLookupEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.ChainIds],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: ({ caveats }) => {\n      if (\n        !caveats ||\n        (caveats !== null && caveats?.length > 1) ||\n        (caveats?.length === 1 && caveats[0].type !== SnapCaveatType.ChainIds)\n      ) {\n        throw rpcErrors.invalidParams({\n          message: `Expected a single \"${SnapCaveatType.ChainIds}\" caveat.`,\n        });\n      }\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const nameLookupEndowmentBuilder = 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 rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  assert(\n    Array.isArray(value) && value.every((val) => isChainId(val)),\n    'Expected caveat value to have type \"string array\"',\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 getNameLookupCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  if (\n    !value ||\n    !Array.isArray(value) ||\n    (Array.isArray(value) && value.length === 0)\n  ) {\n    return { caveats: null };\n  }\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.ChainIds,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the chainIds 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 `chainIds` caveat from.\n * @returns An array of `chainIds` that the snap supports.\n */\nexport function getChainIdsCaveat(\n  permission?: PermissionConstraint,\n): string[] | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.ChainIds);\n\n  const caveat = permission.caveats[0] as Caveat<string, string[]>;\n\n  return caveat.value ?? null;\n}\n\nexport const nameLookupCaveatSpecifications: Record<\n  SnapCaveatType.ChainIds,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.ChainIds]: Object.freeze({\n    type: SnapCaveatType.ChainIds,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n};\n"],"names":["PermissionType","SubjectType","rpcErrors","SnapCaveatType","isChainId","assert","hasProperty","isPlainObject","SnapEndowments","permissionName","NameLookup","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","ChainIds","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","nameLookupEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","Array","isArray","every","val","getNameLookupCaveatMapper","getChainIdsCaveat","permission","nameLookupCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,cAAc,EAAEC,SAAS,QAAQ,wBAAwB;AAElE,SAASC,MAAM,EAAEC,WAAW,EAAEC,aAAa,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,UAAU;AAUhD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;YAACb,eAAec,QAAQ;SAAC;QACzCC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACE,CAACA,WACAA,YAAY,QAAQA,SAASC,SAAS,KACtCD,SAASC,WAAW,KAAKD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKrB,eAAec,QAAQ,EACrE;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEvB,eAAec,QAAQ,CAAC,SAAS,CAAC;gBACnE;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,6BAA6BC,OAAOC,MAAM,CAAC;IACtDhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASqB,eAAeC,MAA2B;IACjD,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,SAAS;QAC3D,MAAM/B,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB5B,OACE8B,MAAMC,OAAO,CAACF,UAAUA,MAAMG,KAAK,CAAC,CAACC,MAAQlC,UAAUkC,OACvD;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,0BACdL,KAAW;IAEX,IACE,CAACA,SACD,CAACC,MAAMC,OAAO,CAACF,UACdC,MAAMC,OAAO,CAACF,UAAUA,MAAMX,MAAM,KAAK,GAC1C;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMrB,eAAec,QAAQ;gBAC7BiB;YACF;SACD;IACH;AACF;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASM,kBACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYnB,SAAS;QACxB,OAAO;IACT;IAEAjB,OAAOoC,WAAWnB,OAAO,CAACC,MAAM,KAAK;IACrClB,OAAOoC,WAAWnB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKrB,eAAec,QAAQ;IAE7D,MAAMgB,SAASQ,WAAWnB,OAAO,CAAC,EAAE;IAEpC,OAAOW,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMQ,iCAGT;IACF,CAACvC,eAAec,QAAQ,CAAC,EAAEa,OAAOC,MAAM,CAAC;QACvCP,MAAMrB,eAAec,QAAQ;QAC7BI,WAAW,CAACY,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}

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

@@ -1,7 +1,7 @@
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { rpcErrors } from '@metamask/rpc-errors';
 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;
 /**
@@ -19,7 +19,7 @@ const targetName = SnapEndowments.Rpc;
         endowmentGetter: (_getterOptions)=>undefined,
         validator: ({ caveats })=>{
             if (caveats?.length !== 1 || caveats[0].type !== SnapCaveatType.RpcOrigin) {
-                throw ethErrors.rpc.invalidParams({
+                throw rpcErrors.invalidParams({
                     message: `Expected a single "${SnapCaveatType.RpcOrigin}" caveat.`
                 });
             }
@@ -41,12 +41,12 @@ export const rpcEndowmentBuilder = Object.freeze({
  * @throws If the caveat value is invalid.
  */ function validateCaveatOrigins(caveat) {
     if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
-        throw ethErrors.rpc.invalidParams({
+        throw rpcErrors.invalidParams({
             message: 'Invalid JSON-RPC origins: Expected a plain object.'
         });
     }
     const { value } = caveat;
-    assertIsRpcOrigins(value, ethErrors.rpc.invalidParams);
+    assertIsRpcOrigins(value, rpcErrors.invalidParams);
 }
 /**
  * Map a raw value from the `initialPermissions` to a caveat specification.

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/rpc.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport type { RpcOrigins } from '@metamask/snaps-utils';\nimport { assertIsRpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isPlainObject, assert } 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":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAE9E,SAASC,kBAAkB,EAAEC,cAAc,QAAQ,wBAAwB;AAE3E,SAASC,WAAW,EAAEC,aAAa,EAAEC,MAAM,QAAQ,kBAAkB;AACrE,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"}
+{"version":3,"sources":["../../../../src/snaps/endowments/rpc.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { RpcOrigins } from '@metamask/snaps-utils';\nimport { assertIsRpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isPlainObject, assert } from '@metamask/utils';\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 rpcErrors.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 rpcErrors.invalidParams({\n      message: 'Invalid JSON-RPC origins: Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsRpcOrigins(value, rpcErrors.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","rpcErrors","assertIsRpcOrigins","SnapCaveatType","hasProperty","isPlainObject","assert","SnapEndowments","targetName","Rpc","specificationBuilder","_builderOptions","permissionType","Endowment","allowedCaveats","RpcOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","rpcEndowmentBuilder","Object","freeze","validateCaveatOrigins","caveat","value","getRpcCaveatMapper","getRpcCaveatOrigins","permission","rpcCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AAEjD,SAASC,kBAAkB,EAAEC,cAAc,QAAQ,wBAAwB;AAE3E,SAASC,WAAW,EAAEC,aAAa,EAAEC,MAAM,QAAQ,kBAAkB;AAErE,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,aAAaD,eAAeE,GAAG;AAerC;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBb,eAAec,SAAS;QACxCL;QACAM,gBAAgB;YAACX,eAAeY,SAAS;SAAC;QAC1CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKnB,eAAeY,SAAS,EAC5C;gBACA,MAAMd,UAAUsB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAErB,eAAeY,SAAS,CAAC,SAAS,CAAC;gBACpE;YACF;QACF;QACAU,cAAc;YAACzB,YAAY0B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,sBAAsBC,OAAOC,MAAM,CAAC;IAC/CrB;IACAE;AACF,GAAY;AAEZ;;;;;;CAMC,GACD,SAASoB,sBAAsBC,MAA2B;IACxD,IAAI,CAAC3B,YAAY2B,QAAQ,YAAY,CAAC1B,cAAc0B,OAAOC,KAAK,GAAG;QACjE,MAAM/B,UAAUsB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAClB7B,mBAAmB8B,OAAO/B,UAAUsB,aAAa;AACnD;AAEA;;;;;;;CAOC,GACD,OAAO,SAASU,mBACdD,KAAW;IAEX,OAAO;QACLZ,SAAS;YACP;gBACEE,MAAMnB,eAAeY,SAAS;gBAC9BiB;YACF;SACD;IACH;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASE,oBACdC,UAAiC;IAEjC7B,OAAO6B,YAAYf;IACnBd,OAAO6B,WAAWf,OAAO,CAACC,MAAM,KAAK;IACrCf,OAAO6B,WAAWf,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKnB,eAAeY,SAAS;IAE9D,MAAMgB,SAASI,WAAWf,OAAO,CAAC,EAAE;IACpC,OAAOW,OAAOC,KAAK;AACrB;AAEA,OAAO,MAAMI,0BAGT;IACF,CAACjC,eAAeY,SAAS,CAAC,EAAEa,OAAOC,MAAM,CAAC;QACxCP,MAAMnB,eAAeY,SAAS;QAC9BI,WAAW,CAACY,SAAgCD,sBAAsBC;IACpE;AACF,EAAE"}

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

@@ -1,7 +1,7 @@
 import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { rpcErrors } from '@metamask/rpc-errors';
 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;
 /**
@@ -20,7 +20,7 @@ const permissionName = SnapEndowments.TransactionInsight;
         endowmentGetter: (_getterOptions)=>undefined,
         validator: ({ caveats })=>{
             if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.TransactionOrigin) {
-                throw ethErrors.rpc.invalidParams({
+                throw rpcErrors.invalidParams({
                     message: `Expected a single "${SnapCaveatType.TransactionOrigin}" caveat.`
                 });
             }
@@ -41,7 +41,7 @@ export const transactionInsightEndowmentBuilder = Object.freeze({
  * @throws If the caveat value is invalid.
  */ function validateCaveat(caveat) {
     if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
-        throw ethErrors.rpc.invalidParams({
+        throw rpcErrors.invalidParams({
             message: 'Expected a plain object.'
         });
     }

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/snaps/endowments/transaction-insight.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionConstraint,\n  CaveatSpecificationConstraint,\n  Caveat,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isObject, isPlainObject } 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":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,cAAc,QAAQ,wBAAwB;AAEvD,SAASC,MAAM,EAAEC,WAAW,EAAEC,QAAQ,EAAEC,aAAa,QAAQ,kBAAkB;AAC/E,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"}
+{"version":3,"sources":["../../../../src/snaps/endowments/transaction-insight.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionConstraint,\n  CaveatSpecificationConstraint,\n  Caveat,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isObject, isPlainObject } from '@metamask/utils';\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 rpcErrors.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 rpcErrors.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","rpcErrors","SnapCaveatType","assert","hasProperty","isObject","isPlainObject","SnapEndowments","permissionName","TransactionInsight","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","TransactionOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","invalidParams","message","subjectTypes","Snap","transactionInsightEndowmentBuilder","Object","freeze","validateCaveat","caveat","value","getTransactionInsightCaveatMapper","keys","allowTransactionOrigin","getTransactionOriginCaveat","permission","transactionInsightCaveatSpecifications"],"mappings":"AASA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAC9E,SAASC,SAAS,QAAQ,uBAAuB;AACjD,SAASC,cAAc,QAAQ,wBAAwB;AAEvD,SAASC,MAAM,EAAEC,WAAW,EAAEC,QAAQ,EAAEC,aAAa,QAAQ,kBAAkB;AAE/E,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;YAACb,eAAec,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,KAAKrB,eAAec,iBAAiB,EACtD;gBACA,MAAMf,UAAUuB,aAAa,CAAC;oBAC5BC,SAAS,CAAC,mBAAmB,EAAEvB,eAAec,iBAAiB,CAAC,SAAS,CAAC;gBAC5E;YACF;QACF;QACAU,cAAc;YAAC1B,YAAY2B,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,qCAAqCC,OAAOC,MAAM,CAAC;IAC9DhB,YAAYN;IACZE;AACF,GAAY;AAEZ;;;;;CAKC,GACD,SAASqB,eAAeC,MAA2B;IACjD,IAAI,CAAC5B,YAAY4B,QAAQ,YAAY,CAAC1B,cAAc0B,SAAS;QAC3D,MAAM/B,UAAUuB,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEQ,KAAK,EAAE,GAAGD;IAElB7B,OACE,OAAO8B,UAAU,WACjB;AAEJ;AAEA;;;;;;;CAOC,GACD,OAAO,SAASC,kCACdD,KAAW;IAEX,IACE,CAACA,SACD,CAAC5B,SAAS4B,UACT5B,SAAS4B,UAAUJ,OAAOM,IAAI,CAACF,OAAOX,MAAM,KAAK,GAClD;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMrB,eAAec,iBAAiB;gBACtCiB,OACE7B,YAAY6B,OAAO,6BAClBA,MAAMG,sBAAsB;YACjC;SACD;IACH;AACF;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,2BACdC,UAAiC;IAEjC,IAAI,CAACA,YAAYjB,SAAS;QACxB,OAAO;IACT;IAEAlB,OAAOmC,WAAWjB,OAAO,CAACC,MAAM,KAAK;IACrCnB,OAAOmC,WAAWjB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKrB,eAAec,iBAAiB;IAEtE,MAAMgB,SAASM,WAAWjB,OAAO,CAAC,EAAE;IAEpC,OAAOW,OAAOC,KAAK,IAAI;AACzB;AAEA,OAAO,MAAMM,yCAGT;IACF,CAACrC,eAAec,iBAAiB,CAAC,EAAEa,OAAOC,MAAM,CAAC;QAChDP,MAAMrB,eAAec,iBAAiB;QACtCI,WAAW,CAACY,SAAgCD,eAAeC;IAC7D;AACF,EAAE"}

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

@@ -27,13 +27,14 @@ function _define_property(obj, key, value) {
     return obj;
 }
 import { createSnapManifest, DEFAULT_REQUESTED_SNAP_VERSION, getTargetVersion, isValidUrl, NpmSnapIdStruct, VirtualFile, normalizeRelative, parseJson } from '@metamask/snaps-utils';
-import { assert, assertIsSemVerVersion, assertStruct, isObject } from '@metamask/utils';
+import { assert, assertIsSemVerVersion, assertStruct, isObject, isValidSemVerVersion } from '@metamask/utils';
 import concat from 'concat-stream';
+import getNpmTarballUrl from 'get-npm-tarball-url';
 import createGunzipStream from 'gunzip-maybe';
 import { ReadableWebToNodeStream } from 'readable-web-to-node-stream';
 import { pipeline } from 'stream';
 import { extract as tarExtract } from 'tar-stream';
-export const DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org';
+export const DEFAULT_NPM_REGISTRY = new URL('https://registry.npmjs.org');
 var _lazyInit = /*#__PURE__*/ new WeakSet();
 export class NpmLocation {
     async manifest() {
@@ -80,7 +81,7 @@ export class NpmLocation {
         assertStruct(url.toString(), NpmSnapIdStruct, 'Invalid Snap Id: ');
         let registry;
         if (url.host === '' && url.port === '' && url.username === '' && url.password === '') {
-            registry = new URL(DEFAULT_NPM_REGISTRY);
+            registry = DEFAULT_NPM_REGISTRY;
         } else {
             registry = 'https://';
             if (url.username) {
@@ -156,6 +157,41 @@ const TARBALL_SIZE_SAFETY_LIMIT = 262144000;
     }
     return packageMetadata;
 }
+/**
+ * Resolves a version range to a version using the NPM registry.
+ *
+ * Unless the version range is already a version, then the NPM registry is skipped.
+ *
+ * @param packageName - The name of the package whose metadata to fetch.
+ * @param versionRange - The version range of the package.
+ * @param registryUrl - The URL of the npm registry to fetch the metadata from.
+ * @param fetchFunction - The fetch function to use. Defaults to the global
+ * {@link fetch}. Useful for Node.js compatibility.
+ * @returns An object containing the resolved version and a URL for its tarball.
+ * @throws If fetching the metadata fails.
+ */ async function resolveNpmVersion(packageName, versionRange, registryUrl, fetchFunction) {
+    // If the version range is already a static version we don't need to look for the metadata.
+    if (registryUrl.toString() === DEFAULT_NPM_REGISTRY.toString() && isValidSemVerVersion(versionRange)) {
+        return {
+            tarballURL: getNpmTarballUrl(packageName, versionRange),
+            targetVersion: versionRange
+        };
+    }
+    const packageMetadata = await fetchNpmMetadata(packageName, registryUrl, fetchFunction);
+    const versions = Object.keys(packageMetadata?.versions ?? {}).map((version)=>{
+        assertIsSemVerVersion(version);
+        return version;
+    });
+    const targetVersion = getTargetVersion(versions, versionRange);
+    if (targetVersion === null) {
+        throw new Error(`Failed to find a matching version in npm metadata for package "${packageName}" and requested semver range "${versionRange}".`);
+    }
+    const tarballURL = packageMetadata?.versions?.[targetVersion]?.dist?.tarball;
+    return {
+        tarballURL,
+        targetVersion
+    };
+}
 /**
  * Fetches the tarball (`.tgz` file) of the specified package and version from
  * the public npm registry.
@@ -170,22 +206,13 @@ const TARBALL_SIZE_SAFETY_LIMIT = 262144000;
  * actual version of the package.
  * @throws If fetching the tarball fails.
  */ async function fetchNpmTarball(packageName, versionRange, registryUrl, fetchFunction) {
-    const packageMetadata = await fetchNpmMetadata(packageName, registryUrl, fetchFunction);
-    const versions = Object.keys(packageMetadata?.versions ?? {}).map((version)=>{
-        assertIsSemVerVersion(version);
-        return version;
-    });
-    const targetVersion = getTargetVersion(versions, versionRange);
-    if (targetVersion === null) {
-        throw new Error(`Failed to find a matching version in npm metadata for package "${packageName}" and requested semver range "${versionRange}".`);
-    }
-    const tarballUrlString = packageMetadata?.versions?.[targetVersion]?.dist?.tarball;
-    if (!isValidUrl(tarballUrlString) || !tarballUrlString.toString().endsWith('.tgz')) {
+    const { tarballURL, targetVersion } = await resolveNpmVersion(packageName, versionRange, registryUrl, fetchFunction);
+    if (!isValidUrl(tarballURL) || !tarballURL.toString().endsWith('.tgz')) {
         throw new Error(`Failed to find valid tarball URL in NPM metadata for package "${packageName}".`);
     }
     // Override the tarball hostname/protocol with registryUrl hostname/protocol
     const newRegistryUrl = new URL(registryUrl);
-    const newTarballUrl = new URL(tarballUrlString);
+    const newTarballUrl = new URL(tarballURL);
     newTarballUrl.hostname = newRegistryUrl.hostname;
     newTarballUrl.protocol = newRegistryUrl.protocol;
     // Perform a raw fetch because we want the Response object itself.