@metamask/keyring-api 6.2.0 → 6.3.0

package/CHANGELOG.md

@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.3.0]
+
+### Added
+
+- Add `getAccountBalances` method to `Keyring` interface ([#320](https://github.com/MetaMask/keyring-api/pull/320)).
+- Add CAIP-19 types to `utils` ([#321](https://github.com/MetaMask/keyring-api/pull/321)).
+
+### Changed
+
+- Bump @metamask/snaps-sdk from 4.2.0 to 4.3.0 ([#323](https://github.com/MetaMask/keyring-api/pull/323)).
+- Split `api.ts` into different files ([#319](https://github.com/MetaMask/keyring-api/pull/319)).
+- Make the `KeyringAccount` type less rigid ([#311](https://github.com/MetaMask/keyring-api/pull/311)).
+
+### Fixed
+
+- Ensure that errors are JSON-serializable ([#162](https://github.com/MetaMask/keyring-api/pull/162)).
+- Don't use internal types in the public API ([#312](https://github.com/MetaMask/keyring-api/pull/312)).
+- Keep all ETH methods in the same `enum` ([#313](https://github.com/MetaMask/keyring-api/pull/313)).
+
+## [6.2.1]
+
+### Changed
+
+- Bump @metamask/key-tree from 9.1.0 to 9.1.1 ([#310](https://github.com/MetaMask/keyring-api/pull/310)).
+
+### Fixed
+
+- Use internal `object` function instead of the upstream one ([#316](https://github.com/MetaMask/keyring-api/pull/316)).
+
 ## [6.2.0]
 
 ### Added
@@ -290,7 +319,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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/v6.2.0...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v6.3.0...HEAD
+[6.3.0]: https://github.com/MetaMask/keyring-api/compare/v6.2.1...v6.3.0
+[6.2.1]: https://github.com/MetaMask/keyring-api/compare/v6.2.0...v6.2.1
 [6.2.0]: https://github.com/MetaMask/keyring-api/compare/v6.1.1...v6.2.0
 [6.1.1]: https://github.com/MetaMask/keyring-api/compare/v6.1.0...v6.1.1
 [6.1.0]: https://github.com/MetaMask/keyring-api/compare/v6.0.0...v6.1.0

package/dist/KeyringClient.js

@@ -17,7 +17,7 @@ const superstruct_1 = require("superstruct");
 const uuid_1 = require("uuid");
 const api_1 = require("./internal/api");
 const rpc_1 = require("./internal/rpc");
-const utils_1 = require("./utils");
+const superstruct_2 = require("./superstruct");
 class KeyringClient {
     /**
      * Create a new instance of `KeyringClient`.
@@ -30,24 +30,24 @@ class KeyringClient {
         __classPrivateFieldSet(this, _KeyringClient_sender, sender, "f");
     }
     async listAccounts() {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.ListAccounts,
         }), api_1.ListAccountsResponseStruct);
     }
     async getAccount(id) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.GetAccount,
             params: { id },
         }), api_1.GetAccountResponseStruct);
     }
     async createAccount(options = {}) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.CreateAccount,
             params: { options },
         }), api_1.CreateAccountResponseStruct);
     }
     async filterAccountChains(id, chains) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.FilterAccountChains,
             params: { id, chains },
         }), api_1.FilterAccountChainsResponseStruct);
@@ -65,24 +65,24 @@ class KeyringClient {
         }), api_1.DeleteAccountResponseStruct);
     }
     async exportAccount(id) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.ExportAccount,
             params: { id },
         }), api_1.ExportAccountResponseStruct);
     }
     async listRequests() {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.ListRequests,
         }), api_1.ListRequestsResponseStruct);
     }
     async getRequest(id) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.GetRequest,
             params: { id },
         }), api_1.GetRequestResponseStruct);
     }
     async submitRequest(request) {
-        return (0, utils_1.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
+        return (0, superstruct_2.strictMask)(await __classPrivateFieldGet(this, _KeyringClient_instances, "m", _KeyringClient_send).call(this, {
             method: rpc_1.KeyringRpcMethod.SubmitRequest,
             params: request,
         }), api_1.SubmitRequestResponseStruct);

package/dist/KeyringClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyringClient.js","sourceRoot":"","sources":["../src/KeyringClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,6CAAqC;AACrC,+BAAkC;AASlC,wCAawB;AACxB,wCAAkD;AAElD,mCAAqC;AAMrC,MAAa,aAAa;IAGxB;;;;OAIG;IACH,YAAY,MAAc;;QAP1B,wCAAgB;QAQd,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAgBD,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,YAAY;SACtC,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,UAAU;YACnC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,UAAgC,EAAE;QAElC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,MAAgB;QACpD,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,mBAAmB;YAC5C,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;SACvB,CAAC,EACF,uCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,YAAY;SACtC,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,UAAU;YACnC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,OAAO,IAAA,kBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,OAA6B,EAAE;QAE/B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,cAAc;YACvC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;SACrB,CAAC,EACF,kCAA4B,CAC7B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;CACF;AApJD,sCAoJC;;AAxIC;;;;;GAKG;AACH,KAAK,8BAAO,OAA+C;IACzD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,IAAI,CAAC;QACvB,OAAO,EAAE,KAAK;QACd,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assert } from 'superstruct';\nimport { v4 as uuid } from 'uuid';\n\nimport type {\n  Keyring,\n  KeyringAccount,\n  KeyringRequest,\n  KeyringAccountData,\n  KeyringResponse,\n} from './api';\nimport {\n  ApproveRequestResponseStruct,\n  CreateAccountResponseStruct,\n  DeleteAccountResponseStruct,\n  ExportAccountResponseStruct,\n  FilterAccountChainsResponseStruct,\n  GetAccountResponseStruct,\n  GetRequestResponseStruct,\n  ListAccountsResponseStruct,\n  ListRequestsResponseStruct,\n  RejectRequestResponseStruct,\n  SubmitRequestResponseStruct,\n  UpdateAccountResponseStruct,\n} from './internal/api';\nimport { KeyringRpcMethod } from './internal/rpc';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { strictMask } from './utils';\n\nexport type Sender = {\n  send(request: JsonRpcRequest): Promise<Json>;\n};\n\nexport class KeyringClient implements Keyring {\n  #sender: Sender;\n\n  /**\n   * Create a new instance of `KeyringClient`.\n   *\n   * @param sender - The `Sender` instance to use to send requests to the snap.\n   */\n  constructor(sender: Sender) {\n    this.#sender = sender;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param partial - A partial JSON-RPC request (method and params).\n   * @returns A promise that resolves to the response to the request.\n   */\n  async #send(partial: Omit<JsonRpcRequest, 'jsonrpc' | 'id'>): Promise<Json> {\n    return this.#sender.send({\n      jsonrpc: '2.0',\n      id: uuid(),\n      ...partial,\n    });\n  }\n\n  async listAccounts(): Promise<KeyringAccount[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ListAccounts,\n      }),\n      ListAccountsResponseStruct,\n    );\n  }\n\n  async getAccount(id: string): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.GetAccount,\n        params: { id },\n      }),\n      GetAccountResponseStruct,\n    );\n  }\n\n  async createAccount(\n    options: Record<string, Json> = {},\n  ): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.CreateAccount,\n        params: { options },\n      }),\n      CreateAccountResponseStruct,\n    );\n  }\n\n  async filterAccountChains(id: string, chains: string[]): Promise<string[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.FilterAccountChains,\n        params: { id, chains },\n      }),\n      FilterAccountChainsResponseStruct,\n    );\n  }\n\n  async updateAccount(account: KeyringAccount): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.UpdateAccount,\n        params: { account },\n      }),\n      UpdateAccountResponseStruct,\n    );\n  }\n\n  async deleteAccount(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.DeleteAccount,\n        params: { id },\n      }),\n      DeleteAccountResponseStruct,\n    );\n  }\n\n  async exportAccount(id: string): Promise<KeyringAccountData> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ExportAccount,\n        params: { id },\n      }),\n      ExportAccountResponseStruct,\n    );\n  }\n\n  async listRequests(): Promise<KeyringRequest[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ListRequests,\n      }),\n      ListRequestsResponseStruct,\n    );\n  }\n\n  async getRequest(id: string): Promise<KeyringRequest> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.GetRequest,\n        params: { id },\n      }),\n      GetRequestResponseStruct,\n    );\n  }\n\n  async submitRequest(request: KeyringRequest): Promise<KeyringResponse> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.SubmitRequest,\n        params: request,\n      }),\n      SubmitRequestResponseStruct,\n    );\n  }\n\n  async approveRequest(\n    id: string,\n    data: Record<string, Json> = {},\n  ): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.ApproveRequest,\n        params: { id, data },\n      }),\n      ApproveRequestResponseStruct,\n    );\n  }\n\n  async rejectRequest(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.RejectRequest,\n        params: { id },\n      }),\n      RejectRequestResponseStruct,\n    );\n  }\n}\n"]}
+{"version":3,"file":"KeyringClient.js","sourceRoot":"","sources":["../src/KeyringClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,6CAAqC;AACrC,+BAAkC;AASlC,wCAawB;AACxB,wCAAkD;AAElD,+CAA2C;AAM3C,MAAa,aAAa;IAGxB;;;;OAIG;IACH,YAAY,MAAc;;QAP1B,wCAAgB;QAQd,uBAAA,IAAI,yBAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAgBD,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,YAAY;SACtC,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,UAAU;YACnC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,UAAgC,EAAE;QAElC,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,MAAgB;QACpD,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,mBAAmB;YAC5C,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;SACvB,CAAC,EACF,uCAAiC,CAClC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,YAAY;SACtC,CAAC,EACF,gCAA0B,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,UAAU;YACnC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,8BAAwB,CACzB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,OAAO,IAAA,wBAAU,EACf,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,OAAO;SAChB,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,OAA6B,EAAE;QAE/B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,cAAc;YACvC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;SACrB,CAAC,EACF,kCAA4B,CAC7B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU;QAC5B,IAAA,oBAAM,EACJ,MAAM,uBAAA,IAAI,qDAAM,MAAV,IAAI,EAAO;YACf,MAAM,EAAE,sBAAgB,CAAC,aAAa;YACtC,MAAM,EAAE,EAAE,EAAE,EAAE;SACf,CAAC,EACF,iCAA2B,CAC5B,CAAC;IACJ,CAAC;CACF;AApJD,sCAoJC;;AAxIC;;;;;GAKG;AACH,KAAK,8BAAO,OAA+C;IACzD,OAAO,uBAAA,IAAI,6BAAQ,CAAC,IAAI,CAAC;QACvB,OAAO,EAAE,KAAK;QACd,EAAE,EAAE,IAAA,SAAI,GAAE;QACV,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assert } from 'superstruct';\nimport { v4 as uuid } from 'uuid';\n\nimport type {\n  Keyring,\n  KeyringAccount,\n  KeyringRequest,\n  KeyringAccountData,\n  KeyringResponse,\n} from './api';\nimport {\n  ApproveRequestResponseStruct,\n  CreateAccountResponseStruct,\n  DeleteAccountResponseStruct,\n  ExportAccountResponseStruct,\n  FilterAccountChainsResponseStruct,\n  GetAccountResponseStruct,\n  GetRequestResponseStruct,\n  ListAccountsResponseStruct,\n  ListRequestsResponseStruct,\n  RejectRequestResponseStruct,\n  SubmitRequestResponseStruct,\n  UpdateAccountResponseStruct,\n} from './internal/api';\nimport { KeyringRpcMethod } from './internal/rpc';\nimport type { JsonRpcRequest } from './JsonRpcRequest';\nimport { strictMask } from './superstruct';\n\nexport type Sender = {\n  send(request: JsonRpcRequest): Promise<Json>;\n};\n\nexport class KeyringClient implements Keyring {\n  #sender: Sender;\n\n  /**\n   * Create a new instance of `KeyringClient`.\n   *\n   * @param sender - The `Sender` instance to use to send requests to the snap.\n   */\n  constructor(sender: Sender) {\n    this.#sender = sender;\n  }\n\n  /**\n   * Send a request to the snap and return the response.\n   *\n   * @param partial - A partial JSON-RPC request (method and params).\n   * @returns A promise that resolves to the response to the request.\n   */\n  async #send(partial: Omit<JsonRpcRequest, 'jsonrpc' | 'id'>): Promise<Json> {\n    return this.#sender.send({\n      jsonrpc: '2.0',\n      id: uuid(),\n      ...partial,\n    });\n  }\n\n  async listAccounts(): Promise<KeyringAccount[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ListAccounts,\n      }),\n      ListAccountsResponseStruct,\n    );\n  }\n\n  async getAccount(id: string): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.GetAccount,\n        params: { id },\n      }),\n      GetAccountResponseStruct,\n    );\n  }\n\n  async createAccount(\n    options: Record<string, Json> = {},\n  ): Promise<KeyringAccount> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.CreateAccount,\n        params: { options },\n      }),\n      CreateAccountResponseStruct,\n    );\n  }\n\n  async filterAccountChains(id: string, chains: string[]): Promise<string[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.FilterAccountChains,\n        params: { id, chains },\n      }),\n      FilterAccountChainsResponseStruct,\n    );\n  }\n\n  async updateAccount(account: KeyringAccount): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.UpdateAccount,\n        params: { account },\n      }),\n      UpdateAccountResponseStruct,\n    );\n  }\n\n  async deleteAccount(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.DeleteAccount,\n        params: { id },\n      }),\n      DeleteAccountResponseStruct,\n    );\n  }\n\n  async exportAccount(id: string): Promise<KeyringAccountData> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ExportAccount,\n        params: { id },\n      }),\n      ExportAccountResponseStruct,\n    );\n  }\n\n  async listRequests(): Promise<KeyringRequest[]> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.ListRequests,\n      }),\n      ListRequestsResponseStruct,\n    );\n  }\n\n  async getRequest(id: string): Promise<KeyringRequest> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.GetRequest,\n        params: { id },\n      }),\n      GetRequestResponseStruct,\n    );\n  }\n\n  async submitRequest(request: KeyringRequest): Promise<KeyringResponse> {\n    return strictMask(\n      await this.#send({\n        method: KeyringRpcMethod.SubmitRequest,\n        params: request,\n      }),\n      SubmitRequestResponseStruct,\n    );\n  }\n\n  async approveRequest(\n    id: string,\n    data: Record<string, Json> = {},\n  ): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.ApproveRequest,\n        params: { id, data },\n      }),\n      ApproveRequestResponseStruct,\n    );\n  }\n\n  async rejectRequest(id: string): Promise<void> {\n    assert(\n      await this.#send({\n        method: KeyringRpcMethod.RejectRequest,\n        params: { id },\n      }),\n      RejectRequestResponseStruct,\n    );\n  }\n}\n"]}

package/dist/api/account.d.ts

@@ -0,0 +1,62 @@
+import type { Infer } from 'superstruct';
+/**
+ * Supported Ethereum account types.
+ */
+export declare enum EthAccountType {
+    Eoa = "eip155:eoa",
+    Erc4337 = "eip155:erc4337"
+}
+/**
+ * Supported Bitcoin account types.
+ */
+export declare enum BtcAccountType {
+    P2wpkh = "bip122:p2wpkh"
+}
+/**
+ * Supported account types.
+ */
+export declare type KeyringAccountType = `${EthAccountType.Eoa}` | `${EthAccountType.Erc4337}` | `${BtcAccountType.P2wpkh}`;
+/**
+ * A struct which represents a Keyring account object. It is abstract enough to
+ * be used with any blockchain. Specific blockchain account types should extend
+ * this struct.
+ *
+ * See {@link KeyringAccount}.
+ */
+export declare const KeyringAccountStruct: import("superstruct").Struct<{
+    type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: string[];
+}, {
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: import("superstruct").Struct<string, null>;
+    /**
+     * Account type.
+     */
+    type: import("superstruct").Struct<"eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh", {
+        "eip155:eoa": "eip155:eoa";
+        "eip155:erc4337": "eip155:erc4337";
+        "bip122:p2wpkh": "bip122:p2wpkh";
+    }>;
+    /**
+     * Account main address.
+     */
+    address: import("superstruct").Struct<string, null>;
+    /**
+     * Account options.
+     */
+    options: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+    /**
+     * Account supported methods.
+     */
+    methods: import("superstruct").Struct<string[], import("superstruct").Struct<string, null>>;
+}>;
+/**
+ * Keyring Account type represents an account and its properties from the
+ * point of view of the keyring.
+ */
+export declare type KeyringAccount = Infer<typeof KeyringAccountStruct>;

package/dist/api/account.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringAccountStruct = exports.BtcAccountType = exports.EthAccountType = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const superstruct_2 = require("../superstruct");
+const utils_2 = require("../utils");
+/**
+ * Supported Ethereum account types.
+ */
+var EthAccountType;
+(function (EthAccountType) {
+    EthAccountType["Eoa"] = "eip155:eoa";
+    EthAccountType["Erc4337"] = "eip155:erc4337";
+})(EthAccountType = exports.EthAccountType || (exports.EthAccountType = {}));
+/**
+ * Supported Bitcoin account types.
+ */
+var BtcAccountType;
+(function (BtcAccountType) {
+    BtcAccountType["P2wpkh"] = "bip122:p2wpkh";
+})(BtcAccountType = exports.BtcAccountType || (exports.BtcAccountType = {}));
+/**
+ * A struct which represents a Keyring account object. It is abstract enough to
+ * be used with any blockchain. Specific blockchain account types should extend
+ * this struct.
+ *
+ * See {@link KeyringAccount}.
+ */
+exports.KeyringAccountStruct = (0, superstruct_2.object)({
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: utils_2.UuidStruct,
+    /**
+     * Account type.
+     */
+    type: (0, superstruct_1.enums)([
+        `${EthAccountType.Eoa}`,
+        `${EthAccountType.Erc4337}`,
+        `${BtcAccountType.P2wpkh}`,
+    ]),
+    /**
+     * Account main address.
+     */
+    address: (0, superstruct_1.string)(),
+    /**
+     * Account options.
+     */
+    options: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+    /**
+     * Account supported methods.
+     */
+    methods: (0, superstruct_1.array)((0, superstruct_1.string)()),
+});
+//# sourceMappingURL=account.js.map

package/dist/api/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/api/account.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6CAA2D;AAE3D,gDAAwC;AACxC,oCAAsC;AAEtC;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED;;GAEG;AACH,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,0CAAwB,CAAA;AAC1B,CAAC,EAFW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAEzB;AAUD;;;;;;GAMG;AACU,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,cAAc,CAAC,GAAG,EAAE;QACvB,GAAG,cAAc,CAAC,OAAO,EAAE;QAC3B,GAAG,cAAc,CAAC,MAAM,EAAE;KAC3B,CAAC;IAEF;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EAAC,IAAA,oBAAM,GAAE,CAAC;CACzB,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport { array, enums, record, string } from 'superstruct';\n\nimport { object } from '../superstruct';\nimport { UuidStruct } from '../utils';\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Erc4337 = 'eip155:erc4337',\n}\n\n/**\n * Supported Bitcoin account types.\n */\nexport enum BtcAccountType {\n  P2wpkh = 'bip122:p2wpkh',\n}\n\n/**\n * Supported account types.\n */\nexport type KeyringAccountType =\n  | `${EthAccountType.Eoa}`\n  | `${EthAccountType.Erc4337}`\n  | `${BtcAccountType.P2wpkh}`;\n\n/**\n * A struct which represents a Keyring account object. It is abstract enough to\n * be used with any blockchain. Specific blockchain account types should extend\n * this struct.\n *\n * See {@link KeyringAccount}.\n */\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account type.\n   */\n  type: enums([\n    `${EthAccountType.Eoa}`,\n    `${EthAccountType.Erc4337}`,\n    `${BtcAccountType.P2wpkh}`,\n  ]),\n\n  /**\n   * Account main address.\n   */\n  address: string(),\n\n  /**\n   * Account options.\n   */\n  options: record(string(), JsonStruct),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(string()),\n});\n\n/**\n * Keyring Account type represents an account and its properties from the\n * point of view of the keyring.\n */\nexport type KeyringAccount = Infer<typeof KeyringAccountStruct>;\n"]}

package/dist/api/balance.d.ts

@@ -0,0 +1,9 @@
+import type { Infer } from 'superstruct';
+export declare const BalanceStruct: import("superstruct").Struct<{
+    amount: string;
+    unit: string;
+}, {
+    amount: import("superstruct").Struct<string, null>;
+    unit: import("superstruct").Struct<string, null>;
+}>;
+export declare type Balance = Infer<typeof BalanceStruct>;

package/dist/api/balance.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BalanceStruct = void 0;
+const superstruct_1 = require("superstruct");
+const superstruct_2 = require("../superstruct");
+const utils_1 = require("../utils");
+exports.BalanceStruct = (0, superstruct_2.object)({
+    amount: utils_1.StringNumberStruct,
+    unit: (0, superstruct_1.string)(),
+});
+//# sourceMappingURL=balance.js.map

package/dist/api/balance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance.js","sourceRoot":"","sources":["../../src/api/balance.ts"],"names":[],"mappings":";;;AACA,6CAAqC;AAErC,gDAAwC;AACxC,oCAA8C;AAEjC,QAAA,aAAa,GAAG,IAAA,oBAAM,EAAC;IAClC,MAAM,EAAE,0BAAkB;IAC1B,IAAI,EAAE,IAAA,oBAAM,GAAE;CACf,CAAC,CAAC","sourcesContent":["import type { Infer } from 'superstruct';\nimport { string } from 'superstruct';\n\nimport { object } from '../superstruct';\nimport { StringNumberStruct } from '../utils';\n\nexport const BalanceStruct = object({\n  amount: StringNumberStruct,\n  unit: string(),\n});\n\nexport type Balance = Infer<typeof BalanceStruct>;\n"]}

package/dist/api/export.d.ts

@@ -0,0 +1,8 @@
+import type { Infer } from 'superstruct';
+export declare const KeyringAccountDataStruct: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+/**
+ * Response to a call to `exportAccount`.
+ *
+ * The exact response depends on the keyring implementation.
+ */
+export declare type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;

package/dist/api/export.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringAccountDataStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+exports.KeyringAccountDataStruct = (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct);
+//# sourceMappingURL=export.js.map

package/dist/api/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/api/export.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6CAA6C;AAEhC,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport { record, string } from 'superstruct';\n\nexport const KeyringAccountDataStruct = record(string(), JsonStruct);\n\n/**\n * Response to a call to `exportAccount`.\n *\n * The exact response depends on the keyring implementation.\n */\nexport type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;\n"]}

package/dist/api/index.d.ts

@@ -0,0 +1,6 @@
+export * from './account';
+export * from './balance';
+export * from './export';
+export * from './keyring';
+export * from './request';
+export * from './response';

package/dist/api/index.js

@@ -0,0 +1,23 @@
+"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("./account"), exports);
+__exportStar(require("./balance"), exports);
+__exportStar(require("./export"), exports);
+__exportStar(require("./keyring"), exports);
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,4CAA0B;AAC1B,4CAA0B;AAC1B,6CAA2B","sourcesContent":["export * from './account';\nexport * from './balance';\nexport * from './export';\nexport * from './keyring';\nexport * from './request';\nexport * from './response';\n"]}

package/dist/{api.d.ts → api/keyring.d.ts}

@@ -1,129 +1,10 @@
 import type { Json } from '@metamask/utils';
-import type { Infer, Struct } from 'superstruct';
-import type { StaticAssertAbstractAccount } from './base-types';
-import type { BtcP2wpkhAccount } from './btc';
-import type { EthEoaAccount, EthErc4337Account } from './eth';
-/**
- * Type of supported accounts.
- */
-export declare type KeyringAccounts = StaticAssertAbstractAccount<EthEoaAccount | EthErc4337Account | BtcP2wpkhAccount>;
-/**
- * Mapping between account types and their matching `superstruct` schema.
- */
-export declare const KeyringAccountStructs: Record<string, Struct<EthEoaAccount> | Struct<EthErc4337Account> | Struct<BtcP2wpkhAccount>>;
-/**
- * Base type for `KeyringAccount` as a `superstruct.object`.
- */
-export declare const BaseKeyringAccountStruct: Struct<{
-    type: "bip122:p2wpkh" | "eip155:eoa" | "eip155:erc4337";
-}, {
-    /**
-     * Account type.
-     */
-    type: Struct<"bip122:p2wpkh" | "eip155:eoa" | "eip155:erc4337", {
-        "bip122:p2wpkh": "bip122:p2wpkh";
-        "eip155:eoa": "eip155:eoa";
-        "eip155:erc4337": "eip155:erc4337";
-    }>;
-}>;
-/**
- * Account as a `superstruct.object`.
- *
- * See {@link KeyringAccount}.
- */
-export declare const KeyringAccountStruct: Struct<{
-    type: "bip122:p2wpkh";
-    id: string;
-    address: string;
-    options: Record<string, Json>;
-    methods: "btc_sendmany"[];
-} | {
-    type: "eip155:eoa";
-    id: string;
-    address: string;
-    options: Record<string, Json>;
-    methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
-} | {
-    type: "eip155:erc4337";
-    id: string;
-    address: string;
-    options: Record<string, Json>;
-    methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
-}, null>;
-/**
- * Account object.
- *
- * Represents an account with its properties and capabilities.
- */
-export declare type KeyringAccount = Infer<typeof KeyringAccountStruct>;
-export declare const KeyringRequestStruct: Struct<{
-    id: string;
-    account: string;
-    scope: string;
-    request: {
-        method: string;
-        params?: Json[] | Record<string, Json>;
-    };
-}, {
-    /**
-     * Keyring request ID (UUIDv4).
-     */
-    id: Struct<string, null>;
-    /**
-     * Request's scope (CAIP-2 chain ID).
-     */
-    scope: Struct<string, null>;
-    /**
-     * Account ID (UUIDv4).
-     */
-    account: Struct<string, null>;
-    /**
-     * Inner request sent by the client application.
-     */
-    request: Struct<{
-        method: string;
-        params?: Json[] | Record<string, Json>;
-    }, {
-        method: Struct<string, null>;
-        params: Struct<import("./superstruct").ExactOptionalTag | Json[] | Record<string, 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 KeyringAccountDataStruct: Struct<Record<string, Json>, null>;
-/**
- * Response to a call to `exportAccount`.
- *
- * The exact response depends on the keyring implementation.
- */
-export declare type KeyringAccountData = Infer<typeof KeyringAccountDataStruct>;
-export declare const KeyringResponseStruct: Struct<{
-    pending: true;
-    redirect?: {
-        message?: string;
-        url?: string;
-    };
-} | {
-    pending: false;
-    result: Json;
-}, null>;
-/**
- * Response to a call to `submitRequest`.
- *
- * Keyring implementations must return a response with `pending: true` if the
- * request will be handled asynchronously. Otherwise, the response must contain
- * the result of the request and `pending: false`.
- *
- * In the asynchronous case, the keyring can return a redirect URL and message
- * to be shown to the user. The user can choose to follow the link or cancel
- * the request. The main use case for this is to redirect the user to the snap
- * dapp to review the request.
- */
-export declare type KeyringResponse = Infer<typeof KeyringResponseStruct>;
+import type { CaipAssetType } from '../utils';
+import type { KeyringAccount } from './account';
+import type { Balance } from './balance';
+import type { KeyringAccountData } from './export';
+import type { KeyringRequest } from './request';
+import type { KeyringResponse } from './response';
 /**
  * Keyring interface.
  *
@@ -160,6 +41,34 @@ export declare type Keyring = {
      * object without any private information.
      */
     createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;
+    /**
+     * Retrieve the balances of a given account.
+     *
+     * This method fetches the balances of specified assets for a given account
+     * ID. It returns a promise that resolves to an object where the keys are
+     * asset types and the values are balance objects containing the amount and
+     * unit.
+     *
+     * @example
+     * ```ts
+     * await keyring.getAccountBalances(
+     *   '43550276-c7d6-4fac-87c7-00390ad0ce90',
+     *   ['bip122:000000000019d6689c085ae165831e93/slip44:0']
+     * );
+     * // Returns something similar to:
+     * // {
+     * //   'bip122:000000000019d6689c085ae165831e93/slip44:0': {
+     * //     amount: '0.0001',
+     * //     unit: 'BTC',
+     * //   }
+     * // }
+     * ```
+     * @param id - ID of the account to retrieve the balances for.
+     * @param assets - Array of asset types (CAIP-19) to retrieve balances for.
+     * @returns A promise that resolves to an object mapping asset types to their
+     * respective balances.
+     */
+    getAccountBalances?(id: string, assets: CaipAssetType[]): Promise<Record<CaipAssetType, Balance>>;
     /**
      * Filter supported chains for a given account.
      *

package/dist/api/keyring.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=keyring.js.map

package/dist/api/keyring.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyring.js","sourceRoot":"","sources":["../../src/api/keyring.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type { CaipAssetType } from '../utils';\nimport type { KeyringAccount } from './account';\nimport type { Balance } from './balance';\nimport type { KeyringAccountData } from './export';\nimport type { KeyringRequest } from './request';\nimport type { KeyringResponse } from './response';\n\n/**\n * Keyring interface.\n *\n * Represents the functionality and operations related to managing accounts and\n * handling requests.\n */\nexport type Keyring = {\n  /**\n   * List accounts.\n   *\n   * Retrieves an array of KeyringAccount objects representing the available\n   * accounts.\n   *\n   * @returns A promise that resolves to an array of KeyringAccount objects.\n   */\n  listAccounts(): Promise<KeyringAccount[]>;\n\n  /**\n   * Get an account.\n   *\n   * Retrieves the KeyringAccount object for the given account ID.\n   *\n   * @param id - The ID of the account to retrieve.\n   * @returns A promise that resolves to the KeyringAccount object if found, or\n   * undefined otherwise.\n   */\n  getAccount(id: string): Promise<KeyringAccount | undefined>;\n\n  /**\n   * Create an account.\n   *\n   * Creates a new account with optional, keyring-defined, account options.\n   *\n   * @param options - Keyring-defined options for the account (optional).\n   * @returns A promise that resolves to the newly created KeyringAccount\n   * object without any private information.\n   */\n  createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;\n\n  /**\n   * Retrieve the balances of a given account.\n   *\n   * This method fetches the balances of specified assets for a given account\n   * ID. It returns a promise that resolves to an object where the keys are\n   * asset types and the values are balance objects containing the amount and\n   * unit.\n   *\n   * @example\n   * ```ts\n   * await keyring.getAccountBalances(\n   *   '43550276-c7d6-4fac-87c7-00390ad0ce90',\n   *   ['bip122:000000000019d6689c085ae165831e93/slip44:0']\n   * );\n   * // Returns something similar to:\n   * // {\n   * //   'bip122:000000000019d6689c085ae165831e93/slip44:0': {\n   * //     amount: '0.0001',\n   * //     unit: 'BTC',\n   * //   }\n   * // }\n   * ```\n   * @param id - ID of the account to retrieve the balances for.\n   * @param assets - Array of asset types (CAIP-19) to retrieve balances for.\n   * @returns A promise that resolves to an object mapping asset types to their\n   * respective balances.\n   */\n  getAccountBalances?(\n    id: string,\n    assets: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>>;\n\n  /**\n   * Filter supported chains for a given account.\n   *\n   * @param id - ID of the account to be checked.\n   * @param chains - List of chains (CAIP-2) to be checked.\n   * @returns A Promise that resolves to a filtered list of CAIP-2 IDs\n   * representing the supported chains.\n   */\n  filterAccountChains(id: string, chains: string[]): Promise<string[]>;\n\n  /**\n   * Update an account.\n   *\n   * Updates the account with the given account object. Does nothing if the\n   * account does not exist.\n   *\n   * @param account - The updated account object.\n   * @returns A promise that resolves when the account is successfully updated.\n   */\n  updateAccount(account: KeyringAccount): Promise<void>;\n\n  /**\n   * Delete an account from the keyring.\n   *\n   * Deletes the account with the given ID from the keyring.\n   *\n   * @param id - The ID of the account to delete.\n   * @returns A promise that resolves when the account is successfully deleted.\n   */\n  deleteAccount(id: string): Promise<void>;\n\n  /**\n   * Exports an account's private key.\n   *\n   * If the keyring cannot export a private key, this function should throw an\n   * error.\n   *\n   * @param id - The ID of the account to export.\n   * @returns A promise that resolves to the exported account.\n   */\n  exportAccount?(id: string): Promise<KeyringAccountData>;\n\n  /**\n   * List all submitted requests.\n   *\n   * Retrieves an array of KeyringRequest objects representing the submitted\n   * requests.\n   *\n   * @returns A promise that resolves to an array of KeyringRequest objects.\n   */\n  listRequests?(): Promise<KeyringRequest[]>;\n\n  /**\n   * Get a request.\n   *\n   * Retrieves the KeyringRequest object for the given request ID.\n   *\n   * @param id - The ID of the request to retrieve.\n   * @returns A promise that resolves to the KeyringRequest object if found, or\n   * undefined otherwise.\n   */\n  getRequest?(id: string): Promise<KeyringRequest | undefined>;\n\n  /**\n   * Submit a request.\n   *\n   * Submits the given KeyringRequest object.\n   *\n   * @param request - The KeyringRequest object to submit.\n   * @returns A promise that resolves to the request response.\n   */\n  submitRequest(request: KeyringRequest): Promise<KeyringResponse>;\n\n  /**\n   * Approve a request.\n   *\n   * Approves the request with the given ID and sets the response if provided.\n   *\n   * @param id - The ID of the request to approve.\n   * @param data - The response to the request (optional).\n   * @returns A promise that resolves when the request is successfully\n   * approved.\n   */\n  approveRequest?(id: string, data?: Record<string, Json>): Promise<void>;\n\n  /**\n   * Reject a request.\n   *\n   * Rejects the request with the given ID.\n   *\n   * @param id - The ID of the request to reject.\n   * @returns A promise that resolves when the request is successfully\n   * rejected.\n   */\n  rejectRequest?(id: string): Promise<void>;\n};\n"]}

package/dist/api/request.d.ts

@@ -0,0 +1,39 @@
+import type { Infer } from 'superstruct';
+export declare const KeyringRequestStruct: import("superstruct").Struct<{
+    id: string;
+    scope: string;
+    account: string;
+    request: {
+        method: string;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+    };
+}, {
+    /**
+     * Keyring request ID (UUIDv4).
+     */
+    id: import("superstruct").Struct<string, null>;
+    /**
+     * Request's scope (CAIP-2 chain ID).
+     */
+    scope: import("superstruct").Struct<string, null>;
+    /**
+     * Account ID (UUIDv4).
+     */
+    account: import("superstruct").Struct<string, null>;
+    /**
+     * Inner request sent by the client application.
+     */
+    request: import("superstruct").Struct<{
+        method: string;
+        params?: import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>;
+    }, {
+        method: import("superstruct").Struct<string, null>;
+        params: import("superstruct").Struct<import("../superstruct").ExactOptionalTag | import("@metamask/utils").Json[] | Record<string, import("@metamask/utils").Json>, null>;
+    }>;
+}>;
+/**
+ * Keyring request.
+ *
+ * Represents a request made to the keyring for account-related operations.
+ */
+export declare type KeyringRequest = Infer<typeof KeyringRequestStruct>;

package/dist/api/request.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringRequestStruct = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const superstruct_2 = require("../superstruct");
+const utils_2 = require("../utils");
+exports.KeyringRequestStruct = (0, superstruct_2.object)({
+    /**
+     * Keyring request ID (UUIDv4).
+     */
+    id: utils_2.UuidStruct,
+    /**
+     * Request's scope (CAIP-2 chain ID).
+     */
+    scope: (0, superstruct_1.string)(),
+    /**
+     * Account ID (UUIDv4).
+     */
+    account: utils_2.UuidStruct,
+    /**
+     * Inner request sent by the client application.
+     */
+    request: (0, superstruct_2.object)({
+        method: (0, superstruct_1.string)(),
+        params: (0, superstruct_2.exactOptional)((0, superstruct_1.union)([(0, superstruct_1.array)(utils_1.JsonStruct), (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct)])),
+    }),
+});
+//# sourceMappingURL=request.js.map

package/dist/api/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../src/api/request.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6CAA2D;AAE3D,gDAAuD;AACvD,oCAAsC;AAEzB,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,KAAK,EAAE,IAAA,oBAAM,GAAE;IAEf;;OAEG;IACH,OAAO,EAAE,kBAAU;IAEnB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC;QACd,MAAM,EAAE,IAAA,oBAAM,GAAE;QAChB,MAAM,EAAE,IAAA,2BAAa,EACnB,IAAA,mBAAK,EAAC,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC,CAAC,CACzD;KACF,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport { array, record, string, union } from 'superstruct';\n\nimport { exactOptional, object } from '../superstruct';\nimport { UuidStruct } from '../utils';\n\nexport const KeyringRequestStruct = object({\n  /**\n   * Keyring request ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Request's scope (CAIP-2 chain ID).\n   */\n  scope: string(),\n\n  /**\n   * Account ID (UUIDv4).\n   */\n  account: UuidStruct,\n\n  /**\n   * Inner request sent by the client application.\n   */\n  request: object({\n    method: string(),\n    params: exactOptional(\n      union([array(JsonStruct), record(string(), JsonStruct)]),\n    ),\n  }),\n});\n\n/**\n * Keyring request.\n *\n * Represents a request made to the keyring for account-related operations.\n */\nexport type KeyringRequest = Infer<typeof KeyringRequestStruct>;\n"]}