@metamask/snaps-controllers 1.0.2 → 2.0.1

package/dist/cjs/snaps/endowments/ethereum-provider.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "ethereumProviderEndowmentBuilder", {
+    enumerable: true,
+    get: function() {
+        return ethereumProviderEndowmentBuilder;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _enum = require("./enum");
+const permissionName = _enum.SnapEndowments.EthereumProvider;
+/**
+ * `endowment:ethereum-provider` returns the name of the ethereum global browser API.
+ * This is intended to populate the endowments of the
+ * SES Compartment in which a Snap executes.
+ *
+ * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the network endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>{
+            return [
+                'ethereum'
+            ];
+        },
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+const ethereumProviderEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=ethereum-provider.js.map

package/dist/cjs/snaps/endowments/ethereum-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/snaps/endowments/ethereum-provider.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.EthereumProvider;\n\ntype EthereumProviderEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: any) => ['ethereum'];\n  allowedCaveats: null;\n}>;\n\n/**\n * `endowment:ethereum-provider` returns the name of the ethereum global browser API.\n * This is intended to populate the endowments of the\n * SES Compartment in which a Snap executes.\n *\n * This populates the global scope with an EIP-1193 provider, which DOES NOT implement all legacy functionality exposed to dapps.\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  EthereumProviderEndowmentSpecification\n> = (_builderOptions?: any) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: null,\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => {\n      return ['ethereum'];\n    },\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const ethereumProviderEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"],"names":["ethereumProviderEndowmentBuilder","permissionName","SnapEndowments","EthereumProvider","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BA4CaA;;;eAAAA;;;sCAvC+B;sBAEb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,gBAAgB;AAStD;;;;;;;;;CASC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;aAAW;QACrB;QACAC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMf,mCAAmCgB,OAAOC,MAAM,CAAC;IAC5DR,YAAYR;IACZG;AACF"}

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

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    endowmentPermissionBuilders: function() {
+        return endowmentPermissionBuilders;
+    },
+    endowmentCaveatSpecifications: function() {
+        return endowmentCaveatSpecifications;
+    },
+    endowmentCaveatMappers: function() {
+        return endowmentCaveatMappers;
+    },
+    handlerEndowments: function() {
+        return handlerEndowments;
+    },
+    getRpcCaveatOrigins: function() {
+        return _rpc.getRpcCaveatOrigins;
+    },
+    getTransactionOriginCaveat: function() {
+        return _transactioninsight.getTransactionOriginCaveat;
+    },
+    getChainIdsCaveat: function() {
+        return _namelookup.getChainIdsCaveat;
+    }
+});
+const _snapsutils = require("@metamask/snaps-utils");
+const _cronjob = require("./cronjob");
+const _ethereumprovider = require("./ethereum-provider");
+const _lifecyclehooks = require("./lifecycle-hooks");
+const _namelookup = require("./name-lookup");
+const _networkaccess = require("./network-access");
+const _rpc = require("./rpc");
+const _transactioninsight = require("./transaction-insight");
+const _webassembly = require("./web-assembly");
+_export_star(require("./enum"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+const endowmentPermissionBuilders = {
+    [_networkaccess.networkAccessEndowmentBuilder.targetName]: _networkaccess.networkAccessEndowmentBuilder,
+    [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.transactionInsightEndowmentBuilder,
+    [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.cronjobEndowmentBuilder,
+    [_ethereumprovider.ethereumProviderEndowmentBuilder.targetName]: _ethereumprovider.ethereumProviderEndowmentBuilder,
+    [_rpc.rpcEndowmentBuilder.targetName]: _rpc.rpcEndowmentBuilder,
+    [_webassembly.webAssemblyEndowmentBuilder.targetName]: _webassembly.webAssemblyEndowmentBuilder,
+    [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.nameLookupEndowmentBuilder,
+    [_lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName]: _lifecyclehooks.lifecycleHooksEndowmentBuilder
+};
+const endowmentCaveatSpecifications = {
+    ..._cronjob.cronjobCaveatSpecifications,
+    ..._transactioninsight.transactionInsightCaveatSpecifications,
+    ..._rpc.rpcCaveatSpecifications,
+    ..._namelookup.nameLookupCaveatSpecifications
+};
+const endowmentCaveatMappers = {
+    [_cronjob.cronjobEndowmentBuilder.targetName]: _cronjob.getCronjobCaveatMapper,
+    [_transactioninsight.transactionInsightEndowmentBuilder.targetName]: _transactioninsight.getTransactionInsightCaveatMapper,
+    [_rpc.rpcEndowmentBuilder.targetName]: _rpc.getRpcCaveatMapper,
+    [_namelookup.nameLookupEndowmentBuilder.targetName]: _namelookup.getNameLookupCaveatMapper
+};
+const handlerEndowments = {
+    [_snapsutils.HandlerType.OnRpcRequest]: _rpc.rpcEndowmentBuilder.targetName,
+    [_snapsutils.HandlerType.OnTransaction]: _transactioninsight.transactionInsightEndowmentBuilder.targetName,
+    [_snapsutils.HandlerType.OnCronjob]: _cronjob.cronjobEndowmentBuilder.targetName,
+    [_snapsutils.HandlerType.OnNameLookup]: _namelookup.nameLookupEndowmentBuilder.targetName,
+    [_snapsutils.HandlerType.OnInstall]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName,
+    [_snapsutils.HandlerType.OnUpdate]: _lifecyclehooks.lifecycleHooksEndowmentBuilder.targetName
+};
+
+//# sourceMappingURL=index.js.map

package/dist/cjs/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":["endowmentPermissionBuilders","endowmentCaveatSpecifications","endowmentCaveatMappers","handlerEndowments","getRpcCaveatOrigins","getTransactionOriginCaveat","getChainIdsCaveat","networkAccessEndowmentBuilder","targetName","transactionInsightEndowmentBuilder","cronjobEndowmentBuilder","ethereumProviderEndowmentBuilder","rpcEndowmentBuilder","webAssemblyEndowmentBuilder","nameLookupEndowmentBuilder","lifecycleHooksEndowmentBuilder","cronjobCaveatSpecifications","transactionInsightCaveatSpecifications","rpcCaveatSpecifications","nameLookupCaveatSpecifications","getCronjobCaveatMapper","getTransactionInsightCaveatMapper","getRpcCaveatMapper","getNameLookupCaveatMapper","HandlerType","OnRpcRequest","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate"],"mappings":";;;;;;;;;;;IA6BaA,2BAA2B;eAA3BA;;IAaAC,6BAA6B;eAA7BA;;IAOAC,sBAAsB;eAAtBA;;IAWAC,iBAAiB;eAAjBA;;IAUJC,mBAAmB;eAAnBA,wBAAmB;;IACnBC,0BAA0B;eAA1BA,8CAA0B;;IAC1BC,iBAAiB;eAAjBA,6BAAiB;;;4BAvEE;yBAOrB;kCAC0C;gCACF;4BAKxC;+BACuC;qBAKvC;oCAKA;6BACqC;qBA0C9B;;;;;;;;;;;;;;AAxCP,MAAMN,8BAA8B;IACzC,CAACO,4CAA6B,CAACC,UAAU,CAAC,EAAED,4CAA6B;IACzE,CAACE,sDAAkC,CAACD,UAAU,CAAC,EAC7CC,sDAAkC;IACpC,CAACC,gCAAuB,CAACF,UAAU,CAAC,EAAEE,gCAAuB;IAC7D,CAACC,kDAAgC,CAACH,UAAU,CAAC,EAC3CG,kDAAgC;IAClC,CAACC,wBAAmB,CAACJ,UAAU,CAAC,EAAEI,wBAAmB;IACrD,CAACC,wCAA2B,CAACL,UAAU,CAAC,EAAEK,wCAA2B;IACrE,CAACC,sCAA0B,CAACN,UAAU,CAAC,EAAEM,sCAA0B;IACnE,CAACC,8CAA8B,CAACP,UAAU,CAAC,EAAEO,8CAA8B;AAC7E;AAEO,MAAMd,gCAAgC;IAC3C,GAAGe,oCAA2B;IAC9B,GAAGC,0DAAsC;IACzC,GAAGC,4BAAuB;IAC1B,GAAGC,0CAA8B;AACnC;AAEO,MAAMjB,yBAGT;IACF,CAACQ,gCAAuB,CAACF,UAAU,CAAC,EAAEY,+BAAsB;IAC5D,CAACX,sDAAkC,CAACD,UAAU,CAAC,EAC7Ca,qDAAiC;IACnC,CAACT,wBAAmB,CAACJ,UAAU,CAAC,EAAEc,uBAAkB;IACpD,CAACR,sCAA0B,CAACN,UAAU,CAAC,EAAEe,qCAAyB;AACpE;AAEO,MAAMpB,oBAAiD;IAC5D,CAACqB,uBAAW,CAACC,YAAY,CAAC,EAAEb,wBAAmB,CAACJ,UAAU;IAC1D,CAACgB,uBAAW,CAACE,aAAa,CAAC,EAAEjB,sDAAkC,CAACD,UAAU;IAC1E,CAACgB,uBAAW,CAACG,SAAS,CAAC,EAAEjB,gCAAuB,CAACF,UAAU;IAC3D,CAACgB,uBAAW,CAACI,YAAY,CAAC,EAAEd,sCAA0B,CAACN,UAAU;IACjE,CAACgB,uBAAW,CAACK,SAAS,CAAC,EAAEd,8CAA8B,CAACP,UAAU;IAClE,CAACgB,uBAAW,CAACM,QAAQ,CAAC,EAAEf,8CAA8B,CAACP,UAAU;AACnE"}

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "lifecycleHooksEndowmentBuilder", {
+    enumerable: true,
+    get: function() {
+        return lifecycleHooksEndowmentBuilder;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _enum = require("./enum");
+const permissionName = _enum.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: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>undefined,
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+const lifecycleHooksEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=lifecycle-hooks.js.map

package/dist/cjs/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":["lifecycleHooksEndowmentBuilder","permissionName","SnapEndowments","LifecycleHooks","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","undefined","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BAyCaA;;;eAAAA;;;sCApC+B;sBAGb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,cAAc;AASpD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC,iBAA2CC;QAC7DC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMhB,iCAAiCiB,OAAOC,MAAM,CAAC;IAC1DT,YAAYR;IACZG;AACF"}

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

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    nameLookupEndowmentBuilder: function() {
+        return nameLookupEndowmentBuilder;
+    },
+    getNameLookupCaveatMapper: function() {
+        return getNameLookupCaveatMapper;
+    },
+    getChainIdsCaveat: function() {
+        return getChainIdsCaveat;
+    },
+    nameLookupCaveatSpecifications: function() {
+        return nameLookupCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _ethrpcerrors = require("eth-rpc-errors");
+const _enum = require("./enum");
+const permissionName = _enum.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: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            _snapsutils.SnapCaveatType.ChainIds
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (!caveats || caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== _snapsutils.SnapCaveatType.ChainIds) {
+                throw _ethrpcerrors.ethErrors.rpc.invalidParams({
+                    message: `Expected a single "${_snapsutils.SnapCaveatType.ChainIds}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+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 (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat)) {
+        throw _ethrpcerrors.ethErrors.rpc.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _utils.assert)(Array.isArray(value) && value.every((val)=>(0, _snapsutils.isChainId)(val)), 'Expected caveat value to have type "string array"');
+}
+function getNameLookupCaveatMapper(value) {
+    if (!value || !Array.isArray(value) || Array.isArray(value) && value.length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.ChainIds,
+                value
+            }
+        ]
+    };
+}
+function getChainIdsCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    (0, _utils.assert)(permission.caveats.length === 1);
+    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.ChainIds);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+const nameLookupCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.ChainIds]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.ChainIds,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=name-lookup.js.map

package/dist/cjs/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":["nameLookupEndowmentBuilder","getNameLookupCaveatMapper","getChainIdsCaveat","nameLookupCaveatSpecifications","permissionName","SnapEndowments","NameLookup","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","ChainIds","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","ethErrors","rpc","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","value","assert","Array","isArray","every","val","isChainId","permission"],"mappings":";;;;;;;;;;;IA2DaA,0BAA0B;eAA1BA;;IAkCGC,yBAAyB;eAAzBA;;IA8BAC,iBAAiB;eAAjBA;;IAeHC,8BAA8B;eAA9BA;;;sCAjI+B;4BACF;uBAES;8BACzB;sBAEK;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,UAAU;AAUhD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,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,KAAKR,0BAAc,CAACC,QAAQ,EACrE;gBACA,MAAMQ,uBAAS,CAACC,GAAG,CAACC,aAAa,CAAC;oBAChCC,SAAS,CAAC,mBAAmB,EAAEZ,0BAAc,CAACC,QAAQ,CAAC,SAAS,CAAC;gBACnE;YACF;QACF;QACAY,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM7B,6BAA6B8B,OAAOC,MAAM,CAAC;IACtDnB,YAAYR;IACZG;AACF;AAEA;;;;;CAKC,GACD,SAASyB,eAAeC,MAA2B;IACjD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,SAAS;QAC3D,MAAMV,uBAAS,CAACC,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAElBI,IAAAA,aAAM,EACJC,MAAMC,OAAO,CAACH,UAAUA,MAAMI,KAAK,CAAC,CAACC,MAAQC,IAAAA,qBAAS,EAACD,OACvD;AAEJ;AAUO,SAASxC,0BACdmC,KAAW;IAEX,IACE,CAACA,SACD,CAACE,MAAMC,OAAO,CAACH,UACdE,MAAMC,OAAO,CAACH,UAAUA,MAAMf,MAAM,KAAK,GAC1C;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,QAAQ;gBAC7BqB;YACF;SACD;IACH;AACF;AAYO,SAASlC,kBACdyC,UAAiC;IAEjC,IAAI,CAACA,YAAYvB,SAAS;QACxB,OAAO;IACT;IAEAiB,IAAAA,aAAM,EAACM,WAAWvB,OAAO,CAACC,MAAM,KAAK;IACrCgB,IAAAA,aAAM,EAACM,WAAWvB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,QAAQ;IAE7D,MAAMkB,SAASU,WAAWvB,OAAO,CAAC,EAAE;IAEpC,OAAOa,OAAOG,KAAK,IAAI;AACzB;AAEO,MAAMjC,iCAGT;IACF,CAACW,0BAAc,CAACC,QAAQ,CAAC,EAAEe,OAAOC,MAAM,CAAC;QACvCT,MAAMR,0BAAc,CAACC,QAAQ;QAC7BI,WAAW,CAACc,SAAgCD,eAAeC;IAC7D;AACF"}

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "networkAccessEndowmentBuilder", {
+    enumerable: true,
+    get: function() {
+        return networkAccessEndowmentBuilder;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _enum = require("./enum");
+const permissionName = _enum.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: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: null,
+        endowmentGetter: (_getterOptions)=>{
+            return [
+                'fetch',
+                'Request',
+                'Headers',
+                'Response'
+            ];
+        },
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+const networkAccessEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+
+//# sourceMappingURL=network-access.js.map

package/dist/cjs/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":["networkAccessEndowmentBuilder","permissionName","SnapEndowments","NetworkAccess","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","endowmentGetter","_getterOptions","subjectTypes","SubjectType","Snap","Object","freeze"],"mappings":";;;;+BA4CaA;;;eAAAA;;;sCAvC+B;sBAEb;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,aAAa;AAWnD;;;;;;;CAOC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;QAChBC,iBAAiB,CAACC;YAChB,OAAO;gBAAC;gBAAS;gBAAW;gBAAW;aAAW;QACpD;QACAC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMf,gCAAgCgB,OAAOC,MAAM,CAAC;IACzDR,YAAYR;IACZG;AACF"}

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

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    rpcEndowmentBuilder: function() {
+        return rpcEndowmentBuilder;
+    },
+    getRpcCaveatMapper: function() {
+        return getRpcCaveatMapper;
+    },
+    getRpcCaveatOrigins: function() {
+        return getRpcCaveatOrigins;
+    },
+    rpcCaveatSpecifications: function() {
+        return rpcCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _ethrpcerrors = require("eth-rpc-errors");
+const _enum = require("./enum");
+const targetName = _enum.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: _permissioncontroller.PermissionType.Endowment,
+        targetName,
+        allowedCaveats: [
+            _snapsutils.SnapCaveatType.RpcOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats?.length !== 1 || caveats[0].type !== _snapsutils.SnapCaveatType.RpcOrigin) {
+                throw _ethrpcerrors.ethErrors.rpc.invalidParams({
+                    message: `Expected a single "${_snapsutils.SnapCaveatType.RpcOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+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 (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
+        throw _ethrpcerrors.ethErrors.rpc.invalidParams({
+            message: 'Invalid JSON-RPC origins: Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _snapsutils.assertIsRpcOrigins)(value, _ethrpcerrors.ethErrors.rpc.invalidParams);
+}
+function getRpcCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.RpcOrigin,
+                value
+            }
+        ]
+    };
+}
+function getRpcCaveatOrigins(permission) {
+    (0, _utils.assert)(permission?.caveats);
+    (0, _utils.assert)(permission.caveats.length === 1);
+    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.RpcOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value;
+}
+const rpcCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.RpcOrigin]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.RpcOrigin,
+        validator: (caveat)=>validateCaveatOrigins(caveat)
+    })
+};
+
+//# sourceMappingURL=rpc.js.map

package/dist/cjs/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":["rpcEndowmentBuilder","getRpcCaveatMapper","getRpcCaveatOrigins","rpcCaveatSpecifications","targetName","SnapEndowments","Rpc","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","allowedCaveats","SnapCaveatType","RpcOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","ethErrors","rpc","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","assertIsRpcOrigins","permission","assert"],"mappings":";;;;;;;;;;;IA+DaA,mBAAmB;eAAnBA;;IA+BGC,kBAAkB;eAAlBA;;IAoBAC,mBAAmB;eAAnBA;;IAWHC,uBAAuB;eAAvBA;;;sCApH+B;4BAEO;uBAEA;8BACzB;sBAEK;AAE/B,MAAMC,aAAaC,oBAAc,CAACC,GAAG;AAerC;;;;;CAKC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCP;QACAQ,gBAAgB;YAACC,0BAAc,CAACC,SAAS;SAAC;QAC1CC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAW,CAAC,EAAEC,OAAO,EAAE;YACrB,IACEA,SAASC,WAAW,KACpBD,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,SAAS,EAC5C;gBACA,MAAMQ,uBAAS,CAACC,GAAG,CAACC,aAAa,CAAC;oBAChCC,SAAS,CAAC,mBAAmB,EAAEZ,0BAAc,CAACC,SAAS,CAAC,SAAS,CAAC;gBACpE;YACF;QACF;QACAY,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,sBAAsB6B,OAAOC,MAAM,CAAC;IAC/C1B;IACAG;AACF;AAEA;;;;;;CAMC,GACD,SAASwB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMb,uBAAS,CAACC,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAClBI,IAAAA,8BAAkB,EAACD,OAAOb,uBAAS,CAACC,GAAG,CAACC,aAAa;AACvD;AAUO,SAASvB,mBACdkC,KAAW;IAEX,OAAO;QACLhB,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,SAAS;gBAC9BqB;YACF;SACD;IACH;AACF;AASO,SAASjC,oBACdmC,UAAiC;IAEjCC,IAAAA,aAAM,EAACD,YAAYlB;IACnBmB,IAAAA,aAAM,EAACD,WAAWlB,OAAO,CAACC,MAAM,KAAK;IACrCkB,IAAAA,aAAM,EAACD,WAAWlB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,SAAS;IAE9D,MAAMkB,SAASK,WAAWlB,OAAO,CAAC,EAAE;IACpC,OAAOa,OAAOG,KAAK;AACrB;AAEO,MAAMhC,0BAGT;IACF,CAACU,0BAAc,CAACC,SAAS,CAAC,EAAEe,OAAOC,MAAM,CAAC;QACxCT,MAAMR,0BAAc,CAACC,SAAS;QAC9BI,WAAW,CAACc,SAAgCD,sBAAsBC;IACpE;AACF"}

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

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    transactionInsightEndowmentBuilder: function() {
+        return transactionInsightEndowmentBuilder;
+    },
+    getTransactionInsightCaveatMapper: function() {
+        return getTransactionInsightCaveatMapper;
+    },
+    getTransactionOriginCaveat: function() {
+        return getTransactionOriginCaveat;
+    },
+    transactionInsightCaveatSpecifications: function() {
+        return transactionInsightCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _ethrpcerrors = require("eth-rpc-errors");
+const _enum = require("./enum");
+const permissionName = _enum.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: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            _snapsutils.SnapCaveatType.TransactionOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: ({ caveats })=>{
+            if (caveats !== null && caveats?.length > 1 || caveats?.length === 1 && caveats[0].type !== _snapsutils.SnapCaveatType.TransactionOrigin) {
+                throw _ethrpcerrors.ethErrors.rpc.invalidParams({
+                    message: `Expected a single "${_snapsutils.SnapCaveatType.TransactionOrigin}" caveat.`
+                });
+            }
+        },
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+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 (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat)) {
+        throw _ethrpcerrors.ethErrors.rpc.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _utils.assert)(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
+}
+function getTransactionInsightCaveatMapper(value) {
+    if (!value || !(0, _utils.isObject)(value) || (0, _utils.isObject)(value) && Object.keys(value).length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.TransactionOrigin,
+                value: (0, _utils.hasProperty)(value, 'allowTransactionOrigin') && value.allowTransactionOrigin
+            }
+        ]
+    };
+}
+function getTransactionOriginCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    (0, _utils.assert)(permission.caveats.length === 1);
+    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.TransactionOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+const transactionInsightCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.TransactionOrigin]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.TransactionOrigin,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=transaction-insight.js.map

package/dist/cjs/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":["transactionInsightEndowmentBuilder","getTransactionInsightCaveatMapper","getTransactionOriginCaveat","transactionInsightCaveatSpecifications","permissionName","SnapEndowments","TransactionInsight","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","TransactionOrigin","endowmentGetter","_getterOptions","undefined","validator","caveats","length","type","ethErrors","rpc","invalidParams","message","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","value","assert","isObject","keys","allowTransactionOrigin","permission"],"mappings":";;;;;;;;;;;IA2DaA,kCAAkC;eAAlCA;;IAkCGC,iCAAiC;eAAjCA;;IAiCAC,0BAA0B;eAA1BA;;IAeHC,sCAAsC;eAAtCA;;;sCApI+B;4BACb;uBAE8B;8BACnC;sBAEK;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,kBAAkB;AAUxD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,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,KAAKR,0BAAc,CAACC,iBAAiB,EACtD;gBACA,MAAMQ,uBAAS,CAACC,GAAG,CAACC,aAAa,CAAC;oBAChCC,SAAS,CAAC,mBAAmB,EAAEZ,0BAAc,CAACC,iBAAiB,CAAC,SAAS,CAAC;gBAC5E;YACF;QACF;QACAY,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM7B,qCAAqC8B,OAAOC,MAAM,CAAC;IAC9DnB,YAAYR;IACZG;AACF;AAEA;;;;;CAKC,GACD,SAASyB,eAAeC,MAA2B;IACjD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,SAAS;QAC3D,MAAMV,uBAAS,CAACC,GAAG,CAACC,aAAa,CAAC;YAChCC,SAAS;QACX;IACF;IAEA,MAAM,EAAEU,KAAK,EAAE,GAAGH;IAElBI,IAAAA,aAAM,EACJ,OAAOD,UAAU,WACjB;AAEJ;AAUO,SAASnC,kCACdmC,KAAW;IAEX,IACE,CAACA,SACD,CAACE,IAAAA,eAAQ,EAACF,UACTE,IAAAA,eAAQ,EAACF,UAAUN,OAAOS,IAAI,CAACH,OAAOf,MAAM,KAAK,GAClD;QACA,OAAO;YAAED,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEE,MAAMR,0BAAc,CAACC,iBAAiB;gBACtCqB,OACEF,IAAAA,kBAAW,EAACE,OAAO,6BAClBA,MAAMI,sBAAsB;YACjC;SACD;IACH;AACF;AAaO,SAAStC,2BACduC,UAAiC;IAEjC,IAAI,CAACA,YAAYrB,SAAS;QACxB,OAAO;IACT;IAEAiB,IAAAA,aAAM,EAACI,WAAWrB,OAAO,CAACC,MAAM,KAAK;IACrCgB,IAAAA,aAAM,EAACI,WAAWrB,OAAO,CAAC,EAAE,CAACE,IAAI,KAAKR,0BAAc,CAACC,iBAAiB;IAEtE,MAAMkB,SAASQ,WAAWrB,OAAO,CAAC,EAAE;IAEpC,OAAOa,OAAOG,KAAK,IAAI;AACzB;AAEO,MAAMjC,yCAGT;IACF,CAACW,0BAAc,CAACC,iBAAiB,CAAC,EAAEe,OAAOC,MAAM,CAAC;QAChDT,MAAMR,0BAAc,CAACC,iBAAiB;QACtCI,WAAW,CAACc,SAAgCD,eAAeC;IAC7D;AACF"}