@metamask-previews/keyring-internal-api 0.0.1-672cc7b

package/dist/internal/events.d.ts

@@ -0,0 +1,169 @@
+/**
+ * Supported keyring events.
+ */
+export declare enum KeyringEvent {
+    AccountCreated = "notify:accountCreated",
+    AccountUpdated = "notify:accountUpdated",
+    AccountDeleted = "notify:accountDeleted",
+    RequestApproved = "notify:requestApproved",
+    RequestRejected = "notify:requestRejected"
+}
+export declare const AccountCreatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountCreated";
+    params: {
+        account: {
+            id: string;
+            type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+            address: string;
+            options: Record<string, import("@metamask/utils").Json>;
+            methods: string[];
+        };
+        accountNameSuggestion?: string;
+        displayConfirmation?: boolean;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountCreated", "notify:accountCreated">;
+    params: import("@metamask/superstruct").Struct<{
+        account: {
+            id: string;
+            type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+            address: string;
+            options: Record<string, import("@metamask/utils").Json>;
+            methods: string[];
+        };
+        accountNameSuggestion?: string;
+        displayConfirmation?: boolean;
+    }, {
+        /**
+         * New account object.
+         */
+        account: import("@metamask/superstruct").Struct<{
+            id: string;
+            type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+            address: string;
+            options: Record<string, import("@metamask/utils").Json>;
+            methods: string[];
+        }, {
+            id: import("@metamask/superstruct").Struct<string, null>;
+            type: import("@metamask/superstruct").Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh", {
+                "eip155:eoa": "eip155:eoa";
+                "eip155:erc4337": "eip155:erc4337";
+                "bip122:p2wpkh": "bip122:p2wpkh";
+            }>;
+            address: import("@metamask/superstruct").Struct<string, null>;
+            options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+            methods: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+        }>;
+        /**
+         * Account name suggestion provided to the MetaMask client.
+         *
+         * The keyring can suggest a name for the account, but it's up to the
+         * client to decide whether to use it. The keyring won't be informed if the
+         * client decides to use a different name.
+         */
+        accountNameSuggestion: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+        /**
+         * Instructs MetaMask to display the add account confirmation dialog in the UI.
+         * **Note:** This is not guaranteed to be honored by the MetaMask client.
+         */
+        displayConfirmation: import("@metamask/superstruct").Struct<boolean | import("@metamask/keyring-utils").ExactOptionalTag, null>;
+    }>;
+}>;
+export declare const AccountUpdatedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountUpdated";
+    params: {
+        account: {
+            id: string;
+            type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+            address: string;
+            options: Record<string, import("@metamask/utils").Json>;
+            methods: string[];
+        };
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountUpdated", "notify:accountUpdated">;
+    params: import("@metamask/superstruct").Struct<{
+        account: {
+            id: string;
+            type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+            address: string;
+            options: Record<string, import("@metamask/utils").Json>;
+            methods: string[];
+        };
+    }, {
+        /**
+         * Updated account object.
+         */
+        account: import("@metamask/superstruct").Struct<{
+            id: string;
+            type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+            address: string;
+            options: Record<string, import("@metamask/utils").Json>;
+            methods: string[];
+        }, {
+            id: import("@metamask/superstruct").Struct<string, null>;
+            type: import("@metamask/superstruct").Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh", {
+                "eip155:eoa": "eip155:eoa";
+                "eip155:erc4337": "eip155:erc4337";
+                "bip122:p2wpkh": "bip122:p2wpkh";
+            }>;
+            address: import("@metamask/superstruct").Struct<string, null>;
+            options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+            methods: import("@metamask/superstruct").Struct<string[], import("@metamask/superstruct").Struct<string, null>>;
+        }>;
+    }>;
+}>;
+export declare const AccountDeletedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:accountDeleted";
+    params: {
+        id: string;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:accountDeleted", "notify:accountDeleted">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+    }, {
+        /**
+         * Deleted account ID.
+         */
+        id: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+}>;
+export declare const RequestApprovedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:requestApproved";
+    params: {
+        id: string;
+        result: import("@metamask/utils").Json;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:requestApproved", "notify:requestApproved">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+        result: import("@metamask/utils").Json;
+    }, {
+        /**
+         * Request ID.
+         */
+        id: import("@metamask/superstruct").Struct<string, null>;
+        /**
+         * Request result.
+         */
+        result: import("@metamask/superstruct").Struct<import("@metamask/utils").Json, unknown>;
+    }>;
+}>;
+export declare const RequestRejectedEventStruct: import("@metamask/superstruct").Struct<{
+    method: "notify:requestRejected";
+    params: {
+        id: string;
+    };
+}, {
+    method: import("@metamask/superstruct").Struct<"notify:requestRejected", "notify:requestRejected">;
+    params: import("@metamask/superstruct").Struct<{
+        id: string;
+    }, {
+        /**
+         * Request ID.
+         */
+        id: import("@metamask/superstruct").Struct<string, null>;
+    }>;
+}>;

package/dist/internal/events.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestRejectedEventStruct = exports.RequestApprovedEventStruct = exports.AccountDeletedEventStruct = exports.AccountUpdatedEventStruct = exports.AccountCreatedEventStruct = exports.KeyringEvent = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+const keyring_utils_1 = require("@metamask/keyring-utils");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+/**
+ * Supported keyring events.
+ */
+var KeyringEvent;
+(function (KeyringEvent) {
+    // Account events
+    KeyringEvent["AccountCreated"] = "notify:accountCreated";
+    KeyringEvent["AccountUpdated"] = "notify:accountUpdated";
+    KeyringEvent["AccountDeleted"] = "notify:accountDeleted";
+    // Request events
+    KeyringEvent["RequestApproved"] = "notify:requestApproved";
+    KeyringEvent["RequestRejected"] = "notify:requestRejected";
+})(KeyringEvent = exports.KeyringEvent || (exports.KeyringEvent = {}));
+exports.AccountCreatedEventStruct = (0, keyring_utils_1.object)({
+    method: (0, superstruct_1.literal)(`${KeyringEvent.AccountCreated}`),
+    params: (0, keyring_utils_1.object)({
+        /**
+         * New account object.
+         */
+        account: keyring_api_1.KeyringAccountStruct,
+        /**
+         * Account name suggestion provided to the MetaMask client.
+         *
+         * The keyring can suggest a name for the account, but it's up to the
+         * client to decide whether to use it. The keyring won't be informed if the
+         * client decides to use a different name.
+         */
+        accountNameSuggestion: (0, keyring_utils_1.exactOptional)((0, superstruct_1.string)()),
+        /**
+         * Instructs MetaMask to display the add account confirmation dialog in the UI.
+         * **Note:** This is not guaranteed to be honored by the MetaMask client.
+         */
+        displayConfirmation: (0, keyring_utils_1.exactOptional)((0, superstruct_1.boolean)()),
+    }),
+});
+exports.AccountUpdatedEventStruct = (0, keyring_utils_1.object)({
+    method: (0, superstruct_1.literal)(`${KeyringEvent.AccountUpdated}`),
+    params: (0, keyring_utils_1.object)({
+        /**
+         * Updated account object.
+         */
+        account: keyring_api_1.KeyringAccountStruct,
+    }),
+});
+exports.AccountDeletedEventStruct = (0, keyring_utils_1.object)({
+    method: (0, superstruct_1.literal)(`${KeyringEvent.AccountDeleted}`),
+    params: (0, keyring_utils_1.object)({
+        /**
+         * Deleted account ID.
+         */
+        id: keyring_utils_1.UuidStruct,
+    }),
+});
+exports.RequestApprovedEventStruct = (0, keyring_utils_1.object)({
+    method: (0, superstruct_1.literal)(`${KeyringEvent.RequestApproved}`),
+    params: (0, keyring_utils_1.object)({
+        /**
+         * Request ID.
+         */
+        id: keyring_utils_1.UuidStruct,
+        /**
+         * Request result.
+         */
+        result: utils_1.JsonStruct,
+    }),
+});
+exports.RequestRejectedEventStruct = (0, keyring_utils_1.object)({
+    method: (0, superstruct_1.literal)(`${KeyringEvent.RequestRejected}`),
+    params: (0, keyring_utils_1.object)({
+        /**
+         * Request ID.
+         */
+        id: keyring_utils_1.UuidStruct,
+    }),
+});
+//# sourceMappingURL=events.js.map

package/dist/internal/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/internal/events.ts"],"names":[],"mappings":";;;AAAA,uDAA6D;AAC7D,2DAA4E;AAC5E,uDAAiE;AACjE,2CAA6C;AAE7C;;GAEG;AACH,IAAY,YASX;AATD,WAAY,YAAY;IACtB,iBAAiB;IACjB,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IAExC,iBAAiB;IACjB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;AAC5C,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB;AAEY,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,kCAAoB;QAE7B;;;;;;WAMG;QACH,qBAAqB,EAAE,IAAA,6BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;QAE9C;;;WAGG;QACH,mBAAmB,EAAE,IAAA,6BAAa,EAAC,IAAA,qBAAO,GAAE,CAAC;KAC9C,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,OAAO,EAAE,kCAAoB;KAC9B,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,yBAAyB,GAAG,IAAA,sBAAM,EAAC;IAC9C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;QAEd;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC;AAEU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,MAAM,EAAE,IAAA,qBAAO,EAAC,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,EAAE,IAAA,sBAAM,EAAC;QACb;;WAEG;QACH,EAAE,EAAE,0BAAU;KACf,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { KeyringAccountStruct } from '@metamask/keyring-api';\nimport { exactOptional, object, UuidStruct } from '@metamask/keyring-utils';\nimport { boolean, literal, string } from '@metamask/superstruct';\nimport { JsonStruct } from '@metamask/utils';\n\n/**\n * Supported keyring events.\n */\nexport enum KeyringEvent {\n  // Account events\n  AccountCreated = 'notify:accountCreated',\n  AccountUpdated = 'notify:accountUpdated',\n  AccountDeleted = 'notify:accountDeleted',\n\n  // Request events\n  RequestApproved = 'notify:requestApproved',\n  RequestRejected = 'notify:requestRejected',\n}\n\nexport const AccountCreatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountCreated}`),\n  params: object({\n    /**\n     * New account object.\n     */\n    account: KeyringAccountStruct,\n\n    /**\n     * Account name suggestion provided to the MetaMask client.\n     *\n     * The keyring can suggest a name for the account, but it's up to the\n     * client to decide whether to use it. The keyring won't be informed if the\n     * client decides to use a different name.\n     */\n    accountNameSuggestion: exactOptional(string()),\n\n    /**\n     * Instructs MetaMask to display the add account confirmation dialog in the UI.\n     * **Note:** This is not guaranteed to be honored by the MetaMask client.\n     */\n    displayConfirmation: exactOptional(boolean()),\n  }),\n});\n\nexport const AccountUpdatedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountUpdated}`),\n  params: object({\n    /**\n     * Updated account object.\n     */\n    account: KeyringAccountStruct,\n  }),\n});\n\nexport const AccountDeletedEventStruct = object({\n  method: literal(`${KeyringEvent.AccountDeleted}`),\n  params: object({\n    /**\n     * Deleted account ID.\n     */\n    id: UuidStruct,\n  }),\n});\n\nexport const RequestApprovedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestApproved}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n});\n\nexport const RequestRejectedEventStruct = object({\n  method: literal(`${KeyringEvent.RequestRejected}`),\n  params: object({\n    /**\n     * Request ID.\n     */\n    id: UuidStruct,\n  }),\n});\n"]}

package/dist/internal/index.d.ts

@@ -0,0 +1,5 @@
+export * from './api';
+export * from './eth';
+export * from './events';
+export * from './rpc';
+export * from './types';

package/dist/internal/index.js

@@ -0,0 +1,22 @@
+"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("./api"), exports);
+__exportStar(require("./eth"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./rpc"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/internal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,wCAAsB;AACtB,2CAAyB;AACzB,wCAAsB;AACtB,0CAAwB","sourcesContent":["export * from './api';\nexport * from './eth';\nexport * from './events';\nexport * from './rpc';\nexport * from './types';\n"]}

package/dist/internal/rpc.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Keyring RPC methods used by the API.
+ */
+export declare enum KeyringRpcMethod {
+    ListAccounts = "keyring_listAccounts",
+    GetAccount = "keyring_getAccount",
+    CreateAccount = "keyring_createAccount",
+    GetAccountBalances = "keyring_getAccountBalances",
+    FilterAccountChains = "keyring_filterAccountChains",
+    UpdateAccount = "keyring_updateAccount",
+    DeleteAccount = "keyring_deleteAccount",
+    ExportAccount = "keyring_exportAccount",
+    ListRequests = "keyring_listRequests",
+    GetRequest = "keyring_getRequest",
+    SubmitRequest = "keyring_submitRequest",
+    ApproveRequest = "keyring_approveRequest",
+    RejectRequest = "keyring_rejectRequest"
+}
+/**
+ * Check if a method is a keyring RPC method.
+ *
+ * @param method - Method to check.
+ * @returns Whether the method is a keyring RPC method.
+ */
+export declare function isKeyringRpcMethod(method: string): boolean;

package/dist/internal/rpc.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isKeyringRpcMethod = exports.KeyringRpcMethod = void 0;
+/**
+ * Keyring RPC methods used by the API.
+ */
+var KeyringRpcMethod;
+(function (KeyringRpcMethod) {
+    KeyringRpcMethod["ListAccounts"] = "keyring_listAccounts";
+    KeyringRpcMethod["GetAccount"] = "keyring_getAccount";
+    KeyringRpcMethod["CreateAccount"] = "keyring_createAccount";
+    KeyringRpcMethod["GetAccountBalances"] = "keyring_getAccountBalances";
+    KeyringRpcMethod["FilterAccountChains"] = "keyring_filterAccountChains";
+    KeyringRpcMethod["UpdateAccount"] = "keyring_updateAccount";
+    KeyringRpcMethod["DeleteAccount"] = "keyring_deleteAccount";
+    KeyringRpcMethod["ExportAccount"] = "keyring_exportAccount";
+    KeyringRpcMethod["ListRequests"] = "keyring_listRequests";
+    KeyringRpcMethod["GetRequest"] = "keyring_getRequest";
+    KeyringRpcMethod["SubmitRequest"] = "keyring_submitRequest";
+    KeyringRpcMethod["ApproveRequest"] = "keyring_approveRequest";
+    KeyringRpcMethod["RejectRequest"] = "keyring_rejectRequest";
+})(KeyringRpcMethod = exports.KeyringRpcMethod || (exports.KeyringRpcMethod = {}));
+/**
+ * Check if a method is a keyring RPC method.
+ *
+ * @param method - Method to check.
+ * @returns Whether the method is a keyring RPC method.
+ */
+function isKeyringRpcMethod(method) {
+    return Object.values(KeyringRpcMethod).includes(method);
+}
+exports.isKeyringRpcMethod = isKeyringRpcMethod;
+//# sourceMappingURL=rpc.js.map

package/dist/internal/rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.js","sourceRoot":"","sources":["../../src/internal/rpc.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,gBAcX;AAdD,WAAY,gBAAgB;IAC1B,yDAAqC,CAAA;IACrC,qDAAiC,CAAA;IACjC,2DAAuC,CAAA;IACvC,qEAAiD,CAAA;IACjD,uEAAmD,CAAA;IACnD,2DAAuC,CAAA;IACvC,2DAAuC,CAAA;IACvC,2DAAuC,CAAA;IACvC,yDAAqC,CAAA;IACrC,qDAAiC,CAAA;IACjC,2DAAuC,CAAA;IACvC,6DAAyC,CAAA;IACzC,2DAAuC,CAAA;AACzC,CAAC,EAdW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAc3B;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC/C,OAAO,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,MAA0B,CAAC,CAAC;AAC9E,CAAC;AAFD,gDAEC","sourcesContent":["/**\n * Keyring RPC methods used by the API.\n */\nexport enum KeyringRpcMethod {\n  ListAccounts = 'keyring_listAccounts',\n  GetAccount = 'keyring_getAccount',\n  CreateAccount = 'keyring_createAccount',\n  GetAccountBalances = 'keyring_getAccountBalances',\n  FilterAccountChains = 'keyring_filterAccountChains',\n  UpdateAccount = 'keyring_updateAccount',\n  DeleteAccount = 'keyring_deleteAccount',\n  ExportAccount = 'keyring_exportAccount',\n  ListRequests = 'keyring_listRequests',\n  GetRequest = 'keyring_getRequest',\n  SubmitRequest = 'keyring_submitRequest',\n  ApproveRequest = 'keyring_approveRequest',\n  RejectRequest = 'keyring_rejectRequest',\n}\n\n/**\n * Check if a method is a keyring RPC method.\n *\n * @param method - Method to check.\n * @returns Whether the method is a keyring RPC method.\n */\nexport function isKeyringRpcMethod(method: string): boolean {\n  return Object.values(KeyringRpcMethod).includes(method as KeyringRpcMethod);\n}\n"]}