wallet: Document the state-injection contract in README
Les mainteneurs répondent en général sous 1 jour
@grypez y travaille déjà.
Depuis le 26/5/2026.
Évaluation
Cette issue n'a pas encore été évaluée.
Description
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.
- Langage dominant
- TypeScript
- Étoiles
- 420
- Forks
- 313
- Merge moyen
- 1 j 12 h
- PR mergées (30 j)
- 384
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de MetaMask/core
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
Les mainteneurs répondent en général sous 1 jour
-
CI: "Validate changelog diffs" job fails on every fork-sourced pull requestPeut-être pris @Roxen-AS l’a pris il y a 11 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
Les mainteneurs répondent en général sous 1 jour
-
platform-api-docs: `scan` strategy misses ESM-only packages, which ship `.d.ts` rather than `.d.cts`Peut-être pris @gaohan1994 l’a pris il y a 13 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour
-
[utils] Replace the `uuid` dependency with `crypto.randomUUID()`Peut-être pris @avantikonde l’a pris il y a 25 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
MetaMask/core#10210 · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
[utils] `toWei` accepts fractional wei and returns wrong valuesPeut-être pris @Roxen-AS l’a pris il y a 11 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de MetaMask/core
Issues similaires
-
mobile-app
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
Open-Locker/Open-Locker#352 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
leanprover-community/lean4game#589 ·
Les mainteneurs répondent en général sous 2 jours
-
Add: CS Action BGOuvertecheck:passed streams:add
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
unocss/unocss#5421 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour