@metamask/snaps-rpc-methods 11.0.0 → 11.1.0

package/dist/endowments/keyring.cjs

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keyringCaveatSpecifications = exports.getKeyringCaveatOrigins = exports.getKeyringCaveatMapper = exports.keyringEndowmentBuilder = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const caveats_1 = require("./caveats/index.cjs");
+const enum_1 = require("./enum.cjs");
+const permissionName = enum_1.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: permission_controller_1.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            snaps_utils_1.SnapCaveatType.KeyringOrigin,
+            snaps_utils_1.SnapCaveatType.MaxRequestTime,
+        ],
+        endowmentGetter: (_getterOptions) => null,
+        validator: (0, caveats_1.createGenericPermissionValidator)([
+            { type: snaps_utils_1.SnapCaveatType.KeyringOrigin },
+            { type: snaps_utils_1.SnapCaveatType.MaxRequestTime, optional: true },
+        ]),
+        subjectTypes: [permission_controller_1.SubjectType.Snap],
+    };
+};
+exports.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_1.hasProperty)(caveat, 'value') || !(0, utils_1.isPlainObject)(caveat.value)) {
+        throw rpc_errors_1.rpcErrors.invalidParams({
+            message: 'Invalid keyring origins: Expected a plain object.',
+        });
+    }
+    const { value } = caveat;
+    (0, snaps_utils_1.assertIsKeyringOrigins)(value, rpc_errors_1.rpcErrors.invalidParams);
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+function getKeyringCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: snaps_utils_1.SnapCaveatType.KeyringOrigin,
+                value,
+            },
+        ],
+    };
+}
+exports.getKeyringCaveatMapper = getKeyringCaveatMapper;
+/**
+ * Getter function to get the {@link KeyringOrigins} caveat value from a
+ * permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link KeyringOrigins}
+ * caveat.
+ */
+function getKeyringCaveatOrigins(permission) {
+    (0, utils_1.assert)(permission?.caveats);
+    (0, utils_1.assert)(permission.caveats.length === 1);
+    (0, utils_1.assert)(permission.caveats[0].type === snaps_utils_1.SnapCaveatType.KeyringOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value;
+}
+exports.getKeyringCaveatOrigins = getKeyringCaveatOrigins;
+exports.keyringCaveatSpecifications = {
+    [snaps_utils_1.SnapCaveatType.KeyringOrigin]: Object.freeze({
+        type: snaps_utils_1.SnapCaveatType.KeyringOrigin,
+        validator: (caveat) => validateCaveatOrigins(caveat),
+    }),
+};
+//# sourceMappingURL=keyring.cjs.map

package/dist/endowments/keyring.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.cjs","sourceRoot":"","sources":["../../src/endowments/keyring.ts"],"names":[],"mappings":";;;AASA,2EAA8E;AAC9E,qDAAiD;AAEjD,uDAA+E;AAE/E,2CAAqE;AAErE,iDAA6D;AAC7D,qCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,OAAO,CAAC;AAW9C;;;;;;GAMG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAyB,EAAE,EAAE;IAChC,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE;YACd,4BAAc,CAAC,aAAa;YAC5B,4BAAc,CAAC,cAAc;SAC9B;QACD,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,SAAS,EAAE,IAAA,0CAAgC,EAAC;YAC1C,EAAE,IAAI,EAAE,4BAAc,CAAC,aAAa,EAAE;YACtC,EAAE,IAAI,EAAE,4BAAc,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;SACxD,CAAC;QACF,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC;AAEZ;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,MAA2B;IACxD,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAClE,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mDAAmD;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,IAAA,oCAAsB,EAAC,KAAK,EAAE,sBAAS,CAAC,aAAa,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,aAAa;gBAClC,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAXD,wDAWC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,UAAiC;IAEjC,IAAA,cAAM,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5B,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACxC,IAAA,cAAM,EAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,4BAAc,CAAC,aAAa,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAmC,CAAC;IACvE,OAAO,MAAM,CAAC,KAAK,CAAC;AACtB,CAAC;AATD,0DASC;AAEY,QAAA,2BAA2B,GAGpC;IACF,CAAC,4BAAc,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5C,IAAI,EAAE,4BAAc,CAAC,aAAa;QAClC,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC;KAC1E,CAAC;CACH,CAAC","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) => null;\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) => null,\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"]}

package/dist/{types/endowments/keyring.d.ts → endowments/keyring.d.cts}

@@ -1,9 +1,9 @@
-import type { CaveatSpecificationConstraint, EndowmentGetterParams, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from '@metamask/permission-controller';
-import { PermissionType, SubjectType } from '@metamask/permission-controller';
-import type { KeyringOrigins } from '@metamask/snaps-utils';
-import { SnapCaveatType } from '@metamask/snaps-utils';
-import type { Json, NonEmptyArray } from '@metamask/utils';
-import { SnapEndowments } from './enum';
+import type { CaveatSpecificationConstraint, EndowmentGetterParams, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from "@metamask/permission-controller";
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import type { KeyringOrigins } from "@metamask/snaps-utils";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.cjs";
 declare const permissionName = SnapEndowments.Keyring;
 export declare const keyringEndowmentBuilder: Readonly<{
     readonly targetName: SnapEndowments.Keyring;
@@ -37,3 +37,4 @@ export declare function getKeyringCaveatMapper(value: Json): Pick<PermissionCons
 export declare function getKeyringCaveatOrigins(permission?: PermissionConstraint): KeyringOrigins | null;
 export declare const keyringCaveatSpecifications: Record<SnapCaveatType.KeyringOrigin, CaveatSpecificationConstraint>;
 export {};
+//# sourceMappingURL=keyring.d.cts.map

package/dist/endowments/keyring.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.d.cts","sourceRoot":"","sources":["../../src/endowments/keyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,6BAA6B,EAC7B,qBAAqB,EACrB,oBAAoB,EACpB,8BAA8B,EAC9B,6BAA6B,EAE9B,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAC5D,OAAO,EAA0B,cAAc,EAAE,8BAA8B;AAC/E,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAI3D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,yBAAyB,CAAC;AAuC9C,eAAO,MAAM,uBAAuB;;;wBApClB,eAAe,SAAS;oBAC5B,qBAAqB;qCACJ,qBAAqB,KAAK,IAAI;wBAC3C,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;sBAC1B,SAAS,WAAW,EAAE;;EAkC3B,CAAC;AAoBZ;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CASvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,CAAC,EAAE,oBAAoB,GAChC,cAAc,GAAG,IAAI,CAOvB;AAED,eAAO,MAAM,2BAA2B,EAAE,MAAM,CAC9C,cAAc,CAAC,aAAa,EAC5B,6BAA6B,CAM9B,CAAC"}

package/dist/endowments/keyring.d.mts

@@ -0,0 +1,40 @@
+import type { CaveatSpecificationConstraint, EndowmentGetterParams, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from "@metamask/permission-controller";
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import type { KeyringOrigins } from "@metamask/snaps-utils";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.mjs";
+declare const permissionName = SnapEndowments.Keyring;
+export declare const keyringEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.Keyring;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => null;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+        subjectTypes: readonly SubjectType[];
+    }>;
+}>;
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export declare function getKeyringCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the {@link KeyringOrigins} caveat value from a
+ * permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link KeyringOrigins}
+ * caveat.
+ */
+export declare function getKeyringCaveatOrigins(permission?: PermissionConstraint): KeyringOrigins | null;
+export declare const keyringCaveatSpecifications: Record<SnapCaveatType.KeyringOrigin, CaveatSpecificationConstraint>;
+export {};
+//# sourceMappingURL=keyring.d.mts.map

package/dist/endowments/keyring.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.d.mts","sourceRoot":"","sources":["../../src/endowments/keyring.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,6BAA6B,EAC7B,qBAAqB,EACrB,oBAAoB,EACpB,8BAA8B,EAC9B,6BAA6B,EAE9B,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAC5D,OAAO,EAA0B,cAAc,EAAE,8BAA8B;AAC/E,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAI3D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,yBAAyB,CAAC;AAuC9C,eAAO,MAAM,uBAAuB;;;wBApClB,eAAe,SAAS;oBAC5B,qBAAqB;qCACJ,qBAAqB,KAAK,IAAI;wBAC3C,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;sBAC1B,SAAS,WAAW,EAAE;;EAkC3B,CAAC;AAoBZ;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CASvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,CAAC,EAAE,oBAAoB,GAChC,cAAc,GAAG,IAAI,CAOvB;AAED,eAAO,MAAM,2BAA2B,EAAE,MAAM,CAC9C,cAAc,CAAC,aAAa,EAC5B,6BAA6B,CAM9B,CAAC"}

package/dist/endowments/keyring.mjs

@@ -1,17 +1,91 @@
-import {
-  getKeyringCaveatMapper,
-  getKeyringCaveatOrigins,
-  keyringCaveatSpecifications,
-  keyringEndowmentBuilder
-} from "../chunk-HOECEYMT.mjs";
-import "../chunk-TG63GBK3.mjs";
-import "../chunk-TT4DP2YW.mjs";
-import "../chunk-23XDKQW2.mjs";
-import "../chunk-CD4OUHO5.mjs";
-export {
-  getKeyringCaveatMapper,
-  getKeyringCaveatOrigins,
-  keyringCaveatSpecifications,
-  keyringEndowmentBuilder
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { assertIsKeyringOrigins, SnapCaveatType } from "@metamask/snaps-utils";
+import { assert, hasProperty, isPlainObject } from "@metamask/utils";
+import { createGenericPermissionValidator } from "./caveats/index.mjs";
+import { SnapEndowments } from "./enum.mjs";
+const permissionName = SnapEndowments.Keyring;
+/**
+ * `endowment:keyring` returns nothing; it is intended to be used as a flag
+ * by the client to detect whether the snap has keyring capabilities.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the keyring endowment.
+ */
+const specificationBuilder = (_builderOptions) => {
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            SnapCaveatType.KeyringOrigin,
+            SnapCaveatType.MaxRequestTime,
+        ],
+        endowmentGetter: (_getterOptions) => null,
+        validator: createGenericPermissionValidator([
+            { type: SnapCaveatType.KeyringOrigin },
+            { type: SnapCaveatType.MaxRequestTime, optional: true },
+        ]),
+        subjectTypes: [SubjectType.Snap],
+    };
+};
+export const keyringEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder,
+});
+/**
+ * Validate the value of a caveat. This does not validate the type of the
+ * caveat itself, only the value of the caveat.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */
+function validateCaveatOrigins(caveat) {
+    if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
+        throw rpcErrors.invalidParams({
+            message: 'Invalid keyring origins: Expected a plain object.',
+        });
+    }
+    const { value } = caveat;
+    assertIsKeyringOrigins(value, rpcErrors.invalidParams);
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+export function getKeyringCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.KeyringOrigin,
+                value,
+            },
+        ],
+    };
+}
+/**
+ * Getter function to get the {@link KeyringOrigins} caveat value from a
+ * permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link KeyringOrigins}
+ * caveat.
+ */
+export function getKeyringCaveatOrigins(permission) {
+    assert(permission?.caveats);
+    assert(permission.caveats.length === 1);
+    assert(permission.caveats[0].type === SnapCaveatType.KeyringOrigin);
+    const caveat = permission.caveats[0];
+    return caveat.value;
+}
+export const keyringCaveatSpecifications = {
+    [SnapCaveatType.KeyringOrigin]: Object.freeze({
+        type: SnapCaveatType.KeyringOrigin,
+        validator: (caveat) => validateCaveatOrigins(caveat),
+    }),
 };
 //# sourceMappingURL=keyring.mjs.map

package/dist/endowments/keyring.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"keyring.mjs","sourceRoot":"","sources":["../../src/endowments/keyring.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAC9E,OAAO,EAAE,SAAS,EAAE,6BAA6B;AAEjD,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,8BAA8B;AAE/E,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,wBAAwB;AAErE,OAAO,EAAE,gCAAgC,EAAE,4BAAkB;AAC7D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC;AAW9C;;;;;;GAMG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAyB,EAAE,EAAE;IAChC,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE;YACd,cAAc,CAAC,aAAa;YAC5B,cAAc,CAAC,cAAc;SAC9B;QACD,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,SAAS,EAAE,gCAAgC,CAAC;YAC1C,EAAE,IAAI,EAAE,cAAc,CAAC,aAAa,EAAE;YACtC,EAAE,IAAI,EAAE,cAAc,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;SACxD,CAAC;QACF,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC;AAEZ;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,MAA2B;IACxD,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAClE,MAAM,SAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,mDAAmD;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,sBAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,cAAc,CAAC,aAAa;gBAClC,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAiC;IAEjC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5B,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IACxC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,aAAa,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAmC,CAAC;IACvE,OAAO,MAAM,CAAC,KAAK,CAAC;AACtB,CAAC;AAED,MAAM,CAAC,MAAM,2BAA2B,GAGpC;IACF,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC5C,IAAI,EAAE,cAAc,CAAC,aAAa;QAClC,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC;KAC1E,CAAC;CACH,CAAC","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) => null;\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) => null,\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"]}

