@metamask/snaps-rpc-methods 4.1.0 → 6.0.0

package/dist/cjs/endowments/keyring.js

@@ -0,0 +1,104 @@
+"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, {
+    keyringEndowmentBuilder: function() {
+        return keyringEndowmentBuilder;
+    },
+    getKeyringCaveatMapper: function() {
+        return getKeyringCaveatMapper;
+    },
+    getKeyringCaveatOrigins: function() {
+        return getKeyringCaveatOrigins;
+    },
+    keyringCaveatSpecifications: function() {
+        return keyringCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _rpcerrors = require("@metamask/rpc-errors");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _caveats = require("./caveats");
+const _enum = require("./enum");
+const permissionName = _enum.SnapEndowments.Keyring;
+/**
+ * `endowment:keyring` returns nothing; it is intended to be used as a flag
+ * by the client to detect whether the snap has keyring capabilities.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the keyring endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            _snapsutils.SnapCaveatType.KeyringOrigin,
+            _snapsutils.SnapCaveatType.MaxRequestTime
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: (0, _caveats.createGenericPermissionValidator)([
+            {
+                type: _snapsutils.SnapCaveatType.KeyringOrigin
+            },
+            {
+                type: _snapsutils.SnapCaveatType.MaxRequestTime,
+                optional: true
+            }
+        ]),
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+const keyringEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder
+});
+/**
+ * Validate the value of a caveat. This does not validate the type of the
+ * caveat itself, only the value of the caveat.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */ function validateCaveatOrigins(caveat) {
+    if (!(0, _utils.hasProperty)(caveat, 'value') || !(0, _utils.isPlainObject)(caveat.value)) {
+        throw _rpcerrors.rpcErrors.invalidParams({
+            message: 'Invalid keyring origins: Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _snapsutils.assertIsKeyringOrigins)(value, _rpcerrors.rpcErrors.invalidParams);
+}
+function getKeyringCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.KeyringOrigin,
+                value
+            }
+        ]
+    };
+}
+function getKeyringCaveatOrigins(permission) {
+    (0, _utils.assert)(permission?.caveats);
+    (0, _utils.assert)(permission.caveats.length === 1);
+    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.KeyringOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value;
+}
+const keyringCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.KeyringOrigin]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.KeyringOrigin,
+        validator: (caveat)=>validateCaveatOrigins(caveat)
+    })
+};
+
+//# sourceMappingURL=keyring.js.map

package/dist/cjs/endowments/keyring.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/endowments/keyring.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { KeyringOrigins } from '@metamask/snaps-utils';\nimport { assertIsKeyringOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isPlainObject } from '@metamask/utils';\n\nimport { createGenericPermissionValidator } from './caveats';\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.Keyring;\n\ntype KeyringEndowmentSpecification = ValidPermissionSpecification<{\n  permissionType: PermissionType.Endowment;\n  targetName: typeof permissionName;\n  endowmentGetter: (_options?: EndowmentGetterParams) => undefined;\n  allowedCaveats: Readonly<NonEmptyArray<string>> | null;\n  validator: PermissionValidatorConstraint;\n  subjectTypes: readonly SubjectType[];\n}>;\n\n/**\n * `endowment:keyring` returns nothing; it is intended to be used as a flag\n * by the client to detect whether the snap has keyring capabilities.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the keyring endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  KeyringEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [\n      SnapCaveatType.KeyringOrigin,\n      SnapCaveatType.MaxRequestTime,\n    ],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: createGenericPermissionValidator([\n      { type: SnapCaveatType.KeyringOrigin },\n      { type: SnapCaveatType.MaxRequestTime, optional: true },\n    ]),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const keyringEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Invalid keyring origins: Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsKeyringOrigins(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getKeyringCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.KeyringOrigin,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the {@link KeyringOrigins} caveat value from a\n * permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link KeyringOrigins}\n * caveat.\n */\nexport function getKeyringCaveatOrigins(\n  permission?: PermissionConstraint,\n): KeyringOrigins | null {\n  assert(permission?.caveats);\n  assert(permission.caveats.length === 1);\n  assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, KeyringOrigins>;\n  return caveat.value;\n}\n\nexport const keyringCaveatSpecifications: Record<\n  SnapCaveatType.KeyringOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.KeyringOrigin]: Object.freeze({\n    type: SnapCaveatType.KeyringOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveatOrigins(caveat),\n  }),\n};\n"],"names":["keyringEndowmentBuilder","getKeyringCaveatMapper","getKeyringCaveatOrigins","keyringCaveatSpecifications","permissionName","SnapEndowments","Keyring","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","KeyringOrigin","MaxRequestTime","endowmentGetter","_getterOptions","undefined","validator","createGenericPermissionValidator","type","optional","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","rpcErrors","invalidParams","message","assertIsKeyringOrigins","caveats","permission","assert","length"],"mappings":";;;;;;;;;;;IA0DaA,uBAAuB;eAAvBA;;IA+BGC,sBAAsB;eAAtBA;;IAsBAC,uBAAuB;eAAvBA;;IAWHC,2BAA2B;eAA3BA;;;sCAjH+B;2BAClB;4BAE6B;uBAEJ;yBAEF;sBAClB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,OAAO;AAW7C;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YACdC,0BAAc,CAACC,aAAa;YAC5BD,0BAAc,CAACE,cAAc;SAC9B;QACDC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAWC,IAAAA,yCAAgC,EAAC;YAC1C;gBAAEC,MAAMR,0BAAc,CAACC,aAAa;YAAC;YACrC;gBAAEO,MAAMR,0BAAc,CAACE,cAAc;gBAAEO,UAAU;YAAK;SACvD;QACDC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM1B,0BAA0B2B,OAAOC,MAAM,CAAC;IACnDhB,YAAYR;IACZG;AACF;AAEA;;;;;;CAMC,GACD,SAASsB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMC,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEH,KAAK,EAAE,GAAGH;IAClBO,IAAAA,kCAAsB,EAACJ,OAAOC,oBAAS,CAACC,aAAa;AACvD;AAUO,SAASlC,uBACdgC,KAAW;IAEX,OAAO;QACLK,SAAS;YACP;gBACEhB,MAAMR,0BAAc,CAACC,aAAa;gBAClCkB;YACF;SACD;IACH;AACF;AAWO,SAAS/B,wBACdqC,UAAiC;IAEjCC,IAAAA,aAAM,EAACD,YAAYD;IACnBE,IAAAA,aAAM,EAACD,WAAWD,OAAO,CAACG,MAAM,KAAK;IACrCD,IAAAA,aAAM,EAACD,WAAWD,OAAO,CAAC,EAAE,CAAChB,IAAI,KAAKR,0BAAc,CAACC,aAAa;IAElE,MAAMe,SAASS,WAAWD,OAAO,CAAC,EAAE;IACpC,OAAOR,OAAOG,KAAK;AACrB;AAEO,MAAM9B,8BAGT;IACF,CAACW,0BAAc,CAACC,aAAa,CAAC,EAAEY,OAAOC,MAAM,CAAC;QAC5CN,MAAMR,0BAAc,CAACC,aAAa;QAClCK,WAAW,CAACU,SAAgCD,sBAAsBC;IACpE;AACF"}

package/dist/cjs/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/endowments/lifecycle-hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/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/endowments/name-lookup.js

@@ -0,0 +1,148 @@
+"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;
+    },
+    getLookupMatchersCaveat: function() {
+        return getLookupMatchersCaveat;
+    },
+    nameLookupCaveatSpecifications: function() {
+        return nameLookupCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _rpcerrors = require("@metamask/rpc-errors");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _caveats = require("./caveats");
+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,
+            _snapsutils.SnapCaveatType.LookupMatchers,
+            _snapsutils.SnapCaveatType.MaxRequestTime
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: (0, _caveats.createGenericPermissionValidator)([
+            {
+                type: _snapsutils.SnapCaveatType.ChainIds,
+                optional: true
+            },
+            {
+                type: _snapsutils.SnapCaveatType.LookupMatchers,
+                optional: true
+            },
+            {
+                type: _snapsutils.SnapCaveatType.MaxRequestTime,
+                optional: true
+            }
+        ]),
+        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 _rpcerrors.rpcErrors.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    switch(caveat.type){
+        case _snapsutils.SnapCaveatType.ChainIds:
+            (0, _utils.assertStruct)(value, _snapsutils.ChainIdsStruct);
+            break;
+        case _snapsutils.SnapCaveatType.LookupMatchers:
+            (0, _utils.assertStruct)(value, _snapsutils.LookupMatchersStruct);
+            break;
+        default:
+            throw _rpcerrors.rpcErrors.invalidParams({
+                message: 'Invalid caveat type, must be one of the following: "chainIds", "matchers".'
+            });
+    }
+}
+function getNameLookupCaveatMapper(value) {
+    if (!value || !(0, _utils.isObject)(value) || Object.keys(value).length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    const caveats = [];
+    if (value.chains) {
+        caveats.push({
+            type: _snapsutils.SnapCaveatType.ChainIds,
+            value: value.chains
+        });
+    }
+    if (value.matchers) {
+        caveats.push({
+            type: _snapsutils.SnapCaveatType.LookupMatchers,
+            value: value.matchers
+        });
+    }
+    (0, _utils.assert)(caveats.length > 0);
+    return {
+        caveats: caveats
+    };
+}
+function getChainIdsCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    const caveat = permission.caveats.find((permCaveat)=>permCaveat.type === _snapsutils.SnapCaveatType.ChainIds);
+    return caveat ? caveat.value : null;
+}
+function getLookupMatchersCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    const caveat = permission.caveats.find((permCaveat)=>permCaveat.type === _snapsutils.SnapCaveatType.LookupMatchers);
+    return caveat ? caveat.value : null;
+}
+const nameLookupCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.ChainIds]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.ChainIds,
+        validator: (caveat)=>validateCaveat(caveat)
+    }),
+    [_snapsutils.SnapCaveatType.LookupMatchers]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.LookupMatchers,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=name-lookup.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/endowments/name-lookup.ts"],"sourcesContent":["import type {\n  EndowmentGetterParams,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n  Caveat,\n  CaveatSpecificationConstraint,\n  PermissionConstraint,\n  CaveatConstraint,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport {\n  ChainIdsStruct,\n  LookupMatchersStruct,\n  SnapCaveatType,\n} from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport {\n  assert,\n  assertStruct,\n  hasProperty,\n  isObject,\n  isPlainObject,\n} from '@metamask/utils';\n\nimport { createGenericPermissionValidator } from './caveats';\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: [\n      SnapCaveatType.ChainIds,\n      SnapCaveatType.LookupMatchers,\n      SnapCaveatType.MaxRequestTime,\n    ],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: createGenericPermissionValidator([\n      { type: SnapCaveatType.ChainIds, optional: true },\n      { type: SnapCaveatType.LookupMatchers, optional: true },\n      { type: SnapCaveatType.MaxRequestTime, optional: true },\n    ]),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const nameLookupEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validates the type of the caveat value.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveat(caveat: Caveat<string, any>): void {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  switch (caveat.type) {\n    case SnapCaveatType.ChainIds:\n      assertStruct(value, ChainIdsStruct);\n      break;\n    case SnapCaveatType.LookupMatchers:\n      assertStruct(value, LookupMatchersStruct);\n      break;\n    default:\n      throw rpcErrors.invalidParams({\n        message:\n          'Invalid caveat type, must be one of the following: \"chainIds\", \"matchers\".',\n      });\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 (!value || !isObject(value) || Object.keys(value).length === 0) {\n    return { caveats: null };\n  }\n\n  const caveats = [];\n\n  if (value.chains) {\n    caveats.push({\n      type: SnapCaveatType.ChainIds,\n      value: value.chains,\n    });\n  }\n\n  if (value.matchers) {\n    caveats.push({\n      type: SnapCaveatType.LookupMatchers,\n      value: value.matchers,\n    });\n  }\n\n  assert(caveats.length > 0);\n\n  return { caveats: caveats as NonEmptyArray<CaveatConstraint> };\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  const caveat = permission.caveats.find(\n    (permCaveat) => permCaveat.type === SnapCaveatType.ChainIds,\n  ) as Caveat<string, string[]> | undefined;\n\n  return caveat ? caveat.value : null;\n}\n\n/**\n * Getter function to get the matchers 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 `matchers` caveat from.\n * @returns A `matchers` object that defines the input that the snap supports.\n */\nexport function getLookupMatchersCaveat(\n  permission?: PermissionConstraint,\n): Record<string, string[]> | null {\n  if (!permission?.caveats) {\n    return null;\n  }\n\n  const caveat = permission.caveats.find(\n    (permCaveat) => permCaveat.type === SnapCaveatType.LookupMatchers,\n  ) as Caveat<string, Record<string, string[]>> | undefined;\n\n  return caveat ? caveat.value : null;\n}\n\nexport const nameLookupCaveatSpecifications: Record<\n  SnapCaveatType.ChainIds | SnapCaveatType.LookupMatchers,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.ChainIds]: Object.freeze({\n    type: SnapCaveatType.ChainIds,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n  [SnapCaveatType.LookupMatchers]: Object.freeze({\n    type: SnapCaveatType.LookupMatchers,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n};\n"],"names":["nameLookupEndowmentBuilder","getNameLookupCaveatMapper","getChainIdsCaveat","getLookupMatchersCaveat","nameLookupCaveatSpecifications","permissionName","SnapEndowments","NameLookup","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","ChainIds","LookupMatchers","MaxRequestTime","endowmentGetter","_getterOptions","undefined","validator","createGenericPermissionValidator","type","optional","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","rpcErrors","invalidParams","message","value","assertStruct","ChainIdsStruct","LookupMatchersStruct","isObject","keys","length","caveats","chains","push","matchers","assert","permission","find","permCaveat"],"mappings":";;;;;;;;;;;IAqEaA,0BAA0B;eAA1BA;;IA2CGC,yBAAyB;eAAzBA;;IAsCAC,iBAAiB;eAAjBA;;IAwBAC,uBAAuB;eAAvBA;;IAcHC,8BAA8B;eAA9BA;;;sCAlL+B;2BAClB;4BAKnB;uBAQA;yBAE0C;sBAClB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,UAAU;AAUhD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YACdC,0BAAc,CAACC,QAAQ;YACvBD,0BAAc,CAACE,cAAc;YAC7BF,0BAAc,CAACG,cAAc;SAC9B;QACDC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAWC,IAAAA,yCAAgC,EAAC;YAC1C;gBAAEC,MAAMT,0BAAc,CAACC,QAAQ;gBAAES,UAAU;YAAK;YAChD;gBAAED,MAAMT,0BAAc,CAACE,cAAc;gBAAEQ,UAAU;YAAK;YACtD;gBAAED,MAAMT,0BAAc,CAACG,cAAc;gBAAEO,UAAU;YAAK;SACvD;QACDC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM5B,6BAA6B6B,OAAOC,MAAM,CAAC;IACtDjB,YAAYR;IACZG;AACF;AAEA;;;;;CAKC,GACD,SAASuB,eAAeC,MAA2B;IACjD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,SAAS;QAC3D,MAAMG,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEC,KAAK,EAAE,GAAGN;IAElB,OAAQA,OAAOR,IAAI;QACjB,KAAKT,0BAAc,CAACC,QAAQ;YAC1BuB,IAAAA,mBAAY,EAACD,OAAOE,0BAAc;YAClC;QACF,KAAKzB,0BAAc,CAACE,cAAc;YAChCsB,IAAAA,mBAAY,EAACD,OAAOG,gCAAoB;YACxC;QACF;YACE,MAAMN,oBAAS,CAACC,aAAa,CAAC;gBAC5BC,SACE;YACJ;IACJ;AACF;AAUO,SAASpC,0BACdqC,KAAW;IAEX,IAAI,CAACA,SAAS,CAACI,IAAAA,eAAQ,EAACJ,UAAUT,OAAOc,IAAI,CAACL,OAAOM,MAAM,KAAK,GAAG;QACjE,OAAO;YAAEC,SAAS;QAAK;IACzB;IAEA,MAAMA,UAAU,EAAE;IAElB,IAAIP,MAAMQ,MAAM,EAAE;QAChBD,QAAQE,IAAI,CAAC;YACXvB,MAAMT,0BAAc,CAACC,QAAQ;YAC7BsB,OAAOA,MAAMQ,MAAM;QACrB;IACF;IAEA,IAAIR,MAAMU,QAAQ,EAAE;QAClBH,QAAQE,IAAI,CAAC;YACXvB,MAAMT,0BAAc,CAACE,cAAc;YACnCqB,OAAOA,MAAMU,QAAQ;QACvB;IACF;IAEAC,IAAAA,aAAM,EAACJ,QAAQD,MAAM,GAAG;IAExB,OAAO;QAAEC,SAASA;IAA2C;AAC/D;AAYO,SAAS3C,kBACdgD,UAAiC;IAEjC,IAAI,CAACA,YAAYL,SAAS;QACxB,OAAO;IACT;IAEA,MAAMb,SAASkB,WAAWL,OAAO,CAACM,IAAI,CACpC,CAACC,aAAeA,WAAW5B,IAAI,KAAKT,0BAAc,CAACC,QAAQ;IAG7D,OAAOgB,SAASA,OAAOM,KAAK,GAAG;AACjC;AAYO,SAASnC,wBACd+C,UAAiC;IAEjC,IAAI,CAACA,YAAYL,SAAS;QACxB,OAAO;IACT;IAEA,MAAMb,SAASkB,WAAWL,OAAO,CAACM,IAAI,CACpC,CAACC,aAAeA,WAAW5B,IAAI,KAAKT,0BAAc,CAACE,cAAc;IAGnE,OAAOe,SAASA,OAAOM,KAAK,GAAG;AACjC;AAEO,MAAMlC,iCAGT;IACF,CAACW,0BAAc,CAACC,QAAQ,CAAC,EAAEa,OAAOC,MAAM,CAAC;QACvCN,MAAMT,0BAAc,CAACC,QAAQ;QAC7BM,WAAW,CAACU,SAAgCD,eAAeC;IAC7D;IACA,CAACjB,0BAAc,CAACE,cAAc,CAAC,EAAEY,OAAOC,MAAM,CAAC;QAC7CN,MAAMT,0BAAc,CAACE,cAAc;QACnCK,WAAW,CAACU,SAAgCD,eAAeC;IAC7D;AACF"}

package/dist/cjs/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/endowments/network-access.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/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/endowments/rpc.js

@@ -0,0 +1,103 @@
+"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 _rpcerrors = require("@metamask/rpc-errors");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _caveats = require("./caveats");
+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,
+            _snapsutils.SnapCaveatType.MaxRequestTime
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: (0, _caveats.createGenericPermissionValidator)([
+            {
+                type: _snapsutils.SnapCaveatType.RpcOrigin
+            },
+            {
+                type: _snapsutils.SnapCaveatType.MaxRequestTime,
+                optional: true
+            }
+        ]),
+        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 _rpcerrors.rpcErrors.invalidParams({
+            message: 'Invalid JSON-RPC origins: Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _snapsutils.assertIsRpcOrigins)(value, _rpcerrors.rpcErrors.invalidParams);
+}
+function getRpcCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.RpcOrigin,
+                value
+            }
+        ]
+    };
+}
+function getRpcCaveatOrigins(permission) {
+    const caveats = permission?.caveats?.filter((caveat)=>caveat.type === _snapsutils.SnapCaveatType.RpcOrigin);
+    (0, _utils.assert)(caveats);
+    (0, _utils.assert)(caveats.length === 1);
+    const caveat = 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/endowments/rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/endowments/rpc.ts"],"sourcesContent":["import type {\n  Caveat,\n  CaveatSpecificationConstraint,\n  EndowmentGetterParams,\n  PermissionConstraint,\n  PermissionSpecificationBuilder,\n  PermissionValidatorConstraint,\n  ValidPermissionSpecification,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport type { RpcOrigins } from '@metamask/snaps-utils';\nimport { assertIsRpcOrigins, SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { hasProperty, isPlainObject, assert } from '@metamask/utils';\n\nimport { createGenericPermissionValidator } from './caveats';\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, SnapCaveatType.MaxRequestTime],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: createGenericPermissionValidator([\n      { type: SnapCaveatType.RpcOrigin },\n      { type: SnapCaveatType.MaxRequestTime, optional: true },\n    ]),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const rpcEndowmentBuilder = Object.freeze({\n  targetName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validate the value of a caveat. This does not validate the type of the\n * caveat itself, only the value of the caveat.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveatOrigins(caveat: Caveat<string, any>) {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {\n    throw rpcErrors.invalidParams({\n      message: 'Invalid JSON-RPC origins: Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n  assertIsRpcOrigins(value, rpcErrors.invalidParams);\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionsController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getRpcCaveatMapper(\n  value: Json,\n): Pick<PermissionConstraint, 'caveats'> {\n  return {\n    caveats: [\n      {\n        type: SnapCaveatType.RpcOrigin,\n        value,\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the {@link RpcOrigins} caveat value from a permission.\n *\n * @param permission - The permission to get the caveat value from.\n * @returns The caveat value.\n * @throws If the permission does not have a valid {@link RpcOrigins} caveat.\n */\nexport function getRpcCaveatOrigins(\n  permission?: PermissionConstraint,\n): RpcOrigins | null {\n  const caveats = permission?.caveats?.filter(\n    (caveat) => caveat.type === SnapCaveatType.RpcOrigin,\n  );\n  assert(caveats);\n  assert(caveats.length === 1);\n\n  const caveat = 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","MaxRequestTime","endowmentGetter","_getterOptions","undefined","validator","createGenericPermissionValidator","type","optional","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveatOrigins","caveat","hasProperty","isPlainObject","value","rpcErrors","invalidParams","message","assertIsRpcOrigins","caveats","permission","filter","assert","length"],"mappings":";;;;;;;;;;;IA0DaA,mBAAmB;eAAnBA;;IA+BGC,kBAAkB;eAAlBA;;IAoBAC,mBAAmB;eAAnBA;;IAaHC,uBAAuB;eAAvBA;;;sCAjH+B;2BAClB;4BAEyB;uBAEA;yBAEF;sBAClB;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;YAAED,0BAAc,CAACE,cAAc;SAAC;QACzEC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAWC,IAAAA,yCAAgC,EAAC;YAC1C;gBAAEC,MAAMR,0BAAc,CAACC,SAAS;YAAC;YACjC;gBAAEO,MAAMR,0BAAc,CAACE,cAAc;gBAAEO,UAAU;YAAK;SACvD;QACDC,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAMzB,sBAAsB0B,OAAOC,MAAM,CAAC;IAC/CvB;IACAG;AACF;AAEA;;;;;;CAMC,GACD,SAASqB,sBAAsBC,MAA2B;IACxD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,OAAOG,KAAK,GAAG;QACjE,MAAMC,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEH,KAAK,EAAE,GAAGH;IAClBO,IAAAA,8BAAkB,EAACJ,OAAOC,oBAAS,CAACC,aAAa;AACnD;AAUO,SAASjC,mBACd+B,KAAW;IAEX,OAAO;QACLK,SAAS;YACP;gBACEhB,MAAMR,0BAAc,CAACC,SAAS;gBAC9BkB;YACF;SACD;IACH;AACF;AASO,SAAS9B,oBACdoC,UAAiC;IAEjC,MAAMD,UAAUC,YAAYD,SAASE,OACnC,CAACV,SAAWA,OAAOR,IAAI,KAAKR,0BAAc,CAACC,SAAS;IAEtD0B,IAAAA,aAAM,EAACH;IACPG,IAAAA,aAAM,EAACH,QAAQI,MAAM,KAAK;IAE1B,MAAMZ,SAASQ,OAAO,CAAC,EAAE;IACzB,OAAOR,OAAOG,KAAK;AACrB;AAEO,MAAM7B,0BAGT;IACF,CAACU,0BAAc,CAACC,SAAS,CAAC,EAAEY,OAAOC,MAAM,CAAC;QACxCN,MAAMR,0BAAc,CAACC,SAAS;QAC9BK,WAAW,CAACU,SAAgCD,sBAAsBC;IACpE;AACF"}

package/dist/cjs/endowments/signature-insight.js

@@ -0,0 +1,110 @@
+"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, {
+    signatureInsightEndowmentBuilder: function() {
+        return signatureInsightEndowmentBuilder;
+    },
+    getSignatureInsightCaveatMapper: function() {
+        return getSignatureInsightCaveatMapper;
+    },
+    getSignatureOriginCaveat: function() {
+        return getSignatureOriginCaveat;
+    },
+    signatureInsightCaveatSpecifications: function() {
+        return signatureInsightCaveatSpecifications;
+    }
+});
+const _permissioncontroller = require("@metamask/permission-controller");
+const _rpcerrors = require("@metamask/rpc-errors");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _caveats = require("./caveats");
+const _enum = require("./enum");
+const permissionName = _enum.SnapEndowments.SignatureInsight;
+/**
+ * `endowment:signature-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 signature confirmation screen.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the signature-insight endowment.
+ */ const specificationBuilder = (_builderOptions)=>{
+    return {
+        permissionType: _permissioncontroller.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            _snapsutils.SnapCaveatType.SignatureOrigin
+        ],
+        endowmentGetter: (_getterOptions)=>undefined,
+        validator: (0, _caveats.createGenericPermissionValidator)([
+            {
+                type: _snapsutils.SnapCaveatType.SignatureOrigin,
+                optional: true
+            },
+            {
+                type: _snapsutils.SnapCaveatType.MaxRequestTime,
+                optional: true
+            }
+        ]),
+        subjectTypes: [
+            _permissioncontroller.SubjectType.Snap
+        ]
+    };
+};
+const signatureInsightEndowmentBuilder = 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 _rpcerrors.rpcErrors.invalidParams({
+            message: 'Expected a plain object.'
+        });
+    }
+    const { value } = caveat;
+    (0, _utils.assert)(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
+}
+function getSignatureInsightCaveatMapper(value) {
+    if (!value || !(0, _utils.isObject)(value) || (0, _utils.isObject)(value) && Object.keys(value).length === 0) {
+        return {
+            caveats: null
+        };
+    }
+    return {
+        caveats: [
+            {
+                type: _snapsutils.SnapCaveatType.SignatureOrigin,
+                value: (0, _utils.hasProperty)(value, 'allowSignatureOrigin') && value.allowSignatureOrigin
+            }
+        ]
+    };
+}
+function getSignatureOriginCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    (0, _utils.assert)(permission.caveats.length === 1);
+    (0, _utils.assert)(permission.caveats[0].type === _snapsutils.SnapCaveatType.SignatureOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value ?? null;
+}
+const signatureInsightCaveatSpecifications = {
+    [_snapsutils.SnapCaveatType.SignatureOrigin]: Object.freeze({
+        type: _snapsutils.SnapCaveatType.SignatureOrigin,
+        validator: (caveat)=>validateCaveat(caveat)
+    })
+};
+
+//# sourceMappingURL=signature-insight.js.map

package/dist/cjs/endowments/signature-insight.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/endowments/signature-insight.ts"],"sourcesContent":["import type {\n  PermissionSpecificationBuilder,\n  EndowmentGetterParams,\n  ValidPermissionSpecification,\n  PermissionValidatorConstraint,\n  PermissionConstraint,\n  CaveatSpecificationConstraint,\n  Caveat,\n} from '@metamask/permission-controller';\nimport { PermissionType, SubjectType } from '@metamask/permission-controller';\nimport { rpcErrors } from '@metamask/rpc-errors';\nimport { SnapCaveatType } from '@metamask/snaps-utils';\nimport type { Json, NonEmptyArray } from '@metamask/utils';\nimport { assert, hasProperty, isObject, isPlainObject } from '@metamask/utils';\n\nimport { createGenericPermissionValidator } from './caveats';\nimport { SnapEndowments } from './enum';\n\nconst permissionName = SnapEndowments.SignatureInsight;\n\ntype SignatureInsightEndowmentSpecification = 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:signature-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 signature confirmation screen.\n *\n * @param _builderOptions - Optional specification builder options.\n * @returns The specification for the signature-insight endowment.\n */\nconst specificationBuilder: PermissionSpecificationBuilder<\n  PermissionType.Endowment,\n  any,\n  SignatureInsightEndowmentSpecification\n> = (_builderOptions?: unknown) => {\n  return {\n    permissionType: PermissionType.Endowment,\n    targetName: permissionName,\n    allowedCaveats: [SnapCaveatType.SignatureOrigin],\n    endowmentGetter: (_getterOptions?: EndowmentGetterParams) => undefined,\n    validator: createGenericPermissionValidator([\n      { type: SnapCaveatType.SignatureOrigin, optional: true },\n      { type: SnapCaveatType.MaxRequestTime, optional: true },\n    ]),\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const signatureInsightEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n\n/**\n * Validates the type of the caveat value.\n *\n * @param caveat - The caveat to validate.\n * @throws If the caveat value is invalid.\n */\nfunction validateCaveat(caveat: Caveat<string, any>): void {\n  if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {\n    throw rpcErrors.invalidParams({\n      message: 'Expected a plain object.',\n    });\n  }\n\n  const { value } = caveat;\n\n  assert(\n    typeof value === 'boolean',\n    'Expected caveat value to have type \"boolean\"',\n  );\n}\n\n/**\n * Map a raw value from the `initialPermissions` to a caveat specification.\n * Note that this function does not do any validation, that's handled by the\n * PermissionController when the permission is requested.\n *\n * @param value - The raw value from the `initialPermissions`.\n * @returns The caveat specification.\n */\nexport function getSignatureInsightCaveatMapper(\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.SignatureOrigin,\n        value:\n          hasProperty(value, 'allowSignatureOrigin') &&\n          (value.allowSignatureOrigin as boolean),\n      },\n    ],\n  };\n}\n\n/**\n * Getter function to get the signature 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 signature origin caveat from.\n * @returns The signature origin, or `null` if the permission does not have a\n * signature origin caveat.\n */\nexport function getSignatureOriginCaveat(\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.SignatureOrigin);\n\n  const caveat = permission.caveats[0] as Caveat<string, boolean>;\n\n  return caveat.value ?? null;\n}\n\nexport const signatureInsightCaveatSpecifications: Record<\n  SnapCaveatType.SignatureOrigin,\n  CaveatSpecificationConstraint\n> = {\n  [SnapCaveatType.SignatureOrigin]: Object.freeze({\n    type: SnapCaveatType.SignatureOrigin,\n    validator: (caveat: Caveat<string, any>) => validateCaveat(caveat),\n  }),\n};\n"],"names":["signatureInsightEndowmentBuilder","getSignatureInsightCaveatMapper","getSignatureOriginCaveat","signatureInsightCaveatSpecifications","permissionName","SnapEndowments","SignatureInsight","specificationBuilder","_builderOptions","permissionType","PermissionType","Endowment","targetName","allowedCaveats","SnapCaveatType","SignatureOrigin","endowmentGetter","_getterOptions","undefined","validator","createGenericPermissionValidator","type","optional","MaxRequestTime","subjectTypes","SubjectType","Snap","Object","freeze","validateCaveat","caveat","hasProperty","isPlainObject","rpcErrors","invalidParams","message","value","assert","isObject","keys","length","caveats","allowSignatureOrigin","permission"],"mappings":";;;;;;;;;;;IAqDaA,gCAAgC;eAAhCA;;IAkCGC,+BAA+B;eAA/BA;;IAiCAC,wBAAwB;eAAxBA;;IAeHC,oCAAoC;eAApCA;;;sCA9H+B;2BAClB;4BACK;uBAE8B;yBAEZ;sBAClB;AAE/B,MAAMC,iBAAiBC,oBAAc,CAACC,gBAAgB;AAUtD;;;;;;CAMC,GACD,MAAMC,uBAIF,CAACC;IACH,OAAO;QACLC,gBAAgBC,oCAAc,CAACC,SAAS;QACxCC,YAAYR;QACZS,gBAAgB;YAACC,0BAAc,CAACC,eAAe;SAAC;QAChDC,iBAAiB,CAACC,iBAA2CC;QAC7DC,WAAWC,IAAAA,yCAAgC,EAAC;YAC1C;gBAAEC,MAAMP,0BAAc,CAACC,eAAe;gBAAEO,UAAU;YAAK;YACvD;gBAAED,MAAMP,0BAAc,CAACS,cAAc;gBAAED,UAAU;YAAK;SACvD;QACDE,cAAc;YAACC,iCAAW,CAACC,IAAI;SAAC;IAClC;AACF;AAEO,MAAM1B,mCAAmC2B,OAAOC,MAAM,CAAC;IAC5DhB,YAAYR;IACZG;AACF;AAEA;;;;;CAKC,GACD,SAASsB,eAAeC,MAA2B;IACjD,IAAI,CAACC,IAAAA,kBAAW,EAACD,QAAQ,YAAY,CAACE,IAAAA,oBAAa,EAACF,SAAS;QAC3D,MAAMG,oBAAS,CAACC,aAAa,CAAC;YAC5BC,SAAS;QACX;IACF;IAEA,MAAM,EAAEC,KAAK,EAAE,GAAGN;IAElBO,IAAAA,aAAM,EACJ,OAAOD,UAAU,WACjB;AAEJ;AAUO,SAASnC,gCACdmC,KAAW;IAEX,IACE,CAACA,SACD,CAACE,IAAAA,eAAQ,EAACF,UACTE,IAAAA,eAAQ,EAACF,UAAUT,OAAOY,IAAI,CAACH,OAAOI,MAAM,KAAK,GAClD;QACA,OAAO;YAAEC,SAAS;QAAK;IACzB;IACA,OAAO;QACLA,SAAS;YACP;gBACEpB,MAAMP,0BAAc,CAACC,eAAe;gBACpCqB,OACEL,IAAAA,kBAAW,EAACK,OAAO,2BAClBA,MAAMM,oBAAoB;YAC/B;SACD;IACH;AACF;AAaO,SAASxC,yBACdyC,UAAiC;IAEjC,IAAI,CAACA,YAAYF,SAAS;QACxB,OAAO;IACT;IAEAJ,IAAAA,aAAM,EAACM,WAAWF,OAAO,CAACD,MAAM,KAAK;IACrCH,IAAAA,aAAM,EAACM,WAAWF,OAAO,CAAC,EAAE,CAACpB,IAAI,KAAKP,0BAAc,CAACC,eAAe;IAEpE,MAAMe,SAASa,WAAWF,OAAO,CAAC,EAAE;IAEpC,OAAOX,OAAOM,KAAK,IAAI;AACzB;AAEO,MAAMjC,uCAGT;IACF,CAACW,0BAAc,CAACC,eAAe,CAAC,EAAEY,OAAOC,MAAM,CAAC;QAC9CP,MAAMP,0BAAc,CAACC,eAAe;QACpCI,WAAW,CAACW,SAAgCD,eAAeC;IAC7D;AACF"}