@metamask/multichain-account-service/dist/MultichainAccountWallet.cjs.map

Service to manage multichain accounts

{"version":3,"file":"MultichainAccountWallet.cjs","sourceRoot":"","sources":["../src/MultichainAccountWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAI+B;AAC/B,uDAAgE;AAChE,uDAA0D;AAa1D,yEAAkE;AAElE;;;GAGG;AACH,MAAa,uBAAuB;IAYlC,YAAY,EACV,SAAS,EACT,aAAa,GAId;QAdQ,8CAA+B;QAE/B,qDAAuC;QAEvC,yDAAgC;QAEhC,yDAA6D;QASpE,uBAAA,IAAI,+BAAO,IAAA,yCAA2B,EAAC,aAAa,CAAC,MAAA,CAAC;QACtD,uBAAA,IAAI,sCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,0CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,0CAAkB,IAAI,GAAG,EAAE,MAAA,CAAC;QAEhC,2BAA2B;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACF,KAAK,MAAM,QAAQ,IAAI,uBAAA,IAAI,0CAAW,EAAE;YACtC,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE;gBAC5C,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;gBAEpC,+BAA+B;gBAC/B,IAAI,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,aAAa,EAAE;oBACrC,SAAS;iBACV;gBAED,gDAAgD;gBAChD,IAAI,iBAAiB,GAAG,uBAAA,IAAI,8CAAe,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;gBACpE,IAAI,CAAC,iBAAiB,EAAE;oBACtB,iBAAiB,GAAG,IAAI,+CAAsB,CAAU;wBACtD,UAAU,EAAE,OAAO,CAAC,UAAU;wBAC9B,MAAM,EAAE,IAAI;wBACZ,SAAS,EAAE,uBAAA,IAAI,0CAAW;qBAC3B,CAAC,CAAC;oBAEH,+DAA+D;oBAC/D,+DAA+D;oBAC/D,iEAAiE;oBACjE,iEAAiE;oBACjE,8DAA8D;oBAC9D,EAAE;oBACF,kEAAkE;oBAClE,wBAAwB;oBACxB,gEAAgE;oBAEhE,uBAAA,IAAI,8CAAe,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;iBAChE;aACF;SACF;QAED,oDAAoD;QACpD,KAAK,MAAM,CACT,UAAU,EACV,iBAAiB,EAClB,IAAI,uBAAA,IAAI,8CAAe,CAAC,OAAO,EAAE,EAAE;YAClC,iBAAiB,CAAC,IAAI,EAAE,CAAC;YAEzB,oCAAoC;YACpC,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,EAAE;gBACpC,uBAAA,IAAI,8CAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;aACxC;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,OAAO,uBAAA,IAAI,mCAAI,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,+BAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,uBAAA,IAAI,8CAAe,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,EAAkB;QAElB,0DAA0D;QAC1D,IAAI,EAAE,KAAK,IAAA,qCAAuB,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAC3C,OAAO,uBAAA,IAAI,8CAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACnC;QAED,6DAA6D;QAC7D,4BAA4B;QAC5B,IAAI,CAAC,IAAA,wCAA0B,EAAC,EAAE,CAAC,EAAE;YACnC,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,UAAU,GAAG,IAAA,uDAAyC,EAAC,EAAE,CAAC,CAAC;QACjE,OAAO,uBAAA,IAAI,8CAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,0BAA0B,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,yBAAyB,CACvB,UAAkB;QAElB,OAAO,uBAAA,IAAI,8CAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,0BAA0B;QACxB,OAAO,KAAK,CAAC,IAAI,CAAC,uBAAA,IAAI,8CAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,2BAA2B;IAC9E,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,4BAA4B;QAC5B,OAAO,CACL,IAAI,CAAC,GAAG,CACN,CAAC,CAAC,EAAE,wCAAwC;QAC5C,GAAG,uBAAA,IAAI,8CAAe,CAAC,IAAI,EAAE,CAC9B,GAAG,CAAC,CACN,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,4BAA4B,CAChC,UAAkB;QAElB,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAChD,IAAI,UAAU,GAAG,cAAc,EAAE;YAC/B,MAAM,IAAI,KAAK,CACb,uFAAuF,cAAc,SAAS,UAAU,EAAE,CAC3H,CAAC;SACH;QAED,IAAI,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,KAAK,EAAE;YACT,sEAAsE;YACtE,aAAa;YACb,KAAK,CAAC,IAAI,EAAE,CAAC;YAEb,OAAO,KAAK,CAAC;SACd;QAED,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACtC,uBAAA,IAAI,0CAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/B,QAAQ,CAAC,cAAc,CAAC;YACtB,aAAa,EAAE,uBAAA,IAAI,8CAAe;YAClC,UAAU;SACX,CAAC,CACH,CACF,CAAC;QAEF,mFAAmF;QACnF,uBAAuB;QACvB,EAAE;QACF,iFAAiF;QACjF,oFAAoF;QACpF,kFAAkF;QAClF,iFAAiF;QACjF,EAAE;QACF,qDAAqD;QACrD,2EAA2E;QAC3E,oEAAoE;QACpE,uEAAuE;QACvE,oFAAoF;QACpF,qEAAqE;QACrE,uDAAuD;QACvD,sFAAsF;QACtF,kFAAkF;QAClF,oFAAoF;QACpF,0DAA0D;QAC1D,EAAE;QACF,mFAAmF;QAEnF,+EAA+E;QAC/E,+CAA+C;QAC/C,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,EAAE;YAC1D,mFAAmF;YACnF,uBAAuB;YACvB,MAAM,KAAK,GAAG,wDAAwD,UAAU,EAAE,CAAC;YAEnF,IAAI,IAAI,GAAG,GAAG,KAAK,GAAG,CAAC;YACvB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;gBAC5B,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE;oBAChC,IAAI,IAAI,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;iBAChC;aACF;YACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEnB,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;SACxB;QAED,iFAAiF;QACjF,oCAAoC;QACpC,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,EAAE;YACV,+EAA+E;YAC/E,KAAK,GAAG,IAAI,+CAAsB,CAAC;gBACjC,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,uBAAA,IAAI,0CAAW;gBAC1B,UAAU;aACX,CAAC,CAAC;SACJ;QAED,4CAA4C;QAC5C,uBAAA,IAAI,8CAAe,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,oCAAoC;QAEhF,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gCAAgC;QAGpC,OAAO,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACjD,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,UAAkB;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,KAAK,EAAE;YACT,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;SACrB;IACH,CAAC;CACF;AA/SD,0DA+SC","sourcesContent":["import {\n  getGroupIndexFromMultichainAccountGroupId,\n  isMultichainAccountGroupId,\n  toMultichainAccountWalletId,\n} from '@metamask/account-api';\nimport { toDefaultAccountGroupId } from '@metamask/account-api';\nimport { AccountWalletType } from '@metamask/account-api';\nimport type {\n  Bip44Account,\n  MultichainAccountWalletId,\n  MultichainAccountWallet as MultichainAccountWalletDefinition,\n} from '@metamask/account-api';\nimport type { AccountGroupId } from '@metamask/account-api';\nimport type { AccountProvider } from '@metamask/account-api';\nimport {\n  type EntropySourceId,\n  type KeyringAccount,\n} from '@metamask/keyring-api';\n\nimport { MultichainAccountGroup } from './MultichainAccountGroup';\n\n/**\n * A multichain account wallet that holds multiple multichain accounts (one multichain account per\n * group index).\n */\nexport class MultichainAccountWallet<\n  Account extends Bip44Account<KeyringAccount>,\n> implements MultichainAccountWalletDefinition<Account>\n{\n  readonly #id: MultichainAccountWalletId;\n\n  readonly #providers: AccountProvider<Account>[];\n\n  readonly #entropySource: EntropySourceId;\n\n  readonly #accountGroups: Map<number, MultichainAccountGroup<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.#accountGroups = new Map();\n\n    // Initial synchronization.\n    this.sync();\n  }\n\n  /**\n   * Force wallet synchronization.\n   *\n   * This can be used if account providers got new accounts that the wallet\n   * doesn't know about.\n   */\n  sync(): void {\n    for (const provider of this.#providers) {\n      for (const account of provider.getAccounts()) {\n        const { entropy } = account.options;\n\n        // Filter for this wallet only.\n        if (entropy.id !== this.entropySource) {\n          continue;\n        }\n\n        // This multichain account might exists already.\n        let multichainAccount = this.#accountGroups.get(entropy.groupIndex);\n        if (!multichainAccount) {\n          multichainAccount = new MultichainAccountGroup<Account>({\n            groupIndex: entropy.groupIndex,\n            wallet: this,\n            providers: this.#providers,\n          });\n\n          // This existing multichain account group might differ from the\n          // `createMultichainAccountGroup` behavior. When creating a new\n          // group, we expect the providers to all succeed. But here, we're\n          // just fetching the account lists from them, so this group might\n          // not be \"aligned\" yet (e.g having a missing Solana account).\n          //\n          // Since \"aligning\" is an async operation, it would have to be run\n          // after the first-sync.\n          // TODO: Implement align mechanism to create \"missing\" accounts.\n\n          this.#accountGroups.set(entropy.groupIndex, multichainAccount);\n        }\n      }\n    }\n\n    // Now force-sync all remaining multichain accounts.\n    for (const [\n      groupIndex,\n      multichainAccount,\n    ] of this.#accountGroups.entries()) {\n      multichainAccount.sync();\n\n      // Clean up old multichain accounts.\n      if (!multichainAccount.hasAccounts()) {\n        this.#accountGroups.delete(groupIndex);\n      }\n    }\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 type, which is always {@link AccountWalletType.Entropy}.\n   *\n   * @returns The multichain account wallet type.\n   */\n  get type(): AccountWalletType.Entropy {\n    return AccountWalletType.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(\n    id: AccountGroupId,\n  ): MultichainAccountGroup<Account> | undefined {\n    // We consider the \"default case\" to be mapped to index 0.\n    if (id === toDefaultAccountGroupId(this.id)) {\n      return this.#accountGroups.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 (!isMultichainAccountGroupId(id)) {\n      return undefined;\n    }\n\n    const groupIndex = getGroupIndexFromMultichainAccountGroupId(id);\n    return this.#accountGroups.get(groupIndex);\n  }\n\n  /**\n   * Gets all multichain accounts. Similar to {@link MultichainAccountWallet.getMultichainAccountGroups}.\n   *\n   * @returns The multichain accounts.\n   */\n  getAccountGroups(): MultichainAccountGroup<Account>[] {\n    return this.getMultichainAccountGroups();\n  }\n\n  /**\n   * Gets multichain account group for a given index.\n   *\n   * @param groupIndex - Multichain account index.\n   * @returns The multichain account associated with the given index.\n   */\n  getMultichainAccountGroup(\n    groupIndex: number,\n  ): MultichainAccountGroup<Account> | undefined {\n    return this.#accountGroups.get(groupIndex);\n  }\n\n  /**\n   * Gets all multichain account groups.\n   *\n   * @returns The multichain accounts.\n   */\n  getMultichainAccountGroups(): MultichainAccountGroup<Account>[] {\n    return Array.from(this.#accountGroups.values()); // TODO: Prevent copy here.\n  }\n\n  /**\n   * Gets next group index for this wallet.\n   *\n   * @returns The next group index of this wallet.\n   */\n  getNextGroupIndex(): number {\n    // We do not check for gaps.\n    return (\n      Math.max(\n        -1, // So it will default to 0 if no groups.\n        ...this.#accountGroups.keys(),\n      ) + 1\n    );\n  }\n\n  /**\n   * Creates a multichain account group for a given group index.\n   *\n   * @param groupIndex - The group index to use.\n   * @throws If any of the account providers fails to create their accounts.\n   * @returns The multichain account group for this group index.\n   */\n  async createMultichainAccountGroup(\n    groupIndex: number,\n  ): Promise<MultichainAccountGroup<Account>> {\n    const nextGroupIndex = this.getNextGroupIndex();\n    if (groupIndex > nextGroupIndex) {\n      throw new Error(\n        `You cannot use a group index that is higher than the next available one: expected <=${nextGroupIndex}, got ${groupIndex}`,\n      );\n    }\n\n    let group = this.getMultichainAccountGroup(groupIndex);\n    if (group) {\n      // If the group already exists, we just `sync` it and returns the same\n      // reference.\n      group.sync();\n\n      return group;\n    }\n\n    const results = await Promise.allSettled(\n      this.#providers.map((provider) =>\n        provider.createAccounts({\n          entropySource: this.#entropySource,\n          groupIndex,\n        }),\n      ),\n    );\n\n    // --------------------------------------------------------------------------------\n    // READ THIS CAREFULLY:\n    //\n    // Since we're not \"fully supporting multichain\" for now, we still rely on single\n    // :accountCreated events to sync multichain account groups and wallets. Which means\n    // that even if of the provider fails, some accounts will still be created on some\n    // other providers and will become \"available\" on the `AccountsController`, like:\n    //\n    // 1. Creating a multichain account group for index 1\n    // 2. EvmAccountProvider.createAccounts returns the EVM account for index 1\n    //   * AccountsController WILL fire :accountCreated for this account\n    //   * This account WILL BE \"available\" on the AccountsController state\n    // 3. SolAccountProvider.createAccounts fails to create a Solana account for index 1\n    //   * AccountsController WON't fire :accountCreated for this account\n    //   * This account WON'T be \"available\" on the Account\n    // 4. MultichainAccountService will receive a :accountCreated for the EVM account from\n    // step 2 and will create a new multichain account group for index 1, but it won't\n    // receive any event for the Solana account of this group. Thus, this group won't be\n    // \"aligned\" (missing \"blockchain account\" on this group).\n    //\n    // --------------------------------------------------------------------------------\n\n    // If any of the provider failed to create their accounts, then we consider the\n    // multichain account group to have failed too.\n    if (results.some((result) => result.status === 'rejected')) {\n      // NOTE: Some accounts might still have been created on other account providers. We\n      // don't rollback them.\n      const error = `Unable to create multichain account group for index: ${groupIndex}`;\n\n      let warn = `${error}:`;\n      for (const result of results) {\n        if (result.status === 'rejected') {\n          warn += `\\n- ${result.reason}`;\n        }\n      }\n      console.warn(warn);\n\n      throw new Error(error);\n    }\n\n    // Because of the :accountAdded automatic sync, we might already have created the\n    // group, so we first try to get it.\n    group = this.getMultichainAccountGroup(groupIndex);\n    if (!group) {\n      // If for some reason it's still not created, we're creating it explicitly now:\n      group = new MultichainAccountGroup({\n        wallet: this,\n        providers: this.#providers,\n        groupIndex,\n      });\n    }\n\n    // Register the account to our internal map.\n    this.#accountGroups.set(groupIndex, group); // `group` cannot be undefined here.\n\n    return group;\n  }\n\n  /**\n   * Creates the next multichain account group.\n   *\n   * @throws If any of the account providers fails to create their accounts.\n   * @returns The multichain account group for the next group index available.\n   */\n  async createNextMultichainAccountGroup(): Promise<\n    MultichainAccountGroup<Account>\n  > {\n    return this.createMultichainAccountGroup(this.getNextGroupIndex());\n  }\n\n  /**\n   * Align all multichain account groups.\n   */\n  async alignGroups(): Promise<void> {\n    const groups = this.getMultichainAccountGroups();\n    await Promise.all(groups.map((g) => g.align()));\n  }\n\n  /**\n   * Align a specific multichain account group.\n   *\n   * @param groupIndex - The group index to align.\n   */\n  async alignGroup(groupIndex: number): Promise<void> {\n    const group = this.getMultichainAccountGroup(groupIndex);\n    if (group) {\n      await group.align();\n    }\n  }\n}\n"]}