package/dist/endowments/lifecycle-hooks.cjs

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

package/dist/endowments/lifecycle-hooks.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle-hooks.cjs","sourceRoot":"","sources":["../../src/endowments/lifecycle-hooks.ts"],"names":[],"mappings":";;;AAKA,2EAA8E;AAG9E,qCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,cAAc,CAAC;AASrD;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAyB,EAAE,EAAE;IAChC,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1D,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC","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) => null;\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) => null,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const lifecycleHooksEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"]}

package/dist/{types/endowments/lifecycle-hooks.d.ts → endowments/lifecycle-hooks.d.cts}

@@ -1,7 +1,7 @@
-import type { PermissionSpecificationBuilder, EndowmentGetterParams } from '@metamask/permission-controller';
-import { PermissionType } from '@metamask/permission-controller';
-import type { NonEmptyArray } from '@metamask/utils';
-import { SnapEndowments } from './enum';
+import type { PermissionSpecificationBuilder, EndowmentGetterParams } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.cjs";
 declare const permissionName = SnapEndowments.LifecycleHooks;
 export declare const lifecycleHooksEndowmentBuilder: Readonly<{
     readonly targetName: SnapEndowments.LifecycleHooks;
@@ -13,3 +13,4 @@ export declare const lifecycleHooksEndowmentBuilder: Readonly<{
     }>;
 }>;
 export {};
+//# sourceMappingURL=lifecycle-hooks.d.cts.map

package/dist/endowments/lifecycle-hooks.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle-hooks.d.cts","sourceRoot":"","sources":["../../src/endowments/lifecycle-hooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,qBAAqB,EAEtB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB;AAErD,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,gCAAgC,CAAC;AA+BrD,eAAO,MAAM,8BAA8B;;;wBA5BzB,eAAe,SAAS;oBAC5B,qBAAqB;qCACJ,qBAAqB,KAAK,IAAI;wBAC3C,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;;EA4B7C,CAAC"}

package/dist/endowments/lifecycle-hooks.d.mts

@@ -0,0 +1,16 @@
+import type { PermissionSpecificationBuilder, EndowmentGetterParams } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import type { NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.mjs";
+declare const permissionName = SnapEndowments.LifecycleHooks;
+export declare const lifecycleHooksEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.LifecycleHooks;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => null;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+    }>;
+}>;
+export {};
+//# sourceMappingURL=lifecycle-hooks.d.mts.map

package/dist/endowments/lifecycle-hooks.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycle-hooks.d.mts","sourceRoot":"","sources":["../../src/endowments/lifecycle-hooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8BAA8B,EAC9B,qBAAqB,EAEtB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB;AAErD,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,gCAAgC,CAAC;AA+BrD,eAAO,MAAM,8BAA8B;;;wBA5BzB,eAAe,SAAS;oBAC5B,qBAAqB;qCACJ,qBAAqB,KAAK,IAAI;wBAC3C,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;;EA4B7C,CAAC"}

package/dist/endowments/lifecycle-hooks.mjs

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

package/dist/endowments/lifecycle-hooks.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"lifecycle-hooks.mjs","sourceRoot":"","sources":["../../src/endowments/lifecycle-hooks.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAG9E,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,MAAM,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;AASrD;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAyB,EAAE,EAAE;IAChC,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1D,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC","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) => null;\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) => null,\n    subjectTypes: [SubjectType.Snap],\n  };\n};\n\nexport const lifecycleHooksEndowmentBuilder = Object.freeze({\n  targetName: permissionName,\n  specificationBuilder,\n} as const);\n"]}

package/dist/endowments/name-lookup.cjs

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nameLookupCaveatSpecifications = exports.getLookupMatchersCaveat = exports.getChainIdsCaveat = exports.getNameLookupCaveatMapper = exports.nameLookupEndowmentBuilder = void 0;
+const permission_controller_1 = require("@metamask/permission-controller");
+const rpc_errors_1 = require("@metamask/rpc-errors");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const caveats_1 = require("./caveats/index.cjs");
+const enum_1 = require("./enum.cjs");
+const permissionName = enum_1.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: permission_controller_1.PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            snaps_utils_1.SnapCaveatType.ChainIds,
+            snaps_utils_1.SnapCaveatType.LookupMatchers,
+            snaps_utils_1.SnapCaveatType.MaxRequestTime,
+        ],
+        endowmentGetter: (_getterOptions) => null,
+        validator: (0, caveats_1.createGenericPermissionValidator)([
+            { type: snaps_utils_1.SnapCaveatType.ChainIds, optional: true },
+            { type: snaps_utils_1.SnapCaveatType.LookupMatchers, optional: true },
+            { type: snaps_utils_1.SnapCaveatType.MaxRequestTime, optional: true },
+        ]),
+        subjectTypes: [permission_controller_1.SubjectType.Snap],
+    };
+};
+exports.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_1.hasProperty)(caveat, 'value') || !(0, utils_1.isPlainObject)(caveat)) {
+        throw rpc_errors_1.rpcErrors.invalidParams({
+            message: 'Expected a plain object.',
+        });
+    }
+    const { value } = caveat;
+    switch (caveat.type) {
+        case snaps_utils_1.SnapCaveatType.ChainIds:
+            (0, utils_1.assertStruct)(value, snaps_utils_1.ChainIdsStruct);
+            break;
+        case snaps_utils_1.SnapCaveatType.LookupMatchers:
+            (0, utils_1.assertStruct)(value, snaps_utils_1.LookupMatchersStruct);
+            break;
+        default:
+            throw rpc_errors_1.rpcErrors.invalidParams({
+                message: 'Invalid caveat type, must be one of the following: "chainIds", "matchers".',
+            });
+    }
+}
+/**
+ * Map a raw value from the `initialPermissions` to a caveat specification.
+ * Note that this function does not do any validation, that's handled by the
+ * PermissionsController when the permission is requested.
+ *
+ * @param value - The raw value from the `initialPermissions`.
+ * @returns The caveat specification.
+ */
+function getNameLookupCaveatMapper(value) {
+    if (!value || !(0, utils_1.isObject)(value) || Object.keys(value).length === 0) {
+        return { caveats: null };
+    }
+    const caveats = [];
+    if (value.chains) {
+        caveats.push({
+            type: snaps_utils_1.SnapCaveatType.ChainIds,
+            value: value.chains,
+        });
+    }
+    if (value.matchers) {
+        caveats.push({
+            type: snaps_utils_1.SnapCaveatType.LookupMatchers,
+            value: value.matchers,
+        });
+    }
+    (0, utils_1.assert)(caveats.length > 0);
+    return { caveats: caveats };
+}
+exports.getNameLookupCaveatMapper = getNameLookupCaveatMapper;
+/**
+ * Getter function to get the chainIds caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the `chainIds` caveat from.
+ * @returns An array of `chainIds` that the snap supports.
+ */
+function getChainIdsCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    const caveat = permission.caveats.find((permCaveat) => permCaveat.type === snaps_utils_1.SnapCaveatType.ChainIds);
+    return caveat ? caveat.value : null;
+}
+exports.getChainIdsCaveat = getChainIdsCaveat;
+/**
+ * Getter function to get the matchers caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the `matchers` caveat from.
+ * @returns A `matchers` object that defines the input that the snap supports.
+ */
+function getLookupMatchersCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    const caveat = permission.caveats.find((permCaveat) => permCaveat.type === snaps_utils_1.SnapCaveatType.LookupMatchers);
+    return caveat ? caveat.value : null;
+}
+exports.getLookupMatchersCaveat = getLookupMatchersCaveat;
+exports.nameLookupCaveatSpecifications = {
+    [snaps_utils_1.SnapCaveatType.ChainIds]: Object.freeze({
+        type: snaps_utils_1.SnapCaveatType.ChainIds,
+        validator: (caveat) => validateCaveat(caveat),
+    }),
+    [snaps_utils_1.SnapCaveatType.LookupMatchers]: Object.freeze({
+        type: snaps_utils_1.SnapCaveatType.LookupMatchers,
+        validator: (caveat) => validateCaveat(caveat),
+    }),
+};
+//# sourceMappingURL=name-lookup.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"name-lookup.cjs","sourceRoot":"","sources":["../../src/endowments/name-lookup.ts"],"names":[],"mappings":";;;AAUA,2EAA8E;AAC9E,qDAAiD;AACjD,uDAI+B;AAE/B,2CAMyB;AAEzB,iDAA6D;AAC7D,qCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,UAAU,CAAC;AAUjD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAyB,EAAE,EAAE;IAChC,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE;YACd,4BAAc,CAAC,QAAQ;YACvB,4BAAc,CAAC,cAAc;YAC7B,4BAAc,CAAC,cAAc;SAC9B;QACD,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,SAAS,EAAE,IAAA,0CAAgC,EAAC;YAC1C,EAAE,IAAI,EAAE,4BAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;YACjD,EAAE,IAAI,EAAE,4BAAc,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;YACvD,EAAE,IAAI,EAAE,4BAAc,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;SACxD,CAAC;QACF,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC;IACtD,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC;AAEZ;;;;;GAKG;AACH,SAAS,cAAc,CAAC,MAA2B;IACjD,IAAI,CAAC,IAAA,mBAAW,EAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,MAAM,sBAAS,CAAC,aAAa,CAAC;YAC5B,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEzB,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,4BAAc,CAAC,QAAQ;YAC1B,IAAA,oBAAY,EAAC,KAAK,EAAE,4BAAc,CAAC,CAAC;YACpC,MAAM;QACR,KAAK,4BAAc,CAAC,cAAc;YAChC,IAAA,oBAAY,EAAC,KAAK,EAAE,kCAAoB,CAAC,CAAC;YAC1C,MAAM;QACR;YACE,MAAM,sBAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EACL,4EAA4E;aAC/E,CAAC,CAAC;IACP,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,yBAAyB,CACvC,KAAW;IAEX,IAAI,CAAC,KAAK,IAAI,CAAC,IAAA,gBAAQ,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,MAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,4BAAc,CAAC,QAAQ;YAC7B,KAAK,EAAE,KAAK,CAAC,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACnB,OAAO,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,4BAAc,CAAC,cAAc;YACnC,KAAK,EAAE,KAAK,CAAC,QAAQ;SACtB,CAAC,CAAC;IACL,CAAC;IAED,IAAA,cAAM,EAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE3B,OAAO,EAAE,OAAO,EAAE,OAA0C,EAAE,CAAC;AACjE,CAAC;AA1BD,8DA0BC;AAED;;;;;;;;;GASG;AACH,SAAgB,iBAAiB,CAC/B,UAAiC;IAEjC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CACpC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,4BAAc,CAAC,QAAQ,CACpB,CAAC;IAE1C,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACtC,CAAC;AAZD,8CAYC;AAED;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CACrC,UAAiC;IAEjC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CACpC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,4BAAc,CAAC,cAAc,CACV,CAAC;IAE1D,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACtC,CAAC;AAZD,0DAYC;AAEY,QAAA,8BAA8B,GAGvC;IACF,CAAC,4BAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACvC,IAAI,EAAE,4BAAc,CAAC,QAAQ;QAC7B,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC;KACnE,CAAC;IACF,CAAC,4BAAc,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC7C,IAAI,EAAE,4BAAc,CAAC,cAAc;QACnC,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC;KACnE,CAAC;CACH,CAAC","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) => null;\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) => null,\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"]}

package/dist/{types/endowments/name-lookup.d.ts → endowments/name-lookup.d.cts}

@@ -1,8 +1,8 @@
-import type { EndowmentGetterParams, PermissionSpecificationBuilder, PermissionValidatorConstraint, CaveatSpecificationConstraint, PermissionConstraint } from '@metamask/permission-controller';
-import { PermissionType } from '@metamask/permission-controller';
-import { SnapCaveatType } from '@metamask/snaps-utils';
-import type { Json, NonEmptyArray } from '@metamask/utils';
-import { SnapEndowments } from './enum';
+import type { EndowmentGetterParams, PermissionSpecificationBuilder, PermissionValidatorConstraint, CaveatSpecificationConstraint, PermissionConstraint } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.cjs";
 declare const permissionName = SnapEndowments.NameLookup;
 export declare const nameLookupEndowmentBuilder: Readonly<{
     readonly targetName: SnapEndowments.NameLookup;
@@ -47,3 +47,4 @@ export declare function getChainIdsCaveat(permission?: PermissionConstraint): st
 export declare function getLookupMatchersCaveat(permission?: PermissionConstraint): Record<string, string[]> | null;
 export declare const nameLookupCaveatSpecifications: Record<SnapCaveatType.ChainIds | SnapCaveatType.LookupMatchers, CaveatSpecificationConstraint>;
 export {};
+//# sourceMappingURL=name-lookup.d.cts.map

package/dist/endowments/name-lookup.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"name-lookup.d.cts","sourceRoot":"","sources":["../../src/endowments/name-lookup.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,8BAA8B,EAC9B,6BAA6B,EAG7B,6BAA6B,EAC7B,oBAAoB,EAErB,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,EAGL,cAAc,EACf,8BAA8B;AAC/B,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAU3D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,4BAA4B,CAAC;AAwCjD,eAAO,MAAM,0BAA0B;;;wBArCrB,eAAe,SAAS;oBAC5B,qBAAqB;qCACJ,qBAAqB,KAAK,IAAI;wBAC3C,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;;EAoC/B,CAAC;AAgCZ;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAwBvC;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,CAAC,EAAE,oBAAoB,GAChC,MAAM,EAAE,GAAG,IAAI,CAUjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,CAAC,EAAE,oBAAoB,GAChC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAUjC;AAED,eAAO,MAAM,8BAA8B,EAAE,MAAM,CACjD,cAAc,CAAC,QAAQ,GAAG,cAAc,CAAC,cAAc,EACvD,6BAA6B,CAU9B,CAAC"}