@metamask/keyring-api 5.1.0 → 6.1.0

package/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.1.0]
+
+### Added
+
+- Add `isEvmAccountType` helper ([#297](https://github.com/MetaMask/keyring-api/pull/297))
+- Add `bip121:p2wpkh` account support ([#294](https://github.com/MetaMask/keyring-api/pull/294))
+
+### Changed
+
+- Remove incorrect `SignTransaction` from `EthErc4337Account` ([#300](https://github.com/MetaMask/keyring-api/pull/300))
+- Bump @metamask/providers from 16.0.0 to 16.1.0 ([#298](https://github.com/MetaMask/keyring-api/pull/298))
+- Bump @metamask/snaps-sdk from 4.0.0 to 4.0.1 ([#292](https://github.com/MetaMask/keyring-api/pull/292))
+- Split account types (EOA + Erc4337) ([#293](https://github.com/MetaMask/keyring-api/pull/293))
+
+## [6.0.0]
+
+### Changed
+
+- **BREAKING**: Add `importTime` property to `InternalAccount` metadata ([#289](https://github.com/MetaMask/keyring-api/pull/289))
+- Bump tar from 6.1.15 to 6.2.1 ([#286](https://github.com/MetaMask/keyring-api/pull/286))
+- Bump @metamask/snaps-sdk from 3.2.0 to 4.0.0 ([#287](https://github.com/MetaMask/keyring-api/pull/287))
+- Add documentation for `eth_decodeUserOperationCallData` ([#254](https://github.com/MetaMask/keyring-api/pull/254))
+- Bump @metamask/snaps-sdk from 3.1.1 to 3.2.0 ([#284](https://github.com/MetaMask/keyring-api/pull/284))
+
 ## [5.1.0]
 
 ### Changed
@@ -252,7 +276,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/v5.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/keyring-api/compare/v6.1.0...HEAD
+[6.1.0]: https://github.com/MetaMask/keyring-api/compare/v6.0.0...v6.1.0
+[6.0.0]: https://github.com/MetaMask/keyring-api/compare/v5.1.0...v6.0.0
 [5.1.0]: https://github.com/MetaMask/keyring-api/compare/v5.0.0...v5.1.0
 [5.0.0]: https://github.com/MetaMask/keyring-api/compare/v4.0.2...v5.0.0
 [4.0.2]: https://github.com/MetaMask/keyring-api/compare/v4.0.1...v4.0.2

package/dist/api.d.ts

@@ -1,77 +1,65 @@
 import type { Json } from '@metamask/utils';
-import type { Infer } from 'superstruct';
+import type { Infer, Struct } from 'superstruct';
+import type { StaticAssertAbstractAccount } from './base-types';
+import type { BtcP2wpkhAccount } from './btc';
+import type { EthEoaAccount, EthErc4337Account } from './eth';
 /**
- * Supported Ethereum methods.
+ * Type of supported accounts.
  */
-export declare enum EthMethod {
-    PersonalSign = "personal_sign",
-    Sign = "eth_sign",
-    SignTransaction = "eth_signTransaction",
-    SignTypedDataV1 = "eth_signTypedData_v1",
-    SignTypedDataV3 = "eth_signTypedData_v3",
-    SignTypedDataV4 = "eth_signTypedData_v4",
-    PrepareUserOperation = "eth_prepareUserOperation",
-    PatchUserOperation = "eth_patchUserOperation",
-    SignUserOperation = "eth_signUserOperation"
-}
+export declare type KeyringAccounts = StaticAssertAbstractAccount<EthEoaAccount | EthErc4337Account | BtcP2wpkhAccount>;
 /**
- * Supported Ethereum account types.
+ * Mapping between account types and their matching `superstruct` schema.
  */
-export declare enum EthAccountType {
-    Eoa = "eip155:eoa",
-    Erc4337 = "eip155:erc4337"
-}
-export declare const KeyringAccountStruct: import("superstruct").Struct<{
-    type: "eip155:eoa" | "eip155:erc4337";
-    id: string;
-    address: string;
-    options: Record<string, Json>;
-    methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
+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 ID (UUIDv4).
-     */
-    id: 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>;
-    /**
-     * Account supported methods.
-     */
-    methods: import("superstruct").Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[], import("superstruct").Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation", {
-        personal_sign: "personal_sign";
-        eth_sign: "eth_sign";
-        eth_signTransaction: "eth_signTransaction";
-        eth_signTypedData_v1: "eth_signTypedData_v1";
-        eth_signTypedData_v3: "eth_signTypedData_v3";
-        eth_signTypedData_v4: "eth_signTypedData_v4";
-        eth_prepareUserOperation: "eth_prepareUserOperation";
-        eth_patchUserOperation: "eth_patchUserOperation";
-        eth_signUserOperation: "eth_signUserOperation";
-    }>>;
     /**
      * Account type.
      */
-    type: import("superstruct").Struct<"eip155:eoa" | "eip155:erc4337", {
+    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: import("superstruct").Struct<{
+export declare const KeyringRequestStruct: Struct<{
     id: string;
-    scope: string;
     account: string;
+    scope: string;
     request: {
         method: string;
         params?: Json[] | Record<string, Json>;
@@ -80,24 +68,24 @@ export declare const KeyringRequestStruct: import("superstruct").Struct<{
     /**
      * Keyring request ID (UUIDv4).
      */
-    id: import("superstruct").Struct<string, null>;
+    id: Struct<string, null>;
     /**
      * Request's scope (CAIP-2 chain ID).
      */
-    scope: import("superstruct").Struct<string, null>;
+    scope: Struct<string, null>;
     /**
      * Account ID (UUIDv4).
      */
-    account: import("superstruct").Struct<string, null>;
+    account: Struct<string, null>;
     /**
      * Inner request sent by the client application.
      */
-    request: import("superstruct").Struct<{
+    request: Struct<{
         method: string;
         params?: Json[] | Record<string, Json>;
     }, {
-        method: import("superstruct").Struct<string, null>;
-        params: import("superstruct").Struct<import("./superstruct").ExactOptionalTag | Json[] | Record<string, Json>, null>;
+        method: Struct<string, null>;
+        params: Struct<import("./superstruct").ExactOptionalTag | Json[] | Record<string, Json>, null>;
     }>;
 }>;
 /**
@@ -106,14 +94,14 @@ export declare const KeyringRequestStruct: import("superstruct").Struct<{
  * Represents a request made to the keyring for account-related operations.
  */
 export declare type KeyringRequest = Infer<typeof KeyringRequestStruct>;
-export declare const KeyringAccountDataStruct: import("superstruct").Struct<Record<string, Json>, null>;
+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: import("superstruct").Struct<{
+export declare const KeyringResponseStruct: Struct<{
     pending: true;
     redirect?: {
         message?: string;

package/dist/api.js

@@ -1,66 +1,50 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyringResponseStruct = exports.KeyringAccountDataStruct = exports.KeyringRequestStruct = exports.KeyringAccountStruct = exports.EthAccountType = exports.EthMethod = void 0;
+exports.KeyringResponseStruct = exports.KeyringAccountDataStruct = exports.KeyringRequestStruct = exports.KeyringAccountStruct = exports.BaseKeyringAccountStruct = exports.KeyringAccountStructs = void 0;
 const utils_1 = require("@metamask/utils");
 const superstruct_1 = require("superstruct");
+const btc_1 = require("./btc");
+const eth_1 = require("./eth");
 const superstruct_2 = require("./superstruct");
 const utils_2 = require("./utils");
 /**
- * Supported Ethereum methods.
+ * Mapping between account types and their matching `superstruct` schema.
  */
-var EthMethod;
-(function (EthMethod) {
-    // General signing methods
-    EthMethod["PersonalSign"] = "personal_sign";
-    EthMethod["Sign"] = "eth_sign";
-    EthMethod["SignTransaction"] = "eth_signTransaction";
-    EthMethod["SignTypedDataV1"] = "eth_signTypedData_v1";
-    EthMethod["SignTypedDataV3"] = "eth_signTypedData_v3";
-    EthMethod["SignTypedDataV4"] = "eth_signTypedData_v4";
-    // ERC-4337 methods
-    EthMethod["PrepareUserOperation"] = "eth_prepareUserOperation";
-    EthMethod["PatchUserOperation"] = "eth_patchUserOperation";
-    EthMethod["SignUserOperation"] = "eth_signUserOperation";
-})(EthMethod = exports.EthMethod || (exports.EthMethod = {}));
+exports.KeyringAccountStructs = {
+    [`${eth_1.EthAccountType.Eoa}`]: eth_1.EthEoaAccountStruct,
+    [`${eth_1.EthAccountType.Erc4337}`]: eth_1.EthErc4337AccountStruct,
+    [`${btc_1.BtcAccountType.P2wpkh}`]: btc_1.BtcP2wpkhAccountStruct,
+};
 /**
- * Supported Ethereum account types.
+ * Base type for `KeyringAccount` as a `superstruct.object`.
  */
-var EthAccountType;
-(function (EthAccountType) {
-    EthAccountType["Eoa"] = "eip155:eoa";
-    EthAccountType["Erc4337"] = "eip155:erc4337";
-})(EthAccountType = exports.EthAccountType || (exports.EthAccountType = {}));
-exports.KeyringAccountStruct = (0, superstruct_2.object)({
-    /**
-     * Account ID (UUIDv4).
-     */
-    id: utils_2.UuidStruct,
-    /**
-     * Account address or next receive address (UTXO).
-     */
-    address: (0, superstruct_1.string)(),
-    /**
-     * Keyring-dependent 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.enums)([
-        `${EthMethod.PersonalSign}`,
-        `${EthMethod.Sign}`,
-        `${EthMethod.SignTransaction}`,
-        `${EthMethod.SignTypedDataV1}`,
-        `${EthMethod.SignTypedDataV3}`,
-        `${EthMethod.SignTypedDataV4}`,
-        `${EthMethod.PrepareUserOperation}`,
-        `${EthMethod.PatchUserOperation}`,
-        `${EthMethod.SignUserOperation}`,
-    ])),
+exports.BaseKeyringAccountStruct = (0, superstruct_2.object)({
     /**
      * Account type.
      */
-    type: (0, superstruct_1.enums)([`${EthAccountType.Eoa}`, `${EthAccountType.Erc4337}`]),
+    type: (0, superstruct_1.enums)([
+        `${eth_1.EthAccountType.Eoa}`,
+        `${eth_1.EthAccountType.Erc4337}`,
+        `${btc_1.BtcAccountType.P2wpkh}`,
+    ]),
+});
+/**
+ * Account as a `superstruct.object`.
+ *
+ * See {@link KeyringAccount}.
+ */
+exports.KeyringAccountStruct = (0, superstruct_1.define)(
+// We do use a custom `define` for this type to avoid having to use a `union` since error
+// messages are a bit confusing.
+//
+// Doing manual validation allows us to use the "concrete" type of each supported acounts giving
+// use a much nicer message from `superstruct`.
+'KeyringAccount', (value) => {
+    // This will also raise if `value` does not match any of the supported account types!
+    const account = (0, superstruct_1.mask)(value, exports.BaseKeyringAccountStruct);
+    // At this point, we know that `value.type` can be used as an index for `KeyringAccountStructs`
+    const [error] = (0, superstruct_1.validate)(value, exports.KeyringAccountStructs[account.type]);
+    return error ?? true;
 });
 exports.KeyringRequestStruct = (0, superstruct_2.object)({
     /**

package/dist/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAE7C,6CAA2E;AAE3E,+CAAsD;AACtD,mCAAqC;AAErC;;GAEG;AACH,IAAY,SAYX;AAZD,WAAY,SAAS;IACnB,0BAA0B;IAC1B,2CAA8B,CAAA;IAC9B,8BAAiB,CAAA;IACjB,oDAAuC,CAAA;IACvC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;IACxC,qDAAwC,CAAA;IACxC,mBAAmB;IACnB,8DAAiD,CAAA;IACjD,0DAA6C,CAAA;IAC7C,wDAA2C,CAAA;AAC7C,CAAC,EAZW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAYpB;AAED;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,oCAAkB,CAAA;IAClB,4CAA0B,CAAA;AAC5B,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;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,EACZ,IAAA,mBAAK,EAAC;QACJ,GAAG,SAAS,CAAC,YAAY,EAAE;QAC3B,GAAG,SAAS,CAAC,IAAI,EAAE;QACnB,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,eAAe,EAAE;QAC9B,GAAG,SAAS,CAAC,oBAAoB,EAAE;QACnC,GAAG,SAAS,CAAC,kBAAkB,EAAE;QACjC,GAAG,SAAS,CAAC,iBAAiB,EAAE;KACjC,CAAC,CACH;IAED;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;CACpE,CAAC,CAAC;AASU,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;AASU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;AASxD,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,EAAE,IAAA,2BAAa,EACrB,IAAA,oBAAM,EAAC;YACL,OAAO,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;YAChC,GAAG,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;SAC7B,CAAC,CACH;KACF,CAAC;IACF,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport type { Infer } from 'superstruct';\nimport { array, enums, literal, record, string, union } from 'superstruct';\n\nimport { exactOptional, object } from './superstruct';\nimport { UuidStruct } from './utils';\n\n/**\n * Supported Ethereum methods.\n */\nexport enum EthMethod {\n  // General signing methods\n  PersonalSign = 'personal_sign',\n  Sign = 'eth_sign',\n  SignTransaction = 'eth_signTransaction',\n  SignTypedDataV1 = 'eth_signTypedData_v1',\n  SignTypedDataV3 = 'eth_signTypedData_v3',\n  SignTypedDataV4 = 'eth_signTypedData_v4',\n  // ERC-4337 methods\n  PrepareUserOperation = 'eth_prepareUserOperation',\n  PatchUserOperation = 'eth_patchUserOperation',\n  SignUserOperation = 'eth_signUserOperation',\n}\n\n/**\n * Supported Ethereum account types.\n */\nexport enum EthAccountType {\n  Eoa = 'eip155:eoa',\n  Erc4337 = 'eip155:erc4337',\n}\n\nexport const KeyringAccountStruct = object({\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: record(string(), JsonStruct),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTransaction}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n      `${EthMethod.PrepareUserOperation}`,\n      `${EthMethod.PatchUserOperation}`,\n      `${EthMethod.SignUserOperation}`,\n    ]),\n  ),\n\n  /**\n   * Account type.\n   */\n  type: enums([`${EthAccountType.Eoa}`, `${EthAccountType.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 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\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\nexport const KeyringResponseStruct = union([\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to true indicates that the request will be\n     * handled asynchronously. The keyring must be called with `approveRequest`\n     * or `rejectRequest` to resolve the request.\n     */\n    pending: literal(true),\n\n    /**\n     * Redirect URL.\n     *\n     * If present in the response, MetaMask will display a confirmation dialog\n     * with a link to the redirect URL. The user can choose to follow the link\n     * or cancel the request.\n     */\n    redirect: exactOptional(\n      object({\n        message: exactOptional(string()),\n        url: exactOptional(string()),\n      }),\n    ),\n  }),\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to false indicates that the request will be\n     * handled synchronously. The keyring must return the result of the\n     * request execution.\n     */\n    pending: literal(false),\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n]);\n\n/**\n * Response to a call to `submitRequest`.\n *\n * Keyring implementations must return a response with `pending: true` if the\n * request will be handled asynchronously. Otherwise, the response must contain\n * the result of the request and `pending: false`.\n *\n * In the asynchronous case, the keyring can return a redirect URL and message\n * to be shown to the user. The user can choose to follow the link or cancel\n * the request. The main use case for this is to redirect the user to the snap\n * dapp to review the request.\n */\nexport type KeyringResponse = Infer<typeof KeyringResponseStruct>;\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   * 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"]}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAE7C,6CAUqB;AAIrB,+BAA+D;AAE/D,+BAIe;AACf,+CAAsD;AACtD,mCAAqC;AASrC;;GAEG;AACU,QAAA,qBAAqB,GAG9B;IACF,CAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC,EAAE,yBAAmB;IAC9C,CAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC,EAAE,6BAAuB;IACtD,CAAC,GAAG,oBAAc,CAAC,MAAM,EAAE,CAAC,EAAE,4BAAsB;CACrD,CAAC;AAEF;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC;IAC7C;;OAEG;IACH,IAAI,EAAE,IAAA,mBAAK,EAAC;QACV,GAAG,oBAAc,CAAC,GAAG,EAAE;QACvB,GAAG,oBAAc,CAAC,OAAO,EAAE;QAC3B,GAAG,oBAAc,CAAC,MAAM,EAAE;KAC3B,CAAC;CACH,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,IAAA,oBAAM;AACxC,yFAAyF;AACzF,gCAAgC;AAChC,EAAE;AACF,gGAAgG;AAChG,+CAA+C;AAC/C,gBAAgB,EAChB,CAAC,KAAc,EAAE,EAAE;IACjB,qFAAqF;IACrF,MAAM,OAAO,GAAG,IAAA,kBAAI,EAAC,KAAK,EAAE,gCAAwB,CAAC,CAAC;IAEtD,+FAA+F;IAC/F,MAAM,CAAC,KAAK,CAAC,GAAG,IAAA,sBAAQ,EACtB,KAAK,EACL,6BAAqB,CAAC,OAAO,CAAC,IAAI,CAAW,CAC9C,CAAC;IAEF,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CACF,CAAC;AASW,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;AASU,QAAA,wBAAwB,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;AASxD,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,IAAI,CAAC;QAEtB;;;;;;WAMG;QACH,QAAQ,EAAE,IAAA,2BAAa,EACrB,IAAA,oBAAM,EAAC;YACL,OAAO,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;YAChC,GAAG,EAAE,IAAA,2BAAa,EAAC,IAAA,oBAAM,GAAE,CAAC;SAC7B,CAAC,CACH;KACF,CAAC;IACF,IAAA,oBAAM,EAAC;QACL;;;;;;WAMG;QACH,OAAO,EAAE,IAAA,qBAAO,EAAC,KAAK,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,kBAAU;KACnB,CAAC;CACH,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  enums,\n  array,\n  define,\n  validate,\n  literal,\n  record,\n  string,\n  union,\n  mask,\n} from 'superstruct';\n\nimport type { StaticAssertAbstractAccount } from './base-types';\nimport type { BtcP2wpkhAccount } from './btc';\nimport { BtcP2wpkhAccountStruct, BtcAccountType } from './btc';\nimport type { EthEoaAccount, EthErc4337Account } from './eth';\nimport {\n  EthEoaAccountStruct,\n  EthErc4337AccountStruct,\n  EthAccountType,\n} from './eth';\nimport { exactOptional, object } from './superstruct';\nimport { UuidStruct } from './utils';\n\n/**\n * Type of supported accounts.\n */\nexport type KeyringAccounts = StaticAssertAbstractAccount<\n  EthEoaAccount | EthErc4337Account | BtcP2wpkhAccount\n>;\n\n/**\n * Mapping between account types and their matching `superstruct` schema.\n */\nexport const KeyringAccountStructs: Record<\n  string,\n  Struct<EthEoaAccount> | Struct<EthErc4337Account> | Struct<BtcP2wpkhAccount>\n> = {\n  [`${EthAccountType.Eoa}`]: EthEoaAccountStruct,\n  [`${EthAccountType.Erc4337}`]: EthErc4337AccountStruct,\n  [`${BtcAccountType.P2wpkh}`]: BtcP2wpkhAccountStruct,\n};\n\n/**\n * Base type for `KeyringAccount` as a `superstruct.object`.\n */\nexport const BaseKeyringAccountStruct = object({\n  /**\n   * Account type.\n   */\n  type: enums([\n    `${EthAccountType.Eoa}`,\n    `${EthAccountType.Erc4337}`,\n    `${BtcAccountType.P2wpkh}`,\n  ]),\n});\n\n/**\n * Account as a `superstruct.object`.\n *\n * See {@link KeyringAccount}.\n */\nexport const KeyringAccountStruct = define<KeyringAccounts>(\n  // We do use a custom `define` for this type to avoid having to use a `union` since error\n  // messages are a bit confusing.\n  //\n  // Doing manual validation allows us to use the \"concrete\" type of each supported acounts giving\n  // use a much nicer message from `superstruct`.\n  'KeyringAccount',\n  (value: unknown) => {\n    // This will also raise if `value` does not match any of the supported account types!\n    const account = mask(value, BaseKeyringAccountStruct);\n\n    // At this point, we know that `value.type` can be used as an index for `KeyringAccountStructs`\n    const [error] = validate(\n      value,\n      KeyringAccountStructs[account.type] as Struct,\n    );\n\n    return error ?? true;\n  },\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 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\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\nexport const KeyringResponseStruct = union([\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to true indicates that the request will be\n     * handled asynchronously. The keyring must be called with `approveRequest`\n     * or `rejectRequest` to resolve the request.\n     */\n    pending: literal(true),\n\n    /**\n     * Redirect URL.\n     *\n     * If present in the response, MetaMask will display a confirmation dialog\n     * with a link to the redirect URL. The user can choose to follow the link\n     * or cancel the request.\n     */\n    redirect: exactOptional(\n      object({\n        message: exactOptional(string()),\n        url: exactOptional(string()),\n      }),\n    ),\n  }),\n  object({\n    /**\n     * Pending flag.\n     *\n     * Setting the pending flag to false indicates that the request will be\n     * handled synchronously. The keyring must return the result of the\n     * request execution.\n     */\n    pending: literal(false),\n\n    /**\n     * Request result.\n     */\n    result: JsonStruct,\n  }),\n]);\n\n/**\n * Response to a call to `submitRequest`.\n *\n * Keyring implementations must return a response with `pending: true` if the\n * request will be handled asynchronously. Otherwise, the response must contain\n * the result of the request and `pending: false`.\n *\n * In the asynchronous case, the keyring can return a redirect URL and message\n * to be shown to the user. The user can choose to follow the link or cancel\n * the request. The main use case for this is to redirect the user to the snap\n * dapp to review the request.\n */\nexport type KeyringResponse = Infer<typeof KeyringResponseStruct>;\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   * 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/base-types.d.ts

@@ -0,0 +1,62 @@
+import type { Json } from '@metamask/utils';
+/**
+ * Base type for any account. This type must be composed and extended to add a `methods`
+ * and `type` fields.
+ *
+ * NOTE: This type isn't a `superstruct.object` as it is used to compose other objects. See
+ * {@link BaseAccountStruct}.
+ */
+export declare const BaseAccount: {
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: 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>;
+};
+/**
+ * Base type for any account as a `superstruct.object`.
+ */
+export declare const BaseAccountStruct: import("superstruct").Struct<{
+    id: string;
+    address: string;
+    options: Record<string, Json>;
+}, {
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: 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>;
+}>;
+/**
+ * Abstract struct that is used to match every supported account type. Making sure their type
+ * definition do not diverge from each others.
+ *
+ * NOTE: This type is using "primitive types" such as `string` to not contrain any real account
+ * type. It's up to those types to use more restrictions on their type definition.
+ */
+export declare type AbstractAccount = {
+    id: string;
+    address: string;
+    options: Record<string, Json>;
+    type: string;
+    methods: string[];
+};
+/**
+ * Type helper to make sure `Type` is "equal to" `AbstractAccount`, asserting that `Type` (an account
+ * type actually) never diverges from other account types.
+ */
+export declare type StaticAssertAbstractAccount<Type extends AbstractAccount> = Type;

package/dist/base-types.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseAccountStruct = exports.BaseAccount = void 0;
+const utils_1 = require("@metamask/utils");
+const superstruct_1 = require("superstruct");
+const utils_2 = require("./utils");
+/**
+ * Base type for any account. This type must be composed and extended to add a `methods`
+ * and `type` fields.
+ *
+ * NOTE: This type isn't a `superstruct.object` as it is used to compose other objects. See
+ * {@link BaseAccountStruct}.
+ */
+exports.BaseAccount = {
+    /**
+     * Account ID (UUIDv4).
+     */
+    id: utils_2.UuidStruct,
+    /**
+     * Account address or next receive address (UTXO).
+     */
+    address: (0, superstruct_1.string)(),
+    /**
+     * Keyring-dependent account options.
+     */
+    options: (0, superstruct_1.record)((0, superstruct_1.string)(), utils_1.JsonStruct),
+};
+/**
+ * Base type for any account as a `superstruct.object`.
+ */
+exports.BaseAccountStruct = (0, superstruct_1.object)(exports.BaseAccount);
+//# sourceMappingURL=base-types.js.map

package/dist/base-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-types.js","sourceRoot":"","sources":["../src/base-types.ts"],"names":[],"mappings":";;;AACA,2CAA6C;AAC7C,6CAAqD;AAErD,mCAAqC;AAErC;;;;;;GAMG;AACU,QAAA,WAAW,GAAG;IACzB;;OAEG;IACH,EAAE,EAAE,kBAAU;IAEd;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,GAAE;IAEjB;;OAEG;IACH,OAAO,EAAE,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC;CACtC,CAAC;AAEF;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAA,oBAAM,EAAC,mBAAW,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { JsonStruct } from '@metamask/utils';\nimport { object, record, string } from 'superstruct';\n\nimport { UuidStruct } from './utils';\n\n/**\n * Base type for any account. This type must be composed and extended to add a `methods`\n * and `type` fields.\n *\n * NOTE: This type isn't a `superstruct.object` as it is used to compose other objects. See\n * {@link BaseAccountStruct}.\n */\nexport const BaseAccount = {\n  /**\n   * Account ID (UUIDv4).\n   */\n  id: UuidStruct,\n\n  /**\n   * Account address or next receive address (UTXO).\n   */\n  address: string(),\n\n  /**\n   * Keyring-dependent account options.\n   */\n  options: record(string(), JsonStruct),\n};\n\n/**\n * Base type for any account as a `superstruct.object`.\n */\nexport const BaseAccountStruct = object(BaseAccount);\n\n/**\n * Abstract struct that is used to match every supported account type. Making sure their type\n * definition do not diverge from each others.\n *\n * NOTE: This type is using \"primitive types\" such as `string` to not contrain any real account\n * type. It's up to those types to use more restrictions on their type definition.\n */\nexport type AbstractAccount = {\n  id: string;\n  address: string;\n  options: Record<string, Json>;\n  type: string;\n  methods: string[];\n};\n\n/**\n * Type helper to make sure `Type` is \"equal to\" `AbstractAccount`, asserting that `Type` (an account\n * type actually) never diverges from other account types.\n */\nexport type StaticAssertAbstractAccount<Type extends AbstractAccount> = Type;\n"]}

package/dist/btc/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/btc/index.js

@@ -0,0 +1,18 @@
+"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("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/btc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/btc/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB","sourcesContent":["export * from './types';\n"]}

package/dist/btc/types.d.ts

@@ -0,0 +1,36 @@
+import type { Infer } from 'superstruct';
+export declare const BtcP2wpkhAddressStruct: import("superstruct").Struct<string, null>;
+/**
+ * Supported Bitcoin methods.
+ */
+export declare enum BtcMethod {
+    SendMany = "btc_sendmany"
+}
+/**
+ * Supported Bitcoin account types.
+ */
+export declare enum BtcAccountType {
+    P2wpkh = "bip122:p2wpkh"
+}
+export declare const BtcP2wpkhAccountStruct: import("superstruct").Struct<{
+    type: "bip122:p2wpkh";
+    id: string;
+    address: string;
+    options: Record<string, import("@metamask/utils").Json>;
+    methods: "btc_sendmany"[];
+}, {
+    /**
+     * Account type.
+     */
+    type: import("superstruct").Struct<"bip122:p2wpkh", "bip122:p2wpkh">;
+    /**
+     * Account supported methods.
+     */
+    methods: import("superstruct").Struct<"btc_sendmany"[], import("superstruct").Struct<"btc_sendmany", {
+        btc_sendmany: "btc_sendmany";
+    }>>;
+    id: import("superstruct").Struct<string, null>;
+    address: import("superstruct").Struct<string, null>;
+    options: import("superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
+}>;
+export declare type BtcP2wpkhAccount = Infer<typeof BtcP2wpkhAccountStruct>;

package/dist/btc/types.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BtcP2wpkhAccountStruct = exports.BtcAccountType = exports.BtcMethod = exports.BtcP2wpkhAddressStruct = void 0;
+const bech32_1 = require("bech32");
+const superstruct_1 = require("superstruct");
+const base_types_1 = require("../base-types");
+exports.BtcP2wpkhAddressStruct = (0, superstruct_1.refine)((0, superstruct_1.string)(), 'BtcP2wpkhAddressStruct', (address) => {
+    try {
+        bech32_1.bech32.decode(address);
+    }
+    catch (error) {
+        return new Error(`Could not decode P2WPKH address: ${error.message}`);
+    }
+    return true;
+});
+/**
+ * Supported Bitcoin methods.
+ */
+var BtcMethod;
+(function (BtcMethod) {
+    // General transaction methods
+    BtcMethod["SendMany"] = "btc_sendmany";
+})(BtcMethod = exports.BtcMethod || (exports.BtcMethod = {}));
+/**
+ * Supported Bitcoin account types.
+ */
+var BtcAccountType;
+(function (BtcAccountType) {
+    BtcAccountType["P2wpkh"] = "bip122:p2wpkh";
+})(BtcAccountType = exports.BtcAccountType || (exports.BtcAccountType = {}));
+exports.BtcP2wpkhAccountStruct = (0, superstruct_1.object)({
+    ...base_types_1.BaseAccount,
+    /**
+     * Account type.
+     */
+    type: (0, superstruct_1.literal)(`${BtcAccountType.P2wpkh}`),
+    /**
+     * Account supported methods.
+     */
+    methods: (0, superstruct_1.array)((0, superstruct_1.enums)([`${BtcMethod.SendMany}`])),
+});
+//# sourceMappingURL=types.js.map

package/dist/btc/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/btc/types.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAEhC,6CAA4E;AAE5E,8CAA4C;AAE/B,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAC1C,IAAA,oBAAM,GAAE,EACR,wBAAwB,EACxB,CAAC,OAAe,EAAE,EAAE;IAClB,IAAI;QACF,eAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;KACxB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,IAAI,KAAK,CACd,oCAAqC,KAAe,CAAC,OAAO,EAAE,CAC/D,CAAC;KACH;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CACF,CAAC;AAEF;;GAEG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,8BAA8B;IAC9B,sCAAyB,CAAA;AAC3B,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED;;GAEG;AACH,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,0CAAwB,CAAA;AAC1B,CAAC,EAFW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAEzB;AAEY,QAAA,sBAAsB,GAAG,IAAA,oBAAM,EAAC;IAC3C,GAAG,wBAAW;IAEd;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,IAAA,mBAAK,EAAC,IAAA,mBAAK,EAAC,CAAC,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;CACjD,CAAC,CAAC","sourcesContent":["import { bech32 } from 'bech32';\nimport type { Infer } from 'superstruct';\nimport { object, string, array, enums, literal, refine } from 'superstruct';\n\nimport { BaseAccount } from '../base-types';\n\nexport const BtcP2wpkhAddressStruct = refine(\n  string(),\n  'BtcP2wpkhAddressStruct',\n  (address: string) => {\n    try {\n      bech32.decode(address);\n    } catch (error) {\n      return new Error(\n        `Could not decode P2WPKH address: ${(error as Error).message}`,\n      );\n    }\n    return true;\n  },\n);\n\n/**\n * Supported Bitcoin methods.\n */\nexport enum BtcMethod {\n  // General transaction methods\n  SendMany = 'btc_sendmany',\n}\n\n/**\n * Supported Bitcoin account types.\n */\nexport enum BtcAccountType {\n  P2wpkh = 'bip122:p2wpkh',\n}\n\nexport const BtcP2wpkhAccountStruct = object({\n  ...BaseAccount,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${BtcAccountType.P2wpkh}`),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(enums([`${BtcMethod.SendMany}`])),\n});\n\nexport type BtcP2wpkhAccount = Infer<typeof BtcP2wpkhAccountStruct>;\n"]}

package/dist/eth/erc4337/types.d.ts

@@ -35,8 +35,8 @@ export declare type EthUserOperation = Infer<typeof EthUserOperationStruct>;
  */
 export declare const EthBaseTransactionStruct: import("superstruct").Struct<{
     value: string;
-    data: string;
     to: string;
+    data: string;
 }, {
     /**
      * Address of the transaction recipient.

package/dist/eth/index.d.ts

@@ -1,2 +1,3 @@
 export * from './erc4337';
 export * from './types';
+export * from './utils';

package/dist/eth/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./erc4337"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/eth/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB","sourcesContent":["export * from './erc4337';\nexport * from './types';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/eth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB","sourcesContent":["export * from './erc4337';\nexport * from './types';\nexport * from './utils';\n"]}