@metamask/snaps-utils 8.0.1 → 8.1.0

package/dist/mock.cjs

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMockEndowments = exports.isConstructor = exports.ALL_APIS = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const events_1 = __importDefault(require("events"));
+const default_endowments_1 = require("./default-endowments.cjs");
+const NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];
+exports.ALL_APIS = [
+    ...default_endowments_1.DEFAULT_ENDOWMENTS,
+    ...NETWORK_APIS,
+    'WebAssembly',
+];
+/**
+ * Get a mock snap API, that always returns `true` for requests.
+ *
+ * @returns A mocked snap provider.
+ */
+function getMockSnapGlobal() {
+    // eslint-disable-next-line @typescript-eslint/require-await
+    return { request: async () => true };
+}
+/**
+ * Get a mock Ethereum provider, that always returns `true` for requests.
+ *
+ * @returns A mocked ethereum provider.
+ */
+function getMockEthereumProvider() {
+    const mockProvider = new events_1.default();
+    // eslint-disable-next-line @typescript-eslint/require-await
+    mockProvider.request = async () => true;
+    return mockProvider;
+}
+/**
+ * Check if a value is a constructor.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a constructor, or `false` otherwise.
+ */
+const isConstructor = (value) => Boolean(typeof value?.prototype?.constructor?.name === 'string');
+exports.isConstructor = isConstructor;
+/**
+ * A function that always returns `true`.
+ *
+ * @returns `true`.
+ */
+const mockFunction = () => true;
+class MockClass {
+}
+const handler = {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    construct(Target, args) {
+        return new Proxy(new Target(...args), handler);
+    },
+    get(_target, _prop) {
+        return mockFunction;
+    },
+};
+/**
+ * Generate a mock class for a given value. The value is wrapped in a Proxy, and
+ * all methods are replaced with a mock function.
+ *
+ * @param value - The value to mock.
+ * @returns A mock class.
+ */
+const generateMockClass = (value) => {
+    return new Proxy(value, handler);
+};
+// Things not currently auto-mocked because of NodeJS, by adding them here we
+// have types for them and can use that to generate mocks if needed.
+const mockWindow = {
+    crypto: crypto_1.default,
+    SubtleCrypto: MockClass,
+};
+/**
+ * Generate a mock endowment for a certain class or function on the `globalThis`
+ * object.
+ *
+ * @param key - The key to generate the mock endowment for.
+ * @returns A mocked class or function. If the key is part of the default
+ * endowments, the original value is returned.
+ */
+const generateMockEndowment = (key) => {
+    const globalValue = globalThis[key];
+    // Default exposed APIs don't need to be mocked
+    if (globalValue && default_endowments_1.DEFAULT_ENDOWMENTS.includes(key)) {
+        return globalValue;
+    }
+    // Fall back to mockWindow for certain APIs not exposed in global in Node.JS
+    const globalOrMocked = globalValue ?? mockWindow[key];
+    const type = typeof globalOrMocked;
+    const isFunction = type === 'function';
+    if (isFunction && (0, exports.isConstructor)(globalOrMocked)) {
+        return generateMockClass(globalOrMocked);
+    }
+    else if (isFunction || !globalOrMocked) {
+        // Fall back to function mock for now
+        return mockFunction;
+    }
+    return globalOrMocked;
+};
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
+const generateMockEndowments = () => {
+    return exports.ALL_APIS.reduce((acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }), { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() });
+};
+exports.generateMockEndowments = generateMockEndowments;
+//# sourceMappingURL=mock.cjs.map

package/dist/mock.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.cjs","sourceRoot":"","sources":["../src/mock.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,oDAAkC;AAElC,iEAA0D;AAE1D,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAEpD,QAAA,QAAQ,GAAa;IAChC,GAAG,uCAAkB;IACrB,GAAG,YAAY;IACf,aAAa;CACd,CAAC;AAUF;;;;GAIG;AACH,SAAS,iBAAiB;IACxB,4DAA4D;IAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB;IAC9B,MAAM,YAAY,GAAG,IAAI,gBAAY,EAAmC,CAAC;IACzE,4DAA4D;IAC5D,YAAY,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;IACxC,OAAO,YAAoC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CAC1C,OAAO,CAAC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC;AADtD,QAAA,aAAa,iBACyC;AAEnE;;;;GAIG;AACH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAChC,MAAM,SAAS;CAAG;AAElB,MAAM,OAAO,GAAG;IACd,gEAAgE;IAChE,SAAS,CAAC,MAAW,EAAE,IAAW;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,OAAY,EAAE,KAAU;QAC1B,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE;IACvC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,6EAA6E;AAC7E,oEAAoE;AACpE,MAAM,UAAU,GAA4B;IAC1C,MAAM,EAAN,gBAAM;IACN,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,WAAW,GAAI,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE7C,+CAA+C;IAC/C,IAAI,WAAW,IAAI,uCAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,WAAW,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAEtD,MAAM,IAAI,GAAG,OAAO,cAAc,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,KAAK,UAAU,CAAC;IACvC,IAAI,UAAU,IAAI,IAAA,qBAAa,EAAC,cAAc,CAAC,EAAE,CAAC;QAChD,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;SAAM,IAAI,UAAU,IAAI,CAAC,cAAc,EAAE,CAAC;QACzC,qCAAqC;QACrC,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF;;;;GAIG;AACI,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,OAAO,gBAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAC7D,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,QAAQ,EAAE,uBAAuB,EAAE,EAAE,CACnE,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,sBAAsB,0BAKjC","sourcesContent":["import crypto from 'crypto';\nimport EventEmitter from 'events';\n\nimport { DEFAULT_ENDOWMENTS } from './default-endowments';\n\nconst NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];\n\nexport const ALL_APIS: string[] = [\n  ...DEFAULT_ENDOWMENTS,\n  ...NETWORK_APIS,\n  'WebAssembly',\n];\n\ntype MockSnapGlobal = {\n  request: () => Promise<any>;\n};\n\ntype MockEthereumProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap API, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapGlobal(): MockSnapGlobal {\n  // eslint-disable-next-line @typescript-eslint/require-await\n  return { request: async () => true };\n}\n\n/**\n * Get a mock Ethereum provider, that always returns `true` for requests.\n *\n * @returns A mocked ethereum provider.\n */\nfunction getMockEthereumProvider(): MockEthereumProvider {\n  const mockProvider = new EventEmitter() as Partial<MockEthereumProvider>;\n  // eslint-disable-next-line @typescript-eslint/require-await\n  mockProvider.request = async () => true;\n  return mockProvider as MockEthereumProvider;\n}\n\n/**\n * Check if a value is a constructor.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a constructor, or `false` otherwise.\n */\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\n/**\n * A function that always returns `true`.\n *\n * @returns `true`.\n */\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\n/**\n * Generate a mock class for a given value. The value is wrapped in a Proxy, and\n * all methods are replaced with a mock function.\n *\n * @param value - The value to mock.\n * @returns A mock class.\n */\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we\n// have types for them and can use that to generate mocks if needed.\nconst mockWindow: Record<string, unknown> = {\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\n/**\n * Generate a mock endowment for a certain class or function on the `globalThis`\n * object.\n *\n * @param key - The key to generate the mock endowment for.\n * @returns A mocked class or function. If the key is part of the default\n * endowments, the original value is returned.\n */\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? mockWindow[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\n/**\n * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.\n *\n * @returns A map of endowments.\n */\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() },\n  );\n};\n"]}

package/dist/mock.d.cts

@@ -0,0 +1,15 @@
+export declare const ALL_APIS: string[];
+/**
+ * Check if a value is a constructor.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a constructor, or `false` otherwise.
+ */
+export declare const isConstructor: (value: any) => boolean;
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
+export declare const generateMockEndowments: () => Record<string, any>;
+//# sourceMappingURL=mock.d.cts.map

package/dist/mock.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.d.cts","sourceRoot":"","sources":["../src/mock.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ,EAAE,MAAM,EAI5B,CAAC;AAgCF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,UAAW,GAAG,YAC0B,CAAC;AAoEnE;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,2BAKlC,CAAC"}

package/dist/mock.d.mts

@@ -0,0 +1,15 @@
+export declare const ALL_APIS: string[];
+/**
+ * Check if a value is a constructor.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a constructor, or `false` otherwise.
+ */
+export declare const isConstructor: (value: any) => boolean;
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
+export declare const generateMockEndowments: () => Record<string, any>;
+//# sourceMappingURL=mock.d.mts.map

package/dist/mock.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock.d.mts","sourceRoot":"","sources":["../src/mock.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ,EAAE,MAAM,EAI5B,CAAC;AAgCF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,UAAW,GAAG,YAC0B,CAAC;AAoEnE;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,2BAKlC,CAAC"}

package/dist/mock.mjs

@@ -1,13 +1,105 @@
-import {
-  ALL_APIS,
-  generateMockEndowments,
-  isConstructor
-} from "./chunk-63OXILAY.mjs";
-import "./chunk-BGSO2GQC.mjs";
-import "./chunk-3RUWAMJT.mjs";
-export {
-  ALL_APIS,
-  generateMockEndowments,
-  isConstructor
+import crypto from "crypto";
+import EventEmitter from "events";
+import { DEFAULT_ENDOWMENTS } from "./default-endowments.mjs";
+const NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];
+export const ALL_APIS = [
+    ...DEFAULT_ENDOWMENTS,
+    ...NETWORK_APIS,
+    'WebAssembly',
+];
+/**
+ * Get a mock snap API, that always returns `true` for requests.
+ *
+ * @returns A mocked snap provider.
+ */
+function getMockSnapGlobal() {
+    // eslint-disable-next-line @typescript-eslint/require-await
+    return { request: async () => true };
+}
+/**
+ * Get a mock Ethereum provider, that always returns `true` for requests.
+ *
+ * @returns A mocked ethereum provider.
+ */
+function getMockEthereumProvider() {
+    const mockProvider = new EventEmitter();
+    // eslint-disable-next-line @typescript-eslint/require-await
+    mockProvider.request = async () => true;
+    return mockProvider;
+}
+/**
+ * Check if a value is a constructor.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a constructor, or `false` otherwise.
+ */
+export const isConstructor = (value) => Boolean(typeof value?.prototype?.constructor?.name === 'string');
+/**
+ * A function that always returns `true`.
+ *
+ * @returns `true`.
+ */
+const mockFunction = () => true;
+class MockClass {
+}
+const handler = {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    construct(Target, args) {
+        return new Proxy(new Target(...args), handler);
+    },
+    get(_target, _prop) {
+        return mockFunction;
+    },
+};
+/**
+ * Generate a mock class for a given value. The value is wrapped in a Proxy, and
+ * all methods are replaced with a mock function.
+ *
+ * @param value - The value to mock.
+ * @returns A mock class.
+ */
+const generateMockClass = (value) => {
+    return new Proxy(value, handler);
+};
+// Things not currently auto-mocked because of NodeJS, by adding them here we
+// have types for them and can use that to generate mocks if needed.
+const mockWindow = {
+    crypto,
+    SubtleCrypto: MockClass,
+};
+/**
+ * Generate a mock endowment for a certain class or function on the `globalThis`
+ * object.
+ *
+ * @param key - The key to generate the mock endowment for.
+ * @returns A mocked class or function. If the key is part of the default
+ * endowments, the original value is returned.
+ */
+const generateMockEndowment = (key) => {
+    const globalValue = globalThis[key];
+    // Default exposed APIs don't need to be mocked
+    if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {
+        return globalValue;
+    }
+    // Fall back to mockWindow for certain APIs not exposed in global in Node.JS
+    const globalOrMocked = globalValue ?? mockWindow[key];
+    const type = typeof globalOrMocked;
+    const isFunction = type === 'function';
+    if (isFunction && isConstructor(globalOrMocked)) {
+        return generateMockClass(globalOrMocked);
+    }
+    else if (isFunction || !globalOrMocked) {
+        // Fall back to function mock for now
+        return mockFunction;
+    }
+    return globalOrMocked;
+};
+/**
+ * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.
+ *
+ * @returns A map of endowments.
+ */
+export const generateMockEndowments = () => {
+    return ALL_APIS.reduce((acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }), { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() });
 };
 //# sourceMappingURL=mock.mjs.map

package/dist/mock.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"mock.mjs","sourceRoot":"","sources":["../src/mock.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,eAAe;AAC5B,OAAO,YAAY,eAAe;AAElC,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAE1D,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAEjE,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,GAAG,kBAAkB;IACrB,GAAG,YAAY;IACf,aAAa;CACd,CAAC;AAUF;;;;GAIG;AACH,SAAS,iBAAiB;IACxB,4DAA4D;IAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB;IAC9B,MAAM,YAAY,GAAG,IAAI,YAAY,EAAmC,CAAC;IACzE,4DAA4D;IAC5D,YAAY,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC;IACxC,OAAO,YAAoC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CAC1C,OAAO,CAAC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC;AAEnE;;;;GAIG;AACH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAChC,MAAM,SAAS;CAAG;AAElB,MAAM,OAAO,GAAG;IACd,gEAAgE;IAChE,SAAS,CAAC,MAAW,EAAE,IAAW;QAChC,OAAO,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,GAAG,CAAC,OAAY,EAAE,KAAU;QAC1B,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAU,EAAE,EAAE;IACvC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,6EAA6E;AAC7E,oEAAoE;AACpE,MAAM,UAAU,GAA4B;IAC1C,MAAM;IACN,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IAC5C,MAAM,WAAW,GAAI,UAAkB,CAAC,GAAG,CAAC,CAAC;IAE7C,+CAA+C;IAC/C,IAAI,WAAW,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,WAAW,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAEtD,MAAM,IAAI,GAAG,OAAO,cAAc,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,KAAK,UAAU,CAAC;IACvC,IAAI,UAAU,IAAI,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QAChD,OAAO,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;SAAM,IAAI,UAAU,IAAI,CAAC,cAAc,EAAE,CAAC;QACzC,qCAAqC;QACrC,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAC7D,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,QAAQ,EAAE,uBAAuB,EAAE,EAAE,CACnE,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import crypto from 'crypto';\nimport EventEmitter from 'events';\n\nimport { DEFAULT_ENDOWMENTS } from './default-endowments';\n\nconst NETWORK_APIS = ['fetch', 'Request', 'Headers', 'Response'];\n\nexport const ALL_APIS: string[] = [\n  ...DEFAULT_ENDOWMENTS,\n  ...NETWORK_APIS,\n  'WebAssembly',\n];\n\ntype MockSnapGlobal = {\n  request: () => Promise<any>;\n};\n\ntype MockEthereumProvider = EventEmitter & {\n  request: () => Promise<any>;\n};\n\n/**\n * Get a mock snap API, that always returns `true` for requests.\n *\n * @returns A mocked snap provider.\n */\nfunction getMockSnapGlobal(): MockSnapGlobal {\n  // eslint-disable-next-line @typescript-eslint/require-await\n  return { request: async () => true };\n}\n\n/**\n * Get a mock Ethereum provider, that always returns `true` for requests.\n *\n * @returns A mocked ethereum provider.\n */\nfunction getMockEthereumProvider(): MockEthereumProvider {\n  const mockProvider = new EventEmitter() as Partial<MockEthereumProvider>;\n  // eslint-disable-next-line @typescript-eslint/require-await\n  mockProvider.request = async () => true;\n  return mockProvider as MockEthereumProvider;\n}\n\n/**\n * Check if a value is a constructor.\n *\n * @param value - The value to check.\n * @returns `true` if the value is a constructor, or `false` otherwise.\n */\nexport const isConstructor = (value: any) =>\n  Boolean(typeof value?.prototype?.constructor?.name === 'string');\n\n/**\n * A function that always returns `true`.\n *\n * @returns `true`.\n */\nconst mockFunction = () => true;\nclass MockClass {}\n\nconst handler = {\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  construct(Target: any, args: any[]): any {\n    return new Proxy(new Target(...args), handler);\n  },\n  get(_target: any, _prop: any) {\n    return mockFunction;\n  },\n};\n\n/**\n * Generate a mock class for a given value. The value is wrapped in a Proxy, and\n * all methods are replaced with a mock function.\n *\n * @param value - The value to mock.\n * @returns A mock class.\n */\nconst generateMockClass = (value: any) => {\n  return new Proxy(value, handler);\n};\n\n// Things not currently auto-mocked because of NodeJS, by adding them here we\n// have types for them and can use that to generate mocks if needed.\nconst mockWindow: Record<string, unknown> = {\n  crypto,\n  SubtleCrypto: MockClass,\n};\n\n/**\n * Generate a mock endowment for a certain class or function on the `globalThis`\n * object.\n *\n * @param key - The key to generate the mock endowment for.\n * @returns A mocked class or function. If the key is part of the default\n * endowments, the original value is returned.\n */\nconst generateMockEndowment = (key: string) => {\n  const globalValue = (globalThis as any)[key];\n\n  // Default exposed APIs don't need to be mocked\n  if (globalValue && DEFAULT_ENDOWMENTS.includes(key)) {\n    return globalValue;\n  }\n\n  // Fall back to mockWindow for certain APIs not exposed in global in Node.JS\n  const globalOrMocked = globalValue ?? mockWindow[key];\n\n  const type = typeof globalOrMocked;\n  const isFunction = type === 'function';\n  if (isFunction && isConstructor(globalOrMocked)) {\n    return generateMockClass(globalOrMocked);\n  } else if (isFunction || !globalOrMocked) {\n    // Fall back to function mock for now\n    return mockFunction;\n  }\n  return globalOrMocked;\n};\n\n/**\n * Generate mock endowments for all the APIs as defined in {@link ALL_APIS}.\n *\n * @returns A map of endowments.\n */\nexport const generateMockEndowments = () => {\n  return ALL_APIS.reduce<Record<string, any>>(\n    (acc, cur) => ({ ...acc, [cur]: generateMockEndowment(cur) }),\n    { snap: getMockSnapGlobal(), ethereum: getMockEthereumProvider() },\n  );\n};\n"]}

package/dist/namespace.cjs

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNamespace = exports.isAccountIdArray = exports.isAccountId = exports.isChainId = exports.isNamespaceId = exports.NamespaceIdStruct = exports.NamespaceStruct = exports.ChainStruct = exports.AccountAddressStruct = exports.AccountIdArrayStruct = exports.AccountIdStruct = exports.ChainIdStruct = exports.ChainIdStringStruct = exports.LimitedString = exports.parseAccountId = exports.parseChainId = exports.ACCOUNT_ADDRESS_REGEX = exports.ACCOUNT_ID_REGEX = exports.CHAIN_ID_REGEX = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+exports.CHAIN_ID_REGEX = /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u;
+exports.ACCOUNT_ID_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;
+exports.ACCOUNT_ADDRESS_REGEX = /^(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;
+/**
+ * Parse a chain ID string to an object containing the namespace and reference.
+ * This validates the chain ID before parsing it.
+ *
+ * @param chainId - The chain ID to validate and parse.
+ * @returns The parsed chain ID.
+ */
+function parseChainId(chainId) {
+    const match = exports.CHAIN_ID_REGEX.exec(chainId);
+    if (!match?.groups) {
+        throw new Error('Invalid chain ID.');
+    }
+    return {
+        namespace: match.groups.namespace,
+        reference: match.groups.reference,
+    };
+}
+exports.parseChainId = parseChainId;
+/**
+ * Parse an account ID to an object containing the chain, chain ID and address.
+ * This validates the account ID before parsing it.
+ *
+ * @param accountId - The account ID to validate and parse.
+ * @returns The parsed account ID.
+ */
+function parseAccountId(accountId) {
+    const match = exports.ACCOUNT_ID_REGEX.exec(accountId);
+    if (!match?.groups) {
+        throw new Error('Invalid account ID.');
+    }
+    return {
+        address: match.groups.accountAddress,
+        chainId: match.groups.chainId,
+        chain: {
+            namespace: match.groups.namespace,
+            reference: match.groups.reference,
+        },
+    };
+}
+exports.parseAccountId = parseAccountId;
+/**
+ * A helper struct for a string with a minimum length of 1 and a maximum length
+ * of 40.
+ */
+exports.LimitedString = (0, superstruct_1.size)((0, superstruct_1.string)(), 1, 40);
+exports.ChainIdStringStruct = (0, superstruct_1.define)('Chain ID', (0, superstruct_1.string)().validator);
+/**
+ * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
+ */
+exports.ChainIdStruct = (0, superstruct_1.pattern)(exports.ChainIdStringStruct, exports.CHAIN_ID_REGEX);
+exports.AccountIdStruct = (0, superstruct_1.pattern)((0, superstruct_1.string)(), exports.ACCOUNT_ID_REGEX);
+exports.AccountIdArrayStruct = (0, superstruct_1.array)(exports.AccountIdStruct);
+exports.AccountAddressStruct = (0, superstruct_1.pattern)((0, superstruct_1.string)(), exports.ACCOUNT_ADDRESS_REGEX);
+/**
+ * A chain descriptor.
+ */
+exports.ChainStruct = (0, superstruct_1.object)({
+    id: exports.ChainIdStruct,
+    name: exports.LimitedString,
+});
+exports.NamespaceStruct = (0, superstruct_1.object)({
+    /**
+     * A list of supported chains in the namespace.
+     */
+    chains: (0, superstruct_1.array)(exports.ChainStruct),
+    /**
+     * A list of supported RPC methods on the namespace, that a DApp can call.
+     */
+    methods: (0, superstruct_1.optional)((0, superstruct_1.array)(exports.LimitedString)),
+    /**
+     * A list of supported RPC events on the namespace, that a DApp can listen to.
+     */
+    events: (0, superstruct_1.optional)((0, superstruct_1.array)(exports.LimitedString)),
+});
+/**
+ * A CAIP-2 namespace, i.e., the first part of a chain ID.
+ */
+exports.NamespaceIdStruct = (0, superstruct_1.pattern)((0, superstruct_1.string)(), /^[-a-z0-9]{3,8}$/u);
+/**
+ * Check if the given value is a CAIP-2 namespace ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-2 namespace ID.
+ */
+function isNamespaceId(value) {
+    return (0, superstruct_1.is)(value, exports.NamespaceIdStruct);
+}
+exports.isNamespaceId = isNamespaceId;
+/**
+ * Check if the given value is a CAIP-2 chain ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-2 chain ID.
+ */
+function isChainId(value) {
+    return (0, superstruct_1.is)(value, exports.ChainIdStruct);
+}
+exports.isChainId = isChainId;
+/**
+ * Check if the given value is a CAIP-10 account ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-10 account ID.
+ */
+function isAccountId(value) {
+    return (0, superstruct_1.is)(value, exports.AccountIdStruct);
+}
+exports.isAccountId = isAccountId;
+/**
+ * Check if the given value is an array of CAIP-10 account IDs.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an array of CAIP-10 account IDs.
+ */
+function isAccountIdArray(value) {
+    return (0, superstruct_1.is)(value, exports.AccountIdArrayStruct);
+}
+exports.isAccountIdArray = isAccountIdArray;
+/**
+ * Check if a value is a {@link Namespace}.
+ *
+ * @param value - The value to validate.
+ * @returns True if the value is a valid {@link Namespace}.
+ */
+function isNamespace(value) {
+    return (0, superstruct_1.is)(value, exports.NamespaceStruct);
+}
+exports.isNamespace = isNamespace;
+//# sourceMappingURL=namespace.cjs.map

package/dist/namespace.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"namespace.cjs","sourceRoot":"","sources":["../src/namespace.ts"],"names":[],"mappings":";;;AAEA,uDAS+B;AAIlB,QAAA,cAAc,GACzB,kEAAkE,CAAC;AAExD,QAAA,gBAAgB,GAC3B,mHAAmH,CAAC;AAEzG,QAAA,qBAAqB,GAAG,yCAAyC,CAAC;AAE/E;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,OAAgB;IAI3C,MAAM,KAAK,GAAG,sBAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;QACjC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;KAClC,CAAC;AACJ,CAAC;AAbD,oCAaC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,SAAoB;IAKjD,MAAM,KAAK,GAAG,wBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc;QACpC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,OAAkB;QACxC,KAAK,EAAE;YACL,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;YACjC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;SAClC;KACF,CAAC;AACJ,CAAC;AAlBD,wCAkBC;AAED;;;GAGG;AACU,QAAA,aAAa,GAAG,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAEtC,QAAA,mBAAmB,GAAG,IAAA,oBAAM,EACvC,UAAU,EACV,IAAA,oBAAM,GAAE,CAAC,SAAS,CACnB,CAAC;AAEF;;GAEG;AACU,QAAA,aAAa,GAAG,IAAA,qBAAO,EAClC,2BAAmB,EACnB,sBAAc,CACf,CAAC;AAIW,QAAA,eAAe,GAAG,IAAA,qBAAO,EAAC,IAAA,oBAAM,GAAE,EAAE,wBAAgB,CAAC,CAAC;AAEtD,QAAA,oBAAoB,GAAG,IAAA,mBAAK,EAAC,uBAAe,CAAC,CAAC;AAC9C,QAAA,oBAAoB,GAAG,IAAA,qBAAO,EAAC,IAAA,oBAAM,GAAE,EAAE,6BAAqB,CAAC,CAAC;AAG7E;;GAEG;AACU,QAAA,WAAW,GAAG,IAAA,oBAAM,EAAC;IAChC,EAAE,EAAE,qBAAa;IACjB,IAAI,EAAE,qBAAa;CACpB,CAAC,CAAC;AAGU,QAAA,eAAe,GAAG,IAAA,oBAAM,EAAC;IACpC;;OAEG;IACH,MAAM,EAAE,IAAA,mBAAK,EAAC,mBAAW,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,qBAAa,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,qBAAa,CAAC,CAAC;CACvC,CAAC,CAAC;AAGH;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,qBAAO,EAAC,IAAA,oBAAM,GAAE,EAAE,mBAAmB,CAAC,CAAC;AAGxE;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,yBAAiB,CAAC,CAAC;AACtC,CAAC;AAFD,sCAEC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,KAAc;IACtC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,qBAAa,CAAC,CAAC;AAClC,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,uBAAe,CAAC,CAAC;AACpC,CAAC;AAFD,kCAEC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,KAAc;IAC7C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,4BAAoB,CAAC,CAAC;AACzC,CAAC;AAFD,4CAEC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,uBAAe,CAAC,CAAC;AACpC,CAAC;AAFD,kCAEC","sourcesContent":["import type { AccountId, ChainId } from '@metamask/snaps-sdk';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  array,\n  define,\n  is,\n  object,\n  optional,\n  pattern,\n  size,\n  string,\n} from '@metamask/superstruct';\n\nimport type { InferMatching } from './structs';\n\nexport const CHAIN_ID_REGEX =\n  /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u;\n\nexport const ACCOUNT_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})):(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\nexport const ACCOUNT_ADDRESS_REGEX = /^(?<accountAddress>[a-zA-Z0-9]{1,64})$/u;\n\n/**\n * Parse a chain ID string to an object containing the namespace and reference.\n * This validates the chain ID before parsing it.\n *\n * @param chainId - The chain ID to validate and parse.\n * @returns The parsed chain ID.\n */\nexport function parseChainId(chainId: ChainId): {\n  namespace: NamespaceId;\n  reference: string;\n} {\n  const match = CHAIN_ID_REGEX.exec(chainId);\n  if (!match?.groups) {\n    throw new Error('Invalid chain ID.');\n  }\n\n  return {\n    namespace: match.groups.namespace,\n    reference: match.groups.reference,\n  };\n}\n\n/**\n * Parse an account ID to an object containing the chain, chain ID and address.\n * This validates the account ID before parsing it.\n *\n * @param accountId - The account ID to validate and parse.\n * @returns The parsed account ID.\n */\nexport function parseAccountId(accountId: AccountId): {\n  chain: { namespace: NamespaceId; reference: string };\n  chainId: ChainId;\n  address: string;\n} {\n  const match = ACCOUNT_ID_REGEX.exec(accountId);\n  if (!match?.groups) {\n    throw new Error('Invalid account ID.');\n  }\n\n  return {\n    address: match.groups.accountAddress,\n    chainId: match.groups.chainId as ChainId,\n    chain: {\n      namespace: match.groups.namespace,\n      reference: match.groups.reference,\n    },\n  };\n}\n\n/**\n * A helper struct for a string with a minimum length of 1 and a maximum length\n * of 40.\n */\nexport const LimitedString = size(string(), 1, 40);\n\nexport const ChainIdStringStruct = define<ChainId>(\n  'Chain ID',\n  string().validator,\n);\n\n/**\n * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.\n */\nexport const ChainIdStruct = pattern<ChainId, null>(\n  ChainIdStringStruct,\n  CHAIN_ID_REGEX,\n);\n\nexport type Caip2ChainId = InferMatching<typeof ChainIdStruct, ChainId>;\n\nexport const AccountIdStruct = pattern(string(), ACCOUNT_ID_REGEX);\n\nexport const AccountIdArrayStruct = array(AccountIdStruct);\nexport const AccountAddressStruct = pattern(string(), ACCOUNT_ADDRESS_REGEX);\nexport type AccountAddress = Infer<typeof AccountAddressStruct>;\n\n/**\n * A chain descriptor.\n */\nexport const ChainStruct = object({\n  id: ChainIdStruct,\n  name: LimitedString,\n});\nexport type Chain = Infer<typeof ChainStruct>;\n\nexport const NamespaceStruct = object({\n  /**\n   * A list of supported chains in the namespace.\n   */\n  chains: array(ChainStruct),\n\n  /**\n   * A list of supported RPC methods on the namespace, that a DApp can call.\n   */\n  methods: optional(array(LimitedString)),\n\n  /**\n   * A list of supported RPC events on the namespace, that a DApp can listen to.\n   */\n  events: optional(array(LimitedString)),\n});\nexport type Namespace = Infer<typeof NamespaceStruct>;\n\n/**\n * A CAIP-2 namespace, i.e., the first part of a chain ID.\n */\nexport const NamespaceIdStruct = pattern(string(), /^[-a-z0-9]{3,8}$/u);\nexport type NamespaceId = Infer<typeof NamespaceIdStruct>;\n\n/**\n * Check if the given value is a CAIP-2 namespace ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 namespace ID.\n */\nexport function isNamespaceId(value: unknown): value is NamespaceId {\n  return is(value, NamespaceIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-2 chain ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-2 chain ID.\n */\nexport function isChainId(value: unknown): value is ChainId {\n  return is(value, ChainIdStruct);\n}\n\n/**\n * Check if the given value is a CAIP-10 account ID.\n *\n * @param value - The value to check.\n * @returns Whether the value is a CAIP-10 account ID.\n */\nexport function isAccountId(value: unknown): value is AccountId {\n  return is(value, AccountIdStruct);\n}\n\n/**\n * Check if the given value is an array of CAIP-10 account IDs.\n *\n * @param value - The value to check.\n * @returns Whether the value is an array of CAIP-10 account IDs.\n */\nexport function isAccountIdArray(value: unknown): value is AccountId[] {\n  return is(value, AccountIdArrayStruct);\n}\n\n/**\n * Check if a value is a {@link Namespace}.\n *\n * @param value - The value to validate.\n * @returns True if the value is a valid {@link Namespace}.\n */\nexport function isNamespace(value: unknown): value is Namespace {\n  return is(value, NamespaceStruct);\n}\n"]}

package/dist/namespace.d.cts

@@ -0,0 +1,130 @@
+import type { AccountId, ChainId } from "@metamask/snaps-sdk";
+import type { Infer } from "@metamask/superstruct";
+import type { InferMatching } from "./structs.cjs";
+export declare const CHAIN_ID_REGEX: RegExp;
+export declare const ACCOUNT_ID_REGEX: RegExp;
+export declare const ACCOUNT_ADDRESS_REGEX: RegExp;
+/**
+ * Parse a chain ID string to an object containing the namespace and reference.
+ * This validates the chain ID before parsing it.
+ *
+ * @param chainId - The chain ID to validate and parse.
+ * @returns The parsed chain ID.
+ */
+export declare function parseChainId(chainId: ChainId): {
+    namespace: NamespaceId;
+    reference: string;
+};
+/**
+ * Parse an account ID to an object containing the chain, chain ID and address.
+ * This validates the account ID before parsing it.
+ *
+ * @param accountId - The account ID to validate and parse.
+ * @returns The parsed account ID.
+ */
+export declare function parseAccountId(accountId: AccountId): {
+    chain: {
+        namespace: NamespaceId;
+        reference: string;
+    };
+    chainId: ChainId;
+    address: string;
+};
+/**
+ * A helper struct for a string with a minimum length of 1 and a maximum length
+ * of 40.
+ */
+export declare const LimitedString: import("@metamask/superstruct").Struct<string, null>;
+export declare const ChainIdStringStruct: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+/**
+ * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
+ */
+export declare const ChainIdStruct: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+export type Caip2ChainId = InferMatching<typeof ChainIdStruct, ChainId>;
+export declare const AccountIdStruct: import("@metamask/superstruct").Struct<string, null>;
+export declare const AccountIdArrayStruct: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+export declare const AccountAddressStruct: import("@metamask/superstruct").Struct<string, null>;
+export type AccountAddress = Infer<typeof AccountAddressStruct>;
+/**
+ * A chain descriptor.
+ */
+export declare const ChainStruct: import("@metamask/superstruct").Struct<{
+    id: `${string}:${string}`;
+    name: string;
+}, {
+    id: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+    name: import("@metamask/superstruct").Struct<string, null>;
+}>;
+export type Chain = Infer<typeof ChainStruct>;
+export declare const NamespaceStruct: import("@metamask/superstruct").Struct<{
+    chains: {
+        id: `${string}:${string}`;
+        name: string;
+    }[];
+    methods?: string[] | undefined;
+    events?: string[] | undefined;
+}, {
+    /**
+     * A list of supported chains in the namespace.
+     */
+    chains: import("@metamask/superstruct").Struct<{
+        id: `${string}:${string}`;
+        name: string;
+    }[], import("@metamask/superstruct").Struct<{
+        id: `${string}:${string}`;
+        name: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<`${string}:${string}`, null>;
+        name: import("@metamask/superstruct").Struct<string, null>;
+    }>>;
+    /**
+     * A list of supported RPC methods on the namespace, that a DApp can call.
+     */
+    methods: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+    /**
+     * A list of supported RPC events on the namespace, that a DApp can listen to.
+     */
+    events: import("@metamask/superstruct").Struct<string[] | undefined, import("@metamask/superstruct").Struct<string, null>>;
+}>;
+export type Namespace = Infer<typeof NamespaceStruct>;
+/**
+ * A CAIP-2 namespace, i.e., the first part of a chain ID.
+ */
+export declare const NamespaceIdStruct: import("@metamask/superstruct").Struct<string, null>;
+export type NamespaceId = Infer<typeof NamespaceIdStruct>;
+/**
+ * Check if the given value is a CAIP-2 namespace ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-2 namespace ID.
+ */
+export declare function isNamespaceId(value: unknown): value is NamespaceId;
+/**
+ * Check if the given value is a CAIP-2 chain ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-2 chain ID.
+ */
+export declare function isChainId(value: unknown): value is ChainId;
+/**
+ * Check if the given value is a CAIP-10 account ID.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a CAIP-10 account ID.
+ */
+export declare function isAccountId(value: unknown): value is AccountId;
+/**
+ * Check if the given value is an array of CAIP-10 account IDs.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is an array of CAIP-10 account IDs.
+ */
+export declare function isAccountIdArray(value: unknown): value is AccountId[];
+/**
+ * Check if a value is a {@link Namespace}.
+ *
+ * @param value - The value to validate.
+ * @returns True if the value is a valid {@link Namespace}.
+ */
+export declare function isNamespace(value: unknown): value is Namespace;
+//# sourceMappingURL=namespace.d.cts.map

package/dist/namespace.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"namespace.d.cts","sourceRoot":"","sources":["../src/namespace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,4BAA4B;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAYnD,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAkB;AAE/C,eAAO,MAAM,cAAc,QACyC,CAAC;AAErE,eAAO,MAAM,gBAAgB,QACwF,CAAC;AAEtH,eAAO,MAAM,qBAAqB,QAA4C,CAAC;AAE/E;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG;IAC9C,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB,CAUA;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG;IACpD,KAAK,EAAE;QAAE,SAAS,EAAE,WAAW,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IACrD,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAcA;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,sDAAwB,CAAC;AAEnD,eAAO,MAAM,mBAAmB,qEAG/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,qEAGzB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,OAAO,aAAa,EAAE,OAAO,CAAC,CAAC;AAExE,eAAO,MAAM,eAAe,sDAAsC,CAAC;AAEnE,eAAO,MAAM,oBAAoB,wGAAyB,CAAC;AAC3D,eAAO,MAAM,oBAAoB,sDAA2C,CAAC;AAC7E,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;EAGtB,CAAC;AACH,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAE9C,eAAO,MAAM,eAAe;;;;;;;;IAC1B;;OAEG;;;;;;;;;;;IAGH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,iBAAiB,sDAAyC,CAAC;AACxE,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE1D;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAE1D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,EAAE,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAE9D"}