@metamask/keyring-api 6.2.1 → 6.3.0

package/dist/utils/caip.d.ts

@@ -0,0 +1,37 @@
+import { type Infer } from 'superstruct';
+/**
+ * A CAIP-19 asset type identifier, i.e., a human-readable type of asset identifier.
+ */
+export declare const CaipAssetTypeStruct: import("superstruct").Struct<string, null>;
+export declare type CaipAssetType = Infer<typeof CaipAssetTypeStruct>;
+/**
+ * A CAIP-19 asset ID identifier, i.e., a human-readable type of asset ID.
+ */
+export declare const CaipAssetIdStruct: import("superstruct").Struct<string, null>;
+export declare type CaipAssetId = Infer<typeof CaipAssetIdStruct>;
+/**
+ * Check if the given value is a {@link CaipAssetType}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipAssetType}.
+ * @example
+ * ```ts
+ * isCaipAssetType('eip155:1/slip44:60'); // true
+ * isCaipAssetType('cosmos:cosmoshub-3/slip44:118'); // true
+ * isCaipAssetType('hedera:mainnet/nft:0.0.55492/12'); // false
+ * ```
+ */
+export declare function isCaipAssetType(value: unknown): value is CaipAssetType;
+/**
+ * Check if the given value is a {@link CaipAssetId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipAssetId}.
+ * @example
+ * ```ts
+ * isCaipAssetType('eip155:1/slip44:60'); // false
+ * isCaipAssetType('cosmos:cosmoshub-3/slip44:118'); // false
+ * isCaipAssetType('hedera:mainnet/nft:0.0.55492/12'); // true
+ * ```
+ */
+export declare function isCaipAssetId(value: unknown): value is CaipAssetId;

package/dist/utils/caip.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCaipAssetId = exports.isCaipAssetType = exports.CaipAssetIdStruct = exports.CaipAssetTypeStruct = void 0;
+const superstruct_1 = require("superstruct");
+const superstruct_2 = require("../superstruct");
+const CAIP_ASSET_TYPE_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})$/u;
+const CAIP_ASSET_ID_REGEX = /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})\/(?<tokenId>[-.%a-zA-Z0-9]{1,78})$/u;
+/**
+ * A CAIP-19 asset type identifier, i.e., a human-readable type of asset identifier.
+ */
+exports.CaipAssetTypeStruct = (0, superstruct_2.definePattern)('CaipAssetType', CAIP_ASSET_TYPE_REGEX);
+/**
+ * A CAIP-19 asset ID identifier, i.e., a human-readable type of asset ID.
+ */
+exports.CaipAssetIdStruct = (0, superstruct_2.definePattern)('CaipAssetId', CAIP_ASSET_ID_REGEX);
+/**
+ * Check if the given value is a {@link CaipAssetType}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipAssetType}.
+ * @example
+ * ```ts
+ * isCaipAssetType('eip155:1/slip44:60'); // true
+ * isCaipAssetType('cosmos:cosmoshub-3/slip44:118'); // true
+ * isCaipAssetType('hedera:mainnet/nft:0.0.55492/12'); // false
+ * ```
+ */
+function isCaipAssetType(value) {
+    return (0, superstruct_1.is)(value, exports.CaipAssetTypeStruct);
+}
+exports.isCaipAssetType = isCaipAssetType;
+/**
+ * Check if the given value is a {@link CaipAssetId}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a {@link CaipAssetId}.
+ * @example
+ * ```ts
+ * isCaipAssetType('eip155:1/slip44:60'); // false
+ * isCaipAssetType('cosmos:cosmoshub-3/slip44:118'); // false
+ * isCaipAssetType('hedera:mainnet/nft:0.0.55492/12'); // true
+ * ```
+ */
+function isCaipAssetId(value) {
+    return (0, superstruct_1.is)(value, exports.CaipAssetIdStruct);
+}
+exports.isCaipAssetId = isCaipAssetId;
+//# sourceMappingURL=caip.js.map

package/dist/utils/caip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"caip.js","sourceRoot":"","sources":["../../src/utils/caip.ts"],"names":[],"mappings":";;;AAAA,6CAA6C;AAE7C,gDAA+C;AAE/C,MAAM,qBAAqB,GACzB,2JAA2J,CAAC;AAE9J,MAAM,mBAAmB,GACvB,6LAA6L,CAAC;AAEhM;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,2BAAa,EAC9C,eAAe,EACf,qBAAqB,CACtB,CAAC;AAGF;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,2BAAa,EAC5C,aAAa,EACb,mBAAmB,CACpB,CAAC;AAGF;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC5C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,2BAAmB,CAAC,CAAC;AACxC,CAAC;AAFD,0CAEC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,yBAAiB,CAAC,CAAC;AACtC,CAAC;AAFD,sCAEC","sourcesContent":["import { is, type Infer } from 'superstruct';\n\nimport { definePattern } from '../superstruct';\n\nconst CAIP_ASSET_TYPE_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})$/u;\n\nconst CAIP_ASSET_ID_REGEX =\n  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})\\/(?<tokenId>[-.%a-zA-Z0-9]{1,78})$/u;\n\n/**\n * A CAIP-19 asset type identifier, i.e., a human-readable type of asset identifier.\n */\nexport const CaipAssetTypeStruct = definePattern(\n  'CaipAssetType',\n  CAIP_ASSET_TYPE_REGEX,\n);\nexport type CaipAssetType = Infer<typeof CaipAssetTypeStruct>;\n\n/**\n * A CAIP-19 asset ID identifier, i.e., a human-readable type of asset ID.\n */\nexport const CaipAssetIdStruct = definePattern(\n  'CaipAssetId',\n  CAIP_ASSET_ID_REGEX,\n);\nexport type CaipAssetId = Infer<typeof CaipAssetIdStruct>;\n\n/**\n * Check if the given value is a {@link CaipAssetType}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipAssetType}.\n * @example\n * ```ts\n * isCaipAssetType('eip155:1/slip44:60'); // true\n * isCaipAssetType('cosmos:cosmoshub-3/slip44:118'); // true\n * isCaipAssetType('hedera:mainnet/nft:0.0.55492/12'); // false\n * ```\n */\nexport function isCaipAssetType(value: unknown): value is CaipAssetType {\n  return is(value, CaipAssetTypeStruct);\n}\n\n/**\n * Check if the given value is a {@link CaipAssetId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link CaipAssetId}.\n * @example\n * ```ts\n * isCaipAssetType('eip155:1/slip44:60'); // false\n * isCaipAssetType('cosmos:cosmoshub-3/slip44:118'); // false\n * isCaipAssetType('hedera:mainnet/nft:0.0.55492/12'); // true\n * ```\n */\nexport function isCaipAssetId(value: unknown): value is CaipAssetId {\n  return is(value, CaipAssetIdStruct);\n}\n"]}

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './caip';
+export * from './types';
+export * from './typing';

package/dist/utils/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./caip"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./typing"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,0CAAwB;AACxB,2CAAyB","sourcesContent":["export * from './caip';\nexport * from './types';\nexport * from './typing';\n"]}

package/dist/utils/types.d.ts

@@ -0,0 +1,17 @@
+import { type Infer } from 'superstruct';
+/**
+ * UUIDv4 struct.
+ */
+export declare const UuidStruct: import("superstruct").Struct<string, null>;
+/**
+ * Validates if a given value is a valid URL.
+ *
+ * @param value - The value to be validated.
+ * @returns A boolean indicating if the value is a valid URL.
+ */
+export declare const UrlStruct: import("superstruct").Struct<string, null>;
+/**
+ * A string which contains a positive float number.
+ */
+export declare const StringNumberStruct: import("superstruct").Struct<string, null>;
+export declare type StringNumber = Infer<typeof StringNumberStruct>;

package/dist/utils/types.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringNumberStruct = exports.UrlStruct = exports.UuidStruct = void 0;
+const superstruct_1 = require("superstruct");
+const superstruct_2 = require("../superstruct");
+/**
+ * UUIDv4 struct.
+ */
+exports.UuidStruct = (0, superstruct_2.definePattern)('UuidV4', /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/iu);
+/**
+ * Validates if a given value is a valid URL.
+ *
+ * @param value - The value to be validated.
+ * @returns A boolean indicating if the value is a valid URL.
+ */
+exports.UrlStruct = (0, superstruct_1.define)('Url', (value) => {
+    try {
+        const url = new URL(value);
+        return url.protocol === 'http:' || url.protocol === 'https:';
+    }
+    catch (_) {
+        return false;
+    }
+});
+/**
+ * A string which contains a positive float number.
+ */
+exports.StringNumberStruct = (0, superstruct_2.definePattern)('StringNumber', /^\d+(\.\d+)?$/u);
+//# sourceMappingURL=types.js.map

package/dist/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":";;;AAAA,6CAAiD;AAEjD,gDAA+C;AAE/C;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,2BAAa,EACrC,QAAQ,EACR,yEAAyE,CAC1E,CAAC;AAEF;;;;;GAKG;AACU,QAAA,SAAS,GAAG,IAAA,oBAAM,EAAS,KAAK,EAAE,CAAC,KAAc,EAAE,EAAE;IAChE,IAAI;QACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAe,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC;KAC9D;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,2BAAa,EAC7C,cAAc,EACd,gBAAgB,CACjB,CAAC","sourcesContent":["import { define, type Infer } from 'superstruct';\n\nimport { definePattern } from '../superstruct';\n\n/**\n * UUIDv4 struct.\n */\nexport const UuidStruct = definePattern(\n  'UuidV4',\n  /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/iu,\n);\n\n/**\n * Validates if a given value is a valid URL.\n *\n * @param value - The value to be validated.\n * @returns A boolean indicating if the value is a valid URL.\n */\nexport const UrlStruct = define<string>('Url', (value: unknown) => {\n  try {\n    const url = new URL(value as string);\n    return url.protocol === 'http:' || url.protocol === 'https:';\n  } catch (_) {\n    return false;\n  }\n});\n\n/**\n * A string which contains a positive float number.\n */\nexport const StringNumberStruct = definePattern(\n  'StringNumber',\n  /^\\d+(\\.\\d+)?$/u,\n);\nexport type StringNumber = Infer<typeof StringNumberStruct>;\n"]}

package/dist/utils/typing.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Omit keys from a union type.
+ *
+ * The normal `Omit` type does not distribute over unions. So we use this
+ * workaround that applies `Omit` to each member of the union.
+ *
+ * See: <https://github.com/microsoft/TypeScript/issues/31501#issuecomment-1280579305>
+ */
+export declare type OmitUnion<Type, Key extends keyof any> = Type extends any ? Omit<Type, Key> : never;
+/**
+ * Type that resolves to `true` if `Child` extends `Base`, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * type A = Extends<{a: string, b: string}, {a: string}>; // true
+ * type B = Extends<{a: string}, {a: string, b: string}>; // false
+ * ```
+ */
+export declare type Extends<Child, Base> = Child extends Base ? true : false;
+/**
+ * Assert that a type extends `true`. It can be used, for example, to assert
+ * that a given type extends another type.
+ *
+ * @example
+ * ```ts
+ * expectTrue<Extends<{a: string, b: string}, {a: string}>>(); // Ok
+ * expectTrue<Extends<{a: string}, {a: string, b: string}>>(); // Error
+ * ```
+ *
+ * This function follows the naming pattern used on `tsd`.
+ */
+export declare function expectTrue<Type extends true>(): void;

package/dist/utils/typing.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectTrue = void 0;
+/**
+ * Assert that a type extends `true`. It can be used, for example, to assert
+ * that a given type extends another type.
+ *
+ * @example
+ * ```ts
+ * expectTrue<Extends<{a: string, b: string}, {a: string}>>(); // Ok
+ * expectTrue<Extends<{a: string}, {a: string, b: string}>>(); // Error
+ * ```
+ *
+ * This function follows the naming pattern used on `tsd`.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function expectTrue() {
+    // Intentionally empty
+}
+exports.expectTrue = expectTrue;
+//# sourceMappingURL=typing.js.map

package/dist/utils/typing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typing.js","sourceRoot":"","sources":["../../src/utils/typing.ts"],"names":[],"mappings":";;;AAuBA;;;;;;;;;;;GAWG;AACH,6DAA6D;AAC7D,SAAgB,UAAU;IACxB,sBAAsB;AACxB,CAAC;AAFD,gCAEC","sourcesContent":["/**\n * Omit keys from a union type.\n *\n * The normal `Omit` type does not distribute over unions. So we use this\n * workaround that applies `Omit` to each member of the union.\n *\n * See: <https://github.com/microsoft/TypeScript/issues/31501#issuecomment-1280579305>\n */\nexport type OmitUnion<Type, Key extends keyof any> = Type extends any\n  ? Omit<Type, Key>\n  : never;\n\n/**\n * Type that resolves to `true` if `Child` extends `Base`, otherwise `false`.\n *\n * @example\n * ```ts\n * type A = Extends<{a: string, b: string}, {a: string}>; // true\n * type B = Extends<{a: string}, {a: string, b: string}>; // false\n * ```\n */\nexport type Extends<Child, Base> = Child extends Base ? true : false;\n\n/**\n * Assert that a type extends `true`. It can be used, for example, to assert\n * that a given type extends another type.\n *\n * @example\n * ```ts\n * expectTrue<Extends<{a: string, b: string}, {a: string}>>(); // Ok\n * expectTrue<Extends<{a: string}, {a: string, b: string}>>(); // Error\n * ```\n *\n * This function follows the naming pattern used on `tsd`.\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function expectTrue<Type extends true>(): void {\n  // Intentionally empty\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/keyring-api",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "description": "MetaMask Keyring API",
   "keywords": [
     "metamask",

package/dist/api.js

@@ -1,108 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyringResponseStruct = exports.KeyringAccountDataStruct = exports.KeyringRequestStruct = exports.KeyringAccountStruct = exports.BaseKeyringAccountStruct = exports.KeyringAccountStructs = void 0;
-const utils_1 = require("@metamask/utils");
-const superstruct_1 = require("superstruct");
-const btc_1 = require("./btc");
-const eth_1 = require("./eth");
-const superstruct_2 = require("./superstruct");
-const utils_2 = require("./utils");
-/**
- * Mapping between account types and their matching `superstruct` schema.
- */
-exports.KeyringAccountStructs = {
-    [`${eth_1.EthAccountType.Eoa}`]: eth_1.EthEoaAccountStruct,
-    [`${eth_1.EthAccountType.Erc4337}`]: eth_1.EthErc4337AccountStruct,
-    [`${btc_1.BtcAccountType.P2wpkh}`]: btc_1.BtcP2wpkhAccountStruct,
-};
-/**
- * Base type for `KeyringAccount` as a `superstruct.object`.
- */
-exports.BaseKeyringAccountStruct = (0, superstruct_2.object)({
-    /**
-     * Account type.
-     */
-    type: (0, superstruct_1.enums)([
-        `${eth_1.EthAccountType.Eoa}`,
-        `${eth_1.EthAccountType.Erc4337}`,
-        `${btc_1.BtcAccountType.P2wpkh}`,
-    ]),
-});
-/**
- * Account as a `superstruct.object`.
- *
- * See {@link KeyringAccount}.
- */
-exports.KeyringAccountStruct = (0, superstruct_1.define)(
-// We do use a custom `define` for this type to avoid having to use a `union` since error
-// messages are a bit confusing.
-//
-// Doing manual validation allows us to use the "concrete" type of each supported acounts giving
-// use a much nicer message from `superstruct`.
-'KeyringAccount', (value) => {
-    // This will also raise if `value` does not match any of the supported account types!
-    const account = (0, superstruct_1.mask)(value, exports.BaseKeyringAccountStruct);
-    // At this point, we know that `value.type` can be used as an index for `KeyringAccountStructs`
-    const [error] = (0, superstruct_1.validate)(value, exports.KeyringAccountStructs[account.type]);
-    return error ?? true;
-});
-exports.KeyringRequestStruct = (0, superstruct_2.object)({
-    /**
-     * Keyring request ID (UUIDv4).
-     */
-    id: utils_2.UuidStruct,
-    /**
-     * Request's scope (CAIP-2 chain ID).
-     */
-    scope: (0, superstruct_1.string)(),
-    /**
-     * Account ID (UUIDv4).
-     */
-    account: utils_2.UuidStruct,
-    /**
-     * Inner request sent by the client application.
-     */
-    request: (0, superstruct_2.object)({
-        method: (0, superstruct_1.string)(),
-        params: (0, superstruct_2.exactOptional)((0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)])),
-    }),
-});
-exports.KeyringAccountDataStruct = (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct);
-exports.KeyringResponseStruct = (0, superstruct_1.union)([
-    (0, superstruct_2.object)({
-        /**
-         * Pending flag.
-         *
-         * Setting the pending flag to true indicates that the request will be
-         * handled asynchronously. The keyring must be called with `approveRequest`
-         * or `rejectRequest` to resolve the request.
-         */
-        pending: (0, superstruct_1.literal)(true),
-        /**
-         * Redirect URL.
-         *
-         * If present in the response, MetaMask will display a confirmation dialog
-         * with a link to the redirect URL. The user can choose to follow the link
-         * or cancel the request.
-         */
-        redirect: (0, superstruct_2.exactOptional)((0, superstruct_2.object)({
-            message: (0, superstruct_2.exactOptional)((0, superstruct_1.string)()),
-            url: (0, superstruct_2.exactOptional)((0, superstruct_1.string)()),
-        })),
-    }),
-    (0, superstruct_2.object)({
-        /**
-         * Pending flag.
-         *
-         * Setting the pending flag to false indicates that the request will be
-         * handled synchronously. The keyring must return the result of the
-         * request execution.
-         */
-        pending: (0, superstruct_1.literal)(false),
-        /**
-         * Request result.
-         */
-        result: utils_1.JsonStruct,
-    }),
-]);
-//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAE7C,6CAUqB;AAIrB,+BAA+D;AAE/D,+BAIe;AACf,+CAAsD;AACtD,mCAAqC;AASrC;;GAEG;AACU,QAAA,qBAAqB,GAG9B;IACF,CAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC,EAAE,yBAAmB;IAC9C,CAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC,EAAE,6BAAuB;IACtD,CAAC,GAAG,oBAAc,CAAC,MAAM,EAAE,CAAC,EAAE,4BAAsB;CACrD,CAAC;AAEF;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,oBAAc,CAAC,GAAG,EAAE;QACvB,GAAG,oBAAc,CAAC,OAAO,EAAE;QAC3B,GAAG,oBAAc,CAAC,MAAM,EAAE;KAC3B,CAAC;CACH,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,IAAA,oBAAM;AACxC,yFAAyF;AACzF,gCAAgC;AAChC,EAAE;AACF,gGAAgG;AAChG,+CAA+C;AAC/C,gBAAgB,EAChB,CAAC,KAAc,EAAE,EAAE;IACjB,qFAAqF;IACrF,MAAM,OAAO,GAAG,IAAA,kBAAI,EAAC,KAAK,EAAE,gCAAwB,CAAC,CAAC;IAEtD,+FAA+F;IAC/F,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EACtB,KAAK,EACL,6BAAqB,CAAC,OAAO,CAAC,IAAI,CAAW,CAC9C,CAAC;IAEF,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CACF,CAAC;AASW,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,GAAE;IAEf;;OAEG;IACH,OAAO,EAAE,kBAAU;IAEnB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC;QACd,MAAM,EAAE,IAAA,oBAAM,GAAE;QAChB,MAAM,EAAE,IAAA,2BAAa,EACnB,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC,CACzD;KACF,CAAC;CACH,CAAC,CAAC;AASU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;AASxD,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,EAAE,IAAA,2BAAa,EACrB,IAAA,oBAAM,EAAC;YACL,OAAO,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;YAChC,GAAG,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;SAC7B,CAAC,CACH;KACF,CAAC;IACF,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  enums,\n  array,\n  define,\n  validate,\n  literal,\n  record,\n  string,\n  union,\n  mask,\n} from 'superstruct';\n\nimport type { StaticAssertAbstractAccount } from './base-types';\nimport type { BtcP2wpkhAccount } from './btc';\nimport { BtcP2wpkhAccountStruct, BtcAccountType } from './btc';\nimport type { EthEoaAccount, EthErc4337Account } from './eth';\nimport {\n  EthEoaAccountStruct,\n  EthErc4337AccountStruct,\n  EthAccountType,\n} from './eth';\nimport { exactOptional, object } from './superstruct';\nimport { UuidStruct } from './utils';\n\n/**\n * Type of supported accounts.\n */\nexport type KeyringAccounts = StaticAssertAbstractAccount<\n  EthEoaAccount | EthErc4337Account | BtcP2wpkhAccount\n>;\n\n/**\n * Mapping between account types and their matching `superstruct` schema.\n */\nexport const KeyringAccountStructs: Record<\n  string,\n  Struct<EthEoaAccount> | Struct<EthErc4337Account> | Struct<BtcP2wpkhAccount>\n> = {\n  [`${EthAccountType.Eoa}`]: EthEoaAccountStruct,\n  [`${EthAccountType.Erc4337}`]: EthErc4337AccountStruct,\n  [`${BtcAccountType.P2wpkh}`]: BtcP2wpkhAccountStruct,\n};\n\n/**\n * Base type for `KeyringAccount` as a `superstruct.object`.\n */\nexport const BaseKeyringAccountStruct = object({\n  /**\n   * Account type.\n   */\n  type: enums([\n    `${EthAccountType.Eoa}`,\n    `${EthAccountType.Erc4337}`,\n    `${BtcAccountType.P2wpkh}`,\n  ]),\n});\n\n/**\n * Account as a `superstruct.object`.\n *\n * See {@link KeyringAccount}.\n */\nexport const KeyringAccountStruct = define<KeyringAccounts>(\n  // We do use a custom `define` for this type to avoid having to use a `union` since error\n  // messages are a bit confusing.\n  //\n  // Doing manual validation allows us to use the \"concrete\" type of each supported acounts giving\n  // use a much nicer message from `superstruct`.\n  'KeyringAccount',\n  (value: unknown) => {\n    // This will also raise if `value` does not match any of the supported account types!\n    const account = mask(value, BaseKeyringAccountStruct);\n\n    // At this point, we know that `value.type` can be used as an index for `KeyringAccountStructs`\n    const [error] = validate(\n      value,\n      KeyringAccountStructs[account.type] as Struct,\n    );\n\n    return error ?? true;\n  },\n);\n\n/**\n * Account object.\n *\n * Represents an account with its properties and capabilities.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n\nexport const KeyringRequestStruct = object({\n  /**\n   * Keyring request ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Request's scope (CAIP-2 chain ID).\n   */\n  scope: string(),\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Inner request sent by the client application.\n   */\n  request: object({\n    method: string(),\n    params: exactOptional(\n      union([array(JsonStruct), record(string(), JsonStruct)]),\n    ),\n  }),\n});\n\n/**\n * Keyring request.\n *\n * Represents a request made to the keyring for account-related operations.\n */\nexport type KeyringRequest = Infer<typeof KeyringRequestStruct>;\n\nexport const KeyringAccountDataStruct = record(string(), JsonStruct);\n\n/**\n * Response to a call to `exportAccount`.\n *\n * The exact response depends on the keyring implementation.\n */\nexport type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;\n\nexport const KeyringResponseStruct = union([\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to true indicates that the request will be\n     * handled asynchronously. The keyring must be called with `approveRequest`\n     * or `rejectRequest` to resolve the request.\n     */\n    pending: literal(true),\n\n    /**\n     * Redirect URL.\n     *\n     * If present in the response, MetaMask will display a confirmation dialog\n     * with a link to the redirect URL. The user can choose to follow the link\n     * or cancel the request.\n     */\n    redirect: exactOptional(\n      object({\n        message: exactOptional(string()),\n        url: exactOptional(string()),\n      }),\n    ),\n  }),\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to false indicates that the request will be\n     * handled synchronously. The keyring must return the result of the\n     * request execution.\n     */\n    pending: literal(false),\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n]);\n\n/**\n * Response to a call to `submitRequest`.\n *\n * Keyring implementations must return a response with `pending: true` if the\n * request will be handled asynchronously. Otherwise, the response must contain\n * the result of the request and `pending: false`.\n *\n * In the asynchronous case, the keyring can return a redirect URL and message\n * to be shown to the user. The user can choose to follow the link or cancel\n * the request. The main use case for this is to redirect the user to the snap\n * dapp to review the request.\n */\nexport type KeyringResponse = Infer<typeof KeyringResponseStruct>;\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional).\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}

package/dist/base-types.d.ts

@@ -1,62 +0,0 @@
-import type { Json } from '@metamask/utils';
-/**
- * Base type for any account. This type must be composed and extended to add a `methods`
- * and `type` fields.
- *
- * NOTE: This type isn't a `superstruct.object` as it is used to compose other objects. See
- * {@link BaseAccountStruct}.
- */
-export declare const BaseAccount: {
-    /**
-     * Account ID (UUIDv4).
-     */
-    id: import("superstruct").Struct<string, null>;
-    /**
-     * Account address or next receive address (UTXO).
-     */
-    address: import("superstruct").Struct<string, null>;
-    /**
-     * Keyring-dependent account options.
-     */
-    options: import("superstruct").Struct<Record<string, Json>, null>;
-};
-/**
- * Base type for any account as a `superstruct.object`.
- */
-export declare const BaseAccountStruct: import("superstruct").Struct<{
-    id: string;
-    address: string;
-    options: Record<string, Json>;
-}, {
-    /**
-     * Account ID (UUIDv4).
-     */
-    id: import("superstruct").Struct<string, null>;
-    /**
-     * Account address or next receive address (UTXO).
-     */
-    address: import("superstruct").Struct<string, null>;
-    /**
-     * Keyring-dependent account options.
-     */
-    options: import("superstruct").Struct<Record<string, Json>, null>;
-}>;
-/**
- * Abstract struct that is used to match every supported account type. Making sure their type
- * definition do not diverge from each others.
- *
- * NOTE: This type is using "primitive types" such as `string` to not contrain any real account
- * type. It's up to those types to use more restrictions on their type definition.
- */
-export declare type AbstractAccount = {
-    id: string;
-    address: string;
-    options: Record<string, Json>;
-    type: string;
-    methods: string[];
-};
-/**
- * Type helper to make sure `Type` is "equal to" `AbstractAccount`, asserting that `Type` (an account
- * type actually) never diverges from other account types.
- */
-export declare type StaticAssertAbstractAccount<Type extends AbstractAccount> = Type;

package/dist/base-types.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseAccountStruct = exports.BaseAccount = void 0;
-const utils_1 = require("@metamask/utils");
-const superstruct_1 = require("superstruct");
-const utils_2 = require("./utils");
-/**
- * Base type for any account. This type must be composed and extended to add a `methods`
- * and `type` fields.
- *
- * NOTE: This type isn't a `superstruct.object` as it is used to compose other objects. See
- * {@link BaseAccountStruct}.
- */
-exports.BaseAccount = {
-    /**
-     * Account ID (UUIDv4).
-     */
-    id: utils_2.UuidStruct,
-    /**
-     * Account address or next receive address (UTXO).
-     */
-    address: (0, superstruct_1.string)(),
-    /**
-     * Keyring-dependent account options.
-     */
-    options: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
-};
-/**
- * Base type for any account as a `superstruct.object`.
- */
-exports.BaseAccountStruct = (0, superstruct_1.object)(exports.BaseAccount);
-//# sourceMappingURL=base-types.js.map

package/dist/base-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base-types.js","sourceRoot":"","sources":["../src/base-types.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAC7C,6CAAqD;AAErD,mCAAqC;AAErC;;;;;;GAMG;AACU,QAAA,WAAW,GAAG;IACzB;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;CACtC,CAAC;AAEF;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EAAC,mBAAW,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport { object, record, string } from 'superstruct';\n\nimport { UuidStruct } from './utils';\n\n/**\n * Base type for any account. This type must be composed and extended to add a `methods`\n * and `type` fields.\n *\n * NOTE: This type isn't a `superstruct.object` as it is used to compose other objects. See\n * {@link BaseAccountStruct}.\n */\nexport const BaseAccount = {\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: record(string(), JsonStruct),\n};\n\n/**\n * Base type for any account as a `superstruct.object`.\n */\nexport const BaseAccountStruct = object(BaseAccount);\n\n/**\n * Abstract struct that is used to match every supported account type. Making sure their type\n * definition do not diverge from each others.\n *\n * NOTE: This type is using \"primitive types\" such as `string` to not contrain any real account\n * type. It's up to those types to use more restrictions on their type definition.\n */\nexport type AbstractAccount = {\n  id: string;\n  address: string;\n  options: Record<string, Json>;\n  type: string;\n  methods: string[];\n};\n\n/**\n * Type helper to make sure `Type` is \"equal to\" `AbstractAccount`, asserting that `Type` (an account\n * type actually) never diverges from other account types.\n */\nexport type StaticAssertAbstractAccount<Type extends AbstractAccount> = Type;\n"]}

package/dist/utils.d.ts

@@ -1,26 +0,0 @@
-import type { Struct } from 'superstruct';
-/**
- * UUIDv4 struct.
- */
-export declare const UuidStruct: Struct<string, null>;
-/**
- * Omit keys from a union type.
- *
- * The normal `Omit` type does not distribute over unions. So we use this
- * workaround that applies `Omit` to each member of the union.
- *
- * See: <https://github.com/microsoft/TypeScript/issues/31501#issuecomment-1280579305>
- */
-export declare type OmitUnion<Type, Key extends keyof any> = Type extends any ? Omit<Type, Key> : never;
-/**
- * Assert that a value is valid according to a struct.
- *
- * It is similar to superstruct's mask function, but it does not ignore extra
- * properties.
- *
- * @param value - Value to check.
- * @param struct - Struct to validate the value against.
- * @param message - Error message to throw if the value is not valid.
- * @returns The value if it is valid.
- */
-export declare function strictMask<Type, Schema>(value: unknown, struct: Struct<Type, Schema>, message?: string): Type;

package/dist/utils.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.strictMask = exports.UuidStruct = void 0;
-const superstruct_1 = require("superstruct");
-const superstruct_2 = require("./superstruct");
-/**
- * UUIDv4 struct.
- */
-exports.UuidStruct = (0, superstruct_2.definePattern)('UuidV4', /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/iu);
-/**
- * Assert that a value is valid according to a struct.
- *
- * It is similar to superstruct's mask function, but it does not ignore extra
- * properties.
- *
- * @param value - Value to check.
- * @param struct - Struct to validate the value against.
- * @param message - Error message to throw if the value is not valid.
- * @returns The value if it is valid.
- */
-function strictMask(value, struct, message) {
-    (0, superstruct_1.assert)(value, struct, message);
-    return value;
-}
-exports.strictMask = strictMask;
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,6CAAqC;AAGrC,+CAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG,IAAA,2BAAa,EACrC,QAAQ,EACR,yEAAyE,CAC1E,CAAC;AAcF;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,KAAc,EACd,MAA4B,EAC5B,OAAgB;IAEhB,IAAA,oBAAM,EAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,gCAOC","sourcesContent":["import { assert } from 'superstruct';\nimport type { Struct } from 'superstruct';\n\nimport { definePattern } from './superstruct';\n\n/**\n * UUIDv4 struct.\n */\nexport const UuidStruct = definePattern(\n  'UuidV4',\n  /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/iu,\n);\n\n/**\n * Omit keys from a union type.\n *\n * The normal `Omit` type does not distribute over unions. So we use this\n * workaround that applies `Omit` to each member of the union.\n *\n * See: <https://github.com/microsoft/TypeScript/issues/31501#issuecomment-1280579305>\n */\nexport type OmitUnion<Type, Key extends keyof any> = Type extends any\n  ? Omit<Type, Key>\n  : never;\n\n/**\n * Assert that a value is valid according to a struct.\n *\n * It is similar to superstruct's mask function, but it does not ignore extra\n * properties.\n *\n * @param value - Value to check.\n * @param struct - Struct to validate the value against.\n * @param message - Error message to throw if the value is not valid.\n * @returns The value if it is valid.\n */\nexport function strictMask<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  message?: string,\n): Type {\n  assert(value, struct, message);\n  return value;\n}\n"]}