@metamask/keyring-api 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-06-20
+### Added
+- Usage examples to [`README.md`](./README.md).
+- Keyring API definition.
+- JSON-RPC snap keyring client. It is intended to be used by a snap's companion dApp to send requests to the snap.
+- SnapController keyring client. It is intended to be used by MetaMask to talk to the snap.
+- Helper functions to create keyring handler in the snap.
+
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/keyring-api/releases/tag/v0.1.0

package/README.md

@@ -0,0 +1,141 @@
+# MetaMask Keyring API
+
+> This TypeScript module is maintained in the style of the MetaMask team.
+
+This TypeScript module simplifies the integration of snaps with MetaMask using
+the Keyring API.
+
+Features:
+
+- **Keyring API Interface**: The module exposes an interface representing the
+  Keyring API. Snaps can implement this interface to seamlessly interact with
+  MetaMask and leverage its functionality.
+
+- **DApp Client**: The module includes a client that enables dApps to
+  communicate with the Keyring snap. This client allows dApps to send requests
+  to the snap, such as retrieving account information or submitting requests.
+
+- **MetaMask Client**: The module provides a client specifically designed for
+  MetaMask integration. This client enables MetaMask to send requests directly
+  to the Keyring snap, facilitating smooth interoperability between the two
+  applications.
+
+- **Request Handler Helper Functions**: The module offers a set of helper
+  functions to simplify the implementation of the request handler in the
+  Keyring snap. These functions assist in processing incoming requests,
+  validating data, and handling various request types from dApps and MetaMask.
+
+## Installation
+
+`yarn add @metamask/keyring-api`
+
+or
+
+`npm install @metamask/keyring-api`
+
+## Usage
+
+### In a snap
+
+Inside the snap, implement the `Keyring` API:
+
+```typescript
+class MySnapKeyring implements Keyring {
+  // Implement the required methods.
+}
+```
+
+Then create a handler that uses an instance of your keyring:
+
+```typescript
+import { keyringRpcDispatcher } from '@metamask/keyring-api';
+
+// Create a new MySnapKeyring instance
+keyring = new MySnapKeyring(keyringState);
+// ...
+
+// And wrap it in a handler
+const keyringHandler: OnRpcRequestHandler = async ({ request }) => {
+  // Load the keyring state if needed
+  // ...
+  return await keyringRpcDispatcher(keyring, request);
+};
+```
+
+Now expose this handler:
+
+```typescript
+export const onRpcRequest: OnRpcRequestHandler = keyringHandler;
+```
+
+Or chain it with other handlers:
+
+```typescript
+import { chainHandlers } from '@metamask/keyring-api';
+
+export const onRpcRequest: OnRpcRequestHandler = chainHandlers(
+  // Other handlers...
+  keyringHandler,
+  // Other handlers...
+);
+```
+
+## API
+
+See our documentation:
+
+- [Latest published API documentation](https://metamask.github.io/keyring-api/latest/)
+- [Latest development API documentation](https://metamask.github.io/keyring-api/staging/)
+
+## Contributing
+
+### Setup
+
+- Install [Node.js](https://nodejs.org) version 16
+  - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
+- Install [Yarn v3](https://yarnpkg.com/getting-started/install)
+- Run `yarn install` to install dependencies and run any required post-install scripts
+
+### Testing and Linting
+
+Run `yarn test` to run the tests once. To run tests on file changes, run `yarn test:watch`.
+
+Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and fix any automatically fixable issues.
+
+### Release & Publishing
+
+The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) and [`action-publish-release`](https://github.com/MetaMask/action-publish-release) are used to automate the release process; see those repositories for more information about how they work.
+
+1. Choose a release version.
+
+   - The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See [the SemVer specification](https://semver.org/) for more information.
+
+2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. `1.x` for a `v1` backport release).
+
+   - The major version branch should be set to the most recent release with that major version. For example, when backporting a `v1.0.2` release, you'd want to ensure there was a `1.x` branch that was set to the `v1.0.1` tag.
+
+3. Trigger the [`workflow_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) event [manually](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow) for the `Create Release Pull Request` action to create the release PR.
+
+   - For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
+   - This should trigger the [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) workflow to create the release PR.
+
+4. Update the changelog to move each change entry into the appropriate change category ([See here](https://keepachangelog.com/en/1.0.0/#types) for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
+
+   - Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
+   - Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
+   - Consolidate related changes into one change entry if it makes it easier to explain.
+   - Run `yarn auto-changelog validate --rc` to check that the changelog is correctly formatted.
+
+5. Review and QA the release.
+
+   - If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.
+
+6. Squash & Merge the release.
+
+   - This should trigger the [`action-publish-release`](https://github.com/MetaMask/action-publish-release) workflow to tag the final release commit and publish the release on GitHub.
+
+7. Publish the release on npm.
+
+   - Wait for the `publish-release` GitHub Action workflow to finish. This should trigger a second job (`publish-npm`), which will wait for a run approval by the [`npm publishers`](https://github.com/orgs/MetaMask/teams/npm-publishers) team.
+   - Approve the `publish-npm` job (or ask somebody on the npm publishers team to approve it for you).
+   - Once the `publish-npm` job has finished, check npm to verify that it has been published.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './keyring-api';
+export * from './keyring-client';
+export * from './keyring-rpc-dispatcher';
+export * from './keyring-snap-controller-client';
+export * from './keyring-snap-rpc-client';

package/dist/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("./keyring-api"), exports);
+__exportStar(require("./keyring-client"), exports);
+__exportStar(require("./keyring-rpc-dispatcher"), exports);
+__exportStar(require("./keyring-snap-controller-client"), exports);
+__exportStar(require("./keyring-snap-rpc-client"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,mDAAiC;AACjC,2DAAyC;AACzC,mEAAiD;AACjD,4DAA0C","sourcesContent":["export * from './keyring-api';\nexport * from './keyring-client';\nexport * from './keyring-rpc-dispatcher';\nexport * from './keyring-snap-controller-client';\nexport * from './keyring-snap-rpc-client';\n"]}

package/dist/keyring-api.d.ts

@@ -0,0 +1,241 @@
+import { Json } from '@metamask/utils';
+import { Infer } from 'superstruct';
+export declare const KeyringAccountStruct: import("superstruct").Struct<{
+    id: string;
+    name: string;
+    address: string;
+    options: Record<string, Json> | null;
+    supportedMethods: ("personal_sign" | "eth_sendTransaction" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v2" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
+    type: "eip155:eoa" | "eip155:erc4337";
+}, {
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: import("superstruct").Struct<string, null>;
+    /**
+     * User-chosen account name.
+     */
+    name: import("superstruct").Struct<string, null>;
+    /**
+     * Account address or next receive address (UTXO).
+     */
+    address: import("superstruct").Struct<string, null>;
+    /**
+     * Keyring-dependent account options.
+     */
+    options: import("superstruct").Struct<Record<string, Json> | null, null>;
+    /**
+     * Account supported methods.
+     */
+    supportedMethods: import("superstruct").Struct<("personal_sign" | "eth_sendTransaction" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v2" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], import("superstruct").Struct<"personal_sign" | "eth_sendTransaction" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData" | "eth_signTypedData_v1" | "eth_signTypedData_v2" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
+        personal_sign: "personal_sign";
+        eth_sendTransaction: "eth_sendTransaction";
+        eth_sign: "eth_sign";
+        eth_signTransaction: "eth_signTransaction";
+        eth_signTypedData: "eth_signTypedData";
+        eth_signTypedData_v1: "eth_signTypedData_v1";
+        eth_signTypedData_v2: "eth_signTypedData_v2";
+        eth_signTypedData_v3: "eth_signTypedData_v3";
+        eth_signTypedData_v4: "eth_signTypedData_v4";
+    }>>;
+    /**
+     * Account type.
+     */
+    type: import("superstruct").Struct<"eip155:eoa" | "eip155:erc4337", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+    }>;
+}>;
+/**
+ * Account object.
+ *
+ * Represents an account with its properties and capabilities.
+ */
+export declare type KeyringAccount = Infer<typeof KeyringAccountStruct>;
+export declare const KeyringJsonRpcRequestStruct: import("superstruct").Struct<{
+    id: string;
+    jsonrpc: "2.0";
+    method: string;
+} | {
+    id: string;
+    jsonrpc: "2.0";
+    method: string;
+    params: Record<string, Json> | Json[];
+}, null>;
+/**
+ * JSON-RPC request type.
+ *
+ * Represents a JSON-RPC request sent by a dApp. The request ID must be a
+ * string and the params field cannot be undefined.
+ */
+export declare type KeyringJsonRpcRequest = Infer<typeof KeyringJsonRpcRequestStruct>;
+export declare const KeyringRequestStruct: import("superstruct").Struct<{
+    account: string;
+    scope: string;
+    request: {
+        id: string;
+        jsonrpc: "2.0";
+        method: string;
+    } | {
+        id: string;
+        jsonrpc: "2.0";
+        method: string;
+        params: Record<string, Json> | Json[];
+    };
+}, {
+    /**
+     * Account ID (UUIDv4).
+     */
+    account: import("superstruct").Struct<string, null>;
+    /**
+     * Request's scope (CAIP-2 chain ID).
+     */
+    scope: import("superstruct").Struct<string, null>;
+    /**
+     * JSON-RPC request sent by the client application.
+     *
+     * Note: The request ID must be a string.
+     */
+    request: import("superstruct").Struct<{
+        id: string;
+        jsonrpc: "2.0";
+        method: string;
+    } | {
+        id: string;
+        jsonrpc: "2.0";
+        method: string;
+        params: Record<string, Json> | Json[];
+    }, null>;
+}>;
+/**
+ * Keyring request.
+ *
+ * Represents a request made to the keyring for account-related operations.
+ */
+export declare type KeyringRequest = Infer<typeof KeyringRequestStruct>;
+export declare const SubmitRequestResponseStruct: import("superstruct").Struct<{
+    pending: true;
+} | {
+    pending: false;
+    result: Json;
+}, null>;
+/**
+ * Response returned when submitting a request to the Keyring.
+ */
+export declare type SubmitRequestResponse = Infer<typeof SubmitRequestResponseStruct>;
+/**
+ * Keyring interface.
+ *
+ * Represents the functionality and operations related to managing accounts and
+ * handling requests.
+ */
+export declare type Keyring = {
+    /**
+     * List accounts.
+     *
+     * Retrieves an array of KeyringAccount objects representing the available
+     * accounts.
+     *
+     * @returns A promise that resolves to an array of KeyringAccount objects.
+     */
+    listAccounts(): Promise<KeyringAccount[]>;
+    /**
+     * Get an account.
+     *
+     * Retrieves the KeyringAccount object for the given account ID.
+     *
+     * @param id - The ID of the account to retrieve.
+     * @returns A promise that resolves to the KeyringAccount object if found, or
+     * undefined otherwise.
+     */
+    getAccount(id: string): Promise<KeyringAccount | undefined>;
+    /**
+     * Create an account.
+     *
+     * Creates a new account with the given name, supported chains, and optional
+     * account options.
+     *
+     * @param name - The name of the account.
+     * @param options - Keyring-defined options for the account (optional).
+     * @returns A promise that resolves to the newly created KeyringAccount
+     * object without any private information.
+     */
+    createAccount(name: string, options?: Record<string, Json> | null): Promise<KeyringAccount>;
+    /**
+     * Filter supported chains for a given account.
+     *
+     * @param id - ID of the account to be checked.
+     * @param chains - List of chains (CAIP-2) to be checked.
+     * @returns A Promise that resolves to a filtered list of CAIP-2 IDs
+     * representing the supported chains.
+     */
+    filterAccountChains(id: string, chains: string[]): Promise<string[]>;
+    /**
+     * Update an account.
+     *
+     * Updates the account with the given account object. Does nothing if the
+     * account does not exist.
+     *
+     * @param account - The updated account object.
+     * @returns A promise that resolves when the account is successfully updated.
+     */
+    updateAccount(account: KeyringAccount): Promise<void>;
+    /**
+     * Delete an account from the keyring.
+     *
+     * Deletes the account with the given ID from the keyring.
+     *
+     * @param id - The ID of the account to delete.
+     * @returns A promise that resolves when the account is successfully deleted.
+     */
+    deleteAccount(id: string): Promise<void>;
+    /**
+     * List all submitted requests.
+     *
+     * Retrieves an array of KeyringRequest objects representing the submitted
+     * requests.
+     *
+     * @returns A promise that resolves to an array of KeyringRequest objects.
+     */
+    listRequests(): Promise<KeyringRequest[]>;
+    /**
+     * Get a request.
+     *
+     * Retrieves the KeyringRequest object for the given request ID.
+     *
+     * @param id - The ID of the request to retrieve.
+     * @returns A promise that resolves to the KeyringRequest object if found, or
+     * undefined otherwise.
+     */
+    getRequest(id: string): Promise<KeyringRequest | undefined>;
+    /**
+     * Submit a request.
+     *
+     * Submits the given KeyringRequest object.
+     *
+     * @param request - The KeyringRequest object to submit.
+     * @returns A promise that resolves to the request response.
+     */
+    submitRequest(request: KeyringRequest): Promise<SubmitRequestResponse>;
+    /**
+     * Approve a request.
+     *
+     * Approves the request with the given ID and sets the response if provided.
+     *
+     * @param id - The ID of the request to approve.
+     * @param result - The response to the request (optional).
+     * @returns A promise that resolves when the request is successfully
+     * approved.
+     */
+    approveRequest(id: string, result?: Json): Promise<void>;
+    /**
+     * Reject a request.
+     *
+     * Rejects the request with the given ID.
+     *
+     * @param id - The ID of the request to reject.
+     * @returns A promise that resolves when the request is successfully
+     * rejected.
+     */
+    rejectRequest(id: string): Promise<void>;
+};

package/dist/keyring-api.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubmitRequestResponseStruct = exports.KeyringRequestStruct = exports.KeyringJsonRpcRequestStruct = exports.KeyringAccountStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const utils_2 = require("./utils");
+exports.KeyringAccountStruct = (0, superstruct_1.object)({
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: utils_2.UuidStruct,
+    /**
+     * User-chosen account name.
+     */
+    name: (0, superstruct_1.string)(),
+    /**
+     * Account address or next receive address (UTXO).
+     */
+    address: (0, superstruct_1.string)(),
+    /**
+     * Keyring-dependent account options.
+     */
+    options: (0, superstruct_1.nullable)((0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)),
+    /**
+     * Account supported methods.
+     */
+    supportedMethods: (0, superstruct_1.array)((0, superstruct_1.enums)([
+        'personal_sign',
+        'eth_sendTransaction',
+        'eth_sign',
+        'eth_signTransaction',
+        'eth_signTypedData',
+        'eth_signTypedData_v1',
+        'eth_signTypedData_v2',
+        'eth_signTypedData_v3',
+        'eth_signTypedData_v4',
+    ])),
+    /**
+     * Account type.
+     */
+    type: (0, superstruct_1.enums)(['eip155:eoa', 'eip155:erc4337']),
+});
+exports.KeyringJsonRpcRequestStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.object)({
+        jsonrpc: (0, superstruct_1.literal)('2.0'),
+        id: (0, superstruct_1.string)(),
+        method: (0, superstruct_1.string)(),
+    }),
+    (0, superstruct_1.object)({
+        jsonrpc: (0, superstruct_1.literal)('2.0'),
+        id: (0, superstruct_1.string)(),
+        method: (0, superstruct_1.string)(),
+        params: (0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)]),
+    }),
+]);
+exports.KeyringRequestStruct = (0, superstruct_1.object)({
+    /**
+     * Account ID (UUIDv4).
+     */
+    account: utils_2.UuidStruct,
+    /**
+     * Request's scope (CAIP-2 chain ID).
+     */
+    scope: (0, superstruct_1.string)(),
+    /**
+     * JSON-RPC request sent by the client application.
+     *
+     * Note: The request ID must be a string.
+     */
+    request: exports.KeyringJsonRpcRequestStruct,
+});
+exports.SubmitRequestResponseStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.object)({
+        pending: (0, superstruct_1.literal)(true),
+    }),
+    (0, superstruct_1.object)({
+        pending: (0, superstruct_1.literal)(false),
+        result: (0, superstruct_1.nullable)(utils_1.JsonStruct),
+    }),
+]);
+//# sourceMappingURL=keyring-api.js.map

package/dist/keyring-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring-api.js","sourceRoot":"","sources":["../src/keyring-api.ts"],"names":[],"mappings":";;;AAAA,2CAAmD;AACnD,6CAUqB;AAErB,mCAAqC;AAExB,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,IAAI,EAAE,IAAA,oBAAM,GAAE;IAEd;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;IAE/C;;OAEG;IACH,gBAAgB,EAAE,IAAA,mBAAK,EACrB,IAAA,mBAAK,EAAC;QACJ,eAAe;QACf,qBAAqB;QACrB,UAAU;QACV,qBAAqB;QACrB,mBAAmB;QACnB,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;QACtB,sBAAsB;KACvB,CAAC,CACH;IAED;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;CAC9C,CAAC,CAAC;AASU,QAAA,2BAA2B,GAAG,IAAA,mBAAK,EAAC;IAC/C,IAAA,oBAAM,EAAC;QACL,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QACvB,EAAE,EAAE,IAAA,oBAAM,GAAE;QACZ,MAAM,EAAE,IAAA,oBAAM,GAAE;KACjB,CAAC;IACF,IAAA,oBAAM,EAAC;QACL,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QACvB,EAAE,EAAE,IAAA,oBAAM,GAAE;QACZ,MAAM,EAAE,IAAA,oBAAM,GAAE;QAChB,MAAM,EAAE,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC;KACjE,CAAC;CACH,CAAC,CAAC;AAUU,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,OAAO,EAAE,kBAAU;IAEnB;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,GAAE;IAEf;;;;OAIG;IACH,OAAO,EAAE,mCAA2B;CACrC,CAAC,CAAC;AASU,QAAA,2BAA2B,GAAG,IAAA,mBAAK,EAAC;IAC/C,IAAA,oBAAM,EAAC;QACL,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;KACvB,CAAC;IACF,IAAA,oBAAM,EAAC;QACL,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QACvB,MAAM,EAAE,IAAA,sBAAQ,EAAC,kBAAU,CAAC;KAC7B,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { Json, JsonStruct } from '@metamask/utils';\nimport {\n  literal,\n  union,\n  nullable,\n  object,\n  string,\n  enums,\n  Infer,\n  record,\n  array,\n} from 'superstruct';\n\nimport { UuidStruct } from './utils';\n\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * User-chosen account name.\n   */\n  name: string(),\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: nullable(record(string(), JsonStruct)),\n\n  /**\n   * Account supported methods.\n   */\n  supportedMethods: array(\n    enums([\n      'personal_sign',\n      'eth_sendTransaction',\n      'eth_sign',\n      'eth_signTransaction',\n      'eth_signTypedData',\n      'eth_signTypedData_v1',\n      'eth_signTypedData_v2',\n      'eth_signTypedData_v3',\n      'eth_signTypedData_v4',\n    ]),\n  ),\n\n  /**\n   * Account type.\n   */\n  type: enums(['eip155:eoa', 'eip155:erc4337']),\n});\n\n/**\n * Account object.\n *\n * Represents an account with its properties and capabilities.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n\nexport const KeyringJsonRpcRequestStruct = union([\n  object({\n    jsonrpc: literal('2.0'),\n    id: string(),\n    method: string(),\n  }),\n  object({\n    jsonrpc: literal('2.0'),\n    id: string(),\n    method: string(),\n    params: union([array(JsonStruct), record(string(), JsonStruct)]),\n  }),\n]);\n\n/**\n * JSON-RPC request type.\n *\n * Represents a JSON-RPC request sent by a dApp. The request ID must be a\n * string and the params field cannot be undefined.\n */\nexport type KeyringJsonRpcRequest = Infer<typeof KeyringJsonRpcRequestStruct>;\n\nexport const KeyringRequestStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Request's scope (CAIP-2 chain ID).\n   */\n  scope: string(),\n\n  /**\n   * JSON-RPC request sent by the client application.\n   *\n   * Note: The request ID must be a string.\n   */\n  request: KeyringJsonRpcRequestStruct,\n});\n\n/**\n * Keyring request.\n *\n * Represents a request made to the keyring for account-related operations.\n */\nexport type KeyringRequest = Infer<typeof KeyringRequestStruct>;\n\nexport const SubmitRequestResponseStruct = union([\n  object({\n    pending: literal(true),\n  }),\n  object({\n    pending: literal(false),\n    result: nullable(JsonStruct),\n  }),\n]);\n\n/**\n * Response returned when submitting a request to the Keyring.\n */\nexport type SubmitRequestResponse = Infer<typeof SubmitRequestResponseStruct>;\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with the given name, supported chains, and optional\n   * account options.\n   *\n   * @param name - The name of the account.\n   * @param options - Keyring-defined options for the account (optional).\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(\n    name: string,\n    options?: Record<string, Json> | null,\n  ): Promise<KeyringAccount>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<SubmitRequestResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param result - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest(id: string, result?: Json): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest(id: string): Promise<void>;\n};\n"]}

package/dist/keyring-client.d.ts

@@ -0,0 +1,26 @@
+import type { Json } from '@metamask/utils';
+import { Keyring, KeyringAccount, KeyringRequest, SubmitRequestResponse } from './keyring-api';
+import { InternalRequest } from './keyring-internal-api';
+export declare type Sender = {
+    send<Response extends Json>(request: InternalRequest): Promise<Response>;
+};
+export declare class KeyringClient implements Keyring {
+    #private;
+    /**
+     * Create a new instance of `KeyringClient`.
+     *
+     * @param sender - The `Sender` instance to use to send requests to the snap.
+     */
+    constructor(sender: Sender);
+    listAccounts(): Promise<KeyringAccount[]>;
+    getAccount(id: string): Promise<KeyringAccount>;
+    createAccount(name: string, options?: Record<string, Json> | null): Promise<KeyringAccount>;
+    filterAccountChains(id: string, chains: string[]): Promise<string[]>;
+    updateAccount(account: KeyringAccount): Promise<void>;
+    deleteAccount(id: string): Promise<void>;
+    listRequests(): Promise<KeyringRequest[]>;
+    getRequest(id: string): Promise<KeyringRequest>;
+    submitRequest(request: KeyringRequest): Promise<SubmitRequestResponse>;
+    approveRequest(id: string): Promise<void>;
+    rejectRequest(id: string): Promise<void>;
+}

package/dist/keyring-client.js

@@ -0,0 +1,112 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _KeyringClient_instances, _KeyringClient_sender, _KeyringClient_send;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringClient = void 0;
+const superstruct_1 = require("superstruct");
+const uuid_1 = require("uuid");
+const keyring_internal_api_1 = require("./keyring-internal-api");
+class KeyringClient {
+    /**
+     * Create a new instance of `KeyringClient`.
+     *
+     * @param sender - The `Sender` instance to use to send requests to the snap.
+     */
+    constructor(sender) {
+        _KeyringClient_instances.add(this);
+        _KeyringClient_sender.set(this, void 0);
+        __classPrivateFieldSet(this, _KeyringClient_sender, sender, "f");
+    }
+    async listAccounts() {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_listAccounts',
+        });
+    }
+    async getAccount(id) {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_getAccount',
+            params: { id },
+        });
+    }
+    async createAccount(name, options = null) {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_createAccount',
+            params: { name, options },
+        });
+    }
+    async filterAccountChains(id, chains) {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_filterAccountChains',
+            params: { id, chains },
+        });
+    }
+    async updateAccount(account) {
+        await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_updateAccount',
+            params: { account },
+        });
+    }
+    async deleteAccount(id) {
+        await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_deleteAccount',
+            params: { id },
+        });
+    }
+    async listRequests() {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_listRequests',
+        });
+    }
+    async getRequest(id) {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_getRequest',
+            params: { id },
+        });
+    }
+    async submitRequest(request) {
+        return await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_submitRequest',
+            params: request,
+        });
+    }
+    async approveRequest(id) {
+        await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_approveRequest',
+            params: { id },
+        });
+    }
+    async rejectRequest(id) {
+        await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+            method: 'keyring_rejectRequest',
+            params: { id },
+        });
+    }
+}
+exports.KeyringClient = KeyringClient;
+_KeyringClient_sender = new WeakMap(), _KeyringClient_instances = new WeakSet(), _KeyringClient_send = 
+/**
+ * Send a request to the snap and return the response.
+ *
+ * @param partial - Partial internal request (method and params).
+ * @returns A promise that resolves to the response to the request.
+ */
+async function _KeyringClient_send(partial) {
+    const request = {
+        jsonrpc: '2.0',
+        id: (0, uuid_1.v4)(),
+        ...partial,
+    };
+    (0, superstruct_1.assert)(request, keyring_internal_api_1.InternalRequestStruct);
+    return await __classPrivateFieldGet(this, _KeyringClient_sender, "f").send(request);
+};
+//# sourceMappingURL=keyring-client.js.map