@metamask-previews/keyring-api 8.1.0-38c4bd5

package/dist/internal/types.d.ts

@@ -0,0 +1,330 @@
+import type { Infer, Struct } from '@metamask/superstruct';
+import { BtcAccountType, EthAccountType } from '../api';
+export declare type InternalAccountType = EthAccountType | BtcAccountType;
+export declare const InternalAccountMetadataStruct: Struct<{
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        snap: Struct<import("../superstruct").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare const InternalEthEoaAccountStruct: Struct<{
+    type: "eip155:eoa";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    address: Struct<string, null>;
+    type: Struct<"eip155:eoa", "eip155:eoa">;
+    methods: Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
+        personal_sign: "personal_sign";
+        eth_sign: "eth_sign";
+        eth_signTransaction: "eth_signTransaction";
+        eth_signTypedData_v1: "eth_signTypedData_v1";
+        eth_signTypedData_v3: "eth_signTypedData_v3";
+        eth_signTypedData_v4: "eth_signTypedData_v4";
+    }>>;
+    id: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+} & {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        snap: Struct<import("../superstruct").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare const InternalEthErc4337AccountStruct: Struct<{
+    type: "eip155:erc4337";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    address: Struct<string, null>;
+    type: Struct<"eip155:erc4337", "eip155:erc4337">;
+    methods: Struct<("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[], Struct<"personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation", {
+        personal_sign: "personal_sign";
+        eth_sign: "eth_sign";
+        eth_signTypedData_v1: "eth_signTypedData_v1";
+        eth_signTypedData_v3: "eth_signTypedData_v3";
+        eth_signTypedData_v4: "eth_signTypedData_v4";
+        eth_prepareUserOperation: "eth_prepareUserOperation";
+        eth_patchUserOperation: "eth_patchUserOperation";
+        eth_signUserOperation: "eth_signUserOperation";
+    }>>;
+    id: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+} & {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        snap: Struct<import("../superstruct").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare const InternalBtcP2wpkhAccountStruct: Struct<{
+    type: "bip122:p2wpkh";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: "btc_sendmany"[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    address: Struct<string, null>;
+    type: Struct<"bip122:p2wpkh", "bip122:p2wpkh">;
+    methods: Struct<"btc_sendmany"[], Struct<"btc_sendmany", {
+        btc_sendmany: "btc_sendmany";
+    }>>;
+    id: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+} & {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        snap: Struct<import("../superstruct").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+}>;
+export declare type InternalEthEoaAccount = Infer<typeof InternalEthEoaAccountStruct>;
+export declare type InternalEthErc4337Account = Infer<typeof InternalEthErc4337AccountStruct>;
+export declare type InternalBtcP2wpkhAccount = Infer<typeof InternalBtcP2wpkhAccountStruct>;
+export declare const InternalAccountStructs: Record<string, Struct<InternalEthEoaAccount> | Struct<InternalEthErc4337Account> | Struct<InternalBtcP2wpkhAccount>>;
+export declare type InternalAccountTypes = InternalEthEoaAccount | InternalEthErc4337Account | InternalBtcP2wpkhAccount;
+export declare const InternalAccountStruct: Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: string[];
+    metadata: {
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    };
+}, {
+    metadata: Struct<{
+        name: string;
+        importTime: number;
+        keyring: {
+            type: string;
+        };
+        nameLastUpdatedAt?: number;
+        snap?: {
+            id: string;
+            name: string;
+            enabled: boolean;
+        };
+        lastSelected?: number;
+    }, {
+        name: Struct<string, null>;
+        nameLastUpdatedAt: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        snap: Struct<import("../superstruct").ExactOptionalTag | {
+            id: string;
+            name: string;
+            enabled: boolean;
+        }, {
+            id: Struct<string, null>;
+            enabled: Struct<boolean, null>;
+            name: Struct<string, null>;
+        }>;
+        lastSelected: Struct<number | import("../superstruct").ExactOptionalTag, null>;
+        importTime: Struct<number, null>;
+        keyring: Struct<{
+            type: string;
+        }, {
+            type: Struct<string, null>;
+        }>;
+    }>;
+    id: Struct<string, null>;
+    type: Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+    }>;
+    address: Struct<string, null>;
+    options: Struct<Record<string, import("@metamask/utils").Json>, null>;
+    methods: Struct<string[], Struct<string, null>>;
+}>;
+/**
+ * Internal account representation.
+ *
+ * This type is used internally by MetaMask to add additional metadata to the
+ * account object. It's should not be used by external applications.
+ */
+export declare type InternalAccount = Infer<typeof InternalAccountStruct>;

package/dist/internal/types.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalAccountStruct = exports.InternalAccountStructs = exports.InternalBtcP2wpkhAccountStruct = exports.InternalEthErc4337AccountStruct = exports.InternalEthEoaAccountStruct = exports.InternalAccountMetadataStruct = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const api_1 = require("../api");
+const types_1 = require("../btc/types");
+const types_2 = require("../eth/types");
+const superstruct_2 = require("../superstruct");
+exports.InternalAccountMetadataStruct = (0, superstruct_2.object)({
+    metadata: (0, superstruct_2.object)({
+        name: (0, superstruct_1.string)(),
+        nameLastUpdatedAt: (0, superstruct_2.exactOptional)((0, superstruct_1.number)()),
+        snap: (0, superstruct_2.exactOptional)((0, superstruct_2.object)({
+            id: (0, superstruct_1.string)(),
+            enabled: (0, superstruct_1.boolean)(),
+            name: (0, superstruct_1.string)(),
+        })),
+        lastSelected: (0, superstruct_2.exactOptional)((0, superstruct_1.number)()),
+        importTime: (0, superstruct_1.number)(),
+        keyring: (0, superstruct_2.object)({
+            type: (0, superstruct_1.string)(),
+        }),
+    }),
+});
+/**
+ * Creates an `InternalAccount` from an existing account `superstruct` object.
+ *
+ * @param accountStruct - An account `superstruct` object.
+ * @returns The `InternalAccount` associated to `accountStruct`.
+ */
+function asInternalAccountStruct(accountStruct) {
+    return (0, superstruct_2.object)({
+        ...accountStruct.schema,
+        ...exports.InternalAccountMetadataStruct.schema,
+    });
+}
+exports.InternalEthEoaAccountStruct = asInternalAccountStruct(types_2.EthEoaAccountStruct);
+exports.InternalEthErc4337AccountStruct = asInternalAccountStruct(types_2.EthErc4337AccountStruct);
+exports.InternalBtcP2wpkhAccountStruct = asInternalAccountStruct(types_1.BtcP2wpkhAccountStruct);
+exports.InternalAccountStructs = {
+    [`${api_1.EthAccountType.Eoa}`]: exports.InternalEthEoaAccountStruct,
+    [`${api_1.EthAccountType.Erc4337}`]: exports.InternalEthErc4337AccountStruct,
+    [`${api_1.BtcAccountType.P2wpkh}`]: exports.InternalBtcP2wpkhAccountStruct,
+};
+exports.InternalAccountStruct = (0, superstruct_2.object)({
+    ...api_1.KeyringAccountStruct.schema,
+    ...exports.InternalAccountMetadataStruct.schema,
+});
+//# sourceMappingURL=types.js.map

package/dist/internal/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/internal/types.ts"],"names":[],"mappings":";;;AACA,uDAAgE;AAEhE,gCAA8E;AAC9E,wCAAsD;AACtD,wCAA4E;AAC5E,gDAAuD;AAI1C,QAAA,6BAA6B,GAAG,IAAA,oBAAM,EAAC;IAClD,QAAQ,EAAE,IAAA,oBAAM,EAAC;QACf,IAAI,EAAE,IAAA,oBAAM,GAAE;QACd,iBAAiB,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAC1C,IAAI,EAAE,IAAA,2BAAa,EACjB,IAAA,oBAAM,EAAC;YACL,EAAE,EAAE,IAAA,oBAAM,GAAE;YACZ,OAAO,EAAE,IAAA,qBAAO,GAAE;YAClB,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC,CACH;QACD,YAAY,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QACrC,UAAU,EAAE,IAAA,oBAAM,GAAE;QACpB,OAAO,EAAE,IAAA,oBAAM,EAAC;YACd,IAAI,EAAE,IAAA,oBAAM,GAAE;SACf,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAS,uBAAuB,CAC9B,aAA6C;IAE7C,OAAO,IAAA,oBAAM,EAAC;QACZ,GAAG,aAAa,CAAC,MAAM;QACvB,GAAG,qCAA6B,CAAC,MAAM;KACxC,CAAC,CAAC;AACL,CAAC;AAEY,QAAA,2BAA2B,GACtC,uBAAuB,CAAC,2BAAmB,CAAC,CAAC;AAElC,QAAA,+BAA+B,GAAG,uBAAuB,CACpE,+BAAuB,CACxB,CAAC;AAEW,QAAA,8BAA8B,GAAG,uBAAuB,CACnE,8BAAsB,CACvB,CAAC;AAYW,QAAA,sBAAsB,GAK/B;IACF,CAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC,EAAE,mCAA2B;IACtD,CAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC,EAAE,uCAA+B;IAC9D,CAAC,GAAG,oBAAc,CAAC,MAAM,EAAE,CAAC,EAAE,sCAA8B;CAC7D,CAAC;AAOW,QAAA,qBAAqB,GAAG,IAAA,oBAAM,EAAC;IAC1C,GAAG,0BAAoB,CAAC,MAAM;IAC9B,GAAG,qCAA6B,CAAC,MAAM;CACxC,CAAC,CAAC","sourcesContent":["import type { Infer, Struct } from '@metamask/superstruct';\nimport { boolean, string, number } from '@metamask/superstruct';\n\nimport { BtcAccountType, EthAccountType, KeyringAccountStruct } from '../api';\nimport { BtcP2wpkhAccountStruct } from '../btc/types';\nimport { EthEoaAccountStruct, EthErc4337AccountStruct } from '../eth/types';\nimport { exactOptional, object } from '../superstruct';\n\nexport type InternalAccountType = EthAccountType | BtcAccountType;\n\nexport const InternalAccountMetadataStruct = object({\n  metadata: object({\n    name: string(),\n    nameLastUpdatedAt: exactOptional(number()),\n    snap: exactOptional(\n      object({\n        id: string(),\n        enabled: boolean(),\n        name: string(),\n      }),\n    ),\n    lastSelected: exactOptional(number()),\n    importTime: number(),\n    keyring: object({\n      type: string(),\n    }),\n  }),\n});\n\n/**\n * Creates an `InternalAccount` from an existing account `superstruct` object.\n *\n * @param accountStruct - An account `superstruct` object.\n * @returns The `InternalAccount` associated to `accountStruct`.\n */\nfunction asInternalAccountStruct<Account, AccountSchema>(\n  accountStruct: Struct<Account, AccountSchema>,\n) {\n  return object({\n    ...accountStruct.schema,\n    ...InternalAccountMetadataStruct.schema,\n  });\n}\n\nexport const InternalEthEoaAccountStruct =\n  asInternalAccountStruct(EthEoaAccountStruct);\n\nexport const InternalEthErc4337AccountStruct = asInternalAccountStruct(\n  EthErc4337AccountStruct,\n);\n\nexport const InternalBtcP2wpkhAccountStruct = asInternalAccountStruct(\n  BtcP2wpkhAccountStruct,\n);\n\nexport type InternalEthEoaAccount = Infer<typeof InternalEthEoaAccountStruct>;\n\nexport type InternalEthErc4337Account = Infer<\n  typeof InternalEthErc4337AccountStruct\n>;\n\nexport type InternalBtcP2wpkhAccount = Infer<\n  typeof InternalBtcP2wpkhAccountStruct\n>;\n\nexport const InternalAccountStructs: Record<\n  string,\n  | Struct<InternalEthEoaAccount>\n  | Struct<InternalEthErc4337Account>\n  | Struct<InternalBtcP2wpkhAccount>\n> = {\n  [`${EthAccountType.Eoa}`]: InternalEthEoaAccountStruct,\n  [`${EthAccountType.Erc4337}`]: InternalEthErc4337AccountStruct,\n  [`${BtcAccountType.P2wpkh}`]: InternalBtcP2wpkhAccountStruct,\n};\n\nexport type InternalAccountTypes =\n  | InternalEthEoaAccount\n  | InternalEthErc4337Account\n  | InternalBtcP2wpkhAccount;\n\nexport const InternalAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n  ...InternalAccountMetadataStruct.schema,\n});\n\n/**\n * Internal account representation.\n *\n * This type is used internally by MetaMask to add additional metadata to the\n * account object. It's should not be used by external applications.\n */\nexport type InternalAccount = Infer<typeof InternalAccountStruct>;\n"]}

