@metamask/snaps-rpc-methods 10.0.1 → 11.1.0

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"}

package/dist/endowments/name-lookup.d.mts

@@ -0,0 +1,50 @@
+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.mjs";
+declare const permissionName = SnapEndowments.NameLookup;
+export declare const nameLookupEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.NameLookup;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: EndowmentGetterParams) => null;
+        allowedCaveats: Readonly<NonEmptyArray<string>> | null;
+        validator: PermissionValidatorConstraint;
+    }>;
+}>;
+/**
+ * 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 getNameLookupCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the chainIds caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the `chainIds` caveat from.
+ * @returns An array of `chainIds` that the snap supports.
+ */
+export declare function getChainIdsCaveat(permission?: PermissionConstraint): string[] | null;
+/**
+ * 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.
+ */
+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.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"name-lookup.d.mts","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"}

package/dist/endowments/name-lookup.mjs

@@ -1,19 +1,135 @@
-import {
-  getChainIdsCaveat,
-  getLookupMatchersCaveat,
-  getNameLookupCaveatMapper,
-  nameLookupCaveatSpecifications,
-  nameLookupEndowmentBuilder
-} from "../chunk-ODN35VOK.mjs";
-import "../chunk-TG63GBK3.mjs";
-import "../chunk-TT4DP2YW.mjs";
-import "../chunk-23XDKQW2.mjs";
-import "../chunk-CD4OUHO5.mjs";
-export {
-  getChainIdsCaveat,
-  getLookupMatchersCaveat,
-  getNameLookupCaveatMapper,
-  nameLookupCaveatSpecifications,
-  nameLookupEndowmentBuilder
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { ChainIdsStruct, LookupMatchersStruct, SnapCaveatType } from "@metamask/snaps-utils";
+import { assert, assertStruct, hasProperty, isObject, isPlainObject } from "@metamask/utils";
+import { createGenericPermissionValidator } from "./caveats/index.mjs";
+import { SnapEndowments } from "./enum.mjs";
+const permissionName = SnapEndowments.NameLookup;
+/**
+ * `endowment:name-lookup` returns nothing; it is intended to be used as a flag
+ * by the extension to detect whether the snap has the capability to resolve a domain/address.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the name-lookup endowment.
+ */
+const specificationBuilder = (_builderOptions) => {
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName: permissionName,
+        allowedCaveats: [
+            SnapCaveatType.ChainIds,
+            SnapCaveatType.LookupMatchers,
+            SnapCaveatType.MaxRequestTime,
+        ],
+        endowmentGetter: (_getterOptions) => null,
+        validator: createGenericPermissionValidator([
+            { type: SnapCaveatType.ChainIds, optional: true },
+            { type: SnapCaveatType.LookupMatchers, optional: true },
+            { type: SnapCaveatType.MaxRequestTime, optional: true },
+        ]),
+        subjectTypes: [SubjectType.Snap],
+    };
+};
+export const nameLookupEndowmentBuilder = Object.freeze({
+    targetName: permissionName,
+    specificationBuilder,
+});
+/**
+ * Validates the type of the caveat value.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */
+function validateCaveat(caveat) {
+    if (!hasProperty(caveat, 'value') || !isPlainObject(caveat)) {
+        throw rpcErrors.invalidParams({
+            message: 'Expected a plain object.',
+        });
+    }
+    const { value } = caveat;
+    switch (caveat.type) {
+        case SnapCaveatType.ChainIds:
+            assertStruct(value, ChainIdsStruct);
+            break;
+        case SnapCaveatType.LookupMatchers:
+            assertStruct(value, LookupMatchersStruct);
+            break;
+        default:
+            throw 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.
+ */
+export function getNameLookupCaveatMapper(value) {
+    if (!value || !isObject(value) || Object.keys(value).length === 0) {
+        return { caveats: null };
+    }
+    const caveats = [];
+    if (value.chains) {
+        caveats.push({
+            type: SnapCaveatType.ChainIds,
+            value: value.chains,
+        });
+    }
+    if (value.matchers) {
+        caveats.push({
+            type: SnapCaveatType.LookupMatchers,
+            value: value.matchers,
+        });
+    }
+    assert(caveats.length > 0);
+    return { caveats: caveats };
+}
+/**
+ * Getter function to get the chainIds caveat from a permission.
+ *
+ * This does basic validation of the caveat, but does not validate the type or
+ * value of the namespaces object itself, as this is handled by the
+ * `PermissionsController` when the permission is requested.
+ *
+ * @param permission - The permission to get the `chainIds` caveat from.
+ * @returns An array of `chainIds` that the snap supports.
+ */
+export function getChainIdsCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    const caveat = permission.caveats.find((permCaveat) => permCaveat.type === SnapCaveatType.ChainIds);
+    return caveat ? caveat.value : null;
+}
+/**
+ * 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.
+ */
+export function getLookupMatchersCaveat(permission) {
+    if (!permission?.caveats) {
+        return null;
+    }
+    const caveat = permission.caveats.find((permCaveat) => permCaveat.type === SnapCaveatType.LookupMatchers);
+    return caveat ? caveat.value : null;
+}
+export const nameLookupCaveatSpecifications = {
+    [SnapCaveatType.ChainIds]: Object.freeze({
+        type: SnapCaveatType.ChainIds,
+        validator: (caveat) => validateCaveat(caveat),
+    }),
+    [SnapCaveatType.LookupMatchers]: Object.freeze({
+        type: SnapCaveatType.LookupMatchers,
+        validator: (caveat) => validateCaveat(caveat),
+    }),
 };
 //# sourceMappingURL=name-lookup.mjs.map

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

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"name-lookup.mjs","sourceRoot":"","sources":["../../src/endowments/name-lookup.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAC9E,OAAO,EAAE,SAAS,EAAE,6BAA6B;AACjD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,cAAc,EACf,8BAA8B;AAE/B,OAAO,EACL,MAAM,EACN,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,aAAa,EACd,wBAAwB;AAEzB,OAAO,EAAE,gCAAgC,EAAE,4BAAkB;AAC7D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,MAAM,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;AAUjD;;;;;;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,QAAQ;YACvB,cAAc,CAAC,cAAc;YAC7B,cAAc,CAAC,cAAc;SAC9B;QACD,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,SAAS,EAAE,gCAAgC,CAAC;YAC1C,EAAE,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;YACjD,EAAE,IAAI,EAAE,cAAc,CAAC,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;YACvD,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,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,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,MAAM,SAAS,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,cAAc,CAAC,QAAQ;YAC1B,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;YACpC,MAAM;QACR,KAAK,cAAc,CAAC,cAAc;YAChC,YAAY,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;YAC1C,MAAM;QACR;YACE,MAAM,SAAS,CAAC,aAAa,CAAC;gBAC5B,OAAO,EACL,4EAA4E;aAC/E,CAAC,CAAC;IACP,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,KAAW;IAEX,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,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,cAAc,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,cAAc,CAAC,cAAc;YACnC,KAAK,EAAE,KAAK,CAAC,QAAQ;SACtB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE3B,OAAO,EAAE,OAAO,EAAE,OAA0C,EAAE,CAAC;AACjE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,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,cAAc,CAAC,QAAQ,CACpB,CAAC;IAE1C,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACtC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,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,cAAc,CAAC,cAAc,CACV,CAAC;IAE1D,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AACtC,CAAC;AAED,MAAM,CAAC,MAAM,8BAA8B,GAGvC;IACF,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACvC,IAAI,EAAE,cAAc,CAAC,QAAQ;QAC7B,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC;KACnE,CAAC;IACF,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QAC7C,IAAI,EAAE,cAAc,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/endowments/network-access.cjs

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

package/dist/endowments/network-access.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-access.cjs","sourceRoot":"","sources":["../../src/endowments/network-access.ts"],"names":[],"mappings":";;;AAKA,2EAA8E;AAE9E,qCAAwC;AAExC,MAAM,cAAc,GAAG,qBAAc,CAAC,aAAa,CAAC;AAWpD;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAE,EAAE;IAC5B,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE;YAC1D,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,YAAY,EAAE,CAAC,mCAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,6BAA6B,GAAG,MAAM,CAAC,MAAM,CAAC;IACzD,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC","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"]}

package/dist/{types/endowments/network-access.d.ts → endowments/network-access.d.cts}

@@ -1,6 +1,6 @@
-import type { PermissionSpecificationBuilder } from '@metamask/permission-controller';
-import { PermissionType } from '@metamask/permission-controller';
-import { SnapEndowments } from './enum';
+import type { PermissionSpecificationBuilder } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import { SnapEndowments } from "./enum.cjs";
 declare const permissionName = SnapEndowments.NetworkAccess;
 export declare const networkAccessEndowmentBuilder: Readonly<{
     readonly targetName: SnapEndowments.NetworkAccess;
@@ -12,3 +12,4 @@ export declare const networkAccessEndowmentBuilder: Readonly<{
     }>;
 }>;
 export {};
+//# sourceMappingURL=network-access.d.cts.map

package/dist/endowments/network-access.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-access.d.cts","sourceRoot":"","sources":["../../src/endowments/network-access.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,8BAA8B,EAE/B,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,+BAA+B,CAAC;AAmCpD,eAAO,MAAM,6BAA6B;;;wBAhCxB,eAAe,SAAS;oBAC5B,qBAAqB;qCAEpB,GAAG,KACX,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC;wBAChC,IAAI;;EA8BX,CAAC"}

package/dist/endowments/network-access.d.mts

@@ -0,0 +1,15 @@
+import type { PermissionSpecificationBuilder } from "@metamask/permission-controller";
+import { PermissionType } from "@metamask/permission-controller";
+import { SnapEndowments } from "./enum.mjs";
+declare const permissionName = SnapEndowments.NetworkAccess;
+export declare const networkAccessEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.NetworkAccess;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, any, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof permissionName;
+        endowmentGetter: (_options?: any) => ['fetch', 'Request', 'Headers', 'Response'];
+        allowedCaveats: null;
+    }>;
+}>;
+export {};
+//# sourceMappingURL=network-access.d.mts.map

package/dist/endowments/network-access.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-access.d.mts","sourceRoot":"","sources":["../../src/endowments/network-access.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,8BAA8B,EAE/B,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAe,wCAAwC;AAE9E,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,cAAc,+BAA+B,CAAC;AAmCpD,eAAO,MAAM,6BAA6B;;;wBAhCxB,eAAe,SAAS;oBAC5B,qBAAqB;qCAEpB,GAAG,KACX,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC;wBAChC,IAAI;;EA8BX,CAAC"}

package/dist/endowments/network-access.mjs

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

package/dist/endowments/network-access.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"network-access.mjs","sourceRoot":"","sources":["../../src/endowments/network-access.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAE9E,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,MAAM,cAAc,GAAG,cAAc,CAAC,aAAa,CAAC;AAWpD;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAE,EAAE;IAC5B,OAAO;QACL,cAAc,EAAE,cAAc,CAAC,SAAS;QACxC,UAAU,EAAE,cAAc;QAC1B,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE;YAC1D,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,YAAY,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC,MAAM,CAAC;IACzD,UAAU,EAAE,cAAc;IAC1B,oBAAoB;CACZ,CAAC,CAAC","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"]}

package/dist/endowments/rpc.cjs

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rpcCaveatSpecifications = exports.getRpcCaveatOrigins = exports.getRpcCaveatMapper = exports.rpcEndowmentBuilder = 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 targetName = enum_1.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: permission_controller_1.PermissionType.Endowment,
+        targetName,
+        allowedCaveats: [snaps_utils_1.SnapCaveatType.RpcOrigin, snaps_utils_1.SnapCaveatType.MaxRequestTime],
+        endowmentGetter: (_getterOptions) => null,
+        validator: (0, caveats_1.createGenericPermissionValidator)([
+            { type: snaps_utils_1.SnapCaveatType.RpcOrigin },
+            { type: snaps_utils_1.SnapCaveatType.MaxRequestTime, optional: true },
+        ]),
+        subjectTypes: [permission_controller_1.SubjectType.Snap],
+    };
+};
+exports.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_1.hasProperty)(caveat, 'value') || !(0, utils_1.isPlainObject)(caveat.value)) {
+        throw rpc_errors_1.rpcErrors.invalidParams({
+            message: 'Invalid JSON-RPC origins: Expected a plain object.',
+        });
+    }
+    const { value } = caveat;
+    (0, snaps_utils_1.assertIsRpcOrigins)(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 getRpcCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: snaps_utils_1.SnapCaveatType.RpcOrigin,
+                value,
+            },
+        ],
+    };
+}
+exports.getRpcCaveatMapper = getRpcCaveatMapper;
+/**
+ * Getter function to get the {@link RpcOrigins} caveat value from a permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link RpcOrigins} caveat.
+ */
+function getRpcCaveatOrigins(permission) {
+    const caveats = permission?.caveats?.filter((caveat) => caveat.type === snaps_utils_1.SnapCaveatType.RpcOrigin);
+    (0, utils_1.assert)(caveats);
+    (0, utils_1.assert)(caveats.length === 1);
+    const caveat = caveats[0];
+    return caveat.value;
+}
+exports.getRpcCaveatOrigins = getRpcCaveatOrigins;
+exports.rpcCaveatSpecifications = {
+    [snaps_utils_1.SnapCaveatType.RpcOrigin]: Object.freeze({
+        type: snaps_utils_1.SnapCaveatType.RpcOrigin,
+        validator: (caveat) => validateCaveatOrigins(caveat),
+    }),
+};
+//# sourceMappingURL=rpc.cjs.map

package/dist/endowments/rpc.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.cjs","sourceRoot":"","sources":["../../src/endowments/rpc.ts"],"names":[],"mappings":";;;AASA,2EAA8E;AAC9E,qDAAiD;AAEjD,uDAA2E;AAE3E,2CAAqE;AAErE,iDAA6D;AAC7D,qCAAwC;AAExC,MAAM,UAAU,GAAG,qBAAc,CAAC,GAAG,CAAC;AAetC;;;;;GAKG;AACH,MAAM,oBAAoB,GAItB,CAAC,eAAqB,EAAoB,EAAE;IAC9C,OAAO;QACL,cAAc,EAAE,sCAAc,CAAC,SAAS;QACxC,UAAU;QACV,cAAc,EAAE,CAAC,4BAAc,CAAC,SAAS,EAAE,4BAAc,CAAC,cAAc,CAAC;QACzE,eAAe,EAAE,CAAC,cAAsC,EAAE,EAAE,CAAC,IAAI;QACjE,SAAS,EAAE,IAAA,0CAAgC,EAAC;YAC1C,EAAE,IAAI,EAAE,4BAAc,CAAC,SAAS,EAAE;YAClC,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,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,UAAU;IACV,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,oDAAoD;SAC9D,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,IAAA,gCAAkB,EAAC,KAAK,EAAE,sBAAS,CAAC,aAAa,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,KAAW;IAEX,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,4BAAc,CAAC,SAAS;gBAC9B,KAAK;aACN;SACF;KACF,CAAC;AACJ,CAAC;AAXD,gDAWC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,UAAiC;IAEjC,MAAM,OAAO,GAAG,UAAU,EAAE,OAAO,EAAE,MAAM,CACzC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,4BAAc,CAAC,SAAS,CACrD,CAAC;IACF,IAAA,cAAM,EAAC,OAAO,CAAC,CAAC;IAChB,IAAA,cAAM,EAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAE7B,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAA+B,CAAC;IACxD,OAAO,MAAM,CAAC,KAAK,CAAC;AACtB,CAAC;AAXD,kDAWC;AAEY,QAAA,uBAAuB,GAGhC;IACF,CAAC,4BAAc,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;QACxC,IAAI,EAAE,4BAAc,CAAC,SAAS;QAC9B,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 { 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) => null;\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) => null,\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"]}

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

@@ -1,11 +1,11 @@
-import type { CaveatSpecificationConstraint, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from '@metamask/permission-controller';
-import { PermissionType, SubjectType } from '@metamask/permission-controller';
-import type { RpcOrigins } from '@metamask/snaps-utils';
-import { SnapCaveatType } from '@metamask/snaps-utils';
-import type { Json, NonEmptyArray } from '@metamask/utils';
-import { SnapEndowments } from './enum';
+import type { CaveatSpecificationConstraint, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from "@metamask/permission-controller";
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import type { RpcOrigins } from "@metamask/snaps-utils";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.cjs";
 declare const targetName = SnapEndowments.Rpc;
-declare type RpcSpecificationBuilderOptions = {};
+type RpcSpecificationBuilderOptions = {};
 export declare const rpcEndowmentBuilder: Readonly<{
     readonly targetName: SnapEndowments.Rpc;
     readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, RpcSpecificationBuilderOptions, {
@@ -36,3 +36,4 @@ export declare function getRpcCaveatMapper(value: Json): Pick<PermissionConstrai
 export declare function getRpcCaveatOrigins(permission?: PermissionConstraint): RpcOrigins | null;
 export declare const rpcCaveatSpecifications: Record<SnapCaveatType.RpcOrigin, CaveatSpecificationConstraint>;
 export {};
+//# sourceMappingURL=rpc.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.d.cts","sourceRoot":"","sources":["../../src/endowments/rpc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,6BAA6B,EAE7B,oBAAoB,EACpB,8BAA8B,EAC9B,6BAA6B,EAE9B,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,UAAU,EAAE,8BAA8B;AACxD,OAAO,EAAsB,cAAc,EAAE,8BAA8B;AAC3E,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAI3D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,UAAU,qBAAqB,CAAC;AAWtC,KAAK,8BAA8B,GAAG,EAErC,CAAC;AA0BF,eAAO,MAAM,mBAAmB;;;wBApCd,eAAe,SAAS;oBAC5B,iBAAiB;qCACA,GAAG,KAAK,IAAI;wBACzB,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;sBAC1B,SAAS,WAAW,EAAE;;EAkC3B,CAAC;AAoBZ;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CASvC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,CAAC,EAAE,oBAAoB,GAChC,UAAU,GAAG,IAAI,CASnB;AAED,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAC1C,cAAc,CAAC,SAAS,EACxB,6BAA6B,CAM9B,CAAC"}

package/dist/endowments/rpc.d.mts

@@ -0,0 +1,39 @@
+import type { CaveatSpecificationConstraint, PermissionConstraint, PermissionSpecificationBuilder, PermissionValidatorConstraint } from "@metamask/permission-controller";
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import type { RpcOrigins } from "@metamask/snaps-utils";
+import { SnapCaveatType } from "@metamask/snaps-utils";
+import type { Json, NonEmptyArray } from "@metamask/utils";
+import { SnapEndowments } from "./enum.mjs";
+declare const targetName = SnapEndowments.Rpc;
+type RpcSpecificationBuilderOptions = {};
+export declare const rpcEndowmentBuilder: Readonly<{
+    readonly targetName: SnapEndowments.Rpc;
+    readonly specificationBuilder: PermissionSpecificationBuilder<PermissionType.Endowment, RpcSpecificationBuilderOptions, {
+        permissionType: PermissionType.Endowment;
+        targetName: typeof targetName;
+        endowmentGetter: (_options?: any) => 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 getRpcCaveatMapper(value: Json): Pick<PermissionConstraint, 'caveats'>;
+/**
+ * Getter function to get the {@link RpcOrigins} caveat value from a permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link RpcOrigins} caveat.
+ */
+export declare function getRpcCaveatOrigins(permission?: PermissionConstraint): RpcOrigins | null;
+export declare const rpcCaveatSpecifications: Record<SnapCaveatType.RpcOrigin, CaveatSpecificationConstraint>;
+export {};
+//# sourceMappingURL=rpc.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.d.mts","sourceRoot":"","sources":["../../src/endowments/rpc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,6BAA6B,EAE7B,oBAAoB,EACpB,8BAA8B,EAC9B,6BAA6B,EAE9B,wCAAwC;AACzC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,wCAAwC;AAE9E,OAAO,KAAK,EAAE,UAAU,EAAE,8BAA8B;AACxD,OAAO,EAAsB,cAAc,EAAE,8BAA8B;AAC3E,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAI3D,OAAO,EAAE,cAAc,EAAE,mBAAe;AAExC,QAAA,MAAM,UAAU,qBAAqB,CAAC;AAWtC,KAAK,8BAA8B,GAAG,EAErC,CAAC;AA0BF,eAAO,MAAM,mBAAmB;;;wBApCd,eAAe,SAAS;oBAC5B,iBAAiB;qCACA,GAAG,KAAK,IAAI;wBACzB,SAAS,cAAc,MAAM,CAAC,CAAC,GAAG,IAAI;mBAC3C,6BAA6B;sBAC1B,SAAS,WAAW,EAAE;;EAkC3B,CAAC;AAoBZ;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,IAAI,GACV,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,CASvC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,CAAC,EAAE,oBAAoB,GAChC,UAAU,GAAG,IAAI,CASnB;AAED,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAC1C,cAAc,CAAC,SAAS,EACxB,6BAA6B,CAM9B,CAAC"}

package/dist/endowments/rpc.mjs

@@ -1,17 +1,85 @@
-import {
-  getRpcCaveatMapper,
-  getRpcCaveatOrigins,
-  rpcCaveatSpecifications,
-  rpcEndowmentBuilder
-} from "../chunk-57BL7O2P.mjs";
-import "../chunk-TG63GBK3.mjs";
-import "../chunk-TT4DP2YW.mjs";
-import "../chunk-23XDKQW2.mjs";
-import "../chunk-CD4OUHO5.mjs";
-export {
-  getRpcCaveatMapper,
-  getRpcCaveatOrigins,
-  rpcCaveatSpecifications,
-  rpcEndowmentBuilder
+import { PermissionType, SubjectType } from "@metamask/permission-controller";
+import { rpcErrors } from "@metamask/rpc-errors";
+import { assertIsRpcOrigins, SnapCaveatType } from "@metamask/snaps-utils";
+import { hasProperty, isPlainObject, assert } from "@metamask/utils";
+import { createGenericPermissionValidator } from "./caveats/index.mjs";
+import { SnapEndowments } from "./enum.mjs";
+const targetName = SnapEndowments.Rpc;
+/**
+ * The specification builder for the JSON-RPC endowment permission.
+ *
+ * @param _builderOptions - Optional specification builder options.
+ * @returns The specification for the JSON-RPC endowment permission.
+ */
+const specificationBuilder = (_builderOptions) => {
+    return {
+        permissionType: PermissionType.Endowment,
+        targetName,
+        allowedCaveats: [SnapCaveatType.RpcOrigin, SnapCaveatType.MaxRequestTime],
+        endowmentGetter: (_getterOptions) => null,
+        validator: createGenericPermissionValidator([
+            { type: SnapCaveatType.RpcOrigin },
+            { type: SnapCaveatType.MaxRequestTime, optional: true },
+        ]),
+        subjectTypes: [SubjectType.Snap],
+    };
+};
+export const rpcEndowmentBuilder = Object.freeze({
+    targetName,
+    specificationBuilder,
+});
+/**
+ * Validate the value of a caveat. This does not validate the type of the
+ * caveat itself, only the value of the caveat.
+ *
+ * @param caveat - The caveat to validate.
+ * @throws If the caveat value is invalid.
+ */
+function validateCaveatOrigins(caveat) {
+    if (!hasProperty(caveat, 'value') || !isPlainObject(caveat.value)) {
+        throw rpcErrors.invalidParams({
+            message: 'Invalid JSON-RPC origins: Expected a plain object.',
+        });
+    }
+    const { value } = caveat;
+    assertIsRpcOrigins(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 getRpcCaveatMapper(value) {
+    return {
+        caveats: [
+            {
+                type: SnapCaveatType.RpcOrigin,
+                value,
+            },
+        ],
+    };
+}
+/**
+ * Getter function to get the {@link RpcOrigins} caveat value from a permission.
+ *
+ * @param permission - The permission to get the caveat value from.
+ * @returns The caveat value.
+ * @throws If the permission does not have a valid {@link RpcOrigins} caveat.
+ */
+export function getRpcCaveatOrigins(permission) {
+    const caveats = permission?.caveats?.filter((caveat) => caveat.type === SnapCaveatType.RpcOrigin);
+    assert(caveats);
+    assert(caveats.length === 1);
+    const caveat = caveats[0];
+    return caveat.value;
+}
+export const rpcCaveatSpecifications = {
+    [SnapCaveatType.RpcOrigin]: Object.freeze({
+        type: SnapCaveatType.RpcOrigin,
+        validator: (caveat) => validateCaveatOrigins(caveat),
+    }),
 };
 //# sourceMappingURL=rpc.mjs.map