@metamask-previews/keyring-api 21.1.0-8202c83 → 21.3.0-2d9d5c0

package/dist/eth/rpc/params.mjs

@@ -0,0 +1,148 @@
+/**
+ * Superstruct validation schemas for Ethereum JSON-RPC method parameters.
+ *
+ * These structs provide runtime validation for the parameters passed to various
+ * Ethereum RPC methods. They can be used by keyring implementations to validate
+ * incoming requests before processing.
+ */
+import { object } from "@metamask/keyring-utils";
+import { any, array, literal, nullable, number, optional, record, string, tuple, type, union, unknown } from "@metamask/superstruct";
+import { EthAddressStruct, EthBytesStruct } from "../types.mjs";
+/**
+ * A struct for validating Ethereum transaction data.
+ *
+ * This uses `type()` instead of `object()` to allow extra properties,
+ * since transaction formats can vary and include additional fields.
+ * The actual transaction validation is performed by the transaction library.
+ */
+export const EthTransactionDataStruct = type({
+    to: optional(nullable(EthAddressStruct)),
+    from: optional(EthAddressStruct),
+    nonce: optional(union([string(), number()])),
+    value: optional(union([string(), number()])),
+    data: optional(EthBytesStruct),
+    gas: optional(union([string(), number()])),
+    gasLimit: optional(union([string(), number()])),
+    gasPrice: optional(union([string(), number()])),
+    maxFeePerGas: optional(union([string(), number()])),
+    maxPriorityFeePerGas: optional(union([string(), number()])),
+    accessList: optional(array(type({
+        address: EthAddressStruct,
+        storageKeys: array(string()),
+    }))),
+    type: optional(union([string(), number()])),
+    chainId: optional(union([string(), number()])),
+});
+/**
+ * A struct for TypedDataV1 format (legacy typed data).
+ * This is an array of { type, name, value } objects.
+ */
+export const EthTypedDataV1Struct = array(object({
+    type: string(),
+    name: string(),
+    value: unknown(),
+}));
+/**
+ * A struct for TypedData types definition.
+ * Maps type names to arrays of { name, type } definitions.
+ */
+export const EthTypedDataTypesStruct = record(string(), array(object({
+    name: string(),
+    type: string(),
+})));
+/**
+ * A struct for TypedMessage format (EIP-712 V3/V4).
+ * Contains types, domain, primaryType, and message.
+ */
+export const EthTypedMessageStruct = object({
+    types: EthTypedDataTypesStruct,
+    primaryType: string(),
+    domain: record(string(), any()),
+    message: record(string(), any()),
+});
+/**
+ * A struct for EIP-1024 encrypted data format (x25519-xsalsa20-poly1305).
+ */
+export const EthEncryptedDataStruct = object({
+    version: literal('x25519-xsalsa20-poly1305'),
+    nonce: string(),
+    ephemPublicKey: string(),
+    ciphertext: string(),
+});
+/**
+ * A struct for EIP-7702 authorization tuple.
+ * Format: [chainId, address, nonce]
+ */
+export const EthEip7702AuthorizationStruct = tuple([
+    number(), // chainId
+    EthAddressStruct, // address (contract to delegate to)
+    number(), // nonce
+]);
+/**
+ * A struct for getEncryptionPublicKey options.
+ */
+export const EthGetEncryptionPublicKeyOptionsStruct = record(string(), unknown());
+// ============================================================================
+// RPC Method Parameter Structs
+// ============================================================================
+/**
+ * Parameters for `eth_signTransaction`.
+ */
+export const EthSignTransactionParamsStruct = tuple([EthTransactionDataStruct]);
+/**
+ * Parameters for `eth_sign`.
+ */
+export const EthSignParamsStruct = tuple([
+    EthAddressStruct, // address
+    EthBytesStruct, // data (hex-encoded message hash)
+]);
+/**
+ * Parameters for `personal_sign`.
+ */
+export const EthPersonalSignParamsStruct = union([
+    tuple([EthBytesStruct]), // [data]
+    tuple([EthBytesStruct, EthAddressStruct]), // [data, address]
+]);
+/**
+ * Parameters for `eth_signTypedData_v1`.
+ */
+export const EthSignTypedDataV1ParamsStruct = tuple([
+    EthAddressStruct, // address
+    EthTypedDataV1Struct, // typed data array
+]);
+/**
+ * Parameters for `eth_signTypedData_v3` and `eth_signTypedData_v4`.
+ */
+export const EthSignTypedDataParamsStruct = tuple([
+    EthAddressStruct, // address
+    EthTypedMessageStruct, // typed data object
+]);
+/**
+ * Parameters for `eth_decrypt`.
+ */
+export const EthDecryptParamsStruct = tuple([EthEncryptedDataStruct]);
+/**
+ * Parameters for `eth_getAppKeyAddress`.
+ */
+export const EthGetAppKeyAddressParamsStruct = tuple([
+    string(), // origin URL
+]);
+/**
+ * Parameters for `eth_signEip7702Authorization`.
+ *
+ * @example
+ * ```ts
+ * const params = [[1, '0xContractAddress', 0]];
+ * ```
+ */
+export const EthSignEip7702AuthorizationParamsStruct = tuple([
+    EthEip7702AuthorizationStruct,
+]);
+/**
+ * Parameters for `eth_getEncryptionPublicKey`.
+ */
+export const EthGetEncryptionPublicKeyParamsStruct = tuple([
+    EthAddressStruct, // address
+    optional(EthGetEncryptionPublicKeyOptionsStruct), // options
+]);
+//# sourceMappingURL=params.mjs.map

package/dist/eth/rpc/params.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.mjs","sourceRoot":"","sources":["../../../src/eth/rpc/params.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,MAAM,EAAE,gCAAgC;AAEjD,OAAO,EACL,GAAG,EACH,KAAK,EACL,OAAO,EACP,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,MAAM,EACN,MAAM,EACN,KAAK,EACL,IAAI,EACJ,KAAK,EACL,OAAO,EACR,8BAA8B;AAE/B,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,qBAAiB;AAE5D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,CAAC;IAC3C,EAAE,EAAE,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACxC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,CAAC;IAChC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5C,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC9B,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC1C,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/C,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/C,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACnD,oBAAoB,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,UAAU,EAAE,QAAQ,CAClB,KAAK,CACH,IAAI,CAAC;QACH,OAAO,EAAE,gBAAgB;QACzB,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;KAC7B,CAAC,CACH,CACF;IACD,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3C,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC/C,CAAC,CAAC;AAIH;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CACvC,MAAM,CAAC;IACL,IAAI,EAAE,MAAM,EAAE;IACd,IAAI,EAAE,MAAM,EAAE;IACd,KAAK,EAAE,OAAO,EAAE;CACjB,CAAC,CACH,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAC3C,MAAM,EAAE,EACR,KAAK,CACH,MAAM,CAAC;IACL,IAAI,EAAE,MAAM,EAAE;IACd,IAAI,EAAE,MAAM,EAAE;CACf,CAAC,CACH,CACF,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC;IAC1C,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,MAAM,EAAE;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC;CACjC,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;IAC3C,OAAO,EAAE,OAAO,CAAC,0BAA0B,CAAC;IAC5C,KAAK,EAAE,MAAM,EAAE;IACf,cAAc,EAAE,MAAM,EAAE;IACxB,UAAU,EAAE,MAAM,EAAE;CACrB,CAAC,CAAC;AAIH;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,CAAC;IACjD,MAAM,EAAE,EAAE,UAAU;IACpB,gBAAgB,EAAE,oCAAoC;IACtD,MAAM,EAAE,EAAE,QAAQ;CACnB,CAAC,CAAC;AAMH;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,MAAM,CAC1D,MAAM,EAAE,EACR,OAAO,EAAE,CACV,CAAC;AAEF,+EAA+E;AAC/E,+BAA+B;AAC/B,+EAA+E;AAE/E;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,KAAK,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC;AAMhF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,CAAC;IACvC,gBAAgB,EAAE,UAAU;IAC5B,cAAc,EAAE,kCAAkC;CACnD,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAK,CAAC;IAC/C,KAAK,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,SAAS;IAClC,KAAK,CAAC,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC,EAAE,kBAAkB;CAC9D,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,KAAK,CAAC;IAClD,gBAAgB,EAAE,UAAU;IAC5B,oBAAoB,EAAE,mBAAmB;CAC1C,CAAC,CAAC;AAMH;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,CAAC;IAChD,gBAAgB,EAAE,UAAU;IAC5B,qBAAqB,EAAE,oBAAoB;CAC5C,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC;AAItE;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,KAAK,CAAC;IACnD,MAAM,EAAE,EAAE,aAAa;CACxB,CAAC,CAAC;AAMH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,KAAK,CAAC;IAC3D,6BAA6B;CAC9B,CAAC,CAAC;AAMH;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,KAAK,CAAC;IACzD,gBAAgB,EAAE,UAAU;IAC5B,QAAQ,CAAC,sCAAsC,CAAC,EAAE,UAAU;CAC7D,CAAC,CAAC","sourcesContent":["/**\n * Superstruct validation schemas for Ethereum JSON-RPC method parameters.\n *\n * These structs provide runtime validation for the parameters passed to various\n * Ethereum RPC methods. They can be used by keyring implementations to validate\n * incoming requests before processing.\n */\n\nimport { object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport {\n  any,\n  array,\n  literal,\n  nullable,\n  number,\n  optional,\n  record,\n  string,\n  tuple,\n  type,\n  union,\n  unknown,\n} from '@metamask/superstruct';\n\nimport { EthAddressStruct, EthBytesStruct } from '../types';\n\n/**\n * A struct for validating Ethereum transaction data.\n *\n * This uses `type()` instead of `object()` to allow extra properties,\n * since transaction formats can vary and include additional fields.\n * The actual transaction validation is performed by the transaction library.\n */\nexport const EthTransactionDataStruct = type({\n  to: optional(nullable(EthAddressStruct)),\n  from: optional(EthAddressStruct),\n  nonce: optional(union([string(), number()])),\n  value: optional(union([string(), number()])),\n  data: optional(EthBytesStruct),\n  gas: optional(union([string(), number()])),\n  gasLimit: optional(union([string(), number()])),\n  gasPrice: optional(union([string(), number()])),\n  maxFeePerGas: optional(union([string(), number()])),\n  maxPriorityFeePerGas: optional(union([string(), number()])),\n  accessList: optional(\n    array(\n      type({\n        address: EthAddressStruct,\n        storageKeys: array(string()),\n      }),\n    ),\n  ),\n  type: optional(union([string(), number()])),\n  chainId: optional(union([string(), number()])),\n});\n\nexport type EthTransactionData = Infer<typeof EthTransactionDataStruct>;\n\n/**\n * A struct for TypedDataV1 format (legacy typed data).\n * This is an array of { type, name, value } objects.\n */\nexport const EthTypedDataV1Struct = array(\n  object({\n    type: string(),\n    name: string(),\n    value: unknown(),\n  }),\n);\n\nexport type EthTypedDataV1 = Infer<typeof EthTypedDataV1Struct>;\n\n/**\n * A struct for TypedData types definition.\n * Maps type names to arrays of { name, type } definitions.\n */\nexport const EthTypedDataTypesStruct = record(\n  string(),\n  array(\n    object({\n      name: string(),\n      type: string(),\n    }),\n  ),\n);\n\nexport type EthTypedDataTypes = Infer<typeof EthTypedDataTypesStruct>;\n\n/**\n * A struct for TypedMessage format (EIP-712 V3/V4).\n * Contains types, domain, primaryType, and message.\n */\nexport const EthTypedMessageStruct = object({\n  types: EthTypedDataTypesStruct,\n  primaryType: string(),\n  domain: record(string(), any()),\n  message: record(string(), any()),\n});\n\nexport type EthTypedMessage = Infer<typeof EthTypedMessageStruct>;\n\n/**\n * A struct for EIP-1024 encrypted data format (x25519-xsalsa20-poly1305).\n */\nexport const EthEncryptedDataStruct = object({\n  version: literal('x25519-xsalsa20-poly1305'),\n  nonce: string(),\n  ephemPublicKey: string(),\n  ciphertext: string(),\n});\n\nexport type EthEncryptedData = Infer<typeof EthEncryptedDataStruct>;\n\n/**\n * A struct for EIP-7702 authorization tuple.\n * Format: [chainId, address, nonce]\n */\nexport const EthEip7702AuthorizationStruct = tuple([\n  number(), // chainId\n  EthAddressStruct, // address (contract to delegate to)\n  number(), // nonce\n]);\n\nexport type EthEip7702Authorization = Infer<\n  typeof EthEip7702AuthorizationStruct\n>;\n\n/**\n * A struct for getEncryptionPublicKey options.\n */\nexport const EthGetEncryptionPublicKeyOptionsStruct = record(\n  string(),\n  unknown(),\n);\n\n// ============================================================================\n// RPC Method Parameter Structs\n// ============================================================================\n\n/**\n * Parameters for `eth_signTransaction`.\n */\nexport const EthSignTransactionParamsStruct = tuple([EthTransactionDataStruct]);\n\nexport type EthSignTransactionParams = Infer<\n  typeof EthSignTransactionParamsStruct\n>;\n\n/**\n * Parameters for `eth_sign`.\n */\nexport const EthSignParamsStruct = tuple([\n  EthAddressStruct, // address\n  EthBytesStruct, // data (hex-encoded message hash)\n]);\n\nexport type EthSignParams = Infer<typeof EthSignParamsStruct>;\n\n/**\n * Parameters for `personal_sign`.\n */\nexport const EthPersonalSignParamsStruct = union([\n  tuple([EthBytesStruct]), // [data]\n  tuple([EthBytesStruct, EthAddressStruct]), // [data, address]\n]);\n\nexport type EthPersonalSignParams = Infer<typeof EthPersonalSignParamsStruct>;\n\n/**\n * Parameters for `eth_signTypedData_v1`.\n */\nexport const EthSignTypedDataV1ParamsStruct = tuple([\n  EthAddressStruct, // address\n  EthTypedDataV1Struct, // typed data array\n]);\n\nexport type EthSignTypedDataV1Params = Infer<\n  typeof EthSignTypedDataV1ParamsStruct\n>;\n\n/**\n * Parameters for `eth_signTypedData_v3` and `eth_signTypedData_v4`.\n */\nexport const EthSignTypedDataParamsStruct = tuple([\n  EthAddressStruct, // address\n  EthTypedMessageStruct, // typed data object\n]);\n\nexport type EthSignTypedDataParams = Infer<typeof EthSignTypedDataParamsStruct>;\n\n/**\n * Parameters for `eth_decrypt`.\n */\nexport const EthDecryptParamsStruct = tuple([EthEncryptedDataStruct]);\n\nexport type EthDecryptParams = Infer<typeof EthDecryptParamsStruct>;\n\n/**\n * Parameters for `eth_getAppKeyAddress`.\n */\nexport const EthGetAppKeyAddressParamsStruct = tuple([\n  string(), // origin URL\n]);\n\nexport type EthGetAppKeyAddressParams = Infer<\n  typeof EthGetAppKeyAddressParamsStruct\n>;\n\n/**\n * Parameters for `eth_signEip7702Authorization`.\n *\n * @example\n * ```ts\n * const params = [[1, '0xContractAddress', 0]];\n * ```\n */\nexport const EthSignEip7702AuthorizationParamsStruct = tuple([\n  EthEip7702AuthorizationStruct,\n]);\n\nexport type EthSignEip7702AuthorizationParams = Infer<\n  typeof EthSignEip7702AuthorizationParamsStruct\n>;\n\n/**\n * Parameters for `eth_getEncryptionPublicKey`.\n */\nexport const EthGetEncryptionPublicKeyParamsStruct = tuple([\n  EthAddressStruct, // address\n  optional(EthGetEncryptionPublicKeyOptionsStruct), // options\n]);\n"]}

package/dist/eth/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":";;;AAAA,2DAAiD;AAEjD,uDAAwE;AACxE,2CAAgD;AAEhD,kCAA6B;AAC7B,0CAIgB;AAEH,QAAA,cAAc,GAAG,IAAA,qBAAa,EAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE9D,QAAA,gBAAgB,GAAG,IAAA,qBAAa,EAC3C,YAAY,EACZ,oBAAoB,CACrB,CAAC;AAEW,QAAA,gBAAgB,GAAG,IAAA,qBAAa,EAC3C,YAAY,EACZ,6BAA6B,CAC9B,CAAC;AAEF;;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,yBAAT,SAAS,QAYpB;AAEY,QAAA,mBAAmB,GAAG,IAAA,sBAAM,EAAC;IACxC,GAAG,0BAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,IAAA,qBAAO,EAAC,WAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAE9C;;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;KAC/B,CAAC,CACH;CACF,CAAC,CAAC;AAIU,QAAA,uBAAuB,GAAG,IAAA,sBAAM,EAAC;IAC5C,GAAG,0BAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,uBAAiB,CAAC,CAAC;IAE1C;;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,oBAAoB,EAAE;QACnC,GAAG,SAAS,CAAC,kBAAkB,EAAE;QACjC,GAAG,SAAS,CAAC,iBAAiB,EAAE;KACjC,CAAC,CACH;CACF,CAAC,CAAC","sourcesContent":["import { object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { nonempty, array, enums, literal } from '@metamask/superstruct';\nimport { definePattern } from '@metamask/utils';\n\nimport { EthScope } from '.';\nimport {\n  CaipChainIdStruct,\n  EthAccountType,\n  KeyringAccountStruct,\n} from '../api';\n\nexport const EthBytesStruct = definePattern('EthBytes', /^0x[0-9a-f]*$/iu);\n\nexport const EthAddressStruct = definePattern(\n  'EthAddress',\n  /^0x[0-9a-f]{40}$/iu,\n);\n\nexport const EthUint256Struct = definePattern(\n  'EthUint256',\n  /^0x([1-9a-f][0-9a-f]*|0)$/iu,\n);\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\nexport const EthEoaAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Eoa}`),\n\n  /**\n   * Account scopes (must be ['eip155:0']).\n   */\n  scopes: nonempty(array(literal(EthScope.Eoa))),\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    ]),\n  ),\n});\n\nexport type EthEoaAccount = Infer<typeof EthEoaAccountStruct>;\n\nexport const EthErc4337AccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Erc4337}`),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n      `${EthMethod.PrepareUserOperation}`,\n      `${EthMethod.PatchUserOperation}`,\n      `${EthMethod.SignUserOperation}`,\n    ]),\n  ),\n});\n\nexport type EthErc4337Account = Infer<typeof EthErc4337AccountStruct>;\n"]}
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":";;;AAAA,2DAAiD;AAEjD,uDAAwE;AACxE,2CAA0D;AAE1D,kCAA6B;AAC7B,0CAIgB;AAEH,QAAA,cAAc,GAAG,IAAA,qBAAa,EAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE9D,QAAA,gBAAgB,GAAG,IAAA,qBAAa,EAC3C,YAAY,EACZ,oBAAoB,CACrB,CAAC;AAEW,QAAA,gBAAgB,GAAG,IAAA,qBAAa,EAC3C,YAAY,EACZ,6BAA6B,CAC9B,CAAC;AAEF;;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,yBAAT,SAAS,QAYpB;AAEY,QAAA,mBAAmB,GAAG,IAAA,sBAAM,EAAC;IACxC,GAAG,0BAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,oBAAc,CAAC,GAAG,EAAE,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,IAAA,qBAAO,EAAC,WAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAE9C;;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;KAC/B,CAAC,CACH;CACF,CAAC,CAAC;AAIU,QAAA,uBAAuB,GAAG,IAAA,sBAAM,EAAC;IAC5C,GAAG,0BAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,oBAAc,CAAC,OAAO,EAAE,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,uBAAiB,CAAC,CAAC;IAE1C;;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,oBAAoB,EAAE;QACnC,GAAG,SAAS,CAAC,kBAAkB,EAAE;QACjC,GAAG,SAAS,CAAC,iBAAiB,EAAE;KACjC,CAAC,CACH;CACF,CAAC,CAAC","sourcesContent":["import { object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { nonempty, array, enums, literal } from '@metamask/superstruct';\nimport { definePattern, type Hex } from '@metamask/utils';\n\nimport { EthScope } from '.';\nimport {\n  CaipChainIdStruct,\n  EthAccountType,\n  KeyringAccountStruct,\n} from '../api';\n\nexport const EthBytesStruct = definePattern('EthBytes', /^0x[0-9a-f]*$/iu);\n\nexport const EthAddressStruct = definePattern<Hex>(\n  'EthAddress',\n  /^0x[0-9a-f]{40}$/iu,\n);\n\nexport const EthUint256Struct = definePattern(\n  'EthUint256',\n  /^0x([1-9a-f][0-9a-f]*|0)$/iu,\n);\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\nexport const EthEoaAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Eoa}`),\n\n  /**\n   * Account scopes (must be ['eip155:0']).\n   */\n  scopes: nonempty(array(literal(EthScope.Eoa))),\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    ]),\n  ),\n});\n\nexport type EthEoaAccount = Infer<typeof EthEoaAccountStruct>;\n\nexport const EthErc4337AccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Erc4337}`),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n      `${EthMethod.PrepareUserOperation}`,\n      `${EthMethod.PatchUserOperation}`,\n      `${EthMethod.SignUserOperation}`,\n    ]),\n  ),\n});\n\nexport type EthErc4337Account = Infer<typeof EthErc4337AccountStruct>;\n"]}

package/dist/eth/types.d.cts

@@ -1,7 +1,7 @@
 import type { Infer } from "@metamask/superstruct";
 import { EthScope } from "./index.cjs";
 export declare const EthBytesStruct: import("@metamask/superstruct").Struct<string, null>;
-export declare const EthAddressStruct: import("@metamask/superstruct").Struct<string, null>;
+export declare const EthAddressStruct: import("@metamask/superstruct").Struct<`0x${string}`, null>;
 export declare const EthUint256Struct: import("@metamask/superstruct").Struct<string, null>;
 /**
  * Supported Ethereum methods.
@@ -28,17 +28,19 @@ export declare const EthEoaAccountStruct: import("@metamask/superstruct").Struct
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     };
-    address: string;
+    address: `0x${string}`;
     scopes: EthScope.Eoa[];
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
 }, {
     /**
      * Account address.
      */
-    address: import("@metamask/superstruct").Struct<string, null>;
+    address: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * Account type.
      */
@@ -67,6 +69,8 @@ export declare const EthEoaAccountStruct: import("@metamask/superstruct").Struct
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     }, null>;
@@ -83,17 +87,19 @@ export declare const EthErc4337AccountStruct: import("@metamask/superstruct").St
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     };
-    address: string;
+    address: `0x${string}`;
     scopes: `${string}:${string}`[];
     methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
 }, {
     /**
      * Account address.
      */
-    address: import("@metamask/superstruct").Struct<string, null>;
+    address: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * Account type.
      */
@@ -124,6 +130,8 @@ export declare const EthErc4337AccountStruct: import("@metamask/superstruct").St
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     }, null>;

package/dist/eth/types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,EAAE,QAAQ,EAAE,oBAAU;AAO7B,eAAO,MAAM,cAAc,sDAA+C,CAAC;AAE3E,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS;IAEnB,YAAY,kBAAkB;IAC9B,IAAI,aAAa;IACjB,eAAe,wBAAwB;IACvC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IAExC,oBAAoB,6BAA6B;IACjD,kBAAkB,2BAA2B;IAC7C,iBAAiB,0BAA0B;CAC5C;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;IAG9B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;EAWH,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE9D,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;IAGlC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;EAaH,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,EAAE,QAAQ,EAAE,oBAAU;AAO7B,eAAO,MAAM,cAAc,sDAA+C,CAAC;AAE3E,eAAO,MAAM,gBAAgB,6DAG5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS;IAEnB,YAAY,kBAAkB;IAC9B,IAAI,aAAa;IACjB,eAAe,wBAAwB;IACvC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IAExC,oBAAoB,6BAA6B;IACjD,kBAAkB,2BAA2B;IAC7C,iBAAiB,0BAA0B;CAC5C;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;IAG9B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;EAWH,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE9D,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;IAGlC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;EAaH,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/eth/types.d.mts

@@ -1,7 +1,7 @@
 import type { Infer } from "@metamask/superstruct";
 import { EthScope } from "./index.mjs";
 export declare const EthBytesStruct: import("@metamask/superstruct").Struct<string, null>;
-export declare const EthAddressStruct: import("@metamask/superstruct").Struct<string, null>;
+export declare const EthAddressStruct: import("@metamask/superstruct").Struct<`0x${string}`, null>;
 export declare const EthUint256Struct: import("@metamask/superstruct").Struct<string, null>;
 /**
  * Supported Ethereum methods.
@@ -28,17 +28,19 @@ export declare const EthEoaAccountStruct: import("@metamask/superstruct").Struct
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     };
-    address: string;
+    address: `0x${string}`;
     scopes: EthScope.Eoa[];
     methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
 }, {
     /**
      * Account address.
      */
-    address: import("@metamask/superstruct").Struct<string, null>;
+    address: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * Account type.
      */
@@ -67,6 +69,8 @@ export declare const EthEoaAccountStruct: import("@metamask/superstruct").Struct
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     }, null>;
@@ -83,17 +87,19 @@ export declare const EthErc4337AccountStruct: import("@metamask/superstruct").St
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     };
-    address: string;
+    address: `0x${string}`;
     scopes: `${string}:${string}`[];
     methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
 }, {
     /**
      * Account address.
      */
-    address: import("@metamask/superstruct").Struct<string, null>;
+    address: import("@metamask/superstruct").Struct<`0x${string}`, null>;
     /**
      * Account type.
      */
@@ -124,6 +130,8 @@ export declare const EthErc4337AccountStruct: import("@metamask/superstruct").St
             groupIndex: number;
         } | {
             type: "private-key";
+        } | {
+            type: "custom";
         };
         exportable?: boolean;
     }, null>;

package/dist/eth/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,EAAE,QAAQ,EAAE,oBAAU;AAO7B,eAAO,MAAM,cAAc,sDAA+C,CAAC;AAE3E,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS;IAEnB,YAAY,kBAAkB;IAC9B,IAAI,aAAa;IACjB,eAAe,wBAAwB;IACvC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IAExC,oBAAoB,6BAA6B;IACjD,kBAAkB,2BAA2B;IAC7C,iBAAiB,0BAA0B;CAC5C;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;IAG9B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;EAWH,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE9D,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;IAGlC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;EAaH,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,8BAA8B;AAInD,OAAO,EAAE,QAAQ,EAAE,oBAAU;AAO7B,eAAO,MAAM,cAAc,sDAA+C,CAAC;AAE3E,eAAO,MAAM,gBAAgB,6DAG5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,sDAG5B,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS;IAEnB,YAAY,kBAAkB;IAC9B,IAAI,aAAa;IACjB,eAAe,wBAAwB;IACvC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IACxC,eAAe,yBAAyB;IAExC,oBAAoB,6BAA6B;IACjD,kBAAkB,2BAA2B;IAC7C,iBAAiB,0BAA0B;CAC5C;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;IAG9B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;EAWH,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAE9D,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;IAGlC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;EAaH,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/eth/types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gCAAgC;AAEjD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,8BAA8B;AACxE,OAAO,EAAE,aAAa,EAAE,wBAAwB;AAEhD,OAAO,EAAE,QAAQ,EAAE,oBAAU;AAC7B,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACrB,yBAAe;AAEhB,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE3E,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAC3C,YAAY,EACZ,oBAAoB,CACrB,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAC3C,YAAY,EACZ,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAN,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,KAAT,SAAS,QAYpB;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC;IACxC,GAAG,oBAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAE9C;;OAEG;IACH,OAAO,EAAE,KAAK,CACZ,KAAK,CAAC;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;KAC/B,CAAC,CACH;CACF,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC;IAC5C,GAAG,oBAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,KAAK,CACZ,KAAK,CAAC;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,oBAAoB,EAAE;QACnC,GAAG,SAAS,CAAC,kBAAkB,EAAE;QACjC,GAAG,SAAS,CAAC,iBAAiB,EAAE;KACjC,CAAC,CACH;CACF,CAAC,CAAC","sourcesContent":["import { object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { nonempty, array, enums, literal } from '@metamask/superstruct';\nimport { definePattern } from '@metamask/utils';\n\nimport { EthScope } from '.';\nimport {\n  CaipChainIdStruct,\n  EthAccountType,\n  KeyringAccountStruct,\n} from '../api';\n\nexport const EthBytesStruct = definePattern('EthBytes', /^0x[0-9a-f]*$/iu);\n\nexport const EthAddressStruct = definePattern(\n  'EthAddress',\n  /^0x[0-9a-f]{40}$/iu,\n);\n\nexport const EthUint256Struct = definePattern(\n  'EthUint256',\n  /^0x([1-9a-f][0-9a-f]*|0)$/iu,\n);\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\nexport const EthEoaAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Eoa}`),\n\n  /**\n   * Account scopes (must be ['eip155:0']).\n   */\n  scopes: nonempty(array(literal(EthScope.Eoa))),\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    ]),\n  ),\n});\n\nexport type EthEoaAccount = Infer<typeof EthEoaAccountStruct>;\n\nexport const EthErc4337AccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Erc4337}`),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n      `${EthMethod.PrepareUserOperation}`,\n      `${EthMethod.PatchUserOperation}`,\n      `${EthMethod.SignUserOperation}`,\n    ]),\n  ),\n});\n\nexport type EthErc4337Account = Infer<typeof EthErc4337AccountStruct>;\n"]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gCAAgC;AAEjD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,8BAA8B;AACxE,OAAO,EAAE,aAAa,EAAY,wBAAwB;AAE1D,OAAO,EAAE,QAAQ,EAAE,oBAAU;AAC7B,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACrB,yBAAe;AAEhB,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE3E,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAC3C,YAAY,EACZ,oBAAoB,CACrB,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAC3C,YAAY,EACZ,6BAA6B,CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAN,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,KAAT,SAAS,QAYpB;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC;IACxC,GAAG,oBAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAE9C;;OAEG;IACH,OAAO,EAAE,KAAK,CACZ,KAAK,CAAC;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;KAC/B,CAAC,CACH;CACF,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC;IAC5C,GAAG,oBAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,gBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;IAE1C;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,OAAO,EAAE,KAAK,CACZ,KAAK,CAAC;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,oBAAoB,EAAE;QACnC,GAAG,SAAS,CAAC,kBAAkB,EAAE;QACjC,GAAG,SAAS,CAAC,iBAAiB,EAAE;KACjC,CAAC,CACH;CACF,CAAC,CAAC","sourcesContent":["import { object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { nonempty, array, enums, literal } from '@metamask/superstruct';\nimport { definePattern, type Hex } from '@metamask/utils';\n\nimport { EthScope } from '.';\nimport {\n  CaipChainIdStruct,\n  EthAccountType,\n  KeyringAccountStruct,\n} from '../api';\n\nexport const EthBytesStruct = definePattern('EthBytes', /^0x[0-9a-f]*$/iu);\n\nexport const EthAddressStruct = definePattern<Hex>(\n  'EthAddress',\n  /^0x[0-9a-f]{40}$/iu,\n);\n\nexport const EthUint256Struct = definePattern(\n  'EthUint256',\n  /^0x([1-9a-f][0-9a-f]*|0)$/iu,\n);\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\nexport const EthEoaAccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Eoa}`),\n\n  /**\n   * Account scopes (must be ['eip155:0']).\n   */\n  scopes: nonempty(array(literal(EthScope.Eoa))),\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    ]),\n  ),\n});\n\nexport type EthEoaAccount = Infer<typeof EthEoaAccountStruct>;\n\nexport const EthErc4337AccountStruct = object({\n  ...KeyringAccountStruct.schema,\n\n  /**\n   * Account address.\n   */\n  address: EthAddressStruct,\n\n  /**\n   * Account type.\n   */\n  type: literal(`${EthAccountType.Erc4337}`),\n\n  /**\n   * Account supported scopes (CAIP-2 chain IDs).\n   */\n  scopes: nonempty(array(CaipChainIdStruct)),\n\n  /**\n   * Account supported methods.\n   */\n  methods: array(\n    enums([\n      `${EthMethod.PersonalSign}`,\n      `${EthMethod.Sign}`,\n      `${EthMethod.SignTypedDataV1}`,\n      `${EthMethod.SignTypedDataV3}`,\n      `${EthMethod.SignTypedDataV4}`,\n      `${EthMethod.PrepareUserOperation}`,\n      `${EthMethod.PatchUserOperation}`,\n      `${EthMethod.SignUserOperation}`,\n    ]),\n  ),\n});\n\nexport type EthErc4337Account = Infer<typeof EthErc4337AccountStruct>;\n"]}

package/dist/eth/v2/eth-keyring-wrapper.cjs

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EthKeyringWrapper = exports.EthKeyringMethod = void 0;
+const tx_1 = require("@ethereumjs/tx");
+const eth_sig_util_1 = require("@metamask/eth-sig-util");
+const superstruct_1 = require("@metamask/superstruct");
+const utils_1 = require("@metamask/utils");
+const keyring_wrapper_1 = require("../../api/v2/wrapper/keyring-wrapper.cjs");
+const rpc_1 = require("../rpc/index.cjs");
+const types_1 = require("../types.cjs");
+/**
+ * Additional Ethereum methods supported by Eth keyrings that are not in the standard EthMethod enum.
+ * These are primarily encryption and utility methods.
+ */
+var EthKeyringMethod;
+(function (EthKeyringMethod) {
+    EthKeyringMethod["Decrypt"] = "eth_decrypt";
+    EthKeyringMethod["GetEncryptionPublicKey"] = "eth_getEncryptionPublicKey";
+    EthKeyringMethod["GetAppKeyAddress"] = "eth_getAppKeyAddress";
+    EthKeyringMethod["SignEip7702Authorization"] = "eth_signEip7702Authorization";
+})(EthKeyringMethod || (exports.EthKeyringMethod = EthKeyringMethod = {}));
+/**
+ * Abstract wrapper for Ethereum-based keyrings that extends KeyringWrapper, that itself implements KeyringV2.
+ *
+ * This class provides common functionality for all Ethereum keyrings including:
+ * - Request handling for standard Ethereum signing methods
+ * - Helper methods for Hex address conversion
+ *
+ * Subclasses must implement:
+ * - `getAccounts()`: Return all managed accounts
+ * - `createAccounts()`: Create new accounts based on options
+ * - `deleteAccount()`: Remove an account from the keyring
+ * - `exportAccount()` (optional): Export private key in specified format
+ */
+class EthKeyringWrapper extends keyring_wrapper_1.KeyringWrapper {
+    /**
+     * Helper method to safely cast a KeyringAccount address to Hex type.
+     * The KeyringAccount.address is typed as string, but for Ethereum accounts
+     * it should always be a valid Hex address.
+     *
+     * @param address - The address from a KeyringAccount.
+     * @returns The address as Hex type.
+     */
+    toHexAddress(address) {
+        return (0, utils_1.add0x)(address);
+    }
+    /**
+     * Handle an Ethereum signing request.
+     *
+     * Routes the request to the appropriate legacy keyring method based on
+     * the RPC method name.
+     *
+     * @param request - The keyring request containing method and params.
+     * @returns The result of the signing operation.
+     */
+    async submitRequest(request) {
+        const { method, params } = request.request;
+        const { address, methods } = await this.getAccount(request.account);
+        const hexAddress = this.toHexAddress(address);
+        // Validate account can handle the method
+        if (!methods.includes(method)) {
+            throw new Error(`Account ${request.account} cannot handle method: ${method}`);
+        }
+        switch (method) {
+            case `${types_1.EthMethod.SignTransaction}`: {
+                if (!this.inner.signTransaction) {
+                    throw new Error('Keyring does not support signTransaction');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthSignTransactionParamsStruct);
+                const [txData] = params;
+                // Convert validated transaction data to TypedTransaction
+                // TODO: Improve typing to ensure txData matches TypedTxData
+                const tx = tx_1.TransactionFactory.fromTxData(txData);
+                // Note: Bigints are not directly representable in JSON
+                return (await this.inner.signTransaction(hexAddress, tx)); // FIXME: Should return type be unknown?
+            }
+            case `${types_1.EthMethod.Sign}`: {
+                if (!this.inner.signMessage) {
+                    throw new Error('Keyring does not support signMessage');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthSignParamsStruct);
+                const [, data] = params;
+                return this.inner.signMessage(hexAddress, data);
+            }
+            case `${types_1.EthMethod.PersonalSign}`: {
+                if (!this.inner.signPersonalMessage) {
+                    throw new Error('Keyring does not support signPersonalMessage');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthPersonalSignParamsStruct);
+                const [data] = params;
+                return this.inner.signPersonalMessage(hexAddress, data);
+            }
+            case `${types_1.EthMethod.SignTypedDataV1}`: {
+                if (!this.inner.signTypedData) {
+                    throw new Error('Keyring does not support signTypedData');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthSignTypedDataV1ParamsStruct);
+                const [, data] = params;
+                return this.inner.signTypedData(hexAddress, data, {
+                    version: eth_sig_util_1.SignTypedDataVersion.V1,
+                });
+            }
+            case `${types_1.EthMethod.SignTypedDataV3}`: {
+                if (!this.inner.signTypedData) {
+                    throw new Error('Keyring does not support signTypedData');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthSignTypedDataParamsStruct);
+                const [, data] = params;
+                return this.inner.signTypedData(hexAddress, 
+                // TODO: Improve typing to ensure data matches MessageTypes
+                data, {
+                    version: eth_sig_util_1.SignTypedDataVersion.V3,
+                });
+            }
+            case `${types_1.EthMethod.SignTypedDataV4}`: {
+                if (!this.inner.signTypedData) {
+                    throw new Error('Keyring does not support signTypedData');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthSignTypedDataParamsStruct);
+                const [, data] = params;
+                return this.inner.signTypedData(hexAddress, 
+                // TODO: Improve typing to ensure data matches MessageTypes
+                data, {
+                    version: eth_sig_util_1.SignTypedDataVersion.V4,
+                });
+            }
+            case `${EthKeyringMethod.Decrypt}`: {
+                if (!this.inner.decryptMessage) {
+                    throw new Error('Keyring does not support decryptMessage');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthDecryptParamsStruct);
+                const [encryptedData] = params;
+                return this.inner.decryptMessage(hexAddress, encryptedData);
+            }
+            case `${EthKeyringMethod.GetEncryptionPublicKey}`: {
+                if (!this.inner.getEncryptionPublicKey) {
+                    throw new Error('Keyring does not support getEncryptionPublicKey');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthGetEncryptionPublicKeyParamsStruct);
+                const [, options] = params;
+                return this.inner.getEncryptionPublicKey(hexAddress, options);
+            }
+            case `${EthKeyringMethod.GetAppKeyAddress}`: {
+                if (!this.inner.getAppKeyAddress) {
+                    throw new Error('Keyring does not support getAppKeyAddress');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthGetAppKeyAddressParamsStruct);
+                const [origin] = params;
+                return this.inner.getAppKeyAddress(hexAddress, origin);
+            }
+            case `${EthKeyringMethod.SignEip7702Authorization}`: {
+                if (!this.inner.signEip7702Authorization) {
+                    throw new Error('Keyring does not support signEip7702Authorization');
+                }
+                (0, superstruct_1.assert)(params, rpc_1.EthSignEip7702AuthorizationParamsStruct);
+                const [authorization] = params;
+                return this.inner.signEip7702Authorization(hexAddress, authorization);
+            }
+            default:
+                throw new Error(`Unsupported method for EthKeyringWrapper: ${method}`);
+        }
+    }
+}
+exports.EthKeyringWrapper = EthKeyringWrapper;
+//# sourceMappingURL=eth-keyring-wrapper.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eth-keyring-wrapper.cjs","sourceRoot":"","sources":["../../../src/eth/v2/eth-keyring-wrapper.ts"],"names":[],"mappings":";;;AAAA,uCAAsE;AAEtE,yDAA8D;AAE9D,uDAA+C;AAC/C,2CAA6D;AAI7D,8EAG8C;AAC9C,0CAUgB;AAChB,wCAAqC;AAErC;;;GAGG;AACH,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,yEAAqD,CAAA;IACrD,6DAAyC,CAAA;IACzC,6EAAyD,CAAA;AAC3D,CAAC,EALW,gBAAgB,gCAAhB,gBAAgB,QAK3B;AAQD;;;;;;;;;;;;GAYG;AACH,MAAsB,iBAGpB,SAAQ,gCAAgD;IACxD;;;;;;;OAOG;IACO,YAAY,CAAC,OAAe;QACpC,OAAO,IAAA,aAAK,EAAC,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,iBAAS,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,IAAA,oBAAM,EAAC,MAAM,EAAE,oCAA8B,CAAC,CAAC;gBAC/C,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;gBACxB,yDAAyD;gBACzD,4DAA4D;gBAC5D,MAAM,EAAE,GAAG,uBAAkB,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,iBAAS,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,IAAA,oBAAM,EAAC,MAAM,EAAE,yBAAmB,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,iBAAS,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,IAAA,oBAAM,EAAC,MAAM,EAAE,iCAA2B,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,iBAAS,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,IAAA,oBAAM,EAAC,MAAM,EAAE,oCAA8B,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,mCAAoB,CAAC,EAAE;iBACjC,CAAC,CAAC;YACL,CAAC;YAED,KAAK,GAAG,iBAAS,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,IAAA,oBAAM,EAAC,MAAM,EAAE,kCAA4B,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,mCAAoB,CAAC,EAAE;iBACjC,CACF,CAAC;YACJ,CAAC;YAED,KAAK,GAAG,iBAAS,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,IAAA,oBAAM,EAAC,MAAM,EAAE,kCAA4B,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,mCAAoB,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,IAAA,oBAAM,EAAC,MAAM,EAAE,4BAAsB,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,IAAA,oBAAM,EAAC,MAAM,EAAE,2CAAqC,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,IAAA,oBAAM,EAAC,MAAM,EAAE,qCAA+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,IAAA,oBAAM,EAAC,MAAM,EAAE,6CAAuC,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;AA5JD,8CA4JC","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/eth-keyring-wrapper.d.cts

@@ -0,0 +1,54 @@
+import type { EthKeyring } from "@metamask/keyring-utils";
+import { type Hex, type Json } from "@metamask/utils";
+import type { KeyringAccount } from "../../api/account.cjs";
+import type { KeyringRequest } from "../../api/request.cjs";
+import { KeyringWrapper, type KeyringWrapperOptions } from "../../api/v2/wrapper/keyring-wrapper.cjs";
+/**
+ * Additional Ethereum methods supported by Eth keyrings that are not in the standard EthMethod enum.
+ * These are primarily encryption and utility methods.
+ */
+export declare enum EthKeyringMethod {
+    Decrypt = "eth_decrypt",
+    GetEncryptionPublicKey = "eth_getEncryptionPublicKey",
+    GetAppKeyAddress = "eth_getAppKeyAddress",
+    SignEip7702Authorization = "eth_signEip7702Authorization"
+}
+/**
+ * Options for constructing an EthKeyringWrapper.
+ */
+export type EthKeyringWrapperOptions<InnerKeyring extends EthKeyring> = KeyringWrapperOptions<InnerKeyring>;
+/**
+ * Abstract wrapper for Ethereum-based keyrings that extends KeyringWrapper, that itself implements KeyringV2.
+ *
+ * This class provides common functionality for all Ethereum keyrings including:
+ * - Request handling for standard Ethereum signing methods
+ * - Helper methods for Hex address conversion
+ *
+ * Subclasses must implement:
+ * - `getAccounts()`: Return all managed accounts
+ * - `createAccounts()`: Create new accounts based on options
+ * - `deleteAccount()`: Remove an account from the keyring
+ * - `exportAccount()` (optional): Export private key in specified format
+ */
+export declare abstract class EthKeyringWrapper<InnerKeyring extends EthKeyring, KeyringAccountType extends KeyringAccount = KeyringAccount> extends KeyringWrapper<InnerKeyring, KeyringAccountType> {
+    /**
+     * Helper method to safely cast a KeyringAccount address to Hex type.
+     * The KeyringAccount.address is typed as string, but for Ethereum accounts
+     * it should always be a valid Hex address.
+     *
+     * @param address - The address from a KeyringAccount.
+     * @returns The address as Hex type.
+     */
+    protected toHexAddress(address: string): Hex;
+    /**
+     * Handle an Ethereum signing request.
+     *
+     * Routes the request to the appropriate legacy keyring method based on
+     * the RPC method name.
+     *
+     * @param request - The keyring request containing method and params.
+     * @returns The result of the signing operation.
+     */
+    submitRequest(request: KeyringRequest): Promise<Json>;
+}
+//# sourceMappingURL=eth-keyring-wrapper.d.cts.map

package/dist/eth/v2/eth-keyring-wrapper.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-keyring-wrapper.d.cts","sourceRoot":"","sources":["../../../src/eth/v2/eth-keyring-wrapper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,gCAAgC;AAE1D,OAAO,EAAS,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,wBAAwB;AAE7D,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA0B;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA0B;AACxD,OAAO,EACL,cAAc,EACd,KAAK,qBAAqB,EAC3B,iDAA6C;AAc9C;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,OAAO,gBAAgB;IACvB,sBAAsB,+BAA+B;IACrD,gBAAgB,yBAAyB;IACzC,wBAAwB,iCAAiC;CAC1D;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,YAAY,SAAS,UAAU,IAClE,qBAAqB,CAAC,YAAY,CAAC,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,8BAAsB,iBAAiB,CACrC,YAAY,SAAS,UAAU,EAC/B,kBAAkB,SAAS,cAAc,GAAG,cAAc,CAC1D,SAAQ,cAAc,CAAC,YAAY,EAAE,kBAAkB,CAAC;IACxD;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG;IAI5C;;;;;;;;OAQG;IACG,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmI5D"}