@metamask/snaps-controllers 1.0.2 → 2.0.1

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

@@ -0,0 +1,45 @@
+import { HandlerType } from '@metamask/snaps-utils';
+import { cronjobCaveatSpecifications, cronjobEndowmentBuilder, getCronjobCaveatMapper } from './cronjob';
+import { ethereumProviderEndowmentBuilder } from './ethereum-provider';
+import { lifecycleHooksEndowmentBuilder } from './lifecycle-hooks';
+import { getNameLookupCaveatMapper, nameLookupCaveatSpecifications, nameLookupEndowmentBuilder } from './name-lookup';
+import { networkAccessEndowmentBuilder } from './network-access';
+import { getRpcCaveatMapper, rpcCaveatSpecifications, rpcEndowmentBuilder } from './rpc';
+import { getTransactionInsightCaveatMapper, transactionInsightCaveatSpecifications, transactionInsightEndowmentBuilder } from './transaction-insight';
+import { webAssemblyEndowmentBuilder } from './web-assembly';
+export const endowmentPermissionBuilders = {
+    [networkAccessEndowmentBuilder.targetName]: networkAccessEndowmentBuilder,
+    [transactionInsightEndowmentBuilder.targetName]: transactionInsightEndowmentBuilder,
+    [cronjobEndowmentBuilder.targetName]: cronjobEndowmentBuilder,
+    [ethereumProviderEndowmentBuilder.targetName]: ethereumProviderEndowmentBuilder,
+    [rpcEndowmentBuilder.targetName]: rpcEndowmentBuilder,
+    [webAssemblyEndowmentBuilder.targetName]: webAssemblyEndowmentBuilder,
+    [nameLookupEndowmentBuilder.targetName]: nameLookupEndowmentBuilder,
+    [lifecycleHooksEndowmentBuilder.targetName]: lifecycleHooksEndowmentBuilder
+};
+export const endowmentCaveatSpecifications = {
+    ...cronjobCaveatSpecifications,
+    ...transactionInsightCaveatSpecifications,
+    ...rpcCaveatSpecifications,
+    ...nameLookupCaveatSpecifications
+};
+export const endowmentCaveatMappers = {
+    [cronjobEndowmentBuilder.targetName]: getCronjobCaveatMapper,
+    [transactionInsightEndowmentBuilder.targetName]: getTransactionInsightCaveatMapper,
+    [rpcEndowmentBuilder.targetName]: getRpcCaveatMapper,
+    [nameLookupEndowmentBuilder.targetName]: getNameLookupCaveatMapper
+};
+export const handlerEndowments = {
+    [HandlerType.OnRpcRequest]: rpcEndowmentBuilder.targetName,
+    [HandlerType.OnTransaction]: transactionInsightEndowmentBuilder.targetName,
+    [HandlerType.OnCronjob]: cronjobEndowmentBuilder.targetName,
+    [HandlerType.OnNameLookup]: nameLookupEndowmentBuilder.targetName,
+    [HandlerType.OnInstall]: lifecycleHooksEndowmentBuilder.targetName,
+    [HandlerType.OnUpdate]: lifecycleHooksEndowmentBuilder.targetName
+};
+export * from './enum';
+export { getRpcCaveatOrigins } from './rpc';
+export { getTransactionOriginCaveat } from './transaction-insight';
+export { getChainIdsCaveat } from './name-lookup';
+
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/index.ts"],"sourcesContent":["import 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"}

package/dist/esm/snaps/endowments/lifecycle-hooks.js

@@ -0,0 +1,27 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+import { SnapEndowments } from './enum';
+const permissionName = SnapEndowments.LifecycleHooks;
+/**
+ * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a
+ * flag by the snap controller to detect whether the snap has the capability to
+ * use lifecycle hooks.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the `lifecycle-hooks` endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>undefined,
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const lifecycleHooksEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=lifecycle-hooks.js.map

package/dist/esm/snaps/endowments/lifecycle-hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/lifecycle-hooks.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport type { NonEmptyArray } from '@metamask/utils';\n\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.LifecycleHooks;\n\ntype LifecycleHooksEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n}>;\n\n/**\n * `endowment:lifecycle-hooks` returns nothing; it is intended to be used as a\n * flag by the snap controller to detect whether the snap has the capability to\n * use lifecycle hooks.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the `lifecycle-hooks` endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  LifecycleHooksEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const lifecycleHooksEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["PermissionType","SubjectType","SnapEndowments","permissionName","LifecycleHooks","specificationBuilder","_builderOptions","permissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","Snap","lifecycleHooksEndowmentBuilder","Object","freeze"],"mappings":"AAKA,SAASA,cAAc,EAAEC,WAAW,QAAQ,kCAAkC;AAG9E,SAASC,cAAc,QAAQ,SAAS;AAExC,MAAMC,iBAAiBD,eAAeE,cAAc;AASpD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBP,eAAeQ,SAAS;QACxCC,YAAYN;QACZO,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACb,YAAYc,IAAI;SAAC;IAClC;AACF;AAEA,OAAO,MAAMC,iCAAiCC,OAAOC,MAAM,CAAC;IAC1DT,YAAYN;IACZE;AACF,GAAY"}

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

@@ -0,0 +1,98 @@
+import { PermissionType, SubjectType } from '@metamask/permission-controller';
+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;
+/**
+ * `endowment:name-lookup` returns nothing; it is intended to be used as a flag
+ * by the extension to detect whether the snap has the capability to resolve a domain/address.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the name-lookup endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            SnapCaveatType.ChainIds
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (!caveats || caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== SnapCaveatType.ChainIds) {
+                throw ethErrors.rpc.invalidParams({
+                    message: `Expected a single "${SnapCaveatType.ChainIds}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            SubjectType.Snap
+        ]
+    };
+};
+export const nameLookupEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+/**
+ * Validates the type of the caveat value.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */ function validateCaveat(caveat) {
+    if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
+        throw ethErrors.rpc.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    assert(Array.isArray(value) && value.every((val)=>isChainId(val)), 'Expected caveat value to have type "string array"');
+}
+/**
+ * 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 getNameLookupCaveatMapper(value) {
+    if (!value || !Array.isArray(value) || Array.isArray(value) && value.length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.ChainIds,
+                value
+            }
+        ]
+    };
+}
+/**
+ * Getter function to get the chainIds caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the `chainIds` caveat from.
+ * @returns An array of `chainIds` that the snap supports.
+ */ export function getChainIdsCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    assert(permission.caveats.length === 1);
+    assert(permission.caveats[0].type === SnapCaveatType.ChainIds);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+export const nameLookupCaveatSpecifications = {
+    [SnapCaveatType.ChainIds]: Object.freeze({
+        type: SnapCaveatType.ChainIds,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=name-lookup.js.map

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

@@ -0,0 +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"}

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/rpc.ts"],"sourcesContent":["import 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"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/transaction-insight.ts"],"sourcesContent":["import 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"}

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

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

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

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

package/dist/esm/snaps/index.js

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

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

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