feat(keyring-snap-bridge): make account creation async

[ccharly]

We now resume the Snap execution before persisting the account into the Snap keyring state.

This allows the Snap to have an existing account (once approved or not by the user, just like before), but this delays the actual account creation on the MetaMask clients (more specifically, the AccountsController in this case), which allows other controllers to react to the AccountsController:accountCreated event and to directly fetch account informations (assets/balances) from the Snap.

In the following example, the SomeOtherController cannot use the account because the account wasn't persisted by the Snap yet:

// Snap keyring methods
snap.createAccount = () => {
  const account = ...;
  
  await emitSnapKeyringEvent(AccountCreated, { account }); // -> This will trigger keyring.handleSnapkeyringEvent
  
  // Now persists the account (since we know MetaMask has accepted it).
  state.accounts.push(account);
}

// Snap keyring (on the MetaMask client)
keyring.handleSnapKeyringEvent = (message) => {
  ...
  switch (message.method) {
    case 'AccountCreated': {
      // Show some dialogs for the user
      if (dialog.accepted) {
        // At this point, Snap execution is still pending...
        await keyring.saveState(); // This will trigger AccountsController:accountAdded (see addNewAccount method in this example) event 
      }
    }
  ...
})

AccountsController.addNewAccount = (account) => {
  this.messenger.publish(`AccountsController:accountAdded`, account); // This will trigger SomeOtherController.onAccountAdded handler
}

SomeOtherController.onAccountAdded = (account) => {
  // !
  // ! Here was the problem, since the account was still not persisted onto the Snap.
  // !
  await this.getSnapClient(account.metadata.snap.id).listAccountAssets();
}

[ccharly]

@metamaskbot publish-previews

[github-actions]

Preview builds have been published. See these instructions (from the core monorepo) for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/keyring-api": "17.0.0-d9aa015",
  "@metamask-previews/eth-hd-keyring": "10.0.0-d9aa015",
  "@metamask-previews/eth-ledger-bridge-keyring": "8.0.4-d9aa015",
  "@metamask-previews/eth-simple-keyring": "8.1.0-d9aa015",
  "@metamask-previews/eth-trezor-keyring": "6.1.0-d9aa015",
  "@metamask-previews/keyring-internal-api": "4.0.2-d9aa015",
  "@metamask-previews/keyring-internal-snap-client": "4.0.0-d9aa015",
  "@metamask-previews/eth-snap-keyring": "10.0.0-d9aa015",
  "@metamask-previews/keyring-snap-client": "4.0.0-d9aa015",
  "@metamask-previews/keyring-snap-sdk": "3.0.0-d9aa015",
  "@metamask-previews/keyring-utils": "2.0.0-d9aa015"
}

[ccharly]

@metamaskbot publish-previews

[github-actions]

Preview builds have been published. See these instructions (from the core monorepo) for more information about preview builds.

Expand for full list of packages and versions.

{
  "@metamask-previews/keyring-api": "17.0.0-b0257dd",
  "@metamask-previews/eth-hd-keyring": "10.0.0-b0257dd",
  "@metamask-previews/eth-ledger-bridge-keyring": "8.0.4-b0257dd",
  "@metamask-previews/eth-simple-keyring": "8.1.0-b0257dd",
  "@metamask-previews/eth-trezor-keyring": "6.1.0-b0257dd",
  "@metamask-previews/keyring-internal-api": "4.0.2-b0257dd",
  "@metamask-previews/keyring-internal-snap-client": "4.0.0-b0257dd",
  "@metamask-previews/eth-snap-keyring": "10.0.0-b0257dd",
  "@metamask-previews/keyring-snap-client": "4.0.0-b0257dd",
  "@metamask-previews/keyring-snap-sdk": "3.0.0-b0257dd",
  "@metamask-previews/keyring-utils": "2.0.0-b0257dd"
}