Update Keyring API reference

[alexandratran]

This removes the external/keyring-api submodule and creates the Keyring API reference manually, adding the categories "Keyring Client API" and "Keyring Interface API." It also updates related content. Fixes #1165.

Previews:

• Keyring API - https://docs.metamask.io/1165-keyring-reference/snaps/reference/keyring-api/
  • Account Management API - https://docs.metamask.io/1165-keyring-reference/snaps/reference/keyring-api/account-management/
    • Account Management API objects - https://docs.metamask.io/1165-keyring-reference/snaps/reference/keyring-api/account-management/objects/
    • Account Management API events - https://docs.metamask.io/1165-keyring-reference/snaps/reference/keyring-api/account-management/events/
  • Chain Methods API - https://docs.metamask.io/1165-keyring-reference/snaps/reference/keyring-api/chain-methods/

For the Client API reference, I used this Notion page for reference and checked it against the updated source code.

[github-actions]

Preview published: 1165-keyring-reference

[joaniefromtheblock]

LGTM. Just did a rough review, but can confirm links work, it's typo-free, and has constant formatting

[danroc]

I find the name Keyring Interface API a bit unclear, it doesn't pass the idea that it contains chain-specific methods that a Snap can choose to support.

Maybe we could rename the APIs like:

Before	After
Keyring Interface API	Chain Methods API
Keyring Client API	Account Management API

This is only a suggestion and I would like to hear what others have to say (ping @gantunesr @montelaidev).

[github-actions]

Preview published: 1165-keyring-reference

[gantunesr]

A small nit

[gantunesr]

I agree with @danroc opinion, also seeing at these descriptions,

• Keyring Client API – An API for dapps to communicate with account management Snaps.
• Keyring Interface API - EVM methods that account management Snaps can implement to support dapp requests from custom accounts.

And what is specified in the keyring-module,

• Keyring API Interface: The module exposes an interface representing the Keyring API. Snaps can implement this interface to seamlessly interact with MetaMask and leverage its functionality.
• Dapp Client: The module includes a client that enables dapps to communicate with the account Snap. This client allows dapps to send requests to the Snap, such as retrieving account information or submitting requests.
• MetaMask Client: The module provides a client specifically designed for MetaMask integration. This client enables MetaMask to send requests directly to the account Snap, facilitating smooth interoperability between the two applications.

I see an opportunity to consolidated these definitions and push for the renaming as proposed here

[github-actions]

Preview published: 1165-keyring-reference

[socket-security]

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

🚮 Removed packages: npm/ansi-sequence-parser@1.1.1, npm/docusaurus-plugin-typedoc@1.0.0-next.17, npm/lunr@2.3.9, npm/marked@4.3.0, npm/shiki@0.14.7, npm/typedoc-plugin-markdown@4.0.0-next.22, npm/typedoc@0.25.9, npm/vscode-oniguruma@1.7.0, npm/vscode-textmate@8.0.0

View full report↗︎

[github-actions]

Preview published: 1165-keyring-reference

[danroc]

LGTM, thanks!