package/dist/rpc-handler.d.ts

@@ -0,0 +1,29 @@
+import type { Json } from '@metamask/utils';
+import type { Keyring } from './api';
+import type { JsonRpcRequest } from './JsonRpcRequest';
+/**
+ * Error thrown when a keyring JSON-RPC method is not supported.
+ */
+export declare class MethodNotSupportedError extends Error {
+    constructor(method: string);
+}
+/**
+ * Handles a keyring JSON-RPC request.
+ *
+ * This function is meant to be used as a handler for Keyring JSON-RPC requests
+ * in an Accounts Snap.
+ *
+ * @param keyring - Keyring instance.
+ * @param request - Keyring JSON-RPC request.
+ * @returns A promise that resolves to the keyring response.
+ * @example
+ * ```ts
+ * export const onKeyringRequest: OnKeyringRequestHandler = async ({
+ *   origin,
+ *   request,
+ * }) => {
+ *   return await handleKeyringRequest(keyring, request);
+ * };
+ * ```
+ */
+export declare function handleKeyringRequest(keyring: Keyring, request: JsonRpcRequest): Promise<Json | void>;

package/dist/rpc-handler.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleKeyringRequest = exports.MethodNotSupportedError = void 0;
+const superstruct_1 = require("@metamask/superstruct");
+const api_1 = require("./internal/api");
+const rpc_1 = require("./internal/rpc");
+const JsonRpcRequest_1 = require("./JsonRpcRequest");
+/**
+ * Error thrown when a keyring JSON-RPC method is not supported.
+ */
+class MethodNotSupportedError extends Error {
+    constructor(method) {
+        super(`Method not supported: ${method}`);
+    }
+}
+exports.MethodNotSupportedError = MethodNotSupportedError;
+/**
+ * Inner function that dispatches JSON-RPC request to the associated Keyring
+ * methods.
+ *
+ * @param keyring - Keyring instance.
+ * @param request - Keyring JSON-RPC request.
+ * @returns A promise that resolves to the keyring response.
+ */
+async function dispatchRequest(keyring, request) {
+    // We first have to make sure that the request is a valid JSON-RPC request so
+    // we can check its method name.
+    (0, superstruct_1.assert)(request, JsonRpcRequest_1.JsonRpcRequestStruct);
+    switch (request.method) {
+        case rpc_1.KeyringRpcMethod.ListAccounts: {
+            (0, superstruct_1.assert)(request, api_1.ListAccountsRequestStruct);
+            return keyring.listAccounts();
+        }
+        case rpc_1.KeyringRpcMethod.GetAccount: {
+            (0, superstruct_1.assert)(request, api_1.GetAccountRequestStruct);
+            return keyring.getAccount(request.params.id);
+        }
+        case rpc_1.KeyringRpcMethod.CreateAccount: {
+            (0, superstruct_1.assert)(request, api_1.CreateAccountRequestStruct);
+            return keyring.createAccount(request.params.options);
+        }
+        case rpc_1.KeyringRpcMethod.GetAccountBalances: {
+            if (keyring.getAccountBalances === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, api_1.GetAccountBalancesRequestStruct);
+            return keyring.getAccountBalances(request.params.id, request.params.assets);
+        }
+        case rpc_1.KeyringRpcMethod.FilterAccountChains: {
+            (0, superstruct_1.assert)(request, api_1.FilterAccountChainsStruct);
+            return keyring.filterAccountChains(request.params.id, request.params.chains);
+        }
+        case rpc_1.KeyringRpcMethod.UpdateAccount: {
+            (0, superstruct_1.assert)(request, api_1.UpdateAccountRequestStruct);
+            return keyring.updateAccount(request.params.account);
+        }
+        case rpc_1.KeyringRpcMethod.DeleteAccount: {
+            (0, superstruct_1.assert)(request, api_1.DeleteAccountRequestStruct);
+            return keyring.deleteAccount(request.params.id);
+        }
+        case rpc_1.KeyringRpcMethod.ExportAccount: {
+            if (keyring.exportAccount === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, api_1.ExportAccountRequestStruct);
+            return keyring.exportAccount(request.params.id);
+        }
+        case rpc_1.KeyringRpcMethod.ListRequests: {
+            if (keyring.listRequests === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, api_1.ListRequestsRequestStruct);
+            return keyring.listRequests();
+        }
+        case rpc_1.KeyringRpcMethod.GetRequest: {
+            if (keyring.getRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, api_1.GetRequestRequestStruct);
+            return keyring.getRequest(request.params.id);
+        }
+        case rpc_1.KeyringRpcMethod.SubmitRequest: {
+            (0, superstruct_1.assert)(request, api_1.SubmitRequestRequestStruct);
+            return keyring.submitRequest(request.params);
+        }
+        case rpc_1.KeyringRpcMethod.ApproveRequest: {
+            if (keyring.approveRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, api_1.ApproveRequestRequestStruct);
+            return keyring.approveRequest(request.params.id, request.params.data);
+        }
+        case rpc_1.KeyringRpcMethod.RejectRequest: {
+            if (keyring.rejectRequest === undefined) {
+                throw new MethodNotSupportedError(request.method);
+            }
+            (0, superstruct_1.assert)(request, api_1.RejectRequestRequestStruct);
+            return keyring.rejectRequest(request.params.id);
+        }
+        default: {
+            throw new MethodNotSupportedError(request.method);
+        }
+    }
+}
+/**
+ * Handles a keyring JSON-RPC request.
+ *
+ * This function is meant to be used as a handler for Keyring JSON-RPC requests
+ * in an Accounts Snap.
+ *
+ * @param keyring - Keyring instance.
+ * @param request - Keyring JSON-RPC request.
+ * @returns A promise that resolves to the keyring response.
+ * @example
+ * ```ts
+ * export const onKeyringRequest: OnKeyringRequestHandler = async ({
+ *   origin,
+ *   request,
+ * }) => {
+ *   return await handleKeyringRequest(keyring, request);
+ * };
+ * ```
+ */
+async function handleKeyringRequest(keyring, request) {
+    try {
+        return await dispatchRequest(keyring, request);
+    }
+    catch (error) {
+        const message = error instanceof Error && typeof error.message === 'string'
+            ? error.message
+            : 'An unknown error occurred while handling the keyring request';
+        throw new Error(message);
+    }
+}
+exports.handleKeyringRequest = handleKeyringRequest;
+//# sourceMappingURL=rpc-handler.js.map

package/dist/rpc-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-handler.js","sourceRoot":"","sources":["../src/rpc-handler.ts"],"names":[],"mappings":";;;AAAA,uDAA+C;AAI/C,wCAcwB;AACxB,wCAAkD;AAElD,qDAAwD;AAExD;;GAEG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAChD,YAAY,MAAc;QACxB,KAAK,CAAC,yBAAyB,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,0DAIC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAC5B,OAAgB,EAChB,OAAuB;IAEvB,6EAA6E;IAC7E,gCAAgC;IAChC,IAAA,oBAAM,EAAC,OAAO,EAAE,qCAAoB,CAAC,CAAC;IAEtC,QAAQ,OAAO,CAAC,MAAM,EAAE;QACtB,KAAK,sBAAgB,CAAC,YAAY,CAAC,CAAC;YAClC,IAAA,oBAAM,EAAC,OAAO,EAAE,+BAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;SAC/B;QAED,KAAK,sBAAgB,CAAC,UAAU,CAAC,CAAC;YAChC,IAAA,oBAAM,EAAC,OAAO,EAAE,6BAAuB,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC9C;QAED,KAAK,sBAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,gCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,KAAK,sBAAgB,CAAC,kBAAkB,CAAC,CAAC;YACxC,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS,EAAE;gBAC5C,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,qCAA+B,CAAC,CAAC;YACjD,OAAO,OAAO,CAAC,kBAAkB,CAC/B,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CACtB,CAAC;SACH;QAED,KAAK,sBAAgB,CAAC,mBAAmB,CAAC,CAAC;YACzC,IAAA,oBAAM,EAAC,OAAO,EAAE,+BAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,mBAAmB,CAChC,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CACtB,CAAC;SACH;QAED,KAAK,sBAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,gCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SACtD;QAED,KAAK,sBAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,gCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,KAAK,sBAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE;gBACvC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,gCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,KAAK,sBAAgB,CAAC,YAAY,CAAC,CAAC;YAClC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;gBACtC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,+BAAyB,CAAC,CAAC;YAC3C,OAAO,OAAO,CAAC,YAAY,EAAE,CAAC;SAC/B;QAED,KAAK,sBAAgB,CAAC,UAAU,CAAC,CAAC;YAChC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE;gBACpC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,6BAAuB,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC9C;QAED,KAAK,sBAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAA,oBAAM,EAAC,OAAO,EAAE,gCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAC9C;QAED,KAAK,sBAAgB,CAAC,cAAc,CAAC,CAAC;YACpC,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE;gBACxC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,iCAA2B,CAAC,CAAC;YAC7C,OAAO,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACvE;QAED,KAAK,sBAAgB,CAAC,aAAa,CAAC,CAAC;YACnC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE;gBACvC,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACnD;YACD,IAAA,oBAAM,EAAC,OAAO,EAAE,gCAA0B,CAAC,CAAC;YAC5C,OAAO,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACnD;KACF;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAgB,EAChB,OAAuB;IAEvB,IAAI;QACF,OAAO,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KAChD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;YACzD,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,8DAA8D,CAAC;QAErE,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;KAC1B;AACH,CAAC;AAdD,oDAcC","sourcesContent":["import { assert } from '@metamask/superstruct';\nimport type { Json } from '@metamask/utils';\n\nimport type { Keyring } from './api';\nimport {\n  GetAccountRequestStruct,\n  CreateAccountRequestStruct,\n  ApproveRequestRequestStruct,\n  DeleteAccountRequestStruct,\n  ExportAccountRequestStruct,\n  GetRequestRequestStruct,\n  RejectRequestRequestStruct,\n  SubmitRequestRequestStruct,\n  UpdateAccountRequestStruct,\n  FilterAccountChainsStruct,\n  ListAccountsRequestStruct,\n  ListRequestsRequestStruct,\n  GetAccountBalancesRequestStruct,\n} from './internal/api';\nimport { KeyringRpcMethod } from './internal/rpc';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { JsonRpcRequestStruct } from './JsonRpcRequest';\n\n/**\n * Error thrown when a keyring JSON-RPC method is not supported.\n */\nexport class MethodNotSupportedError extends Error {\n  constructor(method: string) {\n    super(`Method not supported: ${method}`);\n  }\n}\n\n/**\n * Inner function that dispatches JSON-RPC request to the associated Keyring\n * methods.\n *\n * @param keyring - Keyring instance.\n * @param request - Keyring JSON-RPC request.\n * @returns A promise that resolves to the keyring response.\n */\nasync function dispatchRequest(\n  keyring: Keyring,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  // We first have to make sure that the request is a valid JSON-RPC request so\n  // we can check its method name.\n  assert(request, JsonRpcRequestStruct);\n\n  switch (request.method) {\n    case KeyringRpcMethod.ListAccounts: {\n      assert(request, ListAccountsRequestStruct);\n      return keyring.listAccounts();\n    }\n\n    case KeyringRpcMethod.GetAccount: {\n      assert(request, GetAccountRequestStruct);\n      return keyring.getAccount(request.params.id);\n    }\n\n    case KeyringRpcMethod.CreateAccount: {\n      assert(request, CreateAccountRequestStruct);\n      return keyring.createAccount(request.params.options);\n    }\n\n    case KeyringRpcMethod.GetAccountBalances: {\n      if (keyring.getAccountBalances === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, GetAccountBalancesRequestStruct);\n      return keyring.getAccountBalances(\n        request.params.id,\n        request.params.assets,\n      );\n    }\n\n    case KeyringRpcMethod.FilterAccountChains: {\n      assert(request, FilterAccountChainsStruct);\n      return keyring.filterAccountChains(\n        request.params.id,\n        request.params.chains,\n      );\n    }\n\n    case KeyringRpcMethod.UpdateAccount: {\n      assert(request, UpdateAccountRequestStruct);\n      return keyring.updateAccount(request.params.account);\n    }\n\n    case KeyringRpcMethod.DeleteAccount: {\n      assert(request, DeleteAccountRequestStruct);\n      return keyring.deleteAccount(request.params.id);\n    }\n\n    case KeyringRpcMethod.ExportAccount: {\n      if (keyring.exportAccount === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ExportAccountRequestStruct);\n      return keyring.exportAccount(request.params.id);\n    }\n\n    case KeyringRpcMethod.ListRequests: {\n      if (keyring.listRequests === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ListRequestsRequestStruct);\n      return keyring.listRequests();\n    }\n\n    case KeyringRpcMethod.GetRequest: {\n      if (keyring.getRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, GetRequestRequestStruct);\n      return keyring.getRequest(request.params.id);\n    }\n\n    case KeyringRpcMethod.SubmitRequest: {\n      assert(request, SubmitRequestRequestStruct);\n      return keyring.submitRequest(request.params);\n    }\n\n    case KeyringRpcMethod.ApproveRequest: {\n      if (keyring.approveRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, ApproveRequestRequestStruct);\n      return keyring.approveRequest(request.params.id, request.params.data);\n    }\n\n    case KeyringRpcMethod.RejectRequest: {\n      if (keyring.rejectRequest === undefined) {\n        throw new MethodNotSupportedError(request.method);\n      }\n      assert(request, RejectRequestRequestStruct);\n      return keyring.rejectRequest(request.params.id);\n    }\n\n    default: {\n      throw new MethodNotSupportedError(request.method);\n    }\n  }\n}\n\n/**\n * Handles a keyring JSON-RPC request.\n *\n * This function is meant to be used as a handler for Keyring JSON-RPC requests\n * in an Accounts Snap.\n *\n * @param keyring - Keyring instance.\n * @param request - Keyring JSON-RPC request.\n * @returns A promise that resolves to the keyring response.\n * @example\n * ```ts\n * export const onKeyringRequest: OnKeyringRequestHandler = async ({\n *   origin,\n *   request,\n * }) => {\n *   return await handleKeyringRequest(keyring, request);\n * };\n * ```\n */\nexport async function handleKeyringRequest(\n  keyring: Keyring,\n  request: JsonRpcRequest,\n): Promise<Json | void> {\n  try {\n    return await dispatchRequest(keyring, request);\n  } catch (error) {\n    const message =\n      error instanceof Error && typeof error.message === 'string'\n        ? error.message\n        : 'An unknown error occurred while handling the keyring request';\n\n    throw new Error(message);\n  }\n}\n"]}

package/dist/snap-utils.d.ts

@@ -0,0 +1,11 @@
+import type { SnapsProvider } from '@metamask/snaps-sdk';
+import type { Json } from '@metamask/utils';
+import type { KeyringEvent } from './events';
+/**
+ * Emit a keyring event from a snap.
+ *
+ * @param snap - The global snap object.
+ * @param event - The event name.
+ * @param data - The event data.
+ */
+export declare function emitSnapKeyringEvent(snap: SnapsProvider, event: KeyringEvent, data: Record<string, Json>): Promise<void>;

package/dist/snap-utils.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitSnapKeyringEvent = void 0;
+/**
+ * Emit a keyring event from a snap.
+ *
+ * @param snap - The global snap object.
+ * @param event - The event name.
+ * @param data - The event data.
+ */
+async function emitSnapKeyringEvent(snap, event, data) {
+    await snap.request({
+        method: 'snap_manageAccounts',
+        params: {
+            method: event,
+            params: { ...data },
+        },
+    });
+}
+exports.emitSnapKeyringEvent = emitSnapKeyringEvent;
+//# sourceMappingURL=snap-utils.js.map

package/dist/snap-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snap-utils.js","sourceRoot":"","sources":["../src/snap-utils.ts"],"names":[],"mappings":";;;AAKA;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,IAAmB,EACnB,KAAmB,EACnB,IAA0B;IAE1B,MAAM,IAAI,CAAC,OAAO,CAAC;QACjB,MAAM,EAAE,qBAAqB;QAC7B,MAAM,EAAE;YACN,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,EAAE,GAAG,IAAI,EAAE;SACpB;KACF,CAAC,CAAC;AACL,CAAC;AAZD,oDAYC","sourcesContent":["import type { SnapsProvider } from '@metamask/snaps-sdk';\nimport type { Json } from '@metamask/utils';\n\nimport type { KeyringEvent } from './events';\n\n/**\n * Emit a keyring event from a snap.\n *\n * @param snap - The global snap object.\n * @param event - The event name.\n * @param data - The event data.\n */\nexport async function emitSnapKeyringEvent(\n  snap: SnapsProvider,\n  event: KeyringEvent,\n  data: Record<string, Json>,\n): Promise<void> {\n  await snap.request({\n    method: 'snap_manageAccounts',\n    params: {\n      method: event,\n      params: { ...data },\n    },\n  });\n}\n"]}