@metamask-previews/keyring-internal-api 0.0.1-672cc7b

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +15 -0
  3. package/dist/btc/index.d.ts +1 -0
  4. package/dist/btc/index.js +18 -0
  5. package/dist/btc/index.js.map +1 -0
  6. package/dist/btc/types.d.ts +33 -0
  7. package/dist/btc/types.js +40 -0
  8. package/dist/btc/types.js.map +1 -0
  9. package/dist/eth/erc4337/index.d.ts +1 -0
  10. package/dist/eth/erc4337/index.js +18 -0
  11. package/dist/eth/erc4337/index.js.map +1 -0
  12. package/dist/eth/erc4337/types.d.ts +97 -0
  13. package/dist/eth/erc4337/types.js +61 -0
  14. package/dist/eth/erc4337/types.js.map +1 -0
  15. package/dist/eth/index.d.ts +3 -0
  16. package/dist/eth/index.js +20 -0
  17. package/dist/eth/index.js.map +1 -0
  18. package/dist/eth/types.d.ts +80 -0
  19. package/dist/eth/types.js +73 -0
  20. package/dist/eth/types.js.map +1 -0
  21. package/dist/eth/utils.d.ts +8 -0
  22. package/dist/eth/utils.js +15 -0
  23. package/dist/eth/utils.js.map +1 -0
  24. package/dist/index.d.ts +3 -0
  25. package/dist/index.js +20 -0
  26. package/dist/index.js.map +1 -0
  27. package/dist/internal/api.d.ts +415 -0
  28. package/dist/internal/api.js +138 -0
  29. package/dist/internal/api.js.map +1 -0
  30. package/dist/internal/eth/EthKeyring.d.ts +33 -0
  31. package/dist/internal/eth/EthKeyring.js +3 -0
  32. package/dist/internal/eth/EthKeyring.js.map +1 -0
  33. package/dist/internal/eth/index.d.ts +1 -0
  34. package/dist/internal/eth/index.js +18 -0
  35. package/dist/internal/eth/index.js.map +1 -0
  36. package/dist/internal/events.d.ts +169 -0
  37. package/dist/internal/events.js +83 -0
  38. package/dist/internal/events.js.map +1 -0
  39. package/dist/internal/index.d.ts +5 -0
  40. package/dist/internal/index.js +22 -0
  41. package/dist/internal/index.js.map +1 -0
  42. package/dist/internal/rpc.d.ts +25 -0
  43. package/dist/internal/rpc.js +33 -0
  44. package/dist/internal/rpc.js.map +1 -0
  45. package/dist/internal/types.d.ts +330 -0
  46. package/dist/internal/types.js +49 -0
  47. package/dist/internal/types.js.map +1 -0
  48. package/package.json +78 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,10 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ [Unreleased]: https://github.com/MetaMask/accounts/
package/README.md ADDED
@@ -0,0 +1,15 @@
1
+ # MetaMask Keyring Internal API
2
+
3
+ Keyring internal API that holds internal types and implementations.
4
+
5
+ ## Installation
6
+
7
+ `yarn add @metamask/keyring-internal-api`
8
+
9
+ or
10
+
11
+ `npm install @metamask/keyring-internal-api`
12
+
13
+ ## Contributing
14
+
15
+ This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/accounts#readme).
@@ -0,0 +1 @@
1
+ export * from './types';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./types"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/btc/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB","sourcesContent":["export * from './types';\n"]}
@@ -0,0 +1,33 @@
1
+ import type { Infer } from '@metamask/superstruct';
2
+ export declare const BtcP2wpkhAddressStruct: import("@metamask/superstruct").Struct<string, null>;
3
+ /**
4
+ * Supported Bitcoin methods.
5
+ */
6
+ export declare enum BtcMethod {
7
+ SendMany = "btc_sendmany"
8
+ }
9
+ export declare const BtcP2wpkhAccountStruct: import("@metamask/superstruct").Struct<{
10
+ id: string;
11
+ options: Record<string, import("@metamask/utils").Json>;
12
+ address: string;
13
+ type: "bip122:p2wpkh";
14
+ methods: "btc_sendmany"[];
15
+ }, {
16
+ /**
17
+ * Account address.
18
+ */
19
+ address: import("@metamask/superstruct").Struct<string, null>;
20
+ /**
21
+ * Account type.
22
+ */
23
+ type: import("@metamask/superstruct").Struct<"bip122:p2wpkh", "bip122:p2wpkh">;
24
+ /**
25
+ * Account supported methods.
26
+ */
27
+ methods: import("@metamask/superstruct").Struct<"btc_sendmany"[], import("@metamask/superstruct").Struct<"btc_sendmany", {
28
+ btc_sendmany: "btc_sendmany";
29
+ }>>;
30
+ id: import("@metamask/superstruct").Struct<string, null>;
31
+ options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
32
+ }>;
33
+ export declare type BtcP2wpkhAccount = Infer<typeof BtcP2wpkhAccountStruct>;
@@ -0,0 +1,40 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BtcP2wpkhAccountStruct = exports.BtcMethod = exports.BtcP2wpkhAddressStruct = void 0;
4
+ const keyring_api_1 = require("@metamask/keyring-api");
5
+ const keyring_utils_1 = require("@metamask/keyring-utils");
6
+ const superstruct_1 = require("@metamask/superstruct");
7
+ const bech32_1 = require("bech32");
8
+ exports.BtcP2wpkhAddressStruct = (0, superstruct_1.refine)((0, superstruct_1.string)(), 'BtcP2wpkhAddressStruct', (address) => {
9
+ try {
10
+ bech32_1.bech32.decode(address);
11
+ }
12
+ catch (error) {
13
+ return new Error(`Could not decode P2WPKH address: ${error.message}`);
14
+ }
15
+ return true;
16
+ });
17
+ /**
18
+ * Supported Bitcoin methods.
19
+ */
20
+ var BtcMethod;
21
+ (function (BtcMethod) {
22
+ // General transaction methods
23
+ BtcMethod["SendMany"] = "btc_sendmany";
24
+ })(BtcMethod = exports.BtcMethod || (exports.BtcMethod = {}));
25
+ exports.BtcP2wpkhAccountStruct = (0, keyring_utils_1.object)({
26
+ ...keyring_api_1.KeyringAccountStruct.schema,
27
+ /**
28
+ * Account address.
29
+ */
30
+ address: exports.BtcP2wpkhAddressStruct,
31
+ /**
32
+ * Account type.
33
+ */
34
+ type: (0, superstruct_1.literal)(`${keyring_api_1.BtcAccountType.P2wpkh}`),
35
+ /**
36
+ * Account supported methods.
37
+ */
38
+ methods: (0, superstruct_1.array)((0, superstruct_1.enums)([`${BtcMethod.SendMany}`])),
39
+ });
40
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/btc/types.ts"],"names":[],"mappings":";;;AAAA,uDAA6E;AAC7E,2DAAiD;AAEjD,uDAA8E;AAC9E,mCAAgC;AAEnB,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;AAEY,QAAA,sBAAsB,GAAG,IAAA,sBAAM,EAAC;IAC3C,GAAG,kCAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,8BAAsB;IAE/B;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,4BAAc,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 { KeyringAccountStruct, BtcAccountType } from '@metamask/keyring-api';\nimport { object } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { string, array, enums, refine, literal } from '@metamask/superstruct';\nimport { bech32 } from 'bech32';\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\nexport const BtcP2wpkhAccountStruct = object({\n ...KeyringAccountStruct.schema,\n\n /**\n * Account address.\n */\n address: BtcP2wpkhAddressStruct,\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"]}
@@ -0,0 +1 @@
1
+ export * from './types';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./types"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/eth/erc4337/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB","sourcesContent":["export * from './types';\n"]}
@@ -0,0 +1,97 @@
1
+ import { type Infer } from '@metamask/superstruct';
2
+ /**
3
+ * Struct of a UserOperation as defined by ERC-4337.
4
+ *
5
+ * @see https://eips.ethereum.org/EIPS/eip-4337#definitions
6
+ */
7
+ export declare const EthUserOperationStruct: import("@metamask/superstruct").Struct<{
8
+ sender: string;
9
+ nonce: string;
10
+ initCode: string;
11
+ callData: string;
12
+ callGasLimit: string;
13
+ verificationGasLimit: string;
14
+ preVerificationGas: string;
15
+ maxFeePerGas: string;
16
+ maxPriorityFeePerGas: string;
17
+ paymasterAndData: string;
18
+ signature: string;
19
+ }, {
20
+ sender: import("@metamask/superstruct").Struct<string, null>;
21
+ nonce: import("@metamask/superstruct").Struct<string, null>;
22
+ initCode: import("@metamask/superstruct").Struct<string, null>;
23
+ callData: import("@metamask/superstruct").Struct<string, null>;
24
+ callGasLimit: import("@metamask/superstruct").Struct<string, null>;
25
+ verificationGasLimit: import("@metamask/superstruct").Struct<string, null>;
26
+ preVerificationGas: import("@metamask/superstruct").Struct<string, null>;
27
+ maxFeePerGas: import("@metamask/superstruct").Struct<string, null>;
28
+ maxPriorityFeePerGas: import("@metamask/superstruct").Struct<string, null>;
29
+ paymasterAndData: import("@metamask/superstruct").Struct<string, null>;
30
+ signature: import("@metamask/superstruct").Struct<string, null>;
31
+ }>;
32
+ export declare type EthUserOperation = Infer<typeof EthUserOperationStruct>;
33
+ /**
34
+ * Struct containing the most basic transaction information required to
35
+ * construct a UserOperation.
36
+ */
37
+ export declare const EthBaseTransactionStruct: import("@metamask/superstruct").Struct<{
38
+ data: string;
39
+ to: string;
40
+ value: string;
41
+ }, {
42
+ /**
43
+ * Address of the transaction recipient.
44
+ */
45
+ to: import("@metamask/superstruct").Struct<string, null>;
46
+ /**
47
+ * Amount of wei to transfer to the recipient.
48
+ */
49
+ value: import("@metamask/superstruct").Struct<string, null>;
50
+ /**
51
+ * Data to pass to the recipient.
52
+ */
53
+ data: import("@metamask/superstruct").Struct<string, null>;
54
+ }>;
55
+ export declare type EthBaseTransaction = Infer<typeof EthBaseTransactionStruct>;
56
+ export declare const EthBaseUserOperationStruct: import("@metamask/superstruct").Struct<{
57
+ nonce: string;
58
+ initCode: string;
59
+ callData: string;
60
+ dummyPaymasterAndData: string;
61
+ dummySignature: string;
62
+ bundlerUrl: string;
63
+ gasLimits?: {
64
+ callGasLimit: string;
65
+ verificationGasLimit: string;
66
+ preVerificationGas: string;
67
+ };
68
+ }, {
69
+ nonce: import("@metamask/superstruct").Struct<string, null>;
70
+ initCode: import("@metamask/superstruct").Struct<string, null>;
71
+ callData: import("@metamask/superstruct").Struct<string, null>;
72
+ gasLimits: import("@metamask/superstruct").Struct<import("@metamask/keyring-utils").ExactOptionalTag | {
73
+ callGasLimit: string;
74
+ verificationGasLimit: string;
75
+ preVerificationGas: string;
76
+ }, {
77
+ callGasLimit: import("@metamask/superstruct").Struct<string, null>;
78
+ verificationGasLimit: import("@metamask/superstruct").Struct<string, null>;
79
+ preVerificationGas: import("@metamask/superstruct").Struct<string, null>;
80
+ }>;
81
+ dummyPaymasterAndData: import("@metamask/superstruct").Struct<string, null>;
82
+ dummySignature: import("@metamask/superstruct").Struct<string, null>;
83
+ bundlerUrl: import("@metamask/superstruct").Struct<string, null>;
84
+ }>;
85
+ export declare type EthBaseUserOperation = Infer<typeof EthBaseUserOperationStruct>;
86
+ export declare const EthUserOperationPatchStruct: import("@metamask/superstruct").Struct<{
87
+ paymasterAndData: string;
88
+ callGasLimit?: string;
89
+ verificationGasLimit?: string;
90
+ preVerificationGas?: string;
91
+ }, {
92
+ paymasterAndData: import("@metamask/superstruct").Struct<string, null>;
93
+ callGasLimit: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
94
+ verificationGasLimit: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
95
+ preVerificationGas: import("@metamask/superstruct").Struct<string | import("@metamask/keyring-utils").ExactOptionalTag, null>;
96
+ }>;
97
+ export declare type EthUserOperationPatch = Infer<typeof EthUserOperationPatchStruct>;
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EthUserOperationPatchStruct = exports.EthBaseUserOperationStruct = exports.EthBaseTransactionStruct = exports.EthUserOperationStruct = void 0;
4
+ const keyring_utils_1 = require("@metamask/keyring-utils");
5
+ const types_1 = require("../types");
6
+ /**
7
+ * Struct of a UserOperation as defined by ERC-4337.
8
+ *
9
+ * @see https://eips.ethereum.org/EIPS/eip-4337#definitions
10
+ */
11
+ exports.EthUserOperationStruct = (0, keyring_utils_1.object)({
12
+ sender: types_1.EthAddressStruct,
13
+ nonce: types_1.EthUint256Struct,
14
+ initCode: types_1.EthBytesStruct,
15
+ callData: types_1.EthBytesStruct,
16
+ callGasLimit: types_1.EthUint256Struct,
17
+ verificationGasLimit: types_1.EthUint256Struct,
18
+ preVerificationGas: types_1.EthUint256Struct,
19
+ maxFeePerGas: types_1.EthUint256Struct,
20
+ maxPriorityFeePerGas: types_1.EthUint256Struct,
21
+ paymasterAndData: types_1.EthBytesStruct,
22
+ signature: types_1.EthBytesStruct,
23
+ });
24
+ /**
25
+ * Struct containing the most basic transaction information required to
26
+ * construct a UserOperation.
27
+ */
28
+ exports.EthBaseTransactionStruct = (0, keyring_utils_1.object)({
29
+ /**
30
+ * Address of the transaction recipient.
31
+ */
32
+ to: types_1.EthAddressStruct,
33
+ /**
34
+ * Amount of wei to transfer to the recipient.
35
+ */
36
+ value: types_1.EthUint256Struct,
37
+ /**
38
+ * Data to pass to the recipient.
39
+ */
40
+ data: types_1.EthBytesStruct,
41
+ });
42
+ exports.EthBaseUserOperationStruct = (0, keyring_utils_1.object)({
43
+ nonce: types_1.EthUint256Struct,
44
+ initCode: types_1.EthBytesStruct,
45
+ callData: types_1.EthBytesStruct,
46
+ gasLimits: (0, keyring_utils_1.exactOptional)((0, keyring_utils_1.object)({
47
+ callGasLimit: types_1.EthUint256Struct,
48
+ verificationGasLimit: types_1.EthUint256Struct,
49
+ preVerificationGas: types_1.EthUint256Struct,
50
+ })),
51
+ dummyPaymasterAndData: types_1.EthBytesStruct,
52
+ dummySignature: types_1.EthBytesStruct,
53
+ bundlerUrl: keyring_utils_1.UrlStruct,
54
+ });
55
+ exports.EthUserOperationPatchStruct = (0, keyring_utils_1.object)({
56
+ paymasterAndData: types_1.EthBytesStruct,
57
+ callGasLimit: (0, keyring_utils_1.exactOptional)(types_1.EthUint256Struct),
58
+ verificationGasLimit: (0, keyring_utils_1.exactOptional)(types_1.EthUint256Struct),
59
+ preVerificationGas: (0, keyring_utils_1.exactOptional)(types_1.EthUint256Struct),
60
+ });
61
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/eth/erc4337/types.ts"],"names":[],"mappings":";;;AAAA,2DAA2E;AAG3E,oCAA8E;AAE9E;;;;GAIG;AACU,QAAA,sBAAsB,GAAG,IAAA,sBAAM,EAAC;IAC3C,MAAM,EAAE,wBAAgB;IACxB,KAAK,EAAE,wBAAgB;IACvB,QAAQ,EAAE,sBAAc;IACxB,QAAQ,EAAE,sBAAc;IACxB,YAAY,EAAE,wBAAgB;IAC9B,oBAAoB,EAAE,wBAAgB;IACtC,kBAAkB,EAAE,wBAAgB;IACpC,YAAY,EAAE,wBAAgB;IAC9B,oBAAoB,EAAE,wBAAgB;IACtC,gBAAgB,EAAE,sBAAc;IAChC,SAAS,EAAE,sBAAc;CAC1B,CAAC,CAAC;AAIH;;;GAGG;AACU,QAAA,wBAAwB,GAAG,IAAA,sBAAM,EAAC;IAC7C;;OAEG;IACH,EAAE,EAAE,wBAAgB;IAEpB;;OAEG;IACH,KAAK,EAAE,wBAAgB;IAEvB;;OAEG;IACH,IAAI,EAAE,sBAAc;CACrB,CAAC,CAAC;AAIU,QAAA,0BAA0B,GAAG,IAAA,sBAAM,EAAC;IAC/C,KAAK,EAAE,wBAAgB;IACvB,QAAQ,EAAE,sBAAc;IACxB,QAAQ,EAAE,sBAAc;IACxB,SAAS,EAAE,IAAA,6BAAa,EACtB,IAAA,sBAAM,EAAC;QACL,YAAY,EAAE,wBAAgB;QAC9B,oBAAoB,EAAE,wBAAgB;QACtC,kBAAkB,EAAE,wBAAgB;KACrC,CAAC,CACH;IACD,qBAAqB,EAAE,sBAAc;IACrC,cAAc,EAAE,sBAAc;IAC9B,UAAU,EAAE,yBAAS;CACtB,CAAC,CAAC;AAIU,QAAA,2BAA2B,GAAG,IAAA,sBAAM,EAAC;IAChD,gBAAgB,EAAE,sBAAc;IAChC,YAAY,EAAE,IAAA,6BAAa,EAAC,wBAAgB,CAAC;IAC7C,oBAAoB,EAAE,IAAA,6BAAa,EAAC,wBAAgB,CAAC;IACrD,kBAAkB,EAAE,IAAA,6BAAa,EAAC,wBAAgB,CAAC;CACpD,CAAC,CAAC","sourcesContent":["import { exactOptional, object, UrlStruct } from '@metamask/keyring-utils';\nimport { type Infer } from '@metamask/superstruct';\n\nimport { EthAddressStruct, EthBytesStruct, EthUint256Struct } from '../types';\n\n/**\n * Struct of a UserOperation as defined by ERC-4337.\n *\n * @see https://eips.ethereum.org/EIPS/eip-4337#definitions\n */\nexport const EthUserOperationStruct = object({\n sender: EthAddressStruct,\n nonce: EthUint256Struct,\n initCode: EthBytesStruct,\n callData: EthBytesStruct,\n callGasLimit: EthUint256Struct,\n verificationGasLimit: EthUint256Struct,\n preVerificationGas: EthUint256Struct,\n maxFeePerGas: EthUint256Struct,\n maxPriorityFeePerGas: EthUint256Struct,\n paymasterAndData: EthBytesStruct,\n signature: EthBytesStruct,\n});\n\nexport type EthUserOperation = Infer<typeof EthUserOperationStruct>;\n\n/**\n * Struct containing the most basic transaction information required to\n * construct a UserOperation.\n */\nexport const EthBaseTransactionStruct = object({\n /**\n * Address of the transaction recipient.\n */\n to: EthAddressStruct,\n\n /**\n * Amount of wei to transfer to the recipient.\n */\n value: EthUint256Struct,\n\n /**\n * Data to pass to the recipient.\n */\n data: EthBytesStruct,\n});\n\nexport type EthBaseTransaction = Infer<typeof EthBaseTransactionStruct>;\n\nexport const EthBaseUserOperationStruct = object({\n nonce: EthUint256Struct,\n initCode: EthBytesStruct,\n callData: EthBytesStruct,\n gasLimits: exactOptional(\n object({\n callGasLimit: EthUint256Struct,\n verificationGasLimit: EthUint256Struct,\n preVerificationGas: EthUint256Struct,\n }),\n ),\n dummyPaymasterAndData: EthBytesStruct,\n dummySignature: EthBytesStruct,\n bundlerUrl: UrlStruct,\n});\n\nexport type EthBaseUserOperation = Infer<typeof EthBaseUserOperationStruct>;\n\nexport const EthUserOperationPatchStruct = object({\n paymasterAndData: EthBytesStruct,\n callGasLimit: exactOptional(EthUint256Struct),\n verificationGasLimit: exactOptional(EthUint256Struct),\n preVerificationGas: exactOptional(EthUint256Struct),\n});\n\nexport type EthUserOperationPatch = Infer<typeof EthUserOperationPatchStruct>;\n"]}
@@ -0,0 +1,3 @@
1
+ export * from './erc4337';
2
+ export * from './types';
3
+ export * from './utils';
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./erc4337"), exports);
18
+ __exportStar(require("./types"), exports);
19
+ __exportStar(require("./utils"), exports);
20
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"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"]}
@@ -0,0 +1,80 @@
1
+ import type { Infer } from '@metamask/superstruct';
2
+ export declare const EthBytesStruct: import("@metamask/superstruct").Struct<string, null>;
3
+ export declare const EthAddressStruct: import("@metamask/superstruct").Struct<string, null>;
4
+ export declare const EthUint256Struct: import("@metamask/superstruct").Struct<string, null>;
5
+ /**
6
+ * Supported Ethereum methods.
7
+ */
8
+ export declare enum EthMethod {
9
+ PersonalSign = "personal_sign",
10
+ Sign = "eth_sign",
11
+ SignTransaction = "eth_signTransaction",
12
+ SignTypedDataV1 = "eth_signTypedData_v1",
13
+ SignTypedDataV3 = "eth_signTypedData_v3",
14
+ SignTypedDataV4 = "eth_signTypedData_v4",
15
+ PrepareUserOperation = "eth_prepareUserOperation",
16
+ PatchUserOperation = "eth_patchUserOperation",
17
+ SignUserOperation = "eth_signUserOperation"
18
+ }
19
+ export declare const EthEoaAccountStruct: import("@metamask/superstruct").Struct<{
20
+ id: string;
21
+ options: Record<string, import("@metamask/utils").Json>;
22
+ address: string;
23
+ type: "eip155:eoa";
24
+ methods: ("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[];
25
+ }, {
26
+ /**
27
+ * Account address.
28
+ */
29
+ address: import("@metamask/superstruct").Struct<string, null>;
30
+ /**
31
+ * Account type.
32
+ */
33
+ type: import("@metamask/superstruct").Struct<"eip155:eoa", "eip155:eoa">;
34
+ /**
35
+ * Account supported methods.
36
+ */
37
+ methods: import("@metamask/superstruct").Struct<("personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4")[], import("@metamask/superstruct").Struct<"personal_sign" | "eth_sign" | "eth_signTransaction" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4", {
38
+ personal_sign: "personal_sign";
39
+ eth_sign: "eth_sign";
40
+ eth_signTransaction: "eth_signTransaction";
41
+ eth_signTypedData_v1: "eth_signTypedData_v1";
42
+ eth_signTypedData_v3: "eth_signTypedData_v3";
43
+ eth_signTypedData_v4: "eth_signTypedData_v4";
44
+ }>>;
45
+ id: import("@metamask/superstruct").Struct<string, null>;
46
+ options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
47
+ }>;
48
+ export declare type EthEoaAccount = Infer<typeof EthEoaAccountStruct>;
49
+ export declare const EthErc4337AccountStruct: import("@metamask/superstruct").Struct<{
50
+ id: string;
51
+ options: Record<string, import("@metamask/utils").Json>;
52
+ address: string;
53
+ type: "eip155:erc4337";
54
+ methods: ("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[];
55
+ }, {
56
+ /**
57
+ * Account address.
58
+ */
59
+ address: import("@metamask/superstruct").Struct<string, null>;
60
+ /**
61
+ * Account type.
62
+ */
63
+ type: import("@metamask/superstruct").Struct<"eip155:erc4337", "eip155:erc4337">;
64
+ /**
65
+ * Account supported methods.
66
+ */
67
+ methods: import("@metamask/superstruct").Struct<("personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation")[], import("@metamask/superstruct").Struct<"personal_sign" | "eth_sign" | "eth_signTypedData_v1" | "eth_signTypedData_v3" | "eth_signTypedData_v4" | "eth_prepareUserOperation" | "eth_patchUserOperation" | "eth_signUserOperation", {
68
+ personal_sign: "personal_sign";
69
+ eth_sign: "eth_sign";
70
+ eth_signTypedData_v1: "eth_signTypedData_v1";
71
+ eth_signTypedData_v3: "eth_signTypedData_v3";
72
+ eth_signTypedData_v4: "eth_signTypedData_v4";
73
+ eth_prepareUserOperation: "eth_prepareUserOperation";
74
+ eth_patchUserOperation: "eth_patchUserOperation";
75
+ eth_signUserOperation: "eth_signUserOperation";
76
+ }>>;
77
+ id: import("@metamask/superstruct").Struct<string, null>;
78
+ options: import("@metamask/superstruct").Struct<Record<string, import("@metamask/utils").Json>, null>;
79
+ }>;
80
+ export declare type EthErc4337Account = Infer<typeof EthErc4337AccountStruct>;
@@ -0,0 +1,73 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EthErc4337AccountStruct = exports.EthEoaAccountStruct = exports.EthMethod = exports.EthUint256Struct = exports.EthAddressStruct = exports.EthBytesStruct = void 0;
4
+ const keyring_api_1 = require("@metamask/keyring-api");
5
+ const keyring_utils_1 = require("@metamask/keyring-utils");
6
+ const superstruct_1 = require("@metamask/superstruct");
7
+ exports.EthBytesStruct = (0, keyring_utils_1.definePattern)('EthBytes', /^0x[0-9a-f]*$/iu);
8
+ exports.EthAddressStruct = (0, keyring_utils_1.definePattern)('EthAddress', /^0x[0-9a-f]{40}$/iu);
9
+ exports.EthUint256Struct = (0, keyring_utils_1.definePattern)('EthUint256', /^0x([1-9a-f][0-9a-f]*|0)$/iu);
10
+ /**
11
+ * Supported Ethereum methods.
12
+ */
13
+ var EthMethod;
14
+ (function (EthMethod) {
15
+ // General signing methods
16
+ EthMethod["PersonalSign"] = "personal_sign";
17
+ EthMethod["Sign"] = "eth_sign";
18
+ EthMethod["SignTransaction"] = "eth_signTransaction";
19
+ EthMethod["SignTypedDataV1"] = "eth_signTypedData_v1";
20
+ EthMethod["SignTypedDataV3"] = "eth_signTypedData_v3";
21
+ EthMethod["SignTypedDataV4"] = "eth_signTypedData_v4";
22
+ // ERC-4337 methods
23
+ EthMethod["PrepareUserOperation"] = "eth_prepareUserOperation";
24
+ EthMethod["PatchUserOperation"] = "eth_patchUserOperation";
25
+ EthMethod["SignUserOperation"] = "eth_signUserOperation";
26
+ })(EthMethod = exports.EthMethod || (exports.EthMethod = {}));
27
+ exports.EthEoaAccountStruct = (0, keyring_utils_1.object)({
28
+ ...keyring_api_1.KeyringAccountStruct.schema,
29
+ /**
30
+ * Account address.
31
+ */
32
+ address: exports.EthAddressStruct,
33
+ /**
34
+ * Account type.
35
+ */
36
+ type: (0, superstruct_1.literal)(`${keyring_api_1.EthAccountType.Eoa}`),
37
+ /**
38
+ * Account supported methods.
39
+ */
40
+ methods: (0, superstruct_1.array)((0, superstruct_1.enums)([
41
+ `${EthMethod.PersonalSign}`,
42
+ `${EthMethod.Sign}`,
43
+ `${EthMethod.SignTransaction}`,
44
+ `${EthMethod.SignTypedDataV1}`,
45
+ `${EthMethod.SignTypedDataV3}`,
46
+ `${EthMethod.SignTypedDataV4}`,
47
+ ])),
48
+ });
49
+ exports.EthErc4337AccountStruct = (0, keyring_utils_1.object)({
50
+ ...keyring_api_1.KeyringAccountStruct.schema,
51
+ /**
52
+ * Account address.
53
+ */
54
+ address: exports.EthAddressStruct,
55
+ /**
56
+ * Account type.
57
+ */
58
+ type: (0, superstruct_1.literal)(`${keyring_api_1.EthAccountType.Erc4337}`),
59
+ /**
60
+ * Account supported methods.
61
+ */
62
+ methods: (0, superstruct_1.array)((0, superstruct_1.enums)([
63
+ `${EthMethod.PersonalSign}`,
64
+ `${EthMethod.Sign}`,
65
+ `${EthMethod.SignTypedDataV1}`,
66
+ `${EthMethod.SignTypedDataV3}`,
67
+ `${EthMethod.SignTypedDataV4}`,
68
+ `${EthMethod.PrepareUserOperation}`,
69
+ `${EthMethod.PatchUserOperation}`,
70
+ `${EthMethod.SignUserOperation}`,
71
+ ])),
72
+ });
73
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/eth/types.ts"],"names":[],"mappings":";;;AAAA,uDAA6E;AAC7E,2DAAgE;AAEhE,uDAA8D;AAEjD,QAAA,cAAc,GAAG,IAAA,6BAAa,EAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AAE9D,QAAA,gBAAgB,GAAG,IAAA,6BAAa,EAC3C,YAAY,EACZ,oBAAoB,CACrB,CAAC;AAEW,QAAA,gBAAgB,GAAG,IAAA,6BAAa,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,GAAT,iBAAS,KAAT,iBAAS,QAYpB;AAEY,QAAA,mBAAmB,GAAG,IAAA,sBAAM,EAAC;IACxC,GAAG,kCAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,4BAAc,CAAC,GAAG,EAAE,CAAC;IAEtC;;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,kCAAoB,CAAC,MAAM;IAE9B;;OAEG;IACH,OAAO,EAAE,wBAAgB;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAA,qBAAO,EAAC,GAAG,4BAAc,CAAC,OAAO,EAAE,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 { EthAccountType, KeyringAccountStruct } from '@metamask/keyring-api';\nimport { object, definePattern } from '@metamask/keyring-utils';\nimport type { Infer } from '@metamask/superstruct';\nimport { array, enums, literal } from '@metamask/superstruct';\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 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 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"]}
@@ -0,0 +1,8 @@
1
+ import type { KeyringAccountType } from '@metamask/keyring-api';
2
+ /**
3
+ * Checks if the given type is an EVM account type.
4
+ *
5
+ * @param type - The type to check.
6
+ * @returns Returns true if the type is an EVM account type, false otherwise.
7
+ */
8
+ export declare function isEvmAccountType(type: KeyringAccountType): boolean;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isEvmAccountType = void 0;
4
+ const keyring_api_1 = require("@metamask/keyring-api");
5
+ /**
6
+ * Checks if the given type is an EVM account type.
7
+ *
8
+ * @param type - The type to check.
9
+ * @returns Returns true if the type is an EVM account type, false otherwise.
10
+ */
11
+ function isEvmAccountType(type) {
12
+ return type === keyring_api_1.EthAccountType.Eoa || type === keyring_api_1.EthAccountType.Erc4337;
13
+ }
14
+ exports.isEvmAccountType = isEvmAccountType;
15
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/eth/utils.ts"],"names":[],"mappings":";;;AACA,uDAAuD;AAEvD;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,IAAwB;IACvD,OAAO,IAAI,KAAK,4BAAc,CAAC,GAAG,IAAI,IAAI,KAAK,4BAAc,CAAC,OAAO,CAAC;AACxE,CAAC;AAFD,4CAEC","sourcesContent":["import type { KeyringAccountType } from '@metamask/keyring-api';\nimport { EthAccountType } from '@metamask/keyring-api';\n\n/**\n * Checks if the given type is an EVM account type.\n *\n * @param type - The type to check.\n * @returns Returns true if the type is an EVM account type, false otherwise.\n */\nexport function isEvmAccountType(type: KeyringAccountType): boolean {\n return type === EthAccountType.Eoa || type === EthAccountType.Erc4337;\n}\n"]}
@@ -0,0 +1,3 @@
1
+ export * from './internal';
2
+ export * from './btc';
3
+ export * from './eth';
package/dist/index.js ADDED
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./internal"), exports);
18
+ __exportStar(require("./btc"), exports);
19
+ __exportStar(require("./eth"), exports);
20
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,wCAAsB;AACtB,wCAAsB","sourcesContent":["export * from './internal';\nexport * from './btc';\nexport * from './eth';\n"]}