-
-
Notifications
You must be signed in to change notification settings - Fork 256
refactor(multichain-account-service): Improved performance across package classes and improved error messages #6654
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…to wallets and groups
…tead of getAccountByAddress which iterates through the whole of internal accounts in the AccountsController
| accountsList, | ||
| ); | ||
| // we cast here because we know that the accounts are BIP-44 compatible | ||
| return internalAccounts as Bip44Account<KeyringAccount>[]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although the getAccounts's return type is (InternalAccount | undefined)[], we're sure to get back all the accounts we want since the accounts list will never be stale.
…accountAdded and accountRemoved handling, it is dead code
| MultichainAccountWallet<Bip44Account<KeyringAccount>> | ||
| >; | ||
|
|
||
| readonly #accountIdToContext: Map< |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Decided to get rid of this mapping since it was only being used for handling the accountRemoved and accountAdded events, removing this gets rid of a large loop in the init function as well. If there's a particular need for this data at the client level, we can always add this back in.
…handle createNewVaultAndKeychain and createNewVaultAndRestore code paths
…s, remove redundant state assignment, use assert to ensure wallet existence after creation
…ble with new changes
Bug: Async Provider Failure Leaves Wallet InconsistentIn |
Bug: Error Handling Anti-Pattern in
|
…hen it is disabled, fixed tests
packages/multichain-account-service/src/MultichainAccountGroup.ts
Outdated
Show resolved
Hide resolved
| this.#log('Synchronized'); | ||
| update | ||
| ? this.#log('Finished updating group state...') | ||
| : this.#log('Finished initializing group state...'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Stale Account Data Persists After Updates
The init method doesn't clear the #providerToAccounts and #accountToProvider maps when called with update = true. When update() is invoked with partial state (e.g., only one provider's accounts), old entries for other providers remain in the maps, causing stale data accumulation. This is inconsistent with alignAccounts which clears the maps before repopulation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
State maps are cleared at the only point that they're needed (in the alignAccounts function). The other invocations of update do not require a need to clear the maps.
packages/multichain-account-service/src/providers/BaseBip44AccountProvider.ts
Show resolved
Hide resolved
packages/multichain-account-service/src/providers/BaseBip44AccountProvider.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/providers/BaseBip44AccountProvider.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/providers/BaseBip44AccountProvider.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/MultichainAccountGroup.test.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/MultichainAccountService.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/MultichainAccountService.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/MultichainAccountService.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/MultichainAccountService.ts
Outdated
Show resolved
Hide resolved
packages/multichain-account-service/src/providers/BaseBip44AccountProvider.ts
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Wrapper Data Disconnect: Init vs. Get
AccountProviderWrapper inherits from BaseBip44AccountProvider, creating its own accounts Set. When init() is called on a wrapper instance, it populates the wrapper's inherited accounts Set. However, getAccounts() delegates to the wrapped provider's implementation, which uses the wrapped provider's separate accounts Set. This creates a disconnect where initialization populates the wrapper's Set while retrieval reads from the provider's empty Set, causing getAccounts() to return incorrect results.
packages/multichain-account-service/src/providers/AccountProviderWrapper.ts#L11-L25
core/packages/multichain-account-service/src/providers/AccountProviderWrapper.ts
Lines 11 to 25 in 602ce8f
| */ | |
| export class AccountProviderWrapper extends BaseBip44AccountProvider { | |
| private isEnabled: boolean = true; | |
| private readonly provider: BaseBip44AccountProvider; | |
| constructor( | |
| messenger: MultichainAccountServiceMessenger, | |
| provider: BaseBip44AccountProvider, | |
| ) { | |
| super(messenger); | |
| this.provider = provider; | |
| } | |
| override getName(): string { |
Explanation
MultichainAccountServicecreateMultichainAccountWallet) that handles import/restore/new vault.ServiceStateindex in one pass and passes state slices to wallets/groups (cuts repeated controller scans/calls).initpath and removed deadaccountIdToContextmapping.MultichainAccountWalletinitnow consumes a pre-sliced wallet state (entropySource → groups → providerName → ids) instead of querying providers.MultichainAccountGroupinitregisters account IDs per provider and fills reverse maps; callsprovider.addAccounts(ids)to keep providers in sync.getAccountIds()for direct access to underlying IDs.BaseBip44AccountProvideraddAccounts(ids: string[]), enabling providers to track their own account ID lists.getAccounts()paths rely on known IDs (plural lookups) rather than scanning the full controller list.EvmAccountProvidergetAccount(s)) for create/discover (removesPerformance Analysis
When fully aligned$g = n / p$ .$g = max(f(p))$ , where $f(p)$ is the number of accounts associated with a provider.
When accounts are not fully aligned then
Consider two scenarios:
General formulas
For Scenario 2, the formulas are as follows:
Before this refactor, the number of loops can be represented$n * p * (1 + w + g)$ , which with $p = 4$ , becomes $n^2 + 4n(1 + w)$ .
Before this refactor, the number of controller calls can be represented as$1 + w + g$ , which with $p = 4$ , becomes $1 + w + n/4$ .
After this refactor, the number of loops can be represented by$n * p$ , which with $p = 4$ , becomes $4n$ .
After this refactor, the number of calls is just$1$ .
For Scenario 1, the formulas are entirely dependent on the breakdown of the number of accounts each provider has amongst the$n$ accounts, let's consider a scenario where Solana has $n/2$ , Ethereum has $n/8$ , Bitcoin has $n/4$ and Tron has $n/8$ , the formulas would be as follows:
Before this refactor, the number of loops in the alignment process can be represented as$(p * g) + (n * e)$ , which with $p=4$ and $g = n/2$ , becomes $2n + 3n^2/8$ . Therefore the number of loops for initialization + alignment in this scenario with $p = 4$ and $g = n/2$ , becomes $(19/8)n^2 + (4w + 6)n$ .
Before this refactor, the number of controller calls in the alignment process can be represented as$e$ , which becomes $3n/8$ . Therefore the number of controller calls for initialization + alignment in this scenario with $p = 4$ , becomes $1 + w + 5n/8$ .
After this refactor, the number of loops in the alignment process can be represented as$p * g$ , which becomes $2n$ . Therefore, the number of loops for initialization + alignment in this scenario with $p = 4$ and $g = n/2$ , becomes $6n$ .
After this refactor, the number of controller calls in the alignment process can be represented as$e$ which becomes $3n/8$ . Therefore, the number of controller calls for initialization + alignment in this scenario with $p = 4$ and $g = n/2$ , becomes $1 + 3n/8$ .
In short, previous
initperformance for loops and controller calls was quadratic and linear, respectively. After, it is linear and constant.Performance Charts
Below are charts that show performance (loops and controller calls)$n = 0$ -> $n = 256$ for Scenario 1 and 2 with $w = 2$ , respectively:
References
N/A
Checklist
Note
Refactors multichain account service to a state-driven model with unified wallet creation (import/create/restore), provider ID-based access, and more robust group alignment and error reporting.
ServiceStateinMultichainAccountService.init(); pass state slices toMultichainAccountWallet.initandMultichainAccountGroup.init/updateto avoid repeated controller scans.createMultichainAccountWalletsupportingimport,create(new vault), andrestore; adds use ofKeyringController:createNewVaultAnd{Keychain,Restore}.MultichainAccountWallet.createMultichainAccountGroupinitializes group early, awaits EVM, runs non‑EVM in background or all (option), tolerates partial failures, and updates group state.discoverAccountsconstructs groups from discovered IDs, then aligns.MultichainAccountGroup.init/updateregister provider→IDs and reverse maps; publishmultichainAccountGroupUpdated.getAccountIds();alignAccounts()usesprovider.alignAccounts, handles disabled providers, and aggregates warnings/errors.BaseBip44AccountProvider: addinit(accountsIds), internal ID set,alignAccounts()returning IDs,getAccounts(getAccounts)andgetAccount(getAccount)by ID.EvmAccountProvider: deterministic ID viagetUUIDFromAddressOfNormalAccount; fetch by ID; add created/discovered IDs.{Btc,Sol,Trx}AccountProvider: add created/discovered IDs to internal set.AccountProviderWrapper: addisDisabled()andalignAccountspassthrough; enforce disabled behavior across methods.AccountsController:getAccountsand new keyring vault actions; remove unused utilities.Written by Cursor Bugbot for commit 602ce8f. This will update automatically on new commits. Configure here.