@metamask-previews/keyring-api 22.0.0-018fb62 → 22.0.0-5c366be

package/CHANGELOG.md

@@ -7,8 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add keyring v2 RPC types and structs (`KeyringRpcV2`, `KeyringRpcV2Method`, `isKeyringRpcV2Method`, and request/response structs) ([#408](https://github.com/MetaMask/accounts/pull/408))
+
 ### Changed
 
+- Improve return type of `isKeyringRpcMethod` to use type predicate `method is KeyringRpcMethod` ([#408](https://github.com/MetaMask/accounts/pull/408))
 - Bump `@metamask/utils` from `^11.1.0` to `^11.10.0` ([#489](https://github.com/MetaMask/accounts/pull/489))
 
 ## [22.0.0]

package/dist/api/v2/index.cjs

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./keyring-capabilities.cjs"), exports);
 __exportStar(require("./keyring-type.cjs"), exports);
+__exportStar(require("./keyring-rpc.cjs"), exports);
 __exportStar(require("./create-account/index.cjs"), exports);
 __exportStar(require("./export-account/index.cjs"), exports);
 __exportStar(require("./private-key.cjs"), exports);

package/dist/api/v2/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,6DAAuC;AACvC,qDAA+B;AAC/B,6DAAiC;AACjC,6DAAiC;AACjC,oDAA8B","sourcesContent":["export type * from './keyring';\nexport * from './keyring-capabilities';\nexport * from './keyring-type';\nexport * from './create-account';\nexport * from './export-account';\nexport * from './private-key';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,6DAAuC;AACvC,qDAA+B;AAC/B,oDAA8B;AAC9B,6DAAiC;AACjC,6DAAiC;AACjC,oDAA8B","sourcesContent":["export type * from './keyring';\nexport * from './keyring-capabilities';\nexport * from './keyring-type';\nexport * from './keyring-rpc';\nexport * from './create-account';\nexport * from './export-account';\nexport * from './private-key';\n"]}

package/dist/api/v2/index.d.cts

@@ -1,6 +1,7 @@
 export type * from "./keyring.cjs";
 export * from "./keyring-capabilities.cjs";
 export * from "./keyring-type.cjs";
+export * from "./keyring-rpc.cjs";
 export * from "./create-account/index.cjs";
 export * from "./export-account/index.cjs";
 export * from "./private-key.cjs";

package/dist/api/v2/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AAAA,mCAA+B;AAC/B,2CAAuC;AACvC,mCAA+B;AAC/B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AAAA,mCAA+B;AAC/B,2CAAuC;AACvC,mCAA+B;AAC/B,kCAA8B;AAC9B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B"}

package/dist/api/v2/index.d.mts

@@ -1,6 +1,7 @@
 export type * from "./keyring.mjs";
 export * from "./keyring-capabilities.mjs";
 export * from "./keyring-type.mjs";
+export * from "./keyring-rpc.mjs";
 export * from "./create-account/index.mjs";
 export * from "./export-account/index.mjs";
 export * from "./private-key.mjs";

package/dist/api/v2/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AAAA,mCAA+B;AAC/B,2CAAuC;AACvC,mCAA+B;AAC/B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AAAA,mCAA+B;AAC/B,2CAAuC;AACvC,mCAA+B;AAC/B,kCAA8B;AAC9B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B"}

package/dist/api/v2/index.mjs

@@ -1,5 +1,6 @@
 export * from "./keyring-capabilities.mjs";
 export * from "./keyring-type.mjs";
+export * from "./keyring-rpc.mjs";
 export * from "./create-account/index.mjs";
 export * from "./export-account/index.mjs";
 export * from "./private-key.mjs";

package/dist/api/v2/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AACA,2CAAuC;AACvC,mCAA+B;AAC/B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B","sourcesContent":["export type * from './keyring';\nexport * from './keyring-capabilities';\nexport * from './keyring-type';\nexport * from './create-account';\nexport * from './export-account';\nexport * from './private-key';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/api/v2/index.ts"],"names":[],"mappings":"AACA,2CAAuC;AACvC,mCAA+B;AAC/B,kCAA8B;AAC9B,2CAAiC;AACjC,2CAAiC;AACjC,kCAA8B","sourcesContent":["export type * from './keyring';\nexport * from './keyring-capabilities';\nexport * from './keyring-type';\nexport * from './keyring-rpc';\nexport * from './create-account';\nexport * from './export-account';\nexport * from './private-key';\n"]}

package/dist/api/v2/keyring-rpc.cjs

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmitRequestV2ResponseStruct = exports.SubmitRequestV2RequestStruct = exports.ExportAccountV2ResponseStruct = exports.ExportAccountV2RequestStruct = exports.DeleteAccountV2ResponseStruct = exports.DeleteAccountV2RequestStruct = exports.CreateAccountsV2ResponseStruct = exports.CreateAccountsV2RequestStruct = exports.GetAccountV2ResponseStruct = exports.GetAccountV2RequestStruct = exports.GetAccountsV2ResponseStruct = exports.GetAccountsV2RequestStruct = exports.KeyringRpcV2Method = void 0;
+exports.isKeyringRpcV2Method = isKeyringRpcV2Method;
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const create_account_1 = require("./create-account/index.cjs");
+const export_account_1 = require("./export-account/index.cjs");
+const account_1 = require("../account.cjs");
+const request_1 = require("../request.cjs");
+/**
+ * Keyring RPC methods used by the API.
+ */
+exports.KeyringRpcV2Method = {
+    GetAccounts: 'keyring_getAccounts',
+    CreateAccounts: 'keyring_createAccounts',
+    // Inherited from v1 (but method signatures may differ...):
+    // NOTE: We use literals here to avoid circular dependencies.
+    GetAccount: 'keyring_getAccount',
+    DeleteAccount: 'keyring_deleteAccount',
+    ExportAccount: 'keyring_exportAccount',
+    SubmitRequest: 'keyring_submitRequest',
+};
+/**
+ * Check if a method is a keyring RPC method (v2).
+ *
+ * @param method - Method to check.
+ * @returns Whether the method is a keyring RPC method (v2).
+ */
+function isKeyringRpcV2Method(method) {
+    return Object.values(exports.KeyringRpcV2Method).includes(method);
+}
+// ----------------------------------------------------------------------------
+const CommonHeader = {
+    jsonrpc: (0, superstruct_1.literal)('2.0'),
+    id: (0, superstruct_1.union)([(0, superstruct_1.string)(), (0, superstruct_1.number)(), (0, superstruct_1.literal)(null)]),
+};
+// ----------------------------------------------------------------------------
+// Get accounts
+exports.GetAccountsV2RequestStruct = (0, keyring_utils_1.object)({
+    ...CommonHeader,
+    method: (0, superstruct_1.literal)(`${exports.KeyringRpcV2Method.GetAccounts}`),
+});
+exports.GetAccountsV2ResponseStruct = (0, superstruct_1.array)(account_1.KeyringAccountStruct);
+// ----------------------------------------------------------------------------
+// Get account
+exports.GetAccountV2RequestStruct = (0, keyring_utils_1.object)({
+    ...CommonHeader,
+    method: (0, superstruct_1.literal)(`${exports.KeyringRpcV2Method.GetAccount}`),
+    params: (0, keyring_utils_1.object)({
+        id: keyring_utils_1.UuidStruct,
+    }),
+});
+exports.GetAccountV2ResponseStruct = account_1.KeyringAccountStruct;
+// ----------------------------------------------------------------------------
+// Create accounts
+exports.CreateAccountsV2RequestStruct = (0, keyring_utils_1.object)({
+    ...CommonHeader,
+    method: (0, superstruct_1.literal)(`${exports.KeyringRpcV2Method.CreateAccounts}`),
+    params: create_account_1.CreateAccountOptionsStruct,
+});
+exports.CreateAccountsV2ResponseStruct = (0, superstruct_1.array)(account_1.KeyringAccountStruct);
+// ----------------------------------------------------------------------------
+// Delete account
+exports.DeleteAccountV2RequestStruct = (0, keyring_utils_1.object)({
+    ...CommonHeader,
+    method: (0, superstruct_1.literal)(`${exports.KeyringRpcV2Method.DeleteAccount}`),
+    params: (0, keyring_utils_1.object)({
+        id: keyring_utils_1.UuidStruct,
+    }),
+});
+exports.DeleteAccountV2ResponseStruct = (0, superstruct_1.literal)(null);
+// ----------------------------------------------------------------------------
+// Export account
+exports.ExportAccountV2RequestStruct = (0, keyring_utils_1.object)({
+    ...CommonHeader,
+    method: (0, superstruct_1.literal)(`${exports.KeyringRpcV2Method.ExportAccount}`),
+    params: (0, keyring_utils_1.object)({
+        id: keyring_utils_1.UuidStruct,
+        options: (0, keyring_utils_1.exactOptional)(export_account_1.ExportAccountOptionsStruct),
+    }),
+});
+exports.ExportAccountV2ResponseStruct = export_account_1.PrivateKeyExportedAccountStruct;
+// ----------------------------------------------------------------------------
+// Submit request
+exports.SubmitRequestV2RequestStruct = (0, keyring_utils_1.object)({
+    ...CommonHeader,
+    method: (0, superstruct_1.literal)(`${exports.KeyringRpcV2Method.SubmitRequest}`),
+    params: request_1.KeyringRequestStruct,
+});
+exports.SubmitRequestV2ResponseStruct = utils_1.JsonStruct;
+//# sourceMappingURL=keyring-rpc.cjs.map

package/dist/api/v2/keyring-rpc.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-rpc.cjs","sourceRoot":"","sources":["../../../src/api/v2/keyring-rpc.ts"],"names":[],"mappings":";;;AAqDA,oDAMC;AA3DD,2DAA4E;AAE5E,uDAA8E;AAC9E,2CAA6C;AAE7C,+DAA8D;AAC9D,+DAG0B;AAE1B,4CAAkD;AAClD,4CAAkD;AAelD;;GAEG;AACU,QAAA,kBAAkB,GAAG;IAChC,WAAW,EAAE,qBAAqB;IAClC,cAAc,EAAE,wBAAwB;IACxC,2DAA2D;IAC3D,6DAA6D;IAC7D,UAAU,EAAE,oBAAoB;IAChC,aAAa,EAAE,uBAAuB;IACtC,aAAa,EAAE,uBAAuB;IACtC,aAAa,EAAE,uBAAuB;CAC9B,CAAC;AAQX;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,MAAc;IAEd,OAAO,MAAM,CAAC,MAAM,CAAC,0BAAkB,CAAC,CAAC,QAAQ,CAC/C,MAA4B,CAC7B,CAAC;AACJ,CAAC;AAED,+EAA+E;AAE/E,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;IACvB,EAAE,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,oBAAM,GAAE,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;CAC/C,CAAC;AAEF,+EAA+E;AAC/E,eAAe;AAEF,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,GAAG,YAAY;IACf,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,0BAAkB,CAAC,WAAW,EAAE,CAAC;CACrD,CAAC,CAAC;AAIU,QAAA,2BAA2B,GAAG,IAAA,mBAAK,EAAC,8BAAoB,CAAC,CAAC;AAIvE,+EAA+E;AAC/E,cAAc;AAED,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,GAAG,YAAY;IACf,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,0BAAkB,CAAC,UAAU,EAAE,CAAC;IACnD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,0BAA0B,GAAG,8BAAoB,CAAC;AAI/D,+EAA+E;AAC/E,kBAAkB;AAEL,QAAA,6BAA6B,GAAG,IAAA,sBAAM,EAAC;IAClD,GAAG,YAAY;IACf,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,0BAAkB,CAAC,cAAc,EAAE,CAAC;IACvD,MAAM,EAAE,2CAA0B;CACnC,CAAC,CAAC;AAMU,QAAA,8BAA8B,GAAG,IAAA,mBAAK,EAAC,8BAAoB,CAAC,CAAC;AAM1E,+EAA+E;AAC/E,iBAAiB;AAEJ,QAAA,4BAA4B,GAAG,IAAA,sBAAM,EAAC;IACjD,GAAG,YAAY;IACf,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,0BAAkB,CAAC,aAAa,EAAE,CAAC;IACtD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,6BAA6B,GAAG,IAAA,qBAAO,EAAC,IAAI,CAAC,CAAC;AAM3D,+EAA+E;AAC/E,iBAAiB;AAEJ,QAAA,4BAA4B,GAAG,IAAA,sBAAM,EAAC;IACjD,GAAG,YAAY;IACf,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,0BAAkB,CAAC,aAAa,EAAE,CAAC;IACtD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb,EAAE,EAAE,0BAAU;QACd,OAAO,EAAE,IAAA,6BAAa,EAAC,2CAA0B,CAAC;KACnD,CAAC;CACH,CAAC,CAAC;AAIU,QAAA,6BAA6B,GAAG,gDAA+B,CAAC;AAM7E,+EAA+E;AAC/E,iBAAiB;AAEJ,QAAA,4BAA4B,GAAG,IAAA,sBAAM,EAAC;IACjD,GAAG,YAAY;IACf,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,0BAAkB,CAAC,aAAa,EAAE,CAAC;IACtD,MAAM,EAAE,8BAAoB;CAC7B,CAAC,CAAC;AAIU,QAAA,6BAA6B,GAAG,kBAAU,CAAC","sourcesContent":["import { object, exactOptional, UuidStruct } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, literal, number, string, union } from '@metamask/superstruct';\nimport { JsonStruct } from '@metamask/utils';\n\nimport { CreateAccountOptionsStruct } from './create-account';\nimport {\n  ExportAccountOptionsStruct,\n  PrivateKeyExportedAccountStruct,\n} from './export-account';\nimport type { KeyringV2 } from './keyring';\nimport { KeyringAccountStruct } from '../account';\nimport { KeyringRequestStruct } from '../request';\n\n/**\n * Keyring interface for keyring methods that can be invoked through\n * RPC calls.\n */\nexport type KeyringRpcV2 = {\n  getAccount: KeyringV2['getAccount'];\n  getAccounts: KeyringV2['getAccounts'];\n  createAccounts: KeyringV2['createAccounts'];\n  deleteAccount: KeyringV2['deleteAccount'];\n  submitRequest: KeyringV2['submitRequest'];\n  exportAccount?: KeyringV2['exportAccount'];\n};\n\n/**\n * Keyring RPC methods used by the API.\n */\nexport const KeyringRpcV2Method = {\n  GetAccounts: 'keyring_getAccounts',\n  CreateAccounts: 'keyring_createAccounts',\n  // Inherited from v1 (but method signatures may differ...):\n  // NOTE: We use literals here to avoid circular dependencies.\n  GetAccount: 'keyring_getAccount',\n  DeleteAccount: 'keyring_deleteAccount',\n  ExportAccount: 'keyring_exportAccount',\n  SubmitRequest: 'keyring_submitRequest',\n} as const;\n\n/**\n * Keyring RPC methods used by the API.\n */\nexport type KeyringRpcV2Method =\n  (typeof KeyringRpcV2Method)[keyof typeof KeyringRpcV2Method];\n\n/**\n * Check if a method is a keyring RPC method (v2).\n *\n * @param method - Method to check.\n * @returns Whether the method is a keyring RPC method (v2).\n */\nexport function isKeyringRpcV2Method(\n  method: string,\n): method is KeyringRpcV2Method {\n  return Object.values(KeyringRpcV2Method).includes(\n    method as KeyringRpcV2Method,\n  );\n}\n\n// ----------------------------------------------------------------------------\n\nconst CommonHeader = {\n  jsonrpc: literal('2.0'),\n  id: union([string(), number(), literal(null)]),\n};\n\n// ----------------------------------------------------------------------------\n// Get accounts\n\nexport const GetAccountsV2RequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringRpcV2Method.GetAccounts}`),\n});\n\nexport type GetAccountsV2Request = Infer<typeof GetAccountsV2RequestStruct>;\n\nexport const GetAccountsV2ResponseStruct = array(KeyringAccountStruct);\n\nexport type GetAccountsV2Response = Infer<typeof GetAccountsV2ResponseStruct>;\n\n// ----------------------------------------------------------------------------\n// Get account\n\nexport const GetAccountV2RequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringRpcV2Method.GetAccount}`),\n  params: object({\n    id: UuidStruct,\n  }),\n});\n\nexport type GetAccountV2Request = Infer<typeof GetAccountV2RequestStruct>;\n\nexport const GetAccountV2ResponseStruct = KeyringAccountStruct;\n\nexport type GetAccountV2Response = Infer<typeof GetAccountV2ResponseStruct>;\n\n// ----------------------------------------------------------------------------\n// Create accounts\n\nexport const CreateAccountsV2RequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringRpcV2Method.CreateAccounts}`),\n  params: CreateAccountOptionsStruct,\n});\n\nexport type CreateAccountsV2Request = Infer<\n  typeof CreateAccountsV2RequestStruct\n>;\n\nexport const CreateAccountsV2ResponseStruct = array(KeyringAccountStruct);\n\nexport type CreateAccountsV2Response = Infer<\n  typeof CreateAccountsV2ResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Delete account\n\nexport const DeleteAccountV2RequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringRpcV2Method.DeleteAccount}`),\n  params: object({\n    id: UuidStruct,\n  }),\n});\n\nexport type DeleteAccountV2Request = Infer<typeof DeleteAccountV2RequestStruct>;\n\nexport const DeleteAccountV2ResponseStruct = literal(null);\n\nexport type DeleteAccountV2Response = Infer<\n  typeof DeleteAccountV2ResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Export account\n\nexport const ExportAccountV2RequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringRpcV2Method.ExportAccount}`),\n  params: object({\n    id: UuidStruct,\n    options: exactOptional(ExportAccountOptionsStruct),\n  }),\n});\n\nexport type ExportAccountV2Request = Infer<typeof ExportAccountV2RequestStruct>;\n\nexport const ExportAccountV2ResponseStruct = PrivateKeyExportedAccountStruct;\n\nexport type ExportAccountV2Response = Infer<\n  typeof ExportAccountV2ResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n// Submit request\n\nexport const SubmitRequestV2RequestStruct = object({\n  ...CommonHeader,\n  method: literal(`${KeyringRpcV2Method.SubmitRequest}`),\n  params: KeyringRequestStruct,\n});\n\nexport type SubmitRequestV2Request = Infer<typeof SubmitRequestV2RequestStruct>;\n\nexport const SubmitRequestV2ResponseStruct = JsonStruct;\n\nexport type SubmitRequestV2Response = Infer<\n  typeof SubmitRequestV2ResponseStruct\n>;\n\n// ----------------------------------------------------------------------------\n\n/**\n * Keyring RPC requests.\n */\nexport type KeyringRpcV2Requests =\n  | GetAccountsV2Request\n  | GetAccountV2Request\n  | CreateAccountsV2Request\n  | DeleteAccountV2Request\n  | ExportAccountV2Request\n  | SubmitRequestV2Request;\n\n/**\n * Extract the proper request type for a given `KeyringRpcV2Method`.\n */\nexport type KeyringRpcV2Request<RpcMethod extends KeyringRpcV2Method> = Extract<\n  KeyringRpcV2Requests,\n  { method: `${RpcMethod}` }\n>;\n"]}

package/dist/api/v2/keyring-rpc.d.cts

@@ -0,0 +1,440 @@
+import type { Infer } from "@metamask/superstruct";
+import type { KeyringV2 } from "./keyring.cjs";
+/**
+ * Keyring interface for keyring methods that can be invoked through
+ * RPC calls.
+ */
+export type KeyringRpcV2 = {
+    getAccount: KeyringV2['getAccount'];
+    getAccounts: KeyringV2['getAccounts'];
+    createAccounts: KeyringV2['createAccounts'];
+    deleteAccount: KeyringV2['deleteAccount'];
+    submitRequest: KeyringV2['submitRequest'];
+    exportAccount?: KeyringV2['exportAccount'];
+};
+/**
+ * Keyring RPC methods used by the API.
+ */
+export declare const KeyringRpcV2Method: {
+    readonly GetAccounts: "keyring_getAccounts";
+    readonly CreateAccounts: "keyring_createAccounts";
+    readonly GetAccount: "keyring_getAccount";
+    readonly DeleteAccount: "keyring_deleteAccount";
+    readonly ExportAccount: "keyring_exportAccount";
+    readonly SubmitRequest: "keyring_submitRequest";
+};
+/**
+ * Keyring RPC methods used by the API.
+ */
+export type KeyringRpcV2Method = (typeof KeyringRpcV2Method)[keyof typeof KeyringRpcV2Method];
+/**
+ * Check if a method is a keyring RPC method (v2).
+ *
+ * @param method - Method to check.
+ * @returns Whether the method is a keyring RPC method (v2).
+ */
+export declare function isKeyringRpcV2Method(method: string): method is KeyringRpcV2Method;
+export declare const GetAccountsV2RequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_getAccounts";
+    id: string | number | null;
+    jsonrpc: "2.0";
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_getAccounts", "keyring_getAccounts">;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type GetAccountsV2Request = Infer<typeof GetAccountsV2RequestStruct>;
+export declare const GetAccountsV2ResponseStruct: import("@metamask/superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    id: string;
+    options: Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    };
+    address: string;
+    scopes: `${string}:${string}`[];
+    methods: string[];
+}[], import("@metamask/superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    id: string;
+    options: Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    };
+    address: string;
+    scopes: `${string}:${string}`[];
+    methods: string[];
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    type: import("@metamask/superstruct").Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2pkh": "bip122:p2pkh";
+        "bip122:p2sh": "bip122:p2sh";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+        "bip122:p2tr": "bip122:p2tr";
+        "solana:data-account": "solana:data-account";
+        "tron:eoa": "tron:eoa";
+        "any:account": "any:account";
+    }>;
+    address: import("@metamask/superstruct").Struct<string, null>;
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    }, null>;
+    methods: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+}>>;
+export type GetAccountsV2Response = Infer<typeof GetAccountsV2ResponseStruct>;
+export declare const GetAccountV2RequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_getAccount";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_getAccount", "keyring_getAccount">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type GetAccountV2Request = Infer<typeof GetAccountV2RequestStruct>;
+export declare const GetAccountV2ResponseStruct: import("@metamask/superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    id: string;
+    options: Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    };
+    address: string;
+    scopes: `${string}:${string}`[];
+    methods: string[];
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    type: import("@metamask/superstruct").Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2pkh": "bip122:p2pkh";
+        "bip122:p2sh": "bip122:p2sh";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+        "bip122:p2tr": "bip122:p2tr";
+        "solana:data-account": "solana:data-account";
+        "tron:eoa": "tron:eoa";
+        "any:account": "any:account";
+    }>;
+    address: import("@metamask/superstruct").Struct<string, null>;
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    }, null>;
+    methods: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+}>;
+export type GetAccountV2Response = Infer<typeof GetAccountV2ResponseStruct>;
+export declare const CreateAccountsV2RequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_createAccounts";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        type: "bip44:derive-path";
+        derivationPath: `m/${string}`;
+        entropySource: string;
+    } | {
+        type: "bip44:derive-index";
+        groupIndex: number;
+        entropySource: string;
+    } | {
+        type: "bip44:discover";
+        groupIndex: number;
+        entropySource: string;
+    } | {
+        type: "bip44:derive-index-range";
+        range: {
+            from: number;
+            to: number;
+        };
+        entropySource: string;
+    } | {
+        type: "custom";
+    } | {
+        type: "private-key:import";
+        encoding: "hexadecimal" | "base58";
+        privateKey: string;
+        accountType?: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_createAccounts", "keyring_createAccounts">;
+    params: import("@metamask/superstruct").Struct<{
+        type: "bip44:derive-path";
+        derivationPath: `m/${string}`;
+        entropySource: string;
+    } | {
+        type: "bip44:derive-index";
+        groupIndex: number;
+        entropySource: string;
+    } | {
+        type: "bip44:discover";
+        groupIndex: number;
+        entropySource: string;
+    } | {
+        type: "bip44:derive-index-range";
+        range: {
+            from: number;
+            to: number;
+        };
+        entropySource: string;
+    } | {
+        type: "custom";
+    } | {
+        type: "private-key:import";
+        encoding: "hexadecimal" | "base58";
+        privateKey: string;
+        accountType?: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    }, null>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type CreateAccountsV2Request = Infer<typeof CreateAccountsV2RequestStruct>;
+export declare const CreateAccountsV2ResponseStruct: import("@metamask/superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    id: string;
+    options: Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    };
+    address: string;
+    scopes: `${string}:${string}`[];
+    methods: string[];
+}[], import("@metamask/superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account";
+    id: string;
+    options: Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    };
+    address: string;
+    scopes: `${string}:${string}`[];
+    methods: string[];
+}, {
+    id: import("@metamask/superstruct").Struct<string, null>;
+    type: import("@metamask/superstruct").Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2pkh" | "bip122:p2sh" | "bip122:p2wpkh" | "bip122:p2tr" | "solana:data-account" | "tron:eoa" | "any:account", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2pkh": "bip122:p2pkh";
+        "bip122:p2sh": "bip122:p2sh";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+        "bip122:p2tr": "bip122:p2tr";
+        "solana:data-account": "solana:data-account";
+        "tron:eoa": "tron:eoa";
+        "any:account": "any:account";
+    }>;
+    address: import("@metamask/superstruct").Struct<string, null>;
+    scopes: import("@metamask/superstruct").Struct<`${string}:${string}`[], import("@metamask/superstruct").Struct<`${string}:${string}`, null>>;
+    options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> & {
+        entropy?: {
+            type: "mnemonic";
+            id: string;
+            derivationPath: string;
+            groupIndex: number;
+        } | {
+            type: "private-key";
+        } | {
+            type: "custom";
+        };
+        exportable?: boolean;
+    }, null>;
+    methods: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+}>>;
+export type CreateAccountsV2Response = Infer<typeof CreateAccountsV2ResponseStruct>;
+export declare const DeleteAccountV2RequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_deleteAccount";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_deleteAccount", "keyring_deleteAccount">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type DeleteAccountV2Request = Infer<typeof DeleteAccountV2RequestStruct>;
+export declare const DeleteAccountV2ResponseStruct: import("@metamask/superstruct").Struct<null, null>;
+export type DeleteAccountV2Response = Infer<typeof DeleteAccountV2ResponseStruct>;
+export declare const ExportAccountV2RequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_exportAccount";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+        options?: {
+            type: "private-key";
+            encoding: "hexadecimal" | "base58";
+        };
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_exportAccount", "keyring_exportAccount">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+        options?: {
+            type: "private-key";
+            encoding: "hexadecimal" | "base58";
+        };
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        options: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
+            type: "private-key";
+            encoding: "hexadecimal" | "base58";
+        }, {
+            type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+            encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+                hexadecimal: "hexadecimal";
+                base58: "base58";
+            }>;
+        }>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type ExportAccountV2Request = Infer<typeof ExportAccountV2RequestStruct>;
+export declare const ExportAccountV2ResponseStruct: import("@metamask/superstruct").Struct<{
+    type: "private-key";
+    encoding: "hexadecimal" | "base58";
+    privateKey: string;
+}, {
+    type: import("@metamask/superstruct").Struct<"private-key", "private-key">;
+    privateKey: import("@metamask/superstruct").Struct<string, null>;
+    encoding: import("@metamask/superstruct").Struct<"hexadecimal" | "base58", {
+        hexadecimal: "hexadecimal";
+        base58: "base58";
+    }>;
+}>;
+export type ExportAccountV2Response = Infer<typeof ExportAccountV2ResponseStruct>;
+export declare const SubmitRequestV2RequestStruct: import("@metamask/superstruct").Struct<{
+    method: "keyring_submitRequest";
+    id: string | number | null;
+    jsonrpc: "2.0";
+    params: {
+        id: string;
+        origin: string;
+        request: {
+            method: string;
+            params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[];
+        };
+        scope: string;
+        account: string;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"keyring_submitRequest", "keyring_submitRequest">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+        origin: string;
+        request: {
+            method: string;
+            params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[];
+        };
+        scope: string;
+        account: string;
+    }, {
+        id: import("@metamask/superstruct").Struct<string, null>;
+        scope: import("@metamask/superstruct").Struct<string, null>;
+        account: import("@metamask/superstruct").Struct<string, null>;
+        origin: import("@metamask/superstruct").Struct<string, null>;
+        request: import("@metamask/superstruct").Struct<{
+            method: string;
+            params?: Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[];
+        }, {
+            method: import("@metamask/superstruct").Struct<string, null>;
+            params: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json> | import("@metamask/utils").Json[] | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        }>;
+    }>;
+    jsonrpc: import("@metamask/superstruct").Struct<"2.0", "2.0">;
+    id: import("@metamask/superstruct").Struct<string | number | null, null>;
+}>;
+export type SubmitRequestV2Request = Infer<typeof SubmitRequestV2RequestStruct>;
+export declare const SubmitRequestV2ResponseStruct: import("@metamask/superstruct").Struct<import("@metamask/utils").Json, unknown>;
+export type SubmitRequestV2Response = Infer<typeof SubmitRequestV2ResponseStruct>;
+/**
+ * Keyring RPC requests.
+ */
+export type KeyringRpcV2Requests = GetAccountsV2Request | GetAccountV2Request | CreateAccountsV2Request | DeleteAccountV2Request | ExportAccountV2Request | SubmitRequestV2Request;
+/**
+ * Extract the proper request type for a given `KeyringRpcV2Method`.
+ */
+export type KeyringRpcV2Request<RpcMethod extends KeyringRpcV2Method> = Extract<KeyringRpcV2Requests, {
+    method: `${RpcMethod}`;
+}>;
+//# sourceMappingURL=keyring-rpc.d.cts.map

package/dist/api/v2/keyring-rpc.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-rpc.d.cts","sourceRoot":"","sources":["../../../src/api/v2/keyring-rpc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AASnD,OAAO,KAAK,EAAE,SAAS,EAAE,sBAAkB;AAI3C;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IACpC,WAAW,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IACtC,cAAc,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC5C,aAAa,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAC1C,aAAa,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAC1C,aAAa,CAAC,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;CASrB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,GACb,MAAM,IAAI,kBAAkB,CAI9B;AAYD,eAAO,MAAM,0BAA0B;;;;;;;;EAGrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE5E,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA8B,CAAC;AAEvE,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAK9E,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;EAMpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE1E,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAuB,CAAC;AAE/D,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAK5E,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAEF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA8B,CAAC;AAE1E,MAAM,MAAM,wBAAwB,GAAG,KAAK,CAC1C,OAAO,8BAA8B,CACtC,CAAC;AAKF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;EAMvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEhF,eAAO,MAAM,6BAA6B,oDAAgB,CAAC;AAE3D,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAKF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEhF,eAAO,MAAM,6BAA6B;;;;;;;;;;;EAAkC,CAAC;AAE7E,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAKF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEhF,eAAO,MAAM,6BAA6B,iFAAa,CAAC;AAExD,MAAM,MAAM,uBAAuB,GAAG,KAAK,CACzC,OAAO,6BAA6B,CACrC,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,GACpB,mBAAmB,GACnB,uBAAuB,GACvB,sBAAsB,GACtB,sBAAsB,GACtB,sBAAsB,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,SAAS,SAAS,kBAAkB,IAAI,OAAO,CAC7E,oBAAoB,EACpB;IAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAA;CAAE,CAC3B,CAAC"}