@metamask/keyring-api 21.6.0 → 22.0.0

package/dist/eth/v2/eth-keyring-wrapper.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"eth-keyring-wrapper.mjs","sourceRoot":"","sources":["../../../src/eth/v2/eth-keyring-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAoB,uBAAuB;AAEtE,OAAO,EAAE,oBAAoB,EAAE,+BAA+B;AAE9D,OAAO,EAAE,MAAM,EAAE,8BAA8B;AAC/C,OAAO,EAAE,KAAK,EAAuB,wBAAwB;AAI7D,OAAO,EACL,cAAc,EAEf,iDAA6C;AAC9C,OAAO,EACL,sBAAsB,EACtB,+BAA+B,EAC/B,qCAAqC,EACrC,2BAA2B,EAC3B,uCAAuC,EACvC,mBAAmB,EACnB,8BAA8B,EAC9B,4BAA4B,EAC5B,8BAA8B,EAC/B,yBAAe;AAChB,OAAO,EAAE,SAAS,EAAE,qBAAiB;AAErC;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,yEAAqD,CAAA;IACrD,6DAAyC,CAAA;IACzC,6EAAyD,CAAA;AAC3D,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B;AAQD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,iBAGpB,SAAQ,cAAgD;IACxD;;;;;;;OAOG;IACO,YAAY,CAAC,OAAe;QACpC,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CAAC,OAAuB;QACzC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;QAE3C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACpE,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE9C,yCAAyC;QACzC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,WAAW,OAAO,CAAC,OAAO,0BAA0B,MAAM,EAAE,CAC7D,CAAC;QACJ,CAAC;QAED,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;oBAChC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;gBAC9D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;gBACxB,yDAAyD;gBACzD,4DAA4D;gBAC5D,MAAM,EAAE,GAAG,kBAAkB,CAAC,UAAU,CAAC,MAAqB,CAAC,CAAC;gBAChE,uDAAuD;gBACvD,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CACtC,UAAU,EACV,EAAE,CACH,CAAoB,CAAC,CAAC,wCAAwC;YACjE,CAAC;YAED,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;gBAC1D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;gBACpC,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC;gBACxB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAClD,CAAC;YAED,KAAK,GAAG,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC;oBACpC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;gBAClE,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;gBAC5C,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;gBACtB,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAW,CAAC,CAAC;YACjE,CAAC;YAED,KAAK,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;gBAC5D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;gBAC/C,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC;gBACxB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,EAAE;oBAChD,OAAO,EAAE,oBAAoB,CAAC,EAAE;iBACjC,CAAC,CAAC;YACL,CAAC;YAED,KAAK,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;gBAC5D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;gBAC7C,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC;gBACxB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAC7B,UAAU;gBACV,2DAA2D;gBAC3D,IAAkC,EAClC;oBACE,OAAO,EAAE,oBAAoB,CAAC,EAAE;iBACjC,CACF,CAAC;YACJ,CAAC;YAED,KAAK,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;gBAC5D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;gBAC7C,MAAM,CAAC,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC;gBACxB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAC7B,UAAU;gBACV,2DAA2D;gBAC3D,IAAkC,EAClC;oBACE,OAAO,EAAE,oBAAoB,CAAC,EAAE;iBACjC,CACF,CAAC;YACJ,CAAC;YAED,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;oBAC/B,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;gBAC7D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;gBACvC,MAAM,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;gBAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YAC9D,CAAC;YAED,KAAK,GAAG,gBAAgB,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;gBAClD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC;oBACvC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;gBACrE,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,qCAAqC,CAAC,CAAC;gBACtD,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;gBAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAChE,CAAC;YAED,KAAK,GAAG,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;gBAC5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;oBACjC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;gBAC/D,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;gBAChD,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;gBACxB,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YACzD,CAAC;YAED,KAAK,GAAG,gBAAgB,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAC;gBACpD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,EAAE,CAAC;oBACzC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;gBACvE,CAAC;gBACD,MAAM,CAAC,MAAM,EAAE,uCAAuC,CAAC,CAAC;gBACxD,MAAM,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;gBAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YACxE,CAAC;YAED;gBACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,MAAM,EAAE,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;CACF","sourcesContent":["import { TransactionFactory, type TypedTxData } from '@ethereumjs/tx';\nimport type { MessageTypes, TypedMessage } from '@metamask/eth-sig-util';\nimport { SignTypedDataVersion } from '@metamask/eth-sig-util';\nimport type { EthKeyring } from '@metamask/keyring-utils';\nimport { assert } from '@metamask/superstruct';\nimport { add0x, type Hex, type Json } from '@metamask/utils';\n\nimport type { KeyringAccount } from '../../api/account';\nimport type { KeyringRequest } from '../../api/request';\nimport {\n  KeyringWrapper,\n  type KeyringWrapperOptions,\n} from '../../api/v2/wrapper/keyring-wrapper';\nimport {\n  EthDecryptParamsStruct,\n  EthGetAppKeyAddressParamsStruct,\n  EthGetEncryptionPublicKeyParamsStruct,\n  EthPersonalSignParamsStruct,\n  EthSignEip7702AuthorizationParamsStruct,\n  EthSignParamsStruct,\n  EthSignTransactionParamsStruct,\n  EthSignTypedDataParamsStruct,\n  EthSignTypedDataV1ParamsStruct,\n} from '../rpc';\nimport { EthMethod } from '../types';\n\n/**\n * Additional Ethereum methods supported by Eth keyrings that are not in the standard EthMethod enum.\n * These are primarily encryption and utility methods.\n */\nexport enum EthKeyringMethod {\n  Decrypt = 'eth_decrypt',\n  GetEncryptionPublicKey = 'eth_getEncryptionPublicKey',\n  GetAppKeyAddress = 'eth_getAppKeyAddress',\n  SignEip7702Authorization = 'eth_signEip7702Authorization',\n}\n\n/**\n * Options for constructing an EthKeyringWrapper.\n */\nexport type EthKeyringWrapperOptions<InnerKeyring extends EthKeyring> =\n  KeyringWrapperOptions<InnerKeyring>;\n\n/**\n * Abstract wrapper for Ethereum-based keyrings that extends KeyringWrapper, that itself implements KeyringV2.\n *\n * This class provides common functionality for all Ethereum keyrings including:\n * - Request handling for standard Ethereum signing methods\n * - Helper methods for Hex address conversion\n *\n * Subclasses must implement:\n * - `getAccounts()`: Return all managed accounts\n * - `createAccounts()`: Create new accounts based on options\n * - `deleteAccount()`: Remove an account from the keyring\n * - `exportAccount()` (optional): Export private key in specified format\n */\nexport abstract class EthKeyringWrapper<\n  InnerKeyring extends EthKeyring,\n  KeyringAccountType extends KeyringAccount = KeyringAccount,\n> extends KeyringWrapper<InnerKeyring, KeyringAccountType> {\n  /**\n   * Helper method to safely cast a KeyringAccount address to Hex type.\n   * The KeyringAccount.address is typed as string, but for Ethereum accounts\n   * it should always be a valid Hex address.\n   *\n   * @param address - The address from a KeyringAccount.\n   * @returns The address as Hex type.\n   */\n  protected toHexAddress(address: string): Hex {\n    return add0x(address);\n  }\n\n  /**\n   * Handle an Ethereum signing request.\n   *\n   * Routes the request to the appropriate legacy keyring method based on\n   * the RPC method name.\n   *\n   * @param request - The keyring request containing method and params.\n   * @returns The result of the signing operation.\n   */\n  async submitRequest(request: KeyringRequest): Promise<Json> {\n    const { method, params } = request.request;\n\n    const { address, methods } = await this.getAccount(request.account);\n    const hexAddress = this.toHexAddress(address);\n\n    // Validate account can handle the method\n    if (!methods.includes(method)) {\n      throw new Error(\n        `Account ${request.account} cannot handle method: ${method}`,\n      );\n    }\n\n    switch (method) {\n      case `${EthMethod.SignTransaction}`: {\n        if (!this.inner.signTransaction) {\n          throw new Error('Keyring does not support signTransaction');\n        }\n        assert(params, EthSignTransactionParamsStruct);\n        const [txData] = params;\n        // Convert validated transaction data to TypedTransaction\n        // TODO: Improve typing to ensure txData matches TypedTxData\n        const tx = TransactionFactory.fromTxData(txData as TypedTxData);\n        // Note: Bigints are not directly representable in JSON\n        return (await this.inner.signTransaction(\n          hexAddress,\n          tx,\n        )) as unknown as Json; // FIXME: Should return type be unknown?\n      }\n\n      case `${EthMethod.Sign}`: {\n        if (!this.inner.signMessage) {\n          throw new Error('Keyring does not support signMessage');\n        }\n        assert(params, EthSignParamsStruct);\n        const [, data] = params;\n        return this.inner.signMessage(hexAddress, data);\n      }\n\n      case `${EthMethod.PersonalSign}`: {\n        if (!this.inner.signPersonalMessage) {\n          throw new Error('Keyring does not support signPersonalMessage');\n        }\n        assert(params, EthPersonalSignParamsStruct);\n        const [data] = params;\n        return this.inner.signPersonalMessage(hexAddress, data as Hex);\n      }\n\n      case `${EthMethod.SignTypedDataV1}`: {\n        if (!this.inner.signTypedData) {\n          throw new Error('Keyring does not support signTypedData');\n        }\n        assert(params, EthSignTypedDataV1ParamsStruct);\n        const [, data] = params;\n        return this.inner.signTypedData(hexAddress, data, {\n          version: SignTypedDataVersion.V1,\n        });\n      }\n\n      case `${EthMethod.SignTypedDataV3}`: {\n        if (!this.inner.signTypedData) {\n          throw new Error('Keyring does not support signTypedData');\n        }\n        assert(params, EthSignTypedDataParamsStruct);\n        const [, data] = params;\n        return this.inner.signTypedData(\n          hexAddress,\n          // TODO: Improve typing to ensure data matches MessageTypes\n          data as TypedMessage<MessageTypes>,\n          {\n            version: SignTypedDataVersion.V3,\n          },\n        );\n      }\n\n      case `${EthMethod.SignTypedDataV4}`: {\n        if (!this.inner.signTypedData) {\n          throw new Error('Keyring does not support signTypedData');\n        }\n        assert(params, EthSignTypedDataParamsStruct);\n        const [, data] = params;\n        return this.inner.signTypedData(\n          hexAddress,\n          // TODO: Improve typing to ensure data matches MessageTypes\n          data as TypedMessage<MessageTypes>,\n          {\n            version: SignTypedDataVersion.V4,\n          },\n        );\n      }\n\n      case `${EthKeyringMethod.Decrypt}`: {\n        if (!this.inner.decryptMessage) {\n          throw new Error('Keyring does not support decryptMessage');\n        }\n        assert(params, EthDecryptParamsStruct);\n        const [encryptedData] = params;\n        return this.inner.decryptMessage(hexAddress, encryptedData);\n      }\n\n      case `${EthKeyringMethod.GetEncryptionPublicKey}`: {\n        if (!this.inner.getEncryptionPublicKey) {\n          throw new Error('Keyring does not support getEncryptionPublicKey');\n        }\n        assert(params, EthGetEncryptionPublicKeyParamsStruct);\n        const [, options] = params;\n        return this.inner.getEncryptionPublicKey(hexAddress, options);\n      }\n\n      case `${EthKeyringMethod.GetAppKeyAddress}`: {\n        if (!this.inner.getAppKeyAddress) {\n          throw new Error('Keyring does not support getAppKeyAddress');\n        }\n        assert(params, EthGetAppKeyAddressParamsStruct);\n        const [origin] = params;\n        return this.inner.getAppKeyAddress(hexAddress, origin);\n      }\n\n      case `${EthKeyringMethod.SignEip7702Authorization}`: {\n        if (!this.inner.signEip7702Authorization) {\n          throw new Error('Keyring does not support signEip7702Authorization');\n        }\n        assert(params, EthSignEip7702AuthorizationParamsStruct);\n        const [authorization] = params;\n        return this.inner.signEip7702Authorization(hexAddress, authorization);\n      }\n\n      default:\n        throw new Error(`Unsupported method for EthKeyringWrapper: ${method}`);\n    }\n  }\n}\n"]}

package/dist/eth/v2/index.cjs

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/eth/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAAsC","sourcesContent":["export * from './eth-keyring-wrapper';\n"]}

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

@@ -1,2 +0,0 @@
-export * from "./eth-keyring-wrapper.cjs";
-//# sourceMappingURL=index.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/eth/v2/index.ts"],"names":[],"mappings":"AAAA,0CAAsC"}

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

@@ -1,2 +0,0 @@
-export * from "./eth-keyring-wrapper.mjs";
-//# sourceMappingURL=index.d.mts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/eth/v2/index.ts"],"names":[],"mappings":"AAAA,0CAAsC"}

package/dist/eth/v2/index.mjs

@@ -1,2 +0,0 @@
-export * from "./eth-keyring-wrapper.mjs";
-//# sourceMappingURL=index.mjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/eth/v2/index.ts"],"names":[],"mappings":"AAAA,0CAAsC","sourcesContent":["export * from './eth-keyring-wrapper';\n"]}