@metamask-previews/multichain-account-service 0.9.0-preview-988ea6d → 0.9.0-preview-8cfb0d7

package/CHANGELOG.md

@@ -13,6 +13,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add custom account provider configs ([#6624](https://github.com/MetaMask/core/pull/6624))
   - This new config can be set by the clients to update discovery timeout/retry values.
 
+### Fixed
+
+- No longer create temporary EVM account during discovery ([#6650](https://github.com/MetaMask/core/pull/6650))
+  - We used to create the EVM account and remove it if there we nore activity for that account, now we're just deriving the next address directly, which avoid state mutation.
+  - This prevents `:accountAdded` event from being published, which also prevents account-tree and multichain-account service updates.
+  - Backup & sync will no longer synchronize this temporary account group, which was causing a bug of persisting it on the user profile and to leave forever.
+
 ## [0.9.0]
 
 ### Added

package/dist/providers/EvmAccountProvider.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"EvmAccountProvider.cjs","sourceRoot":"","sources":["../../src/providers/EvmAccountProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAmD;AAInD,uDAAuD;AACvD,qEAA4D;AAM5D,2CAAsE;AAGtE,6EAIoC;AACpC,uCAAiD;AAEjD,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEnC;;;;;GAKG;AACH,SAAS,2BAA2B,CAClC,OAAoC;IAEpC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;AACH,CAAC;AAUY,QAAA,yBAAyB,GAAG,KAAc,CAAC;AAExD,MAAa,kBAAmB,SAAQ,mDAAwB;IAK9D,YACE,SAA4C,EAC5C,SAAmC;QACjC,SAAS,EAAE;YACT,WAAW,EAAE,CAAC;YACd,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,GAAG;SACf;KACF;QAED,KAAK,CAAC,SAAS,CAAC,CAAC;;QAZV,6CAAkC;QAazC,uBAAA,IAAI,8BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,mBAAmB,CAAC,OAAsC;QACxD,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,4BAAc,CAAC,GAAG;YACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAM,iCAAY,CAAC,EAAa,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,kBAAkB,CAAC,IAAI,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,gDAAgD,EAChD,oBAAoB,CACrB,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,wCAAwC,EACxC,eAAe,CAChB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAgCD,KAAK,CAAC,cAAc,CAAC,EACnB,aAAa,EACb,UAAU,GAIX;QACC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;YACV,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QAEF,gDAAgD;QAChD,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAErC,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAA,iDAAsB,EAAC,aAAa,CAAC,CAAC;QAEtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAsDD;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAGtB;QACC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE3C,MAAM,qBAAqB,GAAG,MAAM,uBAAA,IAAI,mFAA0B,MAA9B,IAAI,EAA2B;YACjE,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACtB,QAAQ,EACR,qBAAqB,CACtB,CAAC;QACF,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,EAAE,CAAC;SACX;QAED,uEAAuE;QACvE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QACH,IAAA,cAAM,EACJ,qBAAqB,KAAK,OAAO,EACjC,0DAA0D,CAC3D,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QACF,2BAA2B,CAAC,OAAO,CAAC,CAAC;QACrC,IAAA,+CAAoB,EAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;;AAzMH,gDA0MC;+HA3JC,KAAK,4CAAgB,EACnB,aAAa,EACb,UAAU,EACV,UAAU,GAAG,KAAK,GAKnB;IACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CACnC,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;SACtC;QAED,0EAA0E;QAC1E,IAAI,UAAU,IAAI,UAAU,KAAK,QAAQ,CAAC,MAAM,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvB,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,4CA6BD,KAAK,kDACH,QAAkB,EAClB,OAAY;IAEZ,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAS,EAC9B,GAAG,EAAE,CACH,IAAA,mBAAW,EACT,QAAQ,CAAC,OAAO,CAAC;QACf,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC5B,CAAC,EACF,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS,CACjC,EACH;QACE,WAAW,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,WAAW;QAC/C,SAAS,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS;KAC5C,CACF,CAAC;IAEF,OAAO,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC,iDAED,KAAK,uDAA2B,EAC9B,aAAa,EACb,UAAU,GAIX;IACC,4FAA4F;IAC5F,mCAAmC;IACnC,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,+EAA+E;QAC/E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;SAC7B;QAED,8EAA8E;QAC9E,IAAA,cAAM,EAAC,OAAO,CAAC,IAAI,EAAE,oCAAoC,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnD,IAAA,cAAM,EAAC,KAAK,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAEzD,OAAO,IAAA,aAAK,EACV,IAAA,kBAAU,EAAC,IAAA,sBAAe,EAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CACjE,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAzJM,uBAAI,GAAG,iCAAyB,AAA5B,CAA6B","sourcesContent":["import { publicToAddress } from '@ethereumjs/util';\nimport type { Bip44Account } from '@metamask/account-api';\nimport type { HdKeyring } from '@metamask/eth-hd-keyring';\nimport type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\nimport { EthAccountType } from '@metamask/keyring-api';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type {\n  EthKeyring,\n  InternalAccount,\n} from '@metamask/keyring-internal-api';\nimport type { Provider } from '@metamask/network-controller';\nimport { add0x, assert, bytesToHex, type Hex } from '@metamask/utils';\nimport type { MultichainAccountServiceMessenger } from 'src/types';\n\nimport {\n  assertAreBip44Accounts,\n  assertIsBip44Account,\n  BaseBip44AccountProvider,\n} from './BaseBip44AccountProvider';\nimport { withRetry, withTimeout } from './utils';\n\nconst ETH_MAINNET_CHAIN_ID = '0x1';\n\n/**\n * Asserts an internal account exists.\n *\n * @param account - The internal account to check.\n * @throws An error if the internal account does not exist.\n */\nfunction assertInternalAccountExists(\n  account: InternalAccount | undefined,\n): asserts account is InternalAccount {\n  if (!account) {\n    throw new Error('Internal account does not exist');\n  }\n}\n\nexport type EvmAccountProviderConfig = {\n  discovery: {\n    maxAttempts: number;\n    timeoutMs: number;\n    backOffMs: number;\n  };\n};\n\nexport const EVM_ACCOUNT_PROVIDER_NAME = 'EVM' as const;\n\nexport class EvmAccountProvider extends BaseBip44AccountProvider {\n  static NAME = EVM_ACCOUNT_PROVIDER_NAME;\n\n  readonly #config: EvmAccountProviderConfig;\n\n  constructor(\n    messenger: MultichainAccountServiceMessenger,\n    config: EvmAccountProviderConfig = {\n      discovery: {\n        maxAttempts: 3,\n        timeoutMs: 500,\n        backOffMs: 500,\n      },\n    },\n  ) {\n    super(messenger);\n    this.#config = config;\n  }\n\n  isAccountCompatible(account: Bip44Account<InternalAccount>): boolean {\n    return (\n      account.type === EthAccountType.Eoa &&\n      account.metadata.keyring.type === (KeyringTypes.hd as string)\n    );\n  }\n\n  getName(): string {\n    return EvmAccountProvider.NAME;\n  }\n\n  /**\n   * Get the EVM provider.\n   *\n   * @returns The EVM provider.\n   */\n  getEvmProvider(): Provider {\n    const networkClientId = this.messenger.call(\n      'NetworkController:findNetworkClientIdByChainId',\n      ETH_MAINNET_CHAIN_ID,\n    );\n    const { provider } = this.messenger.call(\n      'NetworkController:getNetworkClientById',\n      networkClientId,\n    );\n    return provider;\n  }\n\n  async #createAccount({\n    entropySource,\n    groupIndex,\n    throwOnGap = false,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n    throwOnGap?: boolean;\n  }): Promise<[Hex, boolean]> {\n    const result = await this.withKeyring<EthKeyring, [Hex, boolean]>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return [existing[groupIndex], false];\n        }\n\n        // If the throwOnGap flag is set, we throw an error to prevent index gaps.\n        if (throwOnGap && groupIndex !== existing.length) {\n          throw new Error('Trying to create too many accounts');\n        }\n\n        const [added] = await keyring.addAccounts(1);\n        return [added, true];\n      },\n    );\n\n    return result;\n  }\n\n  async createAccounts({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n      throwOnGap: true,\n    });\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n\n    // We MUST have the associated internal account.\n    assertInternalAccountExists(account);\n\n    const accountsArray = [account];\n    assertAreBip44Accounts(accountsArray);\n\n    return accountsArray;\n  }\n\n  async #getTransactionCount(\n    provider: Provider,\n    address: Hex,\n  ): Promise<number> {\n    const countHex = await withRetry<Hex>(\n      () =>\n        withTimeout(\n          provider.request({\n            method: 'eth_getTransactionCount',\n            params: [address, 'latest'],\n          }),\n          this.#config.discovery.timeoutMs,\n        ),\n      {\n        maxAttempts: this.#config.discovery.maxAttempts,\n        backOffMs: this.#config.discovery.backOffMs,\n      },\n    );\n\n    return parseInt(countHex, 16);\n  }\n\n  async #getAddressFromGroupIndex({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId,\n    groupIndex: number,\n  }): Promise<Hex> {\n    // NOTE: To avoid exposing this function at keyring level, we just re-use its internal state\n    // and compute the derivation here.\n    return await this.withKeyring<HdKeyring, Hex>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        // If the account already exist, do not re-derive and just re-use that account.\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return existing[groupIndex];\n        }\n\n        // If not, then we just \"peek\" the next address to avoid creating the account.\n        assert(keyring.root, 'Expected HD keyring.root to be set');\n        const hdKey = keyring.root.deriveChild(groupIndex);\n        assert(hdKey.publicKey, 'Expected public key to be set');\n\n        return add0x(\n          bytesToHex(publicToAddress(hdKey.publicKey, true)).toLowerCase(),\n        );\n      },\n    );\n  }\n\n  /**\n   * Discover and create accounts for the EVM provider.\n   *\n   * @param opts - The options for the discovery and creation of accounts.\n   * @param opts.entropySource - The entropy source to use for the discovery and creation of accounts.\n   * @param opts.groupIndex - The index of the group to create the accounts for.\n   * @returns The accounts for the EVM provider.\n   */\n  async discoverAccounts(opts: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const provider = this.getEvmProvider();\n    const { entropySource, groupIndex } = opts;\n\n    const addressFromGroupIndex = await this.#getAddressFromGroupIndex({\n      entropySource,\n      groupIndex,\n    });\n\n    const count = await this.#getTransactionCount(\n      provider,\n      addressFromGroupIndex,\n    );\n    if (count === 0) {\n      return [];\n    }\n\n    // We have some activity on this address, we try to create the account.\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n    });\n    assert(\n      addressFromGroupIndex === address,\n      'Created account does not match address from group index.',\n    );\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n    assertInternalAccountExists(account);\n    assertIsBip44Account(account);\n    return [account];\n  }\n}\n"]}
+{"version":3,"file":"EvmAccountProvider.cjs","sourceRoot":"","sources":["../../src/providers/EvmAccountProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAmD;AAInD,uDAAuD;AACvD,qEAA4D;AAM5D,2CAAsE;AAGtE,6EAIoC;AACpC,uCAAiD;AAEjD,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEnC;;;;;GAKG;AACH,SAAS,2BAA2B,CAClC,OAAoC;IAEpC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;AACH,CAAC;AAUY,QAAA,yBAAyB,GAAG,KAAc,CAAC;AAExD,MAAa,kBAAmB,SAAQ,mDAAwB;IAK9D,YACE,SAA4C,EAC5C,SAAmC;QACjC,SAAS,EAAE;YACT,WAAW,EAAE,CAAC;YACd,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,GAAG;SACf;KACF;QAED,KAAK,CAAC,SAAS,CAAC,CAAC;;QAZV,6CAAkC;QAazC,uBAAA,IAAI,8BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,mBAAmB,CAAC,OAAsC;QACxD,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,4BAAc,CAAC,GAAG;YACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAM,iCAAY,CAAC,EAAa,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,kBAAkB,CAAC,IAAI,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,gDAAgD,EAChD,oBAAoB,CACrB,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,wCAAwC,EACxC,eAAe,CAChB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAgCD,KAAK,CAAC,cAAc,CAAC,EACnB,aAAa,EACb,UAAU,GAIX;QACC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;YACV,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QAEF,gDAAgD;QAChD,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAErC,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAA,iDAAsB,EAAC,aAAa,CAAC,CAAC;QAEtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAsDD;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAGtB;QACC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE3C,MAAM,qBAAqB,GAAG,MAAM,uBAAA,IAAI,mFAA0B,MAA9B,IAAI,EAA2B;YACjE,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACtB,QAAQ,EACR,qBAAqB,CACtB,CAAC;QACF,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,EAAE,CAAC;SACX;QAED,uEAAuE;QACvE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QACH,IAAA,cAAM,EACJ,qBAAqB,KAAK,OAAO,EACjC,0DAA0D,CAC3D,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QACF,2BAA2B,CAAC,OAAO,CAAC,CAAC;QACrC,IAAA,+CAAoB,EAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;;AAzMH,gDA0MC;+HA3JC,KAAK,4CAAgB,EACnB,aAAa,EACb,UAAU,EACV,UAAU,GAAG,KAAK,GAKnB;IACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CACnC,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;SACtC;QAED,0EAA0E;QAC1E,IAAI,UAAU,IAAI,UAAU,KAAK,QAAQ,CAAC,MAAM,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvB,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,4CA6BD,KAAK,kDACH,QAAkB,EAClB,OAAY;IAEZ,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAS,EAC9B,GAAG,EAAE,CACH,IAAA,mBAAW,EACT,QAAQ,CAAC,OAAO,CAAC;QACf,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC5B,CAAC,EACF,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS,CACjC,EACH;QACE,WAAW,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,WAAW;QAC/C,SAAS,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS;KAC5C,CACF,CAAC;IAEF,OAAO,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC,iDAED,KAAK,uDAA2B,EAC9B,aAAa,EACb,UAAU,GAIX;IACC,4FAA4F;IAC5F,mCAAmC;IACnC,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,+EAA+E;QAC/E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;SAC7B;QAED,8EAA8E;QAC9E,IAAA,cAAM,EAAC,OAAO,CAAC,IAAI,EAAE,oCAAoC,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnD,IAAA,cAAM,EAAC,KAAK,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAEzD,OAAO,IAAA,aAAK,EACV,IAAA,kBAAU,EAAC,IAAA,sBAAe,EAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CACjE,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAzJM,uBAAI,GAAG,iCAAyB,AAA5B,CAA6B","sourcesContent":["import { publicToAddress } from '@ethereumjs/util';\nimport type { Bip44Account } from '@metamask/account-api';\nimport type { HdKeyring } from '@metamask/eth-hd-keyring';\nimport type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\nimport { EthAccountType } from '@metamask/keyring-api';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type {\n  EthKeyring,\n  InternalAccount,\n} from '@metamask/keyring-internal-api';\nimport type { Provider } from '@metamask/network-controller';\nimport { add0x, assert, bytesToHex, type Hex } from '@metamask/utils';\nimport type { MultichainAccountServiceMessenger } from 'src/types';\n\nimport {\n  assertAreBip44Accounts,\n  assertIsBip44Account,\n  BaseBip44AccountProvider,\n} from './BaseBip44AccountProvider';\nimport { withRetry, withTimeout } from './utils';\n\nconst ETH_MAINNET_CHAIN_ID = '0x1';\n\n/**\n * Asserts an internal account exists.\n *\n * @param account - The internal account to check.\n * @throws An error if the internal account does not exist.\n */\nfunction assertInternalAccountExists(\n  account: InternalAccount | undefined,\n): asserts account is InternalAccount {\n  if (!account) {\n    throw new Error('Internal account does not exist');\n  }\n}\n\nexport type EvmAccountProviderConfig = {\n  discovery: {\n    maxAttempts: number;\n    timeoutMs: number;\n    backOffMs: number;\n  };\n};\n\nexport const EVM_ACCOUNT_PROVIDER_NAME = 'EVM' as const;\n\nexport class EvmAccountProvider extends BaseBip44AccountProvider {\n  static NAME = EVM_ACCOUNT_PROVIDER_NAME;\n\n  readonly #config: EvmAccountProviderConfig;\n\n  constructor(\n    messenger: MultichainAccountServiceMessenger,\n    config: EvmAccountProviderConfig = {\n      discovery: {\n        maxAttempts: 3,\n        timeoutMs: 500,\n        backOffMs: 500,\n      },\n    },\n  ) {\n    super(messenger);\n    this.#config = config;\n  }\n\n  isAccountCompatible(account: Bip44Account<InternalAccount>): boolean {\n    return (\n      account.type === EthAccountType.Eoa &&\n      account.metadata.keyring.type === (KeyringTypes.hd as string)\n    );\n  }\n\n  getName(): string {\n    return EvmAccountProvider.NAME;\n  }\n\n  /**\n   * Get the EVM provider.\n   *\n   * @returns The EVM provider.\n   */\n  getEvmProvider(): Provider {\n    const networkClientId = this.messenger.call(\n      'NetworkController:findNetworkClientIdByChainId',\n      ETH_MAINNET_CHAIN_ID,\n    );\n    const { provider } = this.messenger.call(\n      'NetworkController:getNetworkClientById',\n      networkClientId,\n    );\n    return provider;\n  }\n\n  async #createAccount({\n    entropySource,\n    groupIndex,\n    throwOnGap = false,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n    throwOnGap?: boolean;\n  }): Promise<[Hex, boolean]> {\n    const result = await this.withKeyring<EthKeyring, [Hex, boolean]>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return [existing[groupIndex], false];\n        }\n\n        // If the throwOnGap flag is set, we throw an error to prevent index gaps.\n        if (throwOnGap && groupIndex !== existing.length) {\n          throw new Error('Trying to create too many accounts');\n        }\n\n        const [added] = await keyring.addAccounts(1);\n        return [added, true];\n      },\n    );\n\n    return result;\n  }\n\n  async createAccounts({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n      throwOnGap: true,\n    });\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n\n    // We MUST have the associated internal account.\n    assertInternalAccountExists(account);\n\n    const accountsArray = [account];\n    assertAreBip44Accounts(accountsArray);\n\n    return accountsArray;\n  }\n\n  async #getTransactionCount(\n    provider: Provider,\n    address: Hex,\n  ): Promise<number> {\n    const countHex = await withRetry<Hex>(\n      () =>\n        withTimeout(\n          provider.request({\n            method: 'eth_getTransactionCount',\n            params: [address, 'latest'],\n          }),\n          this.#config.discovery.timeoutMs,\n        ),\n      {\n        maxAttempts: this.#config.discovery.maxAttempts,\n        backOffMs: this.#config.discovery.backOffMs,\n      },\n    );\n\n    return parseInt(countHex, 16);\n  }\n\n  async #getAddressFromGroupIndex({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Hex> {\n    // NOTE: To avoid exposing this function at keyring level, we just re-use its internal state\n    // and compute the derivation here.\n    return await this.withKeyring<HdKeyring, Hex>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        // If the account already exist, do not re-derive and just re-use that account.\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return existing[groupIndex];\n        }\n\n        // If not, then we just \"peek\" the next address to avoid creating the account.\n        assert(keyring.root, 'Expected HD keyring.root to be set');\n        const hdKey = keyring.root.deriveChild(groupIndex);\n        assert(hdKey.publicKey, 'Expected public key to be set');\n\n        return add0x(\n          bytesToHex(publicToAddress(hdKey.publicKey, true)).toLowerCase(),\n        );\n      },\n    );\n  }\n\n  /**\n   * Discover and create accounts for the EVM provider.\n   *\n   * @param opts - The options for the discovery and creation of accounts.\n   * @param opts.entropySource - The entropy source to use for the discovery and creation of accounts.\n   * @param opts.groupIndex - The index of the group to create the accounts for.\n   * @returns The accounts for the EVM provider.\n   */\n  async discoverAccounts(opts: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const provider = this.getEvmProvider();\n    const { entropySource, groupIndex } = opts;\n\n    const addressFromGroupIndex = await this.#getAddressFromGroupIndex({\n      entropySource,\n      groupIndex,\n    });\n\n    const count = await this.#getTransactionCount(\n      provider,\n      addressFromGroupIndex,\n    );\n    if (count === 0) {\n      return [];\n    }\n\n    // We have some activity on this address, we try to create the account.\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n    });\n    assert(\n      addressFromGroupIndex === address,\n      'Created account does not match address from group index.',\n    );\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n    assertInternalAccountExists(account);\n    assertIsBip44Account(account);\n    return [account];\n  }\n}\n"]}

package/dist/providers/EvmAccountProvider.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"EvmAccountProvider.mjs","sourceRoot":"","sources":["../../src/providers/EvmAccountProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,eAAe,EAAE,yBAAyB;AAInD,OAAO,EAAE,cAAc,EAAE,8BAA8B;AACvD,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAM5D,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAY,wBAAwB;AAGtE,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACzB,uCAAmC;AACpC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAgB;AAEjD,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEnC;;;;;GAKG;AACH,SAAS,2BAA2B,CAClC,OAAoC;IAEpC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;AACH,CAAC;AAUD,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAc,CAAC;AAExD,MAAM,OAAO,kBAAmB,SAAQ,wBAAwB;IAK9D,YACE,SAA4C,EAC5C,SAAmC;QACjC,SAAS,EAAE;YACT,WAAW,EAAE,CAAC;YACd,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,GAAG;SACf;KACF;QAED,KAAK,CAAC,SAAS,CAAC,CAAC;;QAZV,6CAAkC;QAazC,uBAAA,IAAI,8BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,mBAAmB,CAAC,OAAsC;QACxD,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,GAAG;YACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAM,YAAY,CAAC,EAAa,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,kBAAkB,CAAC,IAAI,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,gDAAgD,EAChD,oBAAoB,CACrB,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,wCAAwC,EACxC,eAAe,CAChB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAgCD,KAAK,CAAC,cAAc,CAAC,EACnB,aAAa,EACb,UAAU,GAIX;QACC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;YACV,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QAEF,gDAAgD;QAChD,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAErC,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAsDD;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAGtB;QACC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE3C,MAAM,qBAAqB,GAAG,MAAM,uBAAA,IAAI,mFAA0B,MAA9B,IAAI,EAA2B;YACjE,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACtB,QAAQ,EACR,qBAAqB,CACtB,CAAC;QACF,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,EAAE,CAAC;SACX;QAED,uEAAuE;QACvE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QACH,MAAM,CACJ,qBAAqB,KAAK,OAAO,EACjC,0DAA0D,CAC3D,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QACF,2BAA2B,CAAC,OAAO,CAAC,CAAC;QACrC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;;+HA1JD,KAAK,4CAAgB,EACnB,aAAa,EACb,UAAU,EACV,UAAU,GAAG,KAAK,GAKnB;IACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CACnC,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;SACtC;QAED,0EAA0E;QAC1E,IAAI,UAAU,IAAI,UAAU,KAAK,QAAQ,CAAC,MAAM,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvB,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,4CA6BD,KAAK,kDACH,QAAkB,EAClB,OAAY;IAEZ,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,GAAG,EAAE,CACH,WAAW,CACT,QAAQ,CAAC,OAAO,CAAC;QACf,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC5B,CAAC,EACF,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS,CACjC,EACH;QACE,WAAW,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,WAAW;QAC/C,SAAS,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS;KAC5C,CACF,CAAC;IAEF,OAAO,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC,iDAED,KAAK,uDAA2B,EAC9B,aAAa,EACb,UAAU,GAIX;IACC,4FAA4F;IAC5F,mCAAmC;IACnC,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,+EAA+E;QAC/E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;SAC7B;QAED,8EAA8E;QAC9E,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,oCAAoC,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAEzD,OAAO,KAAK,CACV,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CACjE,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAzJM,uBAAI,GAAG,yBAAyB,AAA5B,CAA6B","sourcesContent":["import { publicToAddress } from '@ethereumjs/util';\nimport type { Bip44Account } from '@metamask/account-api';\nimport type { HdKeyring } from '@metamask/eth-hd-keyring';\nimport type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\nimport { EthAccountType } from '@metamask/keyring-api';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type {\n  EthKeyring,\n  InternalAccount,\n} from '@metamask/keyring-internal-api';\nimport type { Provider } from '@metamask/network-controller';\nimport { add0x, assert, bytesToHex, type Hex } from '@metamask/utils';\nimport type { MultichainAccountServiceMessenger } from 'src/types';\n\nimport {\n  assertAreBip44Accounts,\n  assertIsBip44Account,\n  BaseBip44AccountProvider,\n} from './BaseBip44AccountProvider';\nimport { withRetry, withTimeout } from './utils';\n\nconst ETH_MAINNET_CHAIN_ID = '0x1';\n\n/**\n * Asserts an internal account exists.\n *\n * @param account - The internal account to check.\n * @throws An error if the internal account does not exist.\n */\nfunction assertInternalAccountExists(\n  account: InternalAccount | undefined,\n): asserts account is InternalAccount {\n  if (!account) {\n    throw new Error('Internal account does not exist');\n  }\n}\n\nexport type EvmAccountProviderConfig = {\n  discovery: {\n    maxAttempts: number;\n    timeoutMs: number;\n    backOffMs: number;\n  };\n};\n\nexport const EVM_ACCOUNT_PROVIDER_NAME = 'EVM' as const;\n\nexport class EvmAccountProvider extends BaseBip44AccountProvider {\n  static NAME = EVM_ACCOUNT_PROVIDER_NAME;\n\n  readonly #config: EvmAccountProviderConfig;\n\n  constructor(\n    messenger: MultichainAccountServiceMessenger,\n    config: EvmAccountProviderConfig = {\n      discovery: {\n        maxAttempts: 3,\n        timeoutMs: 500,\n        backOffMs: 500,\n      },\n    },\n  ) {\n    super(messenger);\n    this.#config = config;\n  }\n\n  isAccountCompatible(account: Bip44Account<InternalAccount>): boolean {\n    return (\n      account.type === EthAccountType.Eoa &&\n      account.metadata.keyring.type === (KeyringTypes.hd as string)\n    );\n  }\n\n  getName(): string {\n    return EvmAccountProvider.NAME;\n  }\n\n  /**\n   * Get the EVM provider.\n   *\n   * @returns The EVM provider.\n   */\n  getEvmProvider(): Provider {\n    const networkClientId = this.messenger.call(\n      'NetworkController:findNetworkClientIdByChainId',\n      ETH_MAINNET_CHAIN_ID,\n    );\n    const { provider } = this.messenger.call(\n      'NetworkController:getNetworkClientById',\n      networkClientId,\n    );\n    return provider;\n  }\n\n  async #createAccount({\n    entropySource,\n    groupIndex,\n    throwOnGap = false,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n    throwOnGap?: boolean;\n  }): Promise<[Hex, boolean]> {\n    const result = await this.withKeyring<EthKeyring, [Hex, boolean]>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return [existing[groupIndex], false];\n        }\n\n        // If the throwOnGap flag is set, we throw an error to prevent index gaps.\n        if (throwOnGap && groupIndex !== existing.length) {\n          throw new Error('Trying to create too many accounts');\n        }\n\n        const [added] = await keyring.addAccounts(1);\n        return [added, true];\n      },\n    );\n\n    return result;\n  }\n\n  async createAccounts({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n      throwOnGap: true,\n    });\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n\n    // We MUST have the associated internal account.\n    assertInternalAccountExists(account);\n\n    const accountsArray = [account];\n    assertAreBip44Accounts(accountsArray);\n\n    return accountsArray;\n  }\n\n  async #getTransactionCount(\n    provider: Provider,\n    address: Hex,\n  ): Promise<number> {\n    const countHex = await withRetry<Hex>(\n      () =>\n        withTimeout(\n          provider.request({\n            method: 'eth_getTransactionCount',\n            params: [address, 'latest'],\n          }),\n          this.#config.discovery.timeoutMs,\n        ),\n      {\n        maxAttempts: this.#config.discovery.maxAttempts,\n        backOffMs: this.#config.discovery.backOffMs,\n      },\n    );\n\n    return parseInt(countHex, 16);\n  }\n\n  async #getAddressFromGroupIndex({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId,\n    groupIndex: number,\n  }): Promise<Hex> {\n    // NOTE: To avoid exposing this function at keyring level, we just re-use its internal state\n    // and compute the derivation here.\n    return await this.withKeyring<HdKeyring, Hex>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        // If the account already exist, do not re-derive and just re-use that account.\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return existing[groupIndex];\n        }\n\n        // If not, then we just \"peek\" the next address to avoid creating the account.\n        assert(keyring.root, 'Expected HD keyring.root to be set');\n        const hdKey = keyring.root.deriveChild(groupIndex);\n        assert(hdKey.publicKey, 'Expected public key to be set');\n\n        return add0x(\n          bytesToHex(publicToAddress(hdKey.publicKey, true)).toLowerCase(),\n        );\n      },\n    );\n  }\n\n  /**\n   * Discover and create accounts for the EVM provider.\n   *\n   * @param opts - The options for the discovery and creation of accounts.\n   * @param opts.entropySource - The entropy source to use for the discovery and creation of accounts.\n   * @param opts.groupIndex - The index of the group to create the accounts for.\n   * @returns The accounts for the EVM provider.\n   */\n  async discoverAccounts(opts: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const provider = this.getEvmProvider();\n    const { entropySource, groupIndex } = opts;\n\n    const addressFromGroupIndex = await this.#getAddressFromGroupIndex({\n      entropySource,\n      groupIndex,\n    });\n\n    const count = await this.#getTransactionCount(\n      provider,\n      addressFromGroupIndex,\n    );\n    if (count === 0) {\n      return [];\n    }\n\n    // We have some activity on this address, we try to create the account.\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n    });\n    assert(\n      addressFromGroupIndex === address,\n      'Created account does not match address from group index.',\n    );\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n    assertInternalAccountExists(account);\n    assertIsBip44Account(account);\n    return [account];\n  }\n}\n"]}
+{"version":3,"file":"EvmAccountProvider.mjs","sourceRoot":"","sources":["../../src/providers/EvmAccountProvider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,eAAe,EAAE,yBAAyB;AAInD,OAAO,EAAE,cAAc,EAAE,8BAA8B;AACvD,OAAO,EAAE,YAAY,EAAE,qCAAqC;AAM5D,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAY,wBAAwB;AAGtE,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACzB,uCAAmC;AACpC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAgB;AAEjD,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAEnC;;;;;GAKG;AACH,SAAS,2BAA2B,CAClC,OAAoC;IAEpC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;AACH,CAAC;AAUD,MAAM,CAAC,MAAM,yBAAyB,GAAG,KAAc,CAAC;AAExD,MAAM,OAAO,kBAAmB,SAAQ,wBAAwB;IAK9D,YACE,SAA4C,EAC5C,SAAmC;QACjC,SAAS,EAAE;YACT,WAAW,EAAE,CAAC;YACd,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,GAAG;SACf;KACF;QAED,KAAK,CAAC,SAAS,CAAC,CAAC;;QAZV,6CAAkC;QAazC,uBAAA,IAAI,8BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IAED,mBAAmB,CAAC,OAAsC;QACxD,OAAO,CACL,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,GAAG;YACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAM,YAAY,CAAC,EAAa,CAC9D,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,kBAAkB,CAAC,IAAI,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACzC,gDAAgD,EAChD,oBAAoB,CACrB,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACtC,wCAAwC,EACxC,eAAe,CAChB,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAgCD,KAAK,CAAC,cAAc,CAAC,EACnB,aAAa,EACb,UAAU,GAIX;QACC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;YACV,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QAEF,gDAAgD;QAChD,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAErC,MAAM,aAAa,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,sBAAsB,CAAC,aAAa,CAAC,CAAC;QAEtC,OAAO,aAAa,CAAC;IACvB,CAAC;IAsDD;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAGtB;QACC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE3C,MAAM,qBAAqB,GAAG,MAAM,uBAAA,IAAI,mFAA0B,MAA9B,IAAI,EAA2B;YACjE,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EACtB,QAAQ,EACR,qBAAqB,CACtB,CAAC;QACF,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,EAAE,CAAC;SACX;QAED,uEAAuE;QACvE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,uBAAA,IAAI,wEAAe,MAAnB,IAAI,EAAgB;YAC1C,aAAa;YACb,UAAU;SACX,CAAC,CAAC;QACH,MAAM,CACJ,qBAAqB,KAAK,OAAO,EACjC,0DAA0D,CAC3D,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,wCAAwC,EACxC,OAAO,CACR,CAAC;QACF,2BAA2B,CAAC,OAAO,CAAC,CAAC;QACrC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;;+HA1JD,KAAK,4CAAgB,EACnB,aAAa,EACb,UAAU,EACV,UAAU,GAAG,KAAK,GAKnB;IACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CACnC,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;SACtC;QAED,0EAA0E;QAC1E,IAAI,UAAU,IAAI,UAAU,KAAK,QAAQ,CAAC,MAAM,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAC7C,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvB,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC,4CA6BD,KAAK,kDACH,QAAkB,EAClB,OAAY;IAEZ,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,GAAG,EAAE,CACH,WAAW,CACT,QAAQ,CAAC,OAAO,CAAC;QACf,MAAM,EAAE,yBAAyB;QACjC,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC5B,CAAC,EACF,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS,CACjC,EACH;QACE,WAAW,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,WAAW;QAC/C,SAAS,EAAE,uBAAA,IAAI,kCAAQ,CAAC,SAAS,CAAC,SAAS;KAC5C,CACF,CAAC;IAEF,OAAO,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC,iDAED,KAAK,uDAA2B,EAC9B,aAAa,EACb,UAAU,GAIX;IACC,4FAA4F;IAC5F,mCAAmC;IACnC,OAAO,MAAM,IAAI,CAAC,WAAW,CAC3B,EAAE,EAAE,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACpB,+EAA+E;QAC/E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,UAAU,GAAG,QAAQ,CAAC,MAAM,EAAE;YAChC,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;SAC7B;QAED,8EAA8E;QAC9E,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,oCAAoC,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;QAEzD,OAAO,KAAK,CACV,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,EAAE,CACjE,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAzJM,uBAAI,GAAG,yBAAyB,AAA5B,CAA6B","sourcesContent":["import { publicToAddress } from '@ethereumjs/util';\nimport type { Bip44Account } from '@metamask/account-api';\nimport type { HdKeyring } from '@metamask/eth-hd-keyring';\nimport type { EntropySourceId, KeyringAccount } from '@metamask/keyring-api';\nimport { EthAccountType } from '@metamask/keyring-api';\nimport { KeyringTypes } from '@metamask/keyring-controller';\nimport type {\n  EthKeyring,\n  InternalAccount,\n} from '@metamask/keyring-internal-api';\nimport type { Provider } from '@metamask/network-controller';\nimport { add0x, assert, bytesToHex, type Hex } from '@metamask/utils';\nimport type { MultichainAccountServiceMessenger } from 'src/types';\n\nimport {\n  assertAreBip44Accounts,\n  assertIsBip44Account,\n  BaseBip44AccountProvider,\n} from './BaseBip44AccountProvider';\nimport { withRetry, withTimeout } from './utils';\n\nconst ETH_MAINNET_CHAIN_ID = '0x1';\n\n/**\n * Asserts an internal account exists.\n *\n * @param account - The internal account to check.\n * @throws An error if the internal account does not exist.\n */\nfunction assertInternalAccountExists(\n  account: InternalAccount | undefined,\n): asserts account is InternalAccount {\n  if (!account) {\n    throw new Error('Internal account does not exist');\n  }\n}\n\nexport type EvmAccountProviderConfig = {\n  discovery: {\n    maxAttempts: number;\n    timeoutMs: number;\n    backOffMs: number;\n  };\n};\n\nexport const EVM_ACCOUNT_PROVIDER_NAME = 'EVM' as const;\n\nexport class EvmAccountProvider extends BaseBip44AccountProvider {\n  static NAME = EVM_ACCOUNT_PROVIDER_NAME;\n\n  readonly #config: EvmAccountProviderConfig;\n\n  constructor(\n    messenger: MultichainAccountServiceMessenger,\n    config: EvmAccountProviderConfig = {\n      discovery: {\n        maxAttempts: 3,\n        timeoutMs: 500,\n        backOffMs: 500,\n      },\n    },\n  ) {\n    super(messenger);\n    this.#config = config;\n  }\n\n  isAccountCompatible(account: Bip44Account<InternalAccount>): boolean {\n    return (\n      account.type === EthAccountType.Eoa &&\n      account.metadata.keyring.type === (KeyringTypes.hd as string)\n    );\n  }\n\n  getName(): string {\n    return EvmAccountProvider.NAME;\n  }\n\n  /**\n   * Get the EVM provider.\n   *\n   * @returns The EVM provider.\n   */\n  getEvmProvider(): Provider {\n    const networkClientId = this.messenger.call(\n      'NetworkController:findNetworkClientIdByChainId',\n      ETH_MAINNET_CHAIN_ID,\n    );\n    const { provider } = this.messenger.call(\n      'NetworkController:getNetworkClientById',\n      networkClientId,\n    );\n    return provider;\n  }\n\n  async #createAccount({\n    entropySource,\n    groupIndex,\n    throwOnGap = false,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n    throwOnGap?: boolean;\n  }): Promise<[Hex, boolean]> {\n    const result = await this.withKeyring<EthKeyring, [Hex, boolean]>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return [existing[groupIndex], false];\n        }\n\n        // If the throwOnGap flag is set, we throw an error to prevent index gaps.\n        if (throwOnGap && groupIndex !== existing.length) {\n          throw new Error('Trying to create too many accounts');\n        }\n\n        const [added] = await keyring.addAccounts(1);\n        return [added, true];\n      },\n    );\n\n    return result;\n  }\n\n  async createAccounts({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n      throwOnGap: true,\n    });\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n\n    // We MUST have the associated internal account.\n    assertInternalAccountExists(account);\n\n    const accountsArray = [account];\n    assertAreBip44Accounts(accountsArray);\n\n    return accountsArray;\n  }\n\n  async #getTransactionCount(\n    provider: Provider,\n    address: Hex,\n  ): Promise<number> {\n    const countHex = await withRetry<Hex>(\n      () =>\n        withTimeout(\n          provider.request({\n            method: 'eth_getTransactionCount',\n            params: [address, 'latest'],\n          }),\n          this.#config.discovery.timeoutMs,\n        ),\n      {\n        maxAttempts: this.#config.discovery.maxAttempts,\n        backOffMs: this.#config.discovery.backOffMs,\n      },\n    );\n\n    return parseInt(countHex, 16);\n  }\n\n  async #getAddressFromGroupIndex({\n    entropySource,\n    groupIndex,\n  }: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Hex> {\n    // NOTE: To avoid exposing this function at keyring level, we just re-use its internal state\n    // and compute the derivation here.\n    return await this.withKeyring<HdKeyring, Hex>(\n      { id: entropySource },\n      async ({ keyring }) => {\n        // If the account already exist, do not re-derive and just re-use that account.\n        const existing = await keyring.getAccounts();\n        if (groupIndex < existing.length) {\n          return existing[groupIndex];\n        }\n\n        // If not, then we just \"peek\" the next address to avoid creating the account.\n        assert(keyring.root, 'Expected HD keyring.root to be set');\n        const hdKey = keyring.root.deriveChild(groupIndex);\n        assert(hdKey.publicKey, 'Expected public key to be set');\n\n        return add0x(\n          bytesToHex(publicToAddress(hdKey.publicKey, true)).toLowerCase(),\n        );\n      },\n    );\n  }\n\n  /**\n   * Discover and create accounts for the EVM provider.\n   *\n   * @param opts - The options for the discovery and creation of accounts.\n   * @param opts.entropySource - The entropy source to use for the discovery and creation of accounts.\n   * @param opts.groupIndex - The index of the group to create the accounts for.\n   * @returns The accounts for the EVM provider.\n   */\n  async discoverAccounts(opts: {\n    entropySource: EntropySourceId;\n    groupIndex: number;\n  }): Promise<Bip44Account<KeyringAccount>[]> {\n    const provider = this.getEvmProvider();\n    const { entropySource, groupIndex } = opts;\n\n    const addressFromGroupIndex = await this.#getAddressFromGroupIndex({\n      entropySource,\n      groupIndex,\n    });\n\n    const count = await this.#getTransactionCount(\n      provider,\n      addressFromGroupIndex,\n    );\n    if (count === 0) {\n      return [];\n    }\n\n    // We have some activity on this address, we try to create the account.\n    const [address] = await this.#createAccount({\n      entropySource,\n      groupIndex,\n    });\n    assert(\n      addressFromGroupIndex === address,\n      'Created account does not match address from group index.',\n    );\n\n    const account = this.messenger.call(\n      'AccountsController:getAccountByAddress',\n      address,\n    );\n    assertInternalAccountExists(account);\n    assertIsBip44Account(account);\n    return [account];\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/multichain-account-service",
-  "version": "0.9.0-preview-988ea6d",
+  "version": "0.9.0-preview-8cfb0d7",
   "description": "Service to manage multichain accounts",
   "keywords": [
     "MetaMask",