@metamask-previews/account-api 0.1.0-e86c8ec → 0.1.0-f024bb4

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 (61) hide show
  1. package/dist/api/group.cjs.map +1 -1
  2. package/dist/api/group.d.cts +7 -5
  3. package/dist/api/group.d.cts.map +1 -1
  4. package/dist/api/group.d.mts +7 -5
  5. package/dist/api/group.d.mts.map +1 -1
  6. package/dist/api/group.mjs.map +1 -1
  7. package/dist/api/index.cjs +0 -1
  8. package/dist/api/index.cjs.map +1 -1
  9. package/dist/api/index.d.cts +0 -3
  10. package/dist/api/index.d.cts.map +1 -1
  11. package/dist/api/index.d.mts +0 -3
  12. package/dist/api/index.d.mts.map +1 -1
  13. package/dist/api/index.mjs +0 -1
  14. package/dist/api/index.mjs.map +1 -1
  15. package/dist/api/wallet.cjs.map +1 -1
  16. package/dist/api/wallet.d.cts +0 -1
  17. package/dist/api/wallet.d.cts.map +1 -1
  18. package/dist/api/wallet.d.mts +0 -1
  19. package/dist/api/wallet.d.mts.map +1 -1
  20. package/dist/api/wallet.mjs.map +1 -1
  21. package/package.json +2 -5
  22. package/dist/api/multichain/account.cjs +0 -186
  23. package/dist/api/multichain/account.cjs.map +0 -1
  24. package/dist/api/multichain/account.d.cts +0 -95
  25. package/dist/api/multichain/account.d.cts.map +0 -1
  26. package/dist/api/multichain/account.d.mts +0 -95
  27. package/dist/api/multichain/account.d.mts.map +0 -1
  28. package/dist/api/multichain/account.mjs +0 -179
  29. package/dist/api/multichain/account.mjs.map +0 -1
  30. package/dist/api/multichain/index.cjs +0 -19
  31. package/dist/api/multichain/index.cjs.map +0 -1
  32. package/dist/api/multichain/index.d.cts +0 -3
  33. package/dist/api/multichain/index.d.cts.map +0 -1
  34. package/dist/api/multichain/index.d.mts +0 -3
  35. package/dist/api/multichain/index.d.mts.map +0 -1
  36. package/dist/api/multichain/index.mjs +0 -3
  37. package/dist/api/multichain/index.mjs.map +0 -1
  38. package/dist/api/multichain/wallet.cjs +0 -158
  39. package/dist/api/multichain/wallet.cjs.map +0 -1
  40. package/dist/api/multichain/wallet.d.cts +0 -83
  41. package/dist/api/multichain/wallet.d.cts.map +0 -1
  42. package/dist/api/multichain/wallet.d.mts +0 -83
  43. package/dist/api/multichain/wallet.d.mts.map +0 -1
  44. package/dist/api/multichain/wallet.mjs +0 -153
  45. package/dist/api/multichain/wallet.mjs.map +0 -1
  46. package/dist/api/provider.cjs +0 -3
  47. package/dist/api/provider.cjs.map +0 -1
  48. package/dist/api/provider.d.cts +0 -13
  49. package/dist/api/provider.d.cts.map +0 -1
  50. package/dist/api/provider.d.mts +0 -13
  51. package/dist/api/provider.d.mts.map +0 -1
  52. package/dist/api/provider.mjs +0 -2
  53. package/dist/api/provider.mjs.map +0 -1
  54. package/dist/api/selector.cjs +0 -3
  55. package/dist/api/selector.cjs.map +0 -1
  56. package/dist/api/selector.d.cts +0 -27
  57. package/dist/api/selector.d.cts.map +0 -1
  58. package/dist/api/selector.d.mts +0 -27
  59. package/dist/api/selector.d.mts.map +0 -1
  60. package/dist/api/selector.mjs +0 -2
  61. package/dist/api/selector.mjs.map +0 -1
@@ -1,95 +0,0 @@
1
- import { type KeyringAccount } from "@metamask/keyring-api";
2
- import type { MultichainAccountWallet, MultichainAccountWalletId } from "./wallet.mjs";
3
- import type { AccountGroup } from "../group.mjs";
4
- import type { AccountProvider } from "../provider.mjs";
5
- import type { AccountSelector } from "../selector.mjs";
6
- /**
7
- * Multichain account ID.
8
- */
9
- export type MultichainAccountId = `${MultichainAccountWalletId}/${number}`;
10
- /**
11
- * A multichain account that holds multiple accounts.
12
- */
13
- export declare class MultichainAccount<Account extends KeyringAccount> implements AccountGroup<Account> {
14
- #private;
15
- constructor({ groupIndex, wallet, providers, }: {
16
- groupIndex: number;
17
- wallet: MultichainAccountWallet<Account>;
18
- providers: AccountProvider<Account>[];
19
- });
20
- /**
21
- * Gets the multichain account ID.
22
- *
23
- * @returns The multichain account ID.
24
- */
25
- get id(): MultichainAccountId;
26
- /**
27
- * Gets the multichain account's wallet reference (parent).
28
- *
29
- * @returns The multichain account's wallet.
30
- */
31
- get wallet(): MultichainAccountWallet<Account>;
32
- /**
33
- * Gets the multichain account group index.
34
- *
35
- * @returns The multichain account group index.
36
- */
37
- get index(): number;
38
- /**
39
- * Checks if there's any underlying accounts for this multichain accounts.
40
- *
41
- * @returns True if there's any underlying accounts, false otherwise.
42
- */
43
- hasAccounts(): boolean;
44
- /**
45
- * Gets the accounts for this multichain account.
46
- *
47
- * @returns The accounts.
48
- */
49
- getAccounts(): Account[];
50
- /**
51
- * Gets the account for a given account ID.
52
- *
53
- * @param id - Account ID.
54
- * @returns The account or undefined if not found.
55
- */
56
- getAccount(id: Account['id']): Account | undefined;
57
- /**
58
- * Query an account matching the selector.
59
- *
60
- * @param selector - Query selector.
61
- * @returns The account matching the selector or undefined if not matching.
62
- * @throws If multiple accounts match the selector.
63
- */
64
- get(selector: AccountSelector<Account>): Account | undefined;
65
- /**
66
- * Query accounts matching the selector.
67
- *
68
- * @param selector - Query selector.
69
- * @returns The accounts matching the selector.
70
- */
71
- select(selector: AccountSelector<Account>): Account[];
72
- }
73
- /**
74
- * Gets the multichain account ID from its multichain account wallet ID and its index.
75
- *
76
- * @param walletId - Multichain account wallet ID.
77
- * @param groupIndex - Index of that multichain account.
78
- * @returns The multichain account ID.
79
- */
80
- export declare function toMultichainAccountId(walletId: MultichainAccountWalletId, groupIndex: number): MultichainAccountId;
81
- /**
82
- * Checks if the given value is {@link MultichainAccountId}.
83
- *
84
- * @param value - The value to check.
85
- * @returns Whether the value is a {@link MultichainAccountId}.
86
- */
87
- export declare function isMultichainAccountId(value: string): value is MultichainAccountId;
88
- /**
89
- * Gets the multichain account index from an account group ID.
90
- *
91
- * @param id - Multichain account ID.
92
- * @returns The multichain account index if extractable, undefined otherwise.
93
- */
94
- export declare function getGroupIndexFromMultichainAccountId(id: MultichainAccountId): number;
95
- //# sourceMappingURL=account.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"account.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/account.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EACpB,8BAA8B;AAG/B,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,qBAAiB;AAClB,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAoB;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAoB;AAQnD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,GAAG,yBAAyB,IAAI,MAAM,EAAE,CAAC;AAE3E;;GAEG;AACH,qBAAa,iBAAiB,CAAC,OAAO,SAAS,cAAc,CAC3D,YAAW,YAAY,CAAC,OAAO,CAAC;;gBAUpB,EACV,UAAU,EACV,MAAM,EACN,SAAS,GACV,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,uBAAuB,CAAC,OAAO,CAAC,CAAC;QACzC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;KACvC;IAOD;;;;OAIG;IACH,IAAI,EAAE,IAAI,mBAAmB,CAE5B;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAE7C;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE;IAuBxB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS;IAMlD;;;;;;OAMG;IACH,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,SAAS;IAgB5D;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,GAAG,OAAO,EAAE;CA8BtD;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,yBAAyB,EACnC,UAAU,EAAE,MAAM,GACjB,mBAAmB,CAErB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GACZ,KAAK,IAAI,mBAAmB,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,EAAE,EAAE,mBAAmB,GACtB,MAAM,CASR"}
@@ -1,179 +0,0 @@
1
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
- if (kind === "m") throw new TypeError("Private method is not writable");
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
5
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
- };
7
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
10
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
- };
12
- var _MultichainAccount_id, _MultichainAccount_wallet, _MultichainAccount_index, _MultichainAccount_providers;
13
- import { KeyringAccountEntropyTypeOption } from "@metamask/keyring-api";
14
- import { isScopeEqualToAny } from "@metamask/keyring-utils";
15
- import { AccountWalletCategory } from "../wallet.mjs";
16
- const MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(`^${AccountWalletCategory.Entropy}:.*/(?<groupIndex>\\d+)$`, 'u');
17
- /**
18
- * A multichain account that holds multiple accounts.
19
- */
20
- export class MultichainAccount {
21
- constructor({ groupIndex, wallet, providers, }) {
22
- _MultichainAccount_id.set(this, void 0);
23
- _MultichainAccount_wallet.set(this, void 0);
24
- _MultichainAccount_index.set(this, void 0);
25
- _MultichainAccount_providers.set(this, void 0);
26
- __classPrivateFieldSet(this, _MultichainAccount_id, toMultichainAccountId(wallet.id, groupIndex), "f");
27
- __classPrivateFieldSet(this, _MultichainAccount_index, groupIndex, "f");
28
- __classPrivateFieldSet(this, _MultichainAccount_wallet, wallet, "f");
29
- __classPrivateFieldSet(this, _MultichainAccount_providers, providers, "f");
30
- }
31
- /**
32
- * Gets the multichain account ID.
33
- *
34
- * @returns The multichain account ID.
35
- */
36
- get id() {
37
- return __classPrivateFieldGet(this, _MultichainAccount_id, "f");
38
- }
39
- /**
40
- * Gets the multichain account's wallet reference (parent).
41
- *
42
- * @returns The multichain account's wallet.
43
- */
44
- get wallet() {
45
- return __classPrivateFieldGet(this, _MultichainAccount_wallet, "f");
46
- }
47
- /**
48
- * Gets the multichain account group index.
49
- *
50
- * @returns The multichain account group index.
51
- */
52
- get index() {
53
- return __classPrivateFieldGet(this, _MultichainAccount_index, "f");
54
- }
55
- /**
56
- * Checks if there's any underlying accounts for this multichain accounts.
57
- *
58
- * @returns True if there's any underlying accounts, false otherwise.
59
- */
60
- hasAccounts() {
61
- return this.getAccounts().length > 0;
62
- }
63
- /**
64
- * Gets the accounts for this multichain account.
65
- *
66
- * @returns The accounts.
67
- */
68
- getAccounts() {
69
- let allAccounts = [];
70
- for (const provider of __classPrivateFieldGet(this, _MultichainAccount_providers, "f")) {
71
- allAccounts = allAccounts.concat(provider.getAccounts().filter(
72
- // NOTE: For now we always query the providers to get the latest
73
- // account list. If this becomes too "heavy" in terms of computation
74
- // we might wanna consider adding a state to that object and store
75
- // the list of account IDs here.
76
- (account) => account.options.entropy &&
77
- account.options.entropy.type ===
78
- KeyringAccountEntropyTypeOption.Mnemonic &&
79
- account.options.entropy.id === this.wallet.entropySource &&
80
- account.options.entropy.groupIndex === this.index));
81
- }
82
- return allAccounts;
83
- }
84
- /**
85
- * Gets the account for a given account ID.
86
- *
87
- * @param id - Account ID.
88
- * @returns The account or undefined if not found.
89
- */
90
- getAccount(id) {
91
- // NOTE: Same remark here. We could keep a state to make this operation
92
- // faster.
93
- return this.getAccounts().find((account) => account.id === id);
94
- }
95
- /**
96
- * Query an account matching the selector.
97
- *
98
- * @param selector - Query selector.
99
- * @returns The account matching the selector or undefined if not matching.
100
- * @throws If multiple accounts match the selector.
101
- */
102
- get(selector) {
103
- const accounts = this.select(selector);
104
- if (accounts.length > 1) {
105
- throw new Error(`Too many account candidates, expected 1, got: ${accounts.length}`);
106
- }
107
- if (accounts.length === 0) {
108
- return undefined;
109
- }
110
- return accounts[0]; // This is safe, see checks above.
111
- }
112
- /**
113
- * Query accounts matching the selector.
114
- *
115
- * @param selector - Query selector.
116
- * @returns The accounts matching the selector.
117
- */
118
- select(selector) {
119
- return this.getAccounts().filter((account) => {
120
- let selected = true;
121
- if (selector.id) {
122
- selected && (selected = account.id === selector.id);
123
- }
124
- if (selector.address) {
125
- selected && (selected = account.address === selector.address);
126
- }
127
- if (selector.type) {
128
- selected && (selected = account.type === selector.type);
129
- }
130
- if (selector.methods !== undefined) {
131
- selected && (selected = selector.methods.some((method) => account.methods.includes(method)));
132
- }
133
- if (selector.scopes !== undefined) {
134
- selected && (selected = selector.scopes.some((scope) => {
135
- return (
136
- // This will cover specific EVM EOA scopes as well.
137
- isScopeEqualToAny(scope, account.scopes));
138
- }));
139
- }
140
- return selected;
141
- });
142
- }
143
- }
144
- _MultichainAccount_id = new WeakMap(), _MultichainAccount_wallet = new WeakMap(), _MultichainAccount_index = new WeakMap(), _MultichainAccount_providers = new WeakMap();
145
- /**
146
- * Gets the multichain account ID from its multichain account wallet ID and its index.
147
- *
148
- * @param walletId - Multichain account wallet ID.
149
- * @param groupIndex - Index of that multichain account.
150
- * @returns The multichain account ID.
151
- */
152
- export function toMultichainAccountId(walletId, groupIndex) {
153
- return `${walletId}/${groupIndex}`;
154
- }
155
- /**
156
- * Checks if the given value is {@link MultichainAccountId}.
157
- *
158
- * @param value - The value to check.
159
- * @returns Whether the value is a {@link MultichainAccountId}.
160
- */
161
- export function isMultichainAccountId(value) {
162
- return MULTICHAIN_ACCOUNT_ID_REGEX.test(value);
163
- }
164
- /**
165
- * Gets the multichain account index from an account group ID.
166
- *
167
- * @param id - Multichain account ID.
168
- * @returns The multichain account index if extractable, undefined otherwise.
169
- */
170
- export function getGroupIndexFromMultichainAccountId(id) {
171
- const matched = id.match(MULTICHAIN_ACCOUNT_ID_REGEX);
172
- if (matched?.groups?.groupIndex === undefined) {
173
- // Unable to extract group index, even though, type wise, this should not
174
- // be possible!
175
- throw new Error('Unable to extract group index');
176
- }
177
- return Number(matched.groups.groupIndex);
178
- }
179
- //# sourceMappingURL=account.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"account.mjs","sourceRoot":"","sources":["../../../src/api/multichain/account.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,+BAA+B,EAEhC,8BAA8B;AAC/B,OAAO,EAAE,iBAAiB,EAAE,gCAAgC;AAS5D,OAAO,EAAE,qBAAqB,EAAE,sBAAkB;AAElD,MAAM,2BAA2B,GAAG,IAAI,MAAM,CAC5C,IAAI,qBAAqB,CAAC,OAAO,0BAA0B,EAC3D,GAAG,CACJ,CAAC;AAOF;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAW5B,YAAY,EACV,UAAU,EACV,MAAM,EACN,SAAS,GAKV;QAhBQ,wCAAyB;QAEzB,4CAA0C;QAE1C,2CAAe;QAEf,+CAAuC;QAW9C,uBAAA,IAAI,yBAAO,qBAAqB,CAAC,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,MAAA,CAAC;QACxD,uBAAA,IAAI,4BAAU,UAAU,MAAA,CAAC;QACzB,uBAAA,IAAI,6BAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,gCAAc,SAAS,MAAA,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,6BAAI,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,uBAAA,IAAI,iCAAQ,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,gCAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,IAAI,WAAW,GAAc,EAAE,CAAC;QAEhC,KAAK,MAAM,QAAQ,IAAI,uBAAA,IAAI,oCAAW,EAAE,CAAC;YACvC,WAAW,GAAG,WAAW,CAAC,MAAM,CAC9B,QAAQ,CAAC,WAAW,EAAE,CAAC,MAAM;YAC3B,gEAAgE;YAChE,oEAAoE;YACpE,kEAAkE;YAClE,gCAAgC;YAChC,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,OAAO,CAAC,OAAO;gBACvB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI;oBAC1B,+BAA+B,CAAC,QAAQ;gBAC1C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa;gBACxD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CACpD,CACF,CAAC;QACJ,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,EAAiB;QAC1B,uEAAuE;QACvE,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,QAAkC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,iDAAiD,QAAQ,CAAC,MAAM,EAAE,CACnE,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,kCAAkC;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAkC;QACvC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3C,IAAI,QAAQ,GAAG,IAAI,CAAC;YAEpB,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;gBAChB,QAAQ,KAAR,QAAQ,GAAK,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,EAAC;YAC1C,CAAC;YACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACrB,QAAQ,KAAR,QAAQ,GAAK,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,OAAO,EAAC;YACpD,CAAC;YACD,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClB,QAAQ,KAAR,QAAQ,GAAK,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAC;YAC9C,CAAC;YACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACnC,QAAQ,KAAR,QAAQ,GAAK,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5C,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CACjC,EAAC;YACJ,CAAC;YACD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAClC,QAAQ,KAAR,QAAQ,GAAK,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC1C,OAAO;oBACL,mDAAmD;oBACnD,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CACzC,CAAC;gBACJ,CAAC,CAAC,EAAC;YACL,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAmC,EACnC,UAAkB;IAElB,OAAO,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAa;IAEb,OAAO,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oCAAoC,CAClD,EAAuB;IAEvB,MAAM,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE,MAAM,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9C,yEAAyE;QACzE,eAAe;QACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3C,CAAC","sourcesContent":["import {\n KeyringAccountEntropyTypeOption,\n type KeyringAccount,\n} from '@metamask/keyring-api';\nimport { isScopeEqualToAny } from '@metamask/keyring-utils';\n\nimport type {\n MultichainAccountWallet,\n MultichainAccountWalletId,\n} from './wallet';\nimport type { AccountGroup } from '../group';\nimport type { AccountProvider } from '../provider';\nimport type { AccountSelector } from '../selector';\nimport { AccountWalletCategory } from '../wallet';\n\nconst MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(\n `^${AccountWalletCategory.Entropy}:.*/(?<groupIndex>\\\\d+)$`,\n 'u',\n);\n\n/**\n * Multichain account ID.\n */\nexport type MultichainAccountId = `${MultichainAccountWalletId}/${number}`; // Use number for the account group index.\n\n/**\n * A multichain account that holds multiple accounts.\n */\nexport class MultichainAccount<Account extends KeyringAccount>\n implements AccountGroup<Account>\n{\n readonly #id: MultichainAccountId;\n\n readonly #wallet: MultichainAccountWallet<Account>;\n\n readonly #index: number;\n\n readonly #providers: AccountProvider<Account>[];\n\n constructor({\n groupIndex,\n wallet,\n providers,\n }: {\n groupIndex: number;\n wallet: MultichainAccountWallet<Account>;\n providers: AccountProvider<Account>[];\n }) {\n this.#id = toMultichainAccountId(wallet.id, groupIndex);\n this.#index = groupIndex;\n this.#wallet = wallet;\n this.#providers = providers;\n }\n\n /**\n * Gets the multichain account ID.\n *\n * @returns The multichain account ID.\n */\n get id(): MultichainAccountId {\n return this.#id;\n }\n\n /**\n * Gets the multichain account's wallet reference (parent).\n *\n * @returns The multichain account's wallet.\n */\n get wallet(): MultichainAccountWallet<Account> {\n return this.#wallet;\n }\n\n /**\n * Gets the multichain account group index.\n *\n * @returns The multichain account group index.\n */\n get index(): number {\n return this.#index;\n }\n\n /**\n * Checks if there's any underlying accounts for this multichain accounts.\n *\n * @returns True if there's any underlying accounts, false otherwise.\n */\n hasAccounts(): boolean {\n return this.getAccounts().length > 0;\n }\n\n /**\n * Gets the accounts for this multichain account.\n *\n * @returns The accounts.\n */\n getAccounts(): Account[] {\n let allAccounts: Account[] = [];\n\n for (const provider of this.#providers) {\n allAccounts = allAccounts.concat(\n provider.getAccounts().filter(\n // NOTE: For now we always query the providers to get the latest\n // account list. If this becomes too \"heavy\" in terms of computation\n // we might wanna consider adding a state to that object and store\n // the list of account IDs here.\n (account) =>\n account.options.entropy &&\n account.options.entropy.type ===\n KeyringAccountEntropyTypeOption.Mnemonic &&\n account.options.entropy.id === this.wallet.entropySource &&\n account.options.entropy.groupIndex === this.index,\n ),\n );\n }\n\n return allAccounts;\n }\n\n /**\n * Gets the account for a given account ID.\n *\n * @param id - Account ID.\n * @returns The account or undefined if not found.\n */\n getAccount(id: Account['id']): Account | undefined {\n // NOTE: Same remark here. We could keep a state to make this operation\n // faster.\n return this.getAccounts().find((account) => account.id === id);\n }\n\n /**\n * Query an account matching the selector.\n *\n * @param selector - Query selector.\n * @returns The account matching the selector or undefined if not matching.\n * @throws If multiple accounts match the selector.\n */\n get(selector: AccountSelector<Account>): Account | undefined {\n const accounts = this.select(selector);\n\n if (accounts.length > 1) {\n throw new Error(\n `Too many account candidates, expected 1, got: ${accounts.length}`,\n );\n }\n\n if (accounts.length === 0) {\n return undefined;\n }\n\n return accounts[0]; // This is safe, see checks above.\n }\n\n /**\n * Query accounts matching the selector.\n *\n * @param selector - Query selector.\n * @returns The accounts matching the selector.\n */\n select(selector: AccountSelector<Account>): Account[] {\n return this.getAccounts().filter((account) => {\n let selected = true;\n\n if (selector.id) {\n selected &&= account.id === selector.id;\n }\n if (selector.address) {\n selected &&= account.address === selector.address;\n }\n if (selector.type) {\n selected &&= account.type === selector.type;\n }\n if (selector.methods !== undefined) {\n selected &&= selector.methods.some((method) =>\n account.methods.includes(method),\n );\n }\n if (selector.scopes !== undefined) {\n selected &&= selector.scopes.some((scope) => {\n return (\n // This will cover specific EVM EOA scopes as well.\n isScopeEqualToAny(scope, account.scopes)\n );\n });\n }\n\n return selected;\n });\n }\n}\n\n/**\n * Gets the multichain account ID from its multichain account wallet ID and its index.\n *\n * @param walletId - Multichain account wallet ID.\n * @param groupIndex - Index of that multichain account.\n * @returns The multichain account ID.\n */\nexport function toMultichainAccountId(\n walletId: MultichainAccountWalletId,\n groupIndex: number,\n): MultichainAccountId {\n return `${walletId}/${groupIndex}`;\n}\n\n/**\n * Checks if the given value is {@link MultichainAccountId}.\n *\n * @param value - The value to check.\n * @returns Whether the value is a {@link MultichainAccountId}.\n */\nexport function isMultichainAccountId(\n value: string,\n): value is MultichainAccountId {\n return MULTICHAIN_ACCOUNT_ID_REGEX.test(value);\n}\n\n/**\n * Gets the multichain account index from an account group ID.\n *\n * @param id - Multichain account ID.\n * @returns The multichain account index if extractable, undefined otherwise.\n */\nexport function getGroupIndexFromMultichainAccountId(\n id: MultichainAccountId,\n): number {\n const matched = id.match(MULTICHAIN_ACCOUNT_ID_REGEX);\n if (matched?.groups?.groupIndex === undefined) {\n // Unable to extract group index, even though, type wise, this should not\n // be possible!\n throw new Error('Unable to extract group index');\n }\n\n return Number(matched.groups.groupIndex);\n}\n"]}
@@ -1,19 +0,0 @@
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("./account.cjs"), exports);
18
- __exportStar(require("./wallet.cjs"), exports);
19
- //# sourceMappingURL=index.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA0B;AAC1B,+CAAyB","sourcesContent":["export * from './account';\nexport * from './wallet';\n"]}
@@ -1,3 +0,0 @@
1
- export * from "./account.cjs";
2
- export * from "./wallet.cjs";
3
- //# sourceMappingURL=index.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,6BAAyB"}
@@ -1,3 +0,0 @@
1
- export * from "./account.mjs";
2
- export * from "./wallet.mjs";
3
- //# sourceMappingURL=index.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,6BAAyB"}
@@ -1,3 +0,0 @@
1
- export * from "./account.mjs";
2
- export * from "./wallet.mjs";
3
- //# sourceMappingURL=index.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/api/multichain/index.ts"],"names":[],"mappings":"AAAA,8BAA0B;AAC1B,6BAAyB","sourcesContent":["export * from './account';\nexport * from './wallet';\n"]}
@@ -1,158 +0,0 @@
1
- "use strict";
2
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
3
- if (kind === "m") throw new TypeError("Private method is not writable");
4
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
5
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
6
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
7
- };
8
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
9
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
10
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
11
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
12
- };
13
- var _MultichainAccountWallet_id, _MultichainAccountWallet_providers, _MultichainAccountWallet_entropySource, _MultichainAccountWallet_accounts;
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.MultichainAccountWallet = void 0;
16
- exports.toMultichainAccountWalletId = toMultichainAccountWalletId;
17
- const keyring_api_1 = require("@metamask/keyring-api");
18
- const account_1 = require("./account.cjs");
19
- const group_1 = require("../group.cjs");
20
- const wallet_1 = require("../wallet.cjs");
21
- /**
22
- * A multichain account wallet that holds multiple multichain accounts (one multichain account per
23
- * group index).
24
- */
25
- class MultichainAccountWallet {
26
- constructor({ providers, entropySource, }) {
27
- _MultichainAccountWallet_id.set(this, void 0);
28
- _MultichainAccountWallet_providers.set(this, void 0);
29
- _MultichainAccountWallet_entropySource.set(this, void 0);
30
- _MultichainAccountWallet_accounts.set(this, void 0);
31
- __classPrivateFieldSet(this, _MultichainAccountWallet_id, toMultichainAccountWalletId(entropySource), "f");
32
- __classPrivateFieldSet(this, _MultichainAccountWallet_providers, providers, "f");
33
- __classPrivateFieldSet(this, _MultichainAccountWallet_entropySource, entropySource, "f");
34
- __classPrivateFieldSet(this, _MultichainAccountWallet_accounts, new Map(), "f");
35
- // NOTE: This will traverse all accounts to compute the max index. We could try
36
- // to minimize the number of filtering we're doing on each providers if this
37
- // becomes too costly.
38
- const maxGroupIndex = MultichainAccountWallet.getHighestGroupIndexFrom(providers, entropySource);
39
- // NOTE: We could have some gap for now, until we fully implement the
40
- // gap/alignment mechanisms to backfill all "missing accounts".
41
- for (let groupIndex = 0; groupIndex <= maxGroupIndex; groupIndex++) {
42
- // Use "lower or equal", since we need to "include" the max index (which
43
- // can also be 0)
44
- const multichainAccount = new account_1.MultichainAccount({
45
- groupIndex,
46
- wallet: this,
47
- providers: __classPrivateFieldGet(this, _MultichainAccountWallet_providers, "f"),
48
- });
49
- // We only add multichain account that has underlying accounts.
50
- if (multichainAccount.hasAccounts()) {
51
- __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").set(groupIndex, multichainAccount);
52
- }
53
- }
54
- }
55
- /**
56
- * Gets the highest group index from multiple account providers for a given
57
- * entropy source.
58
- *
59
- * @param providers - Account providers.
60
- * @param entropySource - Entropy source to filter on.
61
- * @returns The highest group index for a given entropy source.
62
- */
63
- static getHighestGroupIndexFrom(providers, entropySource) {
64
- let max = -1;
65
- for (const provider of providers) {
66
- for (const account of provider.getAccounts()) {
67
- if (account.options.entropy &&
68
- account.options.entropy.type ===
69
- keyring_api_1.KeyringAccountEntropyTypeOption.Mnemonic &&
70
- account.options.entropy.id === entropySource) {
71
- max = Math.max(max, account.options.entropy.groupIndex);
72
- }
73
- }
74
- }
75
- return max;
76
- }
77
- /**
78
- * Gets the multichain account wallet ID.
79
- *
80
- * @returns The multichain account wallet ID.
81
- */
82
- get id() {
83
- return __classPrivateFieldGet(this, _MultichainAccountWallet_id, "f");
84
- }
85
- /**
86
- * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.
87
- *
88
- * @returns The multichain account wallet category.
89
- */
90
- get category() {
91
- return wallet_1.AccountWalletCategory.Entropy;
92
- }
93
- /**
94
- * Gets the multichain account wallet entropy source.
95
- *
96
- * @returns The multichain account wallet entropy source.
97
- */
98
- get entropySource() {
99
- return __classPrivateFieldGet(this, _MultichainAccountWallet_entropySource, "f");
100
- }
101
- /**
102
- * Gets multichain account for a given ID.
103
- * The default group ID will default to the multichain account with index 0.
104
- *
105
- * @param id - Account group ID.
106
- * @returns Account group.
107
- */
108
- getAccountGroup(id) {
109
- // We consider the "default case" to be mapped to index 0.
110
- if (id === (0, group_1.toDefaultAccountGroupId)(this.id)) {
111
- return __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").get(0);
112
- }
113
- // If it is not a valid ID, we cannot extract the group index
114
- // from it, so we fail fast.
115
- if (!(0, account_1.isMultichainAccountId)(id)) {
116
- return undefined;
117
- }
118
- const groupIndex = (0, account_1.getGroupIndexFromMultichainAccountId)(id);
119
- return __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").get(groupIndex);
120
- }
121
- /**
122
- * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccounts}.
123
- *
124
- * @returns The multichain accounts.
125
- */
126
- getAccountGroups() {
127
- return this.getMultichainAccounts();
128
- }
129
- /**
130
- * Gets multichain account for a given index.
131
- *
132
- * @param groupIndex - Multichain account index.
133
- * @returns The multichain account associated with the given index.
134
- */
135
- getMultichainAccount(groupIndex) {
136
- return __classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").get(groupIndex);
137
- }
138
- /**
139
- * Gets all multichain accounts.
140
- *
141
- * @returns The multichain accounts.
142
- */
143
- getMultichainAccounts() {
144
- return Array.from(__classPrivateFieldGet(this, _MultichainAccountWallet_accounts, "f").values()); // TODO: Prevent copy here.
145
- }
146
- }
147
- exports.MultichainAccountWallet = MultichainAccountWallet;
148
- _MultichainAccountWallet_id = new WeakMap(), _MultichainAccountWallet_providers = new WeakMap(), _MultichainAccountWallet_entropySource = new WeakMap(), _MultichainAccountWallet_accounts = new WeakMap();
149
- /**
150
- * Gets the multichain account wallet ID from its entropy source.
151
- *
152
- * @param entropySource - Entropy source ID of that wallet.
153
- * @returns The multichain account wallet ID.
154
- */
155
- function toMultichainAccountWalletId(entropySource) {
156
- return `${wallet_1.AccountWalletCategory.Entropy}:${entropySource}`;
157
- }
158
- //# sourceMappingURL=wallet.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAiMA,kEAIC;AArMD,uDAI+B;AAE/B,2CAImB;AAEnB,wCAAmD;AAGnD,0CAAkD;AAQlD;;;GAGG;AACH,MAAa,uBAAuB;IAWlC,YAAY,EACV,SAAS,EACT,aAAa,GAId;QAdQ,8CAA+B;QAE/B,qDAAuC;QAEvC,yDAAgC;QAEhC,oDAAmD;QAS1D,uBAAA,IAAI,+BAAO,2BAA2B,CAAC,aAAa,CAAC,MAAA,CAAC;QACtD,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,0CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,qCAAa,IAAI,GAAG,EAAE,MAAA,CAAC;QAE3B,+EAA+E;QAC/E,4EAA4E;QAC5E,sBAAsB;QACtB,MAAM,aAAa,GAAG,uBAAuB,CAAC,wBAAwB,CACpE,SAAS,EACT,aAAa,CACd,CAAC;QAEF,qEAAqE;QACrE,+DAA+D;QAC/D,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,IAAI,aAAa,EAAE,UAAU,EAAE,EAAE,CAAC;YACnE,wEAAwE;YACxE,iBAAiB;YACjB,MAAM,iBAAiB,GAAG,IAAI,2BAAiB,CAAU;gBACvD,UAAU;gBACV,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,uBAAA,IAAI,0CAAW;aAC3B,CAAC,CAAC;YAEH,+DAA+D;YAC/D,IAAI,iBAAiB,CAAC,WAAW,EAAE,EAAE,CAAC;gBACpC,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,wBAAwB,CAC7B,SAAqC,EACrC,aAA8B;QAE9B,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC;QAEb,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC7C,IACE,OAAO,CAAC,OAAO,CAAC,OAAO;oBACvB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI;wBAC1B,6CAA+B,CAAC,QAAQ;oBAC1C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,aAAa,EAC5C,CAAC;oBACD,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,mCAAI,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,8BAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,uBAAA,IAAI,8CAAe,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,EAAkB;QAChC,0DAA0D;QAC1D,IAAI,EAAE,KAAK,IAAA,+BAAuB,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAC5C,OAAO,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;QAED,6DAA6D;QAC7D,4BAA4B;QAC5B,IAAI,CAAC,IAAA,+BAAqB,EAAC,EAAE,CAAC,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,8CAAoC,EAAC,EAAE,CAAC,CAAC;QAC5D,OAAO,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAClB,UAAkB;QAElB,OAAO,uBAAA,IAAI,yCAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,yCAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,2BAA2B;IACzE,CAAC;CACF;AA9JD,0DA8JC;;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,aAA8B;IAE9B,OAAO,GAAG,8BAAqB,CAAC,OAAO,IAAI,aAAa,EAAE,CAAC;AAC7D,CAAC","sourcesContent":["import {\n KeyringAccountEntropyTypeOption,\n type EntropySourceId,\n type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport {\n getGroupIndexFromMultichainAccountId,\n isMultichainAccountId,\n MultichainAccount,\n} from './account';\nimport type { AccountGroupId } from '../group';\nimport { toDefaultAccountGroupId } from '../group';\nimport type { AccountProvider } from '../provider';\nimport type { AccountWallet } from '../wallet';\nimport { AccountWalletCategory } from '../wallet';\n\n/**\n * Multichain account wallet ID.\n */\nexport type MultichainAccountWalletId =\n `${AccountWalletCategory.Entropy}:${EntropySourceId}`;\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport class MultichainAccountWallet<Account extends KeyringAccount>\n implements AccountWallet<Account>\n{\n readonly #id: MultichainAccountWalletId;\n\n readonly #providers: AccountProvider<Account>[];\n\n readonly #entropySource: EntropySourceId;\n\n readonly #accounts: Map<number, MultichainAccount<Account>>;\n\n constructor({\n providers,\n entropySource,\n }: {\n providers: AccountProvider<Account>[];\n entropySource: EntropySourceId;\n }) {\n this.#id = toMultichainAccountWalletId(entropySource);\n this.#providers = providers;\n this.#entropySource = entropySource;\n this.#accounts = new Map();\n\n // NOTE: This will traverse all accounts to compute the max index. We could try\n // to minimize the number of filtering we're doing on each providers if this\n // becomes too costly.\n const maxGroupIndex = MultichainAccountWallet.getHighestGroupIndexFrom(\n providers,\n entropySource,\n );\n\n // NOTE: We could have some gap for now, until we fully implement the\n // gap/alignment mechanisms to backfill all \"missing accounts\".\n for (let groupIndex = 0; groupIndex <= maxGroupIndex; groupIndex++) {\n // Use \"lower or equal\", since we need to \"include\" the max index (which\n // can also be 0)\n const multichainAccount = new MultichainAccount<Account>({\n groupIndex,\n wallet: this,\n providers: this.#providers,\n });\n\n // We only add multichain account that has underlying accounts.\n if (multichainAccount.hasAccounts()) {\n this.#accounts.set(groupIndex, multichainAccount);\n }\n }\n }\n\n /**\n * Gets the highest group index from multiple account providers for a given\n * entropy source.\n *\n * @param providers - Account providers.\n * @param entropySource - Entropy source to filter on.\n * @returns The highest group index for a given entropy source.\n */\n static getHighestGroupIndexFrom<Account extends KeyringAccount>(\n providers: AccountProvider<Account>[],\n entropySource: EntropySourceId,\n ): number {\n let max = -1;\n\n for (const provider of providers) {\n for (const account of provider.getAccounts()) {\n if (\n account.options.entropy &&\n account.options.entropy.type ===\n KeyringAccountEntropyTypeOption.Mnemonic &&\n account.options.entropy.id === entropySource\n ) {\n max = Math.max(max, account.options.entropy.groupIndex);\n }\n }\n }\n\n return max;\n }\n\n /**\n * Gets the multichain account wallet ID.\n *\n * @returns The multichain account wallet ID.\n */\n get id(): MultichainAccountWalletId {\n return this.#id;\n }\n\n /**\n * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.\n *\n * @returns The multichain account wallet category.\n */\n get category(): AccountWalletCategory.Entropy {\n return AccountWalletCategory.Entropy;\n }\n\n /**\n * Gets the multichain account wallet entropy source.\n *\n * @returns The multichain account wallet entropy source.\n */\n get entropySource(): EntropySourceId {\n return this.#entropySource;\n }\n\n /**\n * Gets multichain account for a given ID.\n * The default group ID will default to the multichain account with index 0.\n *\n * @param id - Account group ID.\n * @returns Account group.\n */\n getAccountGroup(id: AccountGroupId): MultichainAccount<Account> | undefined {\n // We consider the \"default case\" to be mapped to index 0.\n if (id === toDefaultAccountGroupId(this.id)) {\n return this.#accounts.get(0);\n }\n\n // If it is not a valid ID, we cannot extract the group index\n // from it, so we fail fast.\n if (!isMultichainAccountId(id)) {\n return undefined;\n }\n\n const groupIndex = getGroupIndexFromMultichainAccountId(id);\n return this.#accounts.get(groupIndex);\n }\n\n /**\n * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccounts}.\n *\n * @returns The multichain accounts.\n */\n getAccountGroups(): MultichainAccount<Account>[] {\n return this.getMultichainAccounts();\n }\n\n /**\n * Gets multichain account for a given index.\n *\n * @param groupIndex - Multichain account index.\n * @returns The multichain account associated with the given index.\n */\n getMultichainAccount(\n groupIndex: number,\n ): MultichainAccount<Account> | undefined {\n return this.#accounts.get(groupIndex);\n }\n\n /**\n * Gets all multichain accounts.\n *\n * @returns The multichain accounts.\n */\n getMultichainAccounts(): MultichainAccount<Account>[] {\n return Array.from(this.#accounts.values()); // TODO: Prevent copy here.\n }\n}\n\n/**\n * Gets the multichain account wallet ID from its entropy source.\n *\n * @param entropySource - Entropy source ID of that wallet.\n * @returns The multichain account wallet ID.\n */\nexport function toMultichainAccountWalletId(\n entropySource: EntropySourceId,\n): MultichainAccountWalletId {\n return `${AccountWalletCategory.Entropy}:${entropySource}`;\n}\n"]}
@@ -1,83 +0,0 @@
1
- import { type EntropySourceId, type KeyringAccount } from "@metamask/keyring-api";
2
- import { MultichainAccount } from "./account.cjs";
3
- import type { AccountGroupId } from "../group.cjs";
4
- import type { AccountProvider } from "../provider.cjs";
5
- import type { AccountWallet } from "../wallet.cjs";
6
- import { AccountWalletCategory } from "../wallet.cjs";
7
- /**
8
- * Multichain account wallet ID.
9
- */
10
- export type MultichainAccountWalletId = `${AccountWalletCategory.Entropy}:${EntropySourceId}`;
11
- /**
12
- * A multichain account wallet that holds multiple multichain accounts (one multichain account per
13
- * group index).
14
- */
15
- export declare class MultichainAccountWallet<Account extends KeyringAccount> implements AccountWallet<Account> {
16
- #private;
17
- constructor({ providers, entropySource, }: {
18
- providers: AccountProvider<Account>[];
19
- entropySource: EntropySourceId;
20
- });
21
- /**
22
- * Gets the highest group index from multiple account providers for a given
23
- * entropy source.
24
- *
25
- * @param providers - Account providers.
26
- * @param entropySource - Entropy source to filter on.
27
- * @returns The highest group index for a given entropy source.
28
- */
29
- static getHighestGroupIndexFrom<Account extends KeyringAccount>(providers: AccountProvider<Account>[], entropySource: EntropySourceId): number;
30
- /**
31
- * Gets the multichain account wallet ID.
32
- *
33
- * @returns The multichain account wallet ID.
34
- */
35
- get id(): MultichainAccountWalletId;
36
- /**
37
- * Gets the multichain account wallet category, which is always {@link AccountWalletCategory.Entropy}.
38
- *
39
- * @returns The multichain account wallet category.
40
- */
41
- get category(): AccountWalletCategory.Entropy;
42
- /**
43
- * Gets the multichain account wallet entropy source.
44
- *
45
- * @returns The multichain account wallet entropy source.
46
- */
47
- get entropySource(): EntropySourceId;
48
- /**
49
- * Gets multichain account for a given ID.
50
- * The default group ID will default to the multichain account with index 0.
51
- *
52
- * @param id - Account group ID.
53
- * @returns Account group.
54
- */
55
- getAccountGroup(id: AccountGroupId): MultichainAccount<Account> | undefined;
56
- /**
57
- * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccounts}.
58
- *
59
- * @returns The multichain accounts.
60
- */
61
- getAccountGroups(): MultichainAccount<Account>[];
62
- /**
63
- * Gets multichain account for a given index.
64
- *
65
- * @param groupIndex - Multichain account index.
66
- * @returns The multichain account associated with the given index.
67
- */
68
- getMultichainAccount(groupIndex: number): MultichainAccount<Account> | undefined;
69
- /**
70
- * Gets all multichain accounts.
71
- *
72
- * @returns The multichain accounts.
73
- */
74
- getMultichainAccounts(): MultichainAccount<Account>[];
75
- }
76
- /**
77
- * Gets the multichain account wallet ID from its entropy source.
78
- *
79
- * @param entropySource - Entropy source ID of that wallet.
80
- * @returns The multichain account wallet ID.
81
- */
82
- export declare function toMultichainAccountWalletId(entropySource: EntropySourceId): MultichainAccountWalletId;
83
- //# sourceMappingURL=wallet.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,cAAc,EACpB,8BAA8B;AAE/B,OAAO,EAGL,iBAAiB,EAClB,sBAAkB;AACnB,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAiB;AAE/C,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAoB;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAkB;AAC/C,OAAO,EAAE,qBAAqB,EAAE,sBAAkB;AAElD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACnC,GAAG,qBAAqB,CAAC,OAAO,IAAI,eAAe,EAAE,CAAC;AAExD;;;GAGG;AACH,qBAAa,uBAAuB,CAAC,OAAO,SAAS,cAAc,CACjE,YAAW,aAAa,CAAC,OAAO,CAAC;;gBAUrB,EACV,SAAS,EACT,aAAa,GACd,EAAE;QACD,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,aAAa,EAAE,eAAe,CAAC;KAChC;IAgCD;;;;;;;OAOG;IACH,MAAM,CAAC,wBAAwB,CAAC,OAAO,SAAS,cAAc,EAC5D,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,EACrC,aAAa,EAAE,eAAe,GAC7B,MAAM;IAmBT;;;;OAIG;IACH,IAAI,EAAE,IAAI,yBAAyB,CAElC;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,qBAAqB,CAAC,OAAO,CAE5C;IAED;;;;OAIG;IACH,IAAI,aAAa,IAAI,eAAe,CAEnC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,SAAS;IAgB3E;;;;OAIG;IACH,gBAAgB,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE;IAIhD;;;;;OAKG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,GACjB,iBAAiB,CAAC,OAAO,CAAC,GAAG,SAAS;IAIzC;;;;OAIG;IACH,qBAAqB,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE;CAGtD;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,eAAe,GAC7B,yBAAyB,CAE3B"}