wallet: Document the state-injection contract in README
Maintainer antworten meist innerhalb von 1 Tag
@grypez arbeitet bereits daran.
Seit 26.5.2026.
Bewertung
Dieses Issue wurde noch nicht bewertet.
Beschreibung
Problem
@metamask/wallet has no usage documentation. The persistence contract — how consumers supply initial state and subscribe to controller state changes — is entirely implicit. Callers must read the source to understand how to wire persistence, and there is no canonical reference for the expected data shapes or event subscription pattern.
Proposed direction
Add a Usage section to packages/wallet/README.md covering:
- Hydration: pass an initial
stateobject keyed by controller name to theWalletconstructor. Missing keys fall back to each controller's default state. - Writes: subscribe to
${ControllerName}:stateChangedevents onwallet.messenger; usewallet.controllerMetadatato identify which fields carrypersist: true. - Include short code examples for both.
Acceptance
README.mdhas a Usage section with working code examples for both hydration and the stateChanged subscription pattern.- The role of
wallet.controllerMetadata(identifying persist-flagged fields) is explained. - Changelog entry added.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 422
- Forks
- 313
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 384
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus MetaMask/core
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Maintainer antworten meist innerhalb von 1 Tag
-
CI: "Validate changelog diffs" job fails on every fork-sourced pull requestEvtl. vergeben @Roxen-AS hat das vor 14 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
Maintainer antworten meist innerhalb von 1 Tag
-
platform-api-docs: `scan` strategy misses ESM-only packages, which ship `.d.ts` rather than `.d.cts`Evtl. vergeben @gaohan1994 hat das vor 15 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Maintainer antworten meist innerhalb von 1 Tag
-
[utils] Replace the `uuid` dependency with `crypto.randomUUID()`Evtl. vergeben @avantikonde hat das vor 28 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
MetaMask/core#10210 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
[utils] `toWei` accepts fractional wei and returns wrong valuesEvtl. vergeben @Roxen-AS hat das vor 14 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
area: web bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
kinqsradio/orbyn-engineering#227 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
joeldesante/TurfBuilder#258 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
ncecere/open-mcp-portal#85 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 63/100
loathers/garbage-collector#2865 ·
Maintainer antworten meist innerhalb von 1 Tag
-
test-reliability
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Azure/azure-sdk-for-js#40672 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag