feat!: add SnapKeyring.createAccount + internal options

[ccharly]

Introducing a new way of handling internal options (display* flags) that were used to configure the account creation flow.

Initially those flags were being sent by the Snap (only interpreted for preinstalled Snaps) itself to allow to skip some specific steps of the flow (e.g display the account name input OR display the confirmation about the account creation action).

The main problem with the previous approach is that the caller (MetaMask here) of keyring_createAccount cannot skip those steps programmatically. It's up to the Snap to the Snap to emit the right flags with the correct values during the flow.

---

With the new approach, we "hide" those flags behind a context that is owned by the Snap keyring. In addition to that, we've added a new SnapKeyring.createAccount method that allows the caller (MetaMask here, again) to enable those flags if needed.

This way, we can configure the flow to behave differently:

const BITCOIN_SNAP_ID = 'npm:...';
const SOLANA_SNAP_ID = 'npm:...';

const keyring = new SnapKeyring(...);

// Basic flow
keyring.createAccount(SOLANA_SNAP_ID, { scope: '...' }, {
  // We don't want to display those intermediary screens.
  displayConfirmations: false,
});

// Creating a Solana account "on-the-fly" with a default name
keyring.createAccount(SOLANA_SNAP_ID, { scope: '...' }, {
  // We don't want to display those intermediary screens.
  displayConfirmations: false,
  // Will defaults to a generic account name.
  displayAccountNameSuggestion: false,
});

Caution

The current flow will still select the newly created account at the end of the flow, but with this new approach we could easily extend our "internal options" and skip that step too, like

// Could be used by the new bridge EVM <> Solana flow
// OR could be used by profile-sync to create account without selecting them.
keyring.createAccount(SOLANA_SNAP_ID, { scope: '...' }, {
 displayConfirmations: false,
 displayAccountNameSuggestion: false,
 // The Snap keyring won't select this account automatically.
 setSelectedAccount: false,
});

[ccharly]

@metamaskbot publish-preview

[ccharly]

@metamaskbot publish-preview

[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.2.1-a4296e9",
  "@metamask-previews/eth-hd-keyring": "12.1.0-a4296e9",
  "@metamask-previews/eth-ledger-bridge-keyring": "10.0.0-a4296e9",
  "@metamask-previews/eth-simple-keyring": "10.0.0-a4296e9",
  "@metamask-previews/eth-trezor-keyring": "8.0.0-a4296e9",
  "@metamask-previews/keyring-internal-api": "6.0.0-a4296e9",
  "@metamask-previews/keyring-internal-snap-client": "4.0.1-a4296e9",
  "@metamask-previews/eth-snap-keyring": "12.0.0-a4296e9",
  "@metamask-previews/keyring-snap-client": "4.0.1-a4296e9",
  "@metamask-previews/keyring-snap-sdk": "3.1.0-a4296e9",
  "@metamask-previews/keyring-utils": "3.0.0-a4296e9"
}

[ccharly]

@metamaskbot publish-preview

[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.2.1-1ddff34",
  "@metamask-previews/eth-hd-keyring": "12.1.0-1ddff34",
  "@metamask-previews/eth-ledger-bridge-keyring": "10.0.0-1ddff34",
  "@metamask-previews/eth-simple-keyring": "10.0.0-1ddff34",
  "@metamask-previews/eth-trezor-keyring": "8.0.0-1ddff34",
  "@metamask-previews/keyring-internal-api": "6.0.0-1ddff34",
  "@metamask-previews/keyring-internal-snap-client": "4.0.1-1ddff34",
  "@metamask-previews/eth-snap-keyring": "12.0.0-1ddff34",
  "@metamask-previews/keyring-snap-client": "4.0.1-1ddff34",
  "@metamask-previews/keyring-snap-sdk": "3.1.0-1ddff34",
  "@metamask-previews/keyring-utils": "3.0.0-1ddff34"
}

[ccharly]

Review session with @danroc

[ccharly]

@metamaskbot publish-preview

[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.2.1-93b83f1",
  "@metamask-previews/eth-hd-keyring": "12.1.0-93b83f1",
  "@metamask-previews/eth-ledger-bridge-keyring": "10.0.0-93b83f1",
  "@metamask-previews/eth-simple-keyring": "10.0.0-93b83f1",
  "@metamask-previews/eth-trezor-keyring": "8.0.0-93b83f1",
  "@metamask-previews/keyring-internal-api": "6.0.0-93b83f1",
  "@metamask-previews/keyring-internal-snap-client": "4.0.1-93b83f1",
  "@metamask-previews/eth-snap-keyring": "12.0.0-93b83f1",
  "@metamask-previews/keyring-snap-client": "4.0.1-93b83f1",
  "@metamask-previews/keyring-snap-sdk": "3.1.0-93b83f1",
  "@metamask-previews/keyring-utils": "3.0.0-93b83f1"
}

[danroc]

LGTM