docs: Update documentation RPC methods

[Mrtenz]

This updates documentation for all RPC methods to be more user-facing.

Where possible, I used the already existing documentation on docs.metamask.io, and for more recent methods I wrote some documentation from scratch.

See: https://consensyssoftware.atlassian.net/browse/WPC-443.

---

Note

Low Risk
Primarily comment/JSDoc and type-documentation changes; the only code-level tweak is a harmless type import/alias removal in snap_dialog.

Overview
Updates documentation across Snaps RPC methods to be more user-facing: adds/expands JSDoc blocks, links to docs.metamask.io, and concrete usage examples for many snap_* and wallet_* handlers (state, UI interfaces/dialogs, WebSockets, background events, entropy, notifications, etc.).

Also refreshes Snaps SDK type docs for method params/results and permission types (mostly wording/clarity like “ID” vs “id”), and aligns snaps-rpc-methods dialog to use the exported DialogResult type instead of a local alias.

^{Written by Cursor Bugbot for commit 1b743b3. This will update automatically on new commits. Configure here.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.57%. Comparing base (087ecbc) to head (1b743b3).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3868   +/-   ##
=======================================
  Coverage   98.57%   98.57%           
=======================================
  Files         425      425           
  Lines       12311    12311           
  Branches     1919     1919           
=======================================
  Hits        12136    12136           
  Misses        175      175           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[FrederikBolding]

Are these URLs guaranteed? I worry about them changing and we don't notice in this repo

[Mrtenz]

Guaranteed in what sense? This is the format of the new URLs based on the schema. They could of course break if we make changes somewhere, but we should set up redirects in that case.

[FrederikBolding]

Do you wanna try to deal with improving this more separately as discussed on Slack?

[Mrtenz]

Yeah, created a separate ticket to figure out unions, and will move the full type for this to the SDK as well.

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

[FrederikBolding]

Technically Snaps can call this too, not sure if we need to explain that too much though 😄