@metamask-previews/account-api 0.3.0-9522cc5 → 0.6.0-9cb78a8

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 (56) hide show
  1. package/CHANGELOG.md +34 -1
  2. package/dist/api/group.cjs +1 -1
  3. package/dist/api/group.cjs.map +1 -1
  4. package/dist/api/group.d.cts +9 -4
  5. package/dist/api/group.d.cts.map +1 -1
  6. package/dist/api/group.d.mts +9 -4
  7. package/dist/api/group.d.mts.map +1 -1
  8. package/dist/api/group.mjs +1 -1
  9. package/dist/api/group.mjs.map +1 -1
  10. package/dist/api/multichain/group.cjs +42 -0
  11. package/dist/api/multichain/group.cjs.map +1 -0
  12. package/dist/api/multichain/group.d.cts +68 -0
  13. package/dist/api/multichain/group.d.cts.map +1 -0
  14. package/dist/api/multichain/group.d.mts +68 -0
  15. package/dist/api/multichain/group.d.mts.map +1 -0
  16. package/dist/api/multichain/group.mjs +37 -0
  17. package/dist/api/multichain/group.mjs.map +1 -0
  18. package/dist/api/multichain/index.cjs +1 -1
  19. package/dist/api/multichain/index.cjs.map +1 -1
  20. package/dist/api/multichain/index.d.cts +1 -1
  21. package/dist/api/multichain/index.d.cts.map +1 -1
  22. package/dist/api/multichain/index.d.mts +1 -1
  23. package/dist/api/multichain/index.d.mts.map +1 -1
  24. package/dist/api/multichain/index.mjs +1 -1
  25. package/dist/api/multichain/index.mjs.map +1 -1
  26. package/dist/api/multichain/wallet.cjs +0 -139
  27. package/dist/api/multichain/wallet.cjs.map +1 -1
  28. package/dist/api/multichain/wallet.d.cts +8 -42
  29. package/dist/api/multichain/wallet.d.cts.map +1 -1
  30. package/dist/api/multichain/wallet.d.mts +8 -42
  31. package/dist/api/multichain/wallet.d.mts.map +1 -1
  32. package/dist/api/multichain/wallet.mjs +0 -137
  33. package/dist/api/multichain/wallet.mjs.map +1 -1
  34. package/dist/api/provider.cjs.map +1 -1
  35. package/dist/api/provider.d.cts +30 -2
  36. package/dist/api/provider.d.cts.map +1 -1
  37. package/dist/api/provider.d.mts +30 -2
  38. package/dist/api/provider.d.mts.map +1 -1
  39. package/dist/api/provider.mjs.map +1 -1
  40. package/dist/api/wallet.cjs +3 -9
  41. package/dist/api/wallet.cjs.map +1 -1
  42. package/dist/api/wallet.d.cts +9 -10
  43. package/dist/api/wallet.d.cts.map +1 -1
  44. package/dist/api/wallet.d.mts +9 -10
  45. package/dist/api/wallet.d.mts.map +1 -1
  46. package/dist/api/wallet.mjs +3 -9
  47. package/dist/api/wallet.mjs.map +1 -1
  48. package/package.json +2 -5
  49. package/dist/api/multichain/account.cjs +0 -230
  50. package/dist/api/multichain/account.cjs.map +0 -1
  51. package/dist/api/multichain/account.d.cts +0 -110
  52. package/dist/api/multichain/account.d.cts.map +0 -1
  53. package/dist/api/multichain/account.d.mts +0 -110
  54. package/dist/api/multichain/account.d.mts.map +0 -1
  55. package/dist/api/multichain/account.mjs +0 -223
  56. package/dist/api/multichain/account.mjs.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"provider.mjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountProvider<Account extends KeyringAccount> = {\n /**\n * Gets an account for a given ID.\n *\n * @returns An account, or undefined if not found.\n */\n getAccount: (id: Account['id']) => Account | undefined;\n\n /**\n * Gets all accounts for a given entropy source and group index.\n *\n * @returns A list of all account for this provider.\n */\n getAccounts: () => Account[];\n};\n"]}
1
+ {"version":3,"file":"provider.mjs","sourceRoot":"","sources":["../../src/api/provider.ts"],"names":[],"mappings":"","sourcesContent":["import type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\n\n/**\n * An account provider is reponsible of providing accounts to an account group.\n */\nexport type AccountProvider<Account extends KeyringAccount> = {\n /**\n * Gets an account for a given ID.\n *\n * @returns An account, or undefined if not found.\n */\n getAccount: (id: Account['id']) => Account | undefined;\n\n /**\n * Gets all accounts for this provider.\n *\n * @returns A list of all account for this provider.\n */\n getAccounts: () => Account[];\n\n /**\n * Creates accounts for a given entropy source and a given group\n * index.\n *\n * @param options - Options.\n * @param options.entropySource - Entropy source to use.\n * @param options.groupIndex - Group index to use.\n * @returns The list of created accounts.\n */\n createAccounts: (options: {\n entropySource: EntropySourceId;\n groupIndex: number;\n }) => Promise<Account[]>;\n\n /**\n * Discover accounts for a given entropy source and a given group\n * index.\n *\n * NOTE: This method needs to also create the discovered accounts.\n *\n * @param options - Options.\n * @param options.entropySource - Entropy source to use.\n * @param options.groupIndex - Group index to use.\n * @returns The list of discovered and created accounts.\n */\n discoverAndCreateAccounts: (options: {\n entropySource: EntropySourceId;\n groupIndex: number;\n }) => Promise<Account[]>;\n};\n"]}
@@ -9,17 +9,11 @@ exports.toAccountWalletId = toAccountWalletId;
9
9
  */
10
10
  var AccountWalletType;
11
11
  (function (AccountWalletType) {
12
- /**
13
- * Wallet grouping accounts based on their entropy source.
14
- */
12
+ /** Wallet grouping accounts based on their entropy source. */
15
13
  AccountWalletType["Entropy"] = "entropy";
16
- /**
17
- * Wallet grouping accounts based on their keyring's type.
18
- */
14
+ /** Wallet grouping accounts based on their keyring's type. */
19
15
  AccountWalletType["Keyring"] = "keyring";
20
- /**
21
- * Wallet grouping accounts associated with an account management Snap.
22
- */
16
+ /** Wallet grouping accounts associated with an account management Snap. */
23
17
  AccountWalletType["Snap"] = "snap";
24
18
  })(AccountWalletType || (exports.AccountWalletType = AccountWalletType = {}));
25
19
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":";;;AAqEA,8CAKC;AArED;;;;GAIG;AACH,IAAY,iBAeX;AAfD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,kCAAa,CAAA;AACf,CAAC,EAfW,iBAAiB,iCAAjB,iBAAiB,QAe5B;AAqCD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,IAAuB,EACvB,EAAU;IAEV,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountGroup, AccountGroupId } from './group';\n\n/**\n * Wallet type.\n *\n * Each wallet types groups accounts using different criterias.\n */\nexport enum AccountWalletType {\n /**\n * Wallet grouping accounts based on their entropy source.\n */\n Entropy = 'entropy',\n\n /**\n * Wallet grouping accounts based on their keyring's type.\n */\n Keyring = 'keyring',\n\n /**\n * Wallet grouping accounts associated with an account management Snap.\n */\n Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletType}:${string}`;\n\n/**\n * Account wallet that can hold multiple account groups.\n */\nexport type AccountWallet<Account extends KeyringAccount> = {\n /**\n * Account wallet ID.\n */\n get id(): AccountWalletId;\n\n /**\n * Account wallet type.\n */\n get type(): AccountWalletType;\n\n /**\n * Gets account group for a given ID.\n *\n * @param id - Account group ID.\n * @returns Account group.\n */\n getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;\n\n /**\n * Gets all account groups.\n *\n * @returns Account groups.\n */\n getAccountGroups(): AccountGroup<Account>[];\n};\n\n/**\n * Convert a unique ID to a wallet ID for a given type.\n *\n * @param type - A wallet type.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n type: AccountWalletType,\n id: string,\n): AccountWalletId {\n return `${type}:${id}`;\n}\n"]}
1
+ {"version":3,"file":"wallet.cjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":";;;AAsEA,8CAKC;AAtED;;;;GAIG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,2EAA2E;IAC3E,kCAAa,CAAA;AACf,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B;AA4CD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,IAAgB,EAChB,EAAU;IAEV,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountGroup, AccountGroupId } from './group';\n\n/**\n * Wallet type.\n *\n * Each wallet types groups accounts using different criterias.\n */\nexport enum AccountWalletType {\n /** Wallet grouping accounts based on their entropy source. */\n Entropy = 'entropy',\n\n /** Wallet grouping accounts based on their keyring's type. */\n Keyring = 'keyring',\n\n /** Wallet grouping accounts associated with an account management Snap. */\n Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletType}:${string}`;\n\n/**\n * Account wallet that can hold multiple account groups.\n */\nexport type AccountWallet<Account extends KeyringAccount> = {\n /**\n * Account wallet ID.\n */\n get id(): AccountWalletId;\n\n /**\n * Account wallet type.\n */\n get type(): AccountWalletType;\n\n /**\n * Gets account group for a given ID.\n *\n * @param id - Account group ID.\n * @returns Account group.\n */\n getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;\n\n /**\n * Gets all account groups.\n *\n * @returns Account groups.\n */\n getAccountGroups(): AccountGroup<Account>[];\n};\n\n/**\n * Type utility to compute a constrained {@link AccountWalletId} type given a\n * specifc {@link AccountWalletType}.\n */\nexport type AccountWalletIdOf<WalletType extends AccountWalletType> =\n `${WalletType}:${string}`;\n\n/**\n * Convert a unique ID to a wallet ID for a given type.\n *\n * @param type - A wallet type.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId<WalletType extends AccountWalletType>(\n type: WalletType,\n id: string,\n): AccountWalletIdOf<WalletType> {\n return `${type}:${id}`;\n}\n"]}
@@ -6,17 +6,11 @@ import type { AccountGroup, AccountGroupId } from "./group.cjs";
6
6
  * Each wallet types groups accounts using different criterias.
7
7
  */
8
8
  export declare enum AccountWalletType {
9
- /**
10
- * Wallet grouping accounts based on their entropy source.
11
- */
9
+ /** Wallet grouping accounts based on their entropy source. */
12
10
  Entropy = "entropy",
13
- /**
14
- * Wallet grouping accounts based on their keyring's type.
15
- */
11
+ /** Wallet grouping accounts based on their keyring's type. */
16
12
  Keyring = "keyring",
17
- /**
18
- * Wallet grouping accounts associated with an account management Snap.
19
- */
13
+ /** Wallet grouping accounts associated with an account management Snap. */
20
14
  Snap = "snap"
21
15
  }
22
16
  /**
@@ -49,6 +43,11 @@ export type AccountWallet<Account extends KeyringAccount> = {
49
43
  */
50
44
  getAccountGroups(): AccountGroup<Account>[];
51
45
  };
46
+ /**
47
+ * Type utility to compute a constrained {@link AccountWalletId} type given a
48
+ * specifc {@link AccountWalletType}.
49
+ */
50
+ export type AccountWalletIdOf<WalletType extends AccountWalletType> = `${WalletType}:${string}`;
52
51
  /**
53
52
  * Convert a unique ID to a wallet ID for a given type.
54
53
  *
@@ -56,5 +55,5 @@ export type AccountWallet<Account extends KeyringAccount> = {
56
55
  * @param id - A unique ID.
57
56
  * @returns A wallet ID.
58
57
  */
59
- export declare function toAccountWalletId(type: AccountWalletType, id: string): AccountWalletId;
58
+ export declare function toAccountWalletId<WalletType extends AccountWalletType>(type: WalletType, id: string): AccountWalletIdOf<WalletType>;
60
59
  //# sourceMappingURL=wallet.d.cts.map
@@ -1 +1 @@
1
- {"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,iBAAiB,IAAI,MAAM,EAAE,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC;IAE9B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,iBAAiB,EACvB,EAAE,EAAE,MAAM,GACT,eAAe,CAEjB"}
1
+ {"version":3,"file":"wallet.d.cts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B,8DAA8D;IAC9D,OAAO,YAAY;IAEnB,8DAA8D;IAC9D,OAAO,YAAY;IAEnB,2EAA2E;IAC3E,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,iBAAiB,IAAI,MAAM,EAAE,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC;IAE9B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,UAAU,SAAS,iBAAiB,IAChE,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;AAE5B;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,SAAS,iBAAiB,EACpE,IAAI,EAAE,UAAU,EAChB,EAAE,EAAE,MAAM,GACT,iBAAiB,CAAC,UAAU,CAAC,CAE/B"}
@@ -6,17 +6,11 @@ import type { AccountGroup, AccountGroupId } from "./group.mjs";
6
6
  * Each wallet types groups accounts using different criterias.
7
7
  */
8
8
  export declare enum AccountWalletType {
9
- /**
10
- * Wallet grouping accounts based on their entropy source.
11
- */
9
+ /** Wallet grouping accounts based on their entropy source. */
12
10
  Entropy = "entropy",
13
- /**
14
- * Wallet grouping accounts based on their keyring's type.
15
- */
11
+ /** Wallet grouping accounts based on their keyring's type. */
16
12
  Keyring = "keyring",
17
- /**
18
- * Wallet grouping accounts associated with an account management Snap.
19
- */
13
+ /** Wallet grouping accounts associated with an account management Snap. */
20
14
  Snap = "snap"
21
15
  }
22
16
  /**
@@ -49,6 +43,11 @@ export type AccountWallet<Account extends KeyringAccount> = {
49
43
  */
50
44
  getAccountGroups(): AccountGroup<Account>[];
51
45
  };
46
+ /**
47
+ * Type utility to compute a constrained {@link AccountWalletId} type given a
48
+ * specifc {@link AccountWalletType}.
49
+ */
50
+ export type AccountWalletIdOf<WalletType extends AccountWalletType> = `${WalletType}:${string}`;
52
51
  /**
53
52
  * Convert a unique ID to a wallet ID for a given type.
54
53
  *
@@ -56,5 +55,5 @@ export type AccountWallet<Account extends KeyringAccount> = {
56
55
  * @param id - A unique ID.
57
56
  * @returns A wallet ID.
58
57
  */
59
- export declare function toAccountWalletId(type: AccountWalletType, id: string): AccountWalletId;
58
+ export declare function toAccountWalletId<WalletType extends AccountWalletType>(type: WalletType, id: string): AccountWalletIdOf<WalletType>;
60
59
  //# sourceMappingURL=wallet.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,iBAAiB,IAAI,MAAM,EAAE,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC;IAE9B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,iBAAiB,EACvB,EAAE,EAAE,MAAM,GACT,eAAe,CAEjB"}
1
+ {"version":3,"file":"wallet.d.mts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAgB;AAE5D;;;;GAIG;AACH,oBAAY,iBAAiB;IAC3B,8DAA8D;IAC9D,OAAO,YAAY;IAEnB,8DAA8D;IAC9D,OAAO,YAAY;IAEnB,2EAA2E;IAC3E,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,iBAAiB,IAAI,MAAM,EAAE,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,IAAI;IAC1D;;OAEG;IACH,IAAI,EAAE,IAAI,eAAe,CAAC;IAE1B;;OAEG;IACH,IAAI,IAAI,IAAI,iBAAiB,CAAC;IAE9B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAEvE;;;;OAIG;IACH,gBAAgB,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,UAAU,SAAS,iBAAiB,IAChE,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;AAE5B;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,SAAS,iBAAiB,EACpE,IAAI,EAAE,UAAU,EAChB,EAAE,EAAE,MAAM,GACT,iBAAiB,CAAC,UAAU,CAAC,CAE/B"}
@@ -5,17 +5,11 @@
5
5
  */
6
6
  export var AccountWalletType;
7
7
  (function (AccountWalletType) {
8
- /**
9
- * Wallet grouping accounts based on their entropy source.
10
- */
8
+ /** Wallet grouping accounts based on their entropy source. */
11
9
  AccountWalletType["Entropy"] = "entropy";
12
- /**
13
- * Wallet grouping accounts based on their keyring's type.
14
- */
10
+ /** Wallet grouping accounts based on their keyring's type. */
15
11
  AccountWalletType["Keyring"] = "keyring";
16
- /**
17
- * Wallet grouping accounts associated with an account management Snap.
18
- */
12
+ /** Wallet grouping accounts associated with an account management Snap. */
19
13
  AccountWalletType["Snap"] = "snap";
20
14
  })(AccountWalletType || (AccountWalletType = {}));
21
15
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,CAAN,IAAY,iBAeX;AAfD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,kCAAa,CAAA;AACf,CAAC,EAfW,iBAAiB,KAAjB,iBAAiB,QAe5B;AAqCD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAuB,EACvB,EAAU;IAEV,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountGroup, AccountGroupId } from './group';\n\n/**\n * Wallet type.\n *\n * Each wallet types groups accounts using different criterias.\n */\nexport enum AccountWalletType {\n /**\n * Wallet grouping accounts based on their entropy source.\n */\n Entropy = 'entropy',\n\n /**\n * Wallet grouping accounts based on their keyring's type.\n */\n Keyring = 'keyring',\n\n /**\n * Wallet grouping accounts associated with an account management Snap.\n */\n Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletType}:${string}`;\n\n/**\n * Account wallet that can hold multiple account groups.\n */\nexport type AccountWallet<Account extends KeyringAccount> = {\n /**\n * Account wallet ID.\n */\n get id(): AccountWalletId;\n\n /**\n * Account wallet type.\n */\n get type(): AccountWalletType;\n\n /**\n * Gets account group for a given ID.\n *\n * @param id - Account group ID.\n * @returns Account group.\n */\n getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;\n\n /**\n * Gets all account groups.\n *\n * @returns Account groups.\n */\n getAccountGroups(): AccountGroup<Account>[];\n};\n\n/**\n * Convert a unique ID to a wallet ID for a given type.\n *\n * @param type - A wallet type.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId(\n type: AccountWalletType,\n id: string,\n): AccountWalletId {\n return `${type}:${id}`;\n}\n"]}
1
+ {"version":3,"file":"wallet.mjs","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,CAAN,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,8DAA8D;IAC9D,wCAAmB,CAAA;IAEnB,2EAA2E;IAC3E,kCAAa,CAAA;AACf,CAAC,EATW,iBAAiB,KAAjB,iBAAiB,QAS5B;AA4CD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAgB,EAChB,EAAU;IAEV,OAAO,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;AACzB,CAAC","sourcesContent":["import type { KeyringAccount } from '@metamask/keyring-api';\n\n// Circular import are allowed when using `import type`.\nimport type { AccountGroup, AccountGroupId } from './group';\n\n/**\n * Wallet type.\n *\n * Each wallet types groups accounts using different criterias.\n */\nexport enum AccountWalletType {\n /** Wallet grouping accounts based on their entropy source. */\n Entropy = 'entropy',\n\n /** Wallet grouping accounts based on their keyring's type. */\n Keyring = 'keyring',\n\n /** Wallet grouping accounts associated with an account management Snap. */\n Snap = 'snap',\n}\n\n/**\n * Account wallet ID.\n */\nexport type AccountWalletId = `${AccountWalletType}:${string}`;\n\n/**\n * Account wallet that can hold multiple account groups.\n */\nexport type AccountWallet<Account extends KeyringAccount> = {\n /**\n * Account wallet ID.\n */\n get id(): AccountWalletId;\n\n /**\n * Account wallet type.\n */\n get type(): AccountWalletType;\n\n /**\n * Gets account group for a given ID.\n *\n * @param id - Account group ID.\n * @returns Account group.\n */\n getAccountGroup(id: AccountGroupId): AccountGroup<Account> | undefined;\n\n /**\n * Gets all account groups.\n *\n * @returns Account groups.\n */\n getAccountGroups(): AccountGroup<Account>[];\n};\n\n/**\n * Type utility to compute a constrained {@link AccountWalletId} type given a\n * specifc {@link AccountWalletType}.\n */\nexport type AccountWalletIdOf<WalletType extends AccountWalletType> =\n `${WalletType}:${string}`;\n\n/**\n * Convert a unique ID to a wallet ID for a given type.\n *\n * @param type - A wallet type.\n * @param id - A unique ID.\n * @returns A wallet ID.\n */\nexport function toAccountWalletId<WalletType extends AccountWalletType>(\n type: WalletType,\n id: string,\n): AccountWalletIdOf<WalletType> {\n return `${type}:${id}`;\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask-previews/account-api",
3
- "version": "0.3.0-9522cc5",
3
+ "version": "0.6.0-9cb78a8",
4
4
  "description": "MetaMask Account API",
5
5
  "keywords": [
6
6
  "metamask",
@@ -47,7 +47,6 @@
47
47
  },
48
48
  "dependencies": {
49
49
  "@metamask/keyring-api": "19.1.0",
50
- "@metamask/keyring-utils": "3.1.0",
51
50
  "@metamask/superstruct": "^3.1.0"
52
51
  },
53
52
  "devDependencies": {
@@ -58,7 +57,6 @@
58
57
  "@ts-bridge/cli": "^0.6.3",
59
58
  "@types/jest": "^29.5.12",
60
59
  "@types/node": "^20.12.12",
61
- "@types/uuid": "^9.0.8",
62
60
  "deepmerge": "^4.2.2",
63
61
  "depcheck": "^1.4.7",
64
62
  "jest": "^29.5.0",
@@ -68,8 +66,7 @@
68
66
  "ts-node": "^10.9.2",
69
67
  "tsd": "^0.31.0",
70
68
  "typedoc": "^0.25.13",
71
- "typescript": "~5.6.3",
72
- "uuid": "^9.0.1"
69
+ "typescript": "~5.6.3"
73
70
  },
74
71
  "engines": {
75
72
  "node": "^18.18 || >=20"
@@ -1,230 +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 _MultichainAccount_id, _MultichainAccount_wallet, _MultichainAccount_index, _MultichainAccount_providers, _MultichainAccount_providerToAccounts, _MultichainAccount_accountToProvider;
14
- Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.MultichainAccount = void 0;
16
- exports.toMultichainAccountId = toMultichainAccountId;
17
- exports.isMultichainAccountId = isMultichainAccountId;
18
- exports.getGroupIndexFromMultichainAccountId = getGroupIndexFromMultichainAccountId;
19
- const keyring_utils_1 = require("@metamask/keyring-utils");
20
- const group_1 = require("../group.cjs");
21
- const wallet_1 = require("../wallet.cjs");
22
- const MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(`^${wallet_1.AccountWalletType.Entropy}:.*/(?<groupIndex>\\d+)$`, 'u');
23
- /**
24
- * A multichain account that holds multiple accounts.
25
- */
26
- class MultichainAccount {
27
- constructor({ groupIndex, wallet, providers, }) {
28
- _MultichainAccount_id.set(this, void 0);
29
- _MultichainAccount_wallet.set(this, void 0);
30
- _MultichainAccount_index.set(this, void 0);
31
- _MultichainAccount_providers.set(this, void 0);
32
- _MultichainAccount_providerToAccounts.set(this, void 0);
33
- _MultichainAccount_accountToProvider.set(this, void 0);
34
- __classPrivateFieldSet(this, _MultichainAccount_id, toMultichainAccountId(wallet.id, groupIndex), "f");
35
- __classPrivateFieldSet(this, _MultichainAccount_index, groupIndex, "f");
36
- __classPrivateFieldSet(this, _MultichainAccount_wallet, wallet, "f");
37
- __classPrivateFieldSet(this, _MultichainAccount_providers, providers, "f");
38
- __classPrivateFieldSet(this, _MultichainAccount_providerToAccounts, new Map(), "f");
39
- __classPrivateFieldSet(this, _MultichainAccount_accountToProvider, new Map(), "f");
40
- this.sync();
41
- }
42
- /**
43
- * Force multichain account synchronization.
44
- *
45
- * This can be used if account providers got new accounts that the multichain
46
- * account doesn't know about.
47
- */
48
- sync() {
49
- // Clear reverse mapping and re-construct it entirely based on the refreshed
50
- // list of accounts from each providers.
51
- __classPrivateFieldGet(this, _MultichainAccount_accountToProvider, "f").clear();
52
- for (const provider of __classPrivateFieldGet(this, _MultichainAccount_providers, "f")) {
53
- // Filter account only for that index.
54
- const accounts = [];
55
- for (const account of provider.getAccounts()) {
56
- if (account.options.entropy.id === this.wallet.entropySource &&
57
- account.options.entropy.groupIndex === this.index) {
58
- // We only use IDs to always fetch the latest version of accounts.
59
- accounts.push(account.id);
60
- }
61
- }
62
- __classPrivateFieldGet(this, _MultichainAccount_providerToAccounts, "f").set(provider, accounts);
63
- // Reverse-mapping for fast indexing.
64
- for (const id of accounts) {
65
- __classPrivateFieldGet(this, _MultichainAccount_accountToProvider, "f").set(id, provider);
66
- }
67
- }
68
- }
69
- /**
70
- * Gets the multichain account ID.
71
- *
72
- * @returns The multichain account ID.
73
- */
74
- get id() {
75
- return __classPrivateFieldGet(this, _MultichainAccount_id, "f");
76
- }
77
- /**
78
- * Gets the multichain account type.
79
- *
80
- * @returns The multichain account type.
81
- */
82
- get type() {
83
- return group_1.AccountGroupType.MultichainAccount;
84
- }
85
- /**
86
- * Gets the multichain account's wallet reference (parent).
87
- *
88
- * @returns The multichain account's wallet.
89
- */
90
- get wallet() {
91
- return __classPrivateFieldGet(this, _MultichainAccount_wallet, "f");
92
- }
93
- /**
94
- * Gets the multichain account group index.
95
- *
96
- * @returns The multichain account group index.
97
- */
98
- get index() {
99
- return __classPrivateFieldGet(this, _MultichainAccount_index, "f");
100
- }
101
- /**
102
- * Checks if there's any underlying accounts for this multichain accounts.
103
- *
104
- * @returns True if there's any underlying accounts, false otherwise.
105
- */
106
- hasAccounts() {
107
- // If there's anything in the reverse-map, it means we have some accounts.
108
- return __classPrivateFieldGet(this, _MultichainAccount_accountToProvider, "f").size > 0;
109
- }
110
- /**
111
- * Gets the accounts for this multichain account.
112
- *
113
- * @returns The accounts.
114
- */
115
- getAccounts() {
116
- const allAccounts = [];
117
- for (const [provider, accounts] of __classPrivateFieldGet(this, _MultichainAccount_providerToAccounts, "f").entries()) {
118
- for (const id of accounts) {
119
- const account = provider.getAccount(id);
120
- if (account) {
121
- // If for some reason we cannot get this account from the provider, it
122
- // might means it has been deleted or something, so we just filter it
123
- // out.
124
- allAccounts.push(account);
125
- }
126
- }
127
- }
128
- return allAccounts;
129
- }
130
- /**
131
- * Gets the account for a given account ID.
132
- *
133
- * @param id - Account ID.
134
- * @returns The account or undefined if not found.
135
- */
136
- getAccount(id) {
137
- const provider = __classPrivateFieldGet(this, _MultichainAccount_accountToProvider, "f").get(id);
138
- // If there's nothing in the map, it means we tried to get an account
139
- // that does not belong to this multichain account.
140
- if (!provider) {
141
- return undefined;
142
- }
143
- return provider.getAccount(id);
144
- }
145
- /**
146
- * Query an account matching the selector.
147
- *
148
- * @param selector - Query selector.
149
- * @returns The account matching the selector or undefined if not matching.
150
- * @throws If multiple accounts match the selector.
151
- */
152
- get(selector) {
153
- const accounts = this.select(selector);
154
- if (accounts.length > 1) {
155
- throw new Error(`Too many account candidates, expected 1, got: ${accounts.length}`);
156
- }
157
- if (accounts.length === 0) {
158
- return undefined;
159
- }
160
- return accounts[0]; // This is safe, see checks above.
161
- }
162
- /**
163
- * Query accounts matching the selector.
164
- *
165
- * @param selector - Query selector.
166
- * @returns The accounts matching the selector.
167
- */
168
- select(selector) {
169
- return this.getAccounts().filter((account) => {
170
- let selected = true;
171
- if (selector.id) {
172
- selected && (selected = account.id === selector.id);
173
- }
174
- if (selector.address) {
175
- selected && (selected = account.address === selector.address);
176
- }
177
- if (selector.type) {
178
- selected && (selected = account.type === selector.type);
179
- }
180
- if (selector.methods !== undefined) {
181
- selected && (selected = selector.methods.some((method) => account.methods.includes(method)));
182
- }
183
- if (selector.scopes !== undefined) {
184
- selected && (selected = selector.scopes.some((scope) => {
185
- return (
186
- // This will cover specific EVM EOA scopes as well.
187
- (0, keyring_utils_1.isScopeEqualToAny)(scope, account.scopes));
188
- }));
189
- }
190
- return selected;
191
- });
192
- }
193
- }
194
- exports.MultichainAccount = MultichainAccount;
195
- _MultichainAccount_id = new WeakMap(), _MultichainAccount_wallet = new WeakMap(), _MultichainAccount_index = new WeakMap(), _MultichainAccount_providers = new WeakMap(), _MultichainAccount_providerToAccounts = new WeakMap(), _MultichainAccount_accountToProvider = new WeakMap();
196
- /**
197
- * Gets the multichain account ID from its multichain account wallet ID and its index.
198
- *
199
- * @param walletId - Multichain account wallet ID.
200
- * @param groupIndex - Index of that multichain account.
201
- * @returns The multichain account ID.
202
- */
203
- function toMultichainAccountId(walletId, groupIndex) {
204
- return `${walletId}/${groupIndex}`;
205
- }
206
- /**
207
- * Checks if the given value is {@link MultichainAccountId}.
208
- *
209
- * @param value - The value to check.
210
- * @returns Whether the value is a {@link MultichainAccountId}.
211
- */
212
- function isMultichainAccountId(value) {
213
- return MULTICHAIN_ACCOUNT_ID_REGEX.test(value);
214
- }
215
- /**
216
- * Gets the multichain account index from an account group ID.
217
- *
218
- * @param id - Multichain account ID.
219
- * @returns The multichain account index if extractable, undefined otherwise.
220
- */
221
- function getGroupIndexFromMultichainAccountId(id) {
222
- const matched = id.match(MULTICHAIN_ACCOUNT_ID_REGEX);
223
- if (matched?.groups?.groupIndex === undefined) {
224
- // Unable to extract group index, even though, type wise, this should not
225
- // be possible!
226
- throw new Error('Unable to extract group index');
227
- }
228
- return Number(matched.groups.groupIndex);
229
- }
230
- //# sourceMappingURL=account.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"account.cjs","sourceRoot":"","sources":["../../../src/api/multichain/account.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAwPA,sDAKC;AAQD,sDAIC;AAQD,oFAWC;AA3RD,2DAA4D;AAQ5D,wCAA4C;AAG5C,0CAA8C;AAE9C,MAAM,2BAA2B,GAAG,IAAI,MAAM,CAC5C,IAAI,0BAAiB,CAAC,OAAO,0BAA0B,EACvD,GAAG,CACJ,CAAC;AAOF;;GAEG;AACH,MAAa,iBAAiB;IAe5B,YAAY,EACV,UAAU,EACV,MAAM,EACN,SAAS,GAKV;QApBQ,wCAAyB;QAEzB,4CAA0C;QAE1C,2CAAe;QAEf,+CAAuC;QAEvC,wDAAoE;QAEpE,uDAAiE;QAWxE,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;QAC5B,uBAAA,IAAI,yCAAuB,IAAI,GAAG,EAAE,MAAA,CAAC;QACrC,uBAAA,IAAI,wCAAsB,IAAI,GAAG,EAAE,MAAA,CAAC;QAEpC,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACF,4EAA4E;QAC5E,wCAAwC;QACxC,uBAAA,IAAI,4CAAmB,CAAC,KAAK,EAAE,CAAC;QAEhC,KAAK,MAAM,QAAQ,IAAI,uBAAA,IAAI,oCAAW,EAAE,CAAC;YACvC,sCAAsC;YACtC,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;gBAC7C,IACE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,aAAa;oBACxD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,EACjD,CAAC;oBACD,kEAAkE;oBAClE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;YACD,uBAAA,IAAI,6CAAoB,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAEjD,qCAAqC;YACrC,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC1B,uBAAA,IAAI,4CAAmB,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,6BAAI,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,wBAAgB,CAAC,iBAAiB,CAAC;IAC5C,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,0EAA0E;QAC1E,OAAO,uBAAA,IAAI,4CAAmB,CAAC,IAAI,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,MAAM,WAAW,GAAc,EAAE,CAAC;QAElC,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,uBAAA,IAAI,6CAAoB,CAAC,OAAO,EAAE,EAAE,CAAC;YACtE,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;gBAExC,IAAI,OAAO,EAAE,CAAC;oBACZ,sEAAsE;oBACtE,qEAAqE;oBACrE,OAAO;oBACP,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,EAAiB;QAC1B,MAAM,QAAQ,GAAG,uBAAA,IAAI,4CAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEjD,qEAAqE;QACrE,mDAAmD;QACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACjC,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,IAAA,iCAAiB,EAAC,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;AApND,8CAoNC;;AAED;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,QAAmC,EACnC,UAAkB;IAElB,OAAO,GAAG,QAAQ,IAAI,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,KAAa;IAEb,OAAO,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,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 { type KeyringAccount } from '@metamask/keyring-api';\nimport { isScopeEqualToAny } from '@metamask/keyring-utils';\n\nimport type {\n MultichainAccountWallet,\n MultichainAccountWalletId,\n} from './wallet';\nimport type { Bip44Account } from '../bip44';\nimport type { AccountGroup } from '../group';\nimport { AccountGroupType } from '../group';\nimport type { AccountProvider } from '../provider';\nimport type { AccountSelector } from '../selector';\nimport { AccountWalletType } from '../wallet';\n\nconst MULTICHAIN_ACCOUNT_ID_REGEX = new RegExp(\n `^${AccountWalletType.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 Bip44Account<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 readonly #providerToAccounts: Map<AccountProvider<Account>, Account['id'][]>;\n\n readonly #accountToProvider: Map<Account['id'], 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 this.#providerToAccounts = new Map();\n this.#accountToProvider = new Map();\n\n this.sync();\n }\n\n /**\n * Force multichain account synchronization.\n *\n * This can be used if account providers got new accounts that the multichain\n * account doesn't know about.\n */\n sync(): void {\n // Clear reverse mapping and re-construct it entirely based on the refreshed\n // list of accounts from each providers.\n this.#accountToProvider.clear();\n\n for (const provider of this.#providers) {\n // Filter account only for that index.\n const accounts = [];\n for (const account of provider.getAccounts()) {\n if (\n account.options.entropy.id === this.wallet.entropySource &&\n account.options.entropy.groupIndex === this.index\n ) {\n // We only use IDs to always fetch the latest version of accounts.\n accounts.push(account.id);\n }\n }\n this.#providerToAccounts.set(provider, accounts);\n\n // Reverse-mapping for fast indexing.\n for (const id of accounts) {\n this.#accountToProvider.set(id, provider);\n }\n }\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 type.\n *\n * @returns The multichain account type.\n */\n get type(): AccountGroupType.MultichainAccount {\n return AccountGroupType.MultichainAccount;\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 // If there's anything in the reverse-map, it means we have some accounts.\n return this.#accountToProvider.size > 0;\n }\n\n /**\n * Gets the accounts for this multichain account.\n *\n * @returns The accounts.\n */\n getAccounts(): Account[] {\n const allAccounts: Account[] = [];\n\n for (const [provider, accounts] of this.#providerToAccounts.entries()) {\n for (const id of accounts) {\n const account = provider.getAccount(id);\n\n if (account) {\n // If for some reason we cannot get this account from the provider, it\n // might means it has been deleted or something, so we just filter it\n // out.\n allAccounts.push(account);\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 const provider = this.#accountToProvider.get(id);\n\n // If there's nothing in the map, it means we tried to get an account\n // that does not belong to this multichain account.\n if (!provider) {\n return undefined;\n }\n return provider.getAccount(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,110 +0,0 @@
1
- import { type KeyringAccount } from "@metamask/keyring-api";
2
- import type { MultichainAccountWallet, MultichainAccountWalletId } from "./wallet.cjs";
3
- import type { Bip44Account } from "../bip44.cjs";
4
- import type { AccountGroup } from "../group.cjs";
5
- import { AccountGroupType } from "../group.cjs";
6
- import type { AccountProvider } from "../provider.cjs";
7
- import type { AccountSelector } from "../selector.cjs";
8
- /**
9
- * Multichain account ID.
10
- */
11
- export type MultichainAccountId = `${MultichainAccountWalletId}/${number}`;
12
- /**
13
- * A multichain account that holds multiple accounts.
14
- */
15
- export declare class MultichainAccount<Account extends Bip44Account<KeyringAccount>> implements AccountGroup<Account> {
16
- #private;
17
- constructor({ groupIndex, wallet, providers, }: {
18
- groupIndex: number;
19
- wallet: MultichainAccountWallet<Account>;
20
- providers: AccountProvider<Account>[];
21
- });
22
- /**
23
- * Force multichain account synchronization.
24
- *
25
- * This can be used if account providers got new accounts that the multichain
26
- * account doesn't know about.
27
- */
28
- sync(): void;
29
- /**
30
- * Gets the multichain account ID.
31
- *
32
- * @returns The multichain account ID.
33
- */
34
- get id(): MultichainAccountId;
35
- /**
36
- * Gets the multichain account type.
37
- *
38
- * @returns The multichain account type.
39
- */
40
- get type(): AccountGroupType.MultichainAccount;
41
- /**
42
- * Gets the multichain account's wallet reference (parent).
43
- *
44
- * @returns The multichain account's wallet.
45
- */
46
- get wallet(): MultichainAccountWallet<Account>;
47
- /**
48
- * Gets the multichain account group index.
49
- *
50
- * @returns The multichain account group index.
51
- */
52
- get index(): number;
53
- /**
54
- * Checks if there's any underlying accounts for this multichain accounts.
55
- *
56
- * @returns True if there's any underlying accounts, false otherwise.
57
- */
58
- hasAccounts(): boolean;
59
- /**
60
- * Gets the accounts for this multichain account.
61
- *
62
- * @returns The accounts.
63
- */
64
- getAccounts(): Account[];
65
- /**
66
- * Gets the account for a given account ID.
67
- *
68
- * @param id - Account ID.
69
- * @returns The account or undefined if not found.
70
- */
71
- getAccount(id: Account['id']): Account | undefined;
72
- /**
73
- * Query an account matching the selector.
74
- *
75
- * @param selector - Query selector.
76
- * @returns The account matching the selector or undefined if not matching.
77
- * @throws If multiple accounts match the selector.
78
- */
79
- get(selector: AccountSelector<Account>): Account | undefined;
80
- /**
81
- * Query accounts matching the selector.
82
- *
83
- * @param selector - Query selector.
84
- * @returns The accounts matching the selector.
85
- */
86
- select(selector: AccountSelector<Account>): Account[];
87
- }
88
- /**
89
- * Gets the multichain account ID from its multichain account wallet ID and its index.
90
- *
91
- * @param walletId - Multichain account wallet ID.
92
- * @param groupIndex - Index of that multichain account.
93
- * @returns The multichain account ID.
94
- */
95
- export declare function toMultichainAccountId(walletId: MultichainAccountWalletId, groupIndex: number): MultichainAccountId;
96
- /**
97
- * Checks if the given value is {@link MultichainAccountId}.
98
- *
99
- * @param value - The value to check.
100
- * @returns Whether the value is a {@link MultichainAccountId}.
101
- */
102
- export declare function isMultichainAccountId(value: string): value is MultichainAccountId;
103
- /**
104
- * Gets the multichain account index from an account group ID.
105
- *
106
- * @param id - Multichain account ID.
107
- * @returns The multichain account index if extractable, undefined otherwise.
108
- */
109
- export declare function getGroupIndexFromMultichainAccountId(id: MultichainAccountId): number;
110
- //# sourceMappingURL=account.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"account.d.cts","sourceRoot":"","sources":["../../../src/api/multichain/account.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,8BAA8B;AAG5D,OAAO,KAAK,EACV,uBAAuB,EACvB,yBAAyB,EAC1B,qBAAiB;AAClB,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAiB;AAC7C,OAAO,EAAE,gBAAgB,EAAE,qBAAiB;AAC5C,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,YAAY,CAAC,cAAc,CAAC,CACzE,YAAW,YAAY,CAAC,OAAO,CAAC;;gBAcpB,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;IAWD;;;;;OAKG;IACH,IAAI,IAAI,IAAI;IA0BZ;;;;OAIG;IACH,IAAI,EAAE,IAAI,mBAAmB,CAE5B;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,gBAAgB,CAAC,iBAAiB,CAE7C;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;IAKtB;;;;OAIG;IACH,WAAW,IAAI,OAAO,EAAE;IAmBxB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,GAAG,SAAS;IAWlD;;;;;;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"}