FuelLabs/sway

Rename storage access methods

Open

#4 740 ouverte le 4 juil. 2023

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Rust (5 421 forks)batch import
breakingcompiler: uienhancementgood first issuelib: stdstorageteam:compiler

Métriques du dépôt

Stars
 (61 702 stars)
Métriques de merge PR
 (Merge moyen 5j 4h) (19 PRs mergées en 30 j)

Description

StorageKey's read and try_read are confusing, notably because of errors related to uninitialized storage.

try_read should be the default behavior and there should be extensive documentation of what happens with the storage initialization.

try_read should be renamed to read and read to read_unchecked, but this is a breaking and abrasive change, so we should consider a way of migrating the interface that doesn't startle the users.

Guide contributeur

Direction de recherche
Tout d'abord, localisez la structure `StorageKey` et ses méthodes `read` et `try read` dans la base de code Sway (probablement dans `sway core` ou `sway types`). Examinez les commentaires de l'issue pour toute stratégie de migration proposée. Envisagez d'implémenter un avertissement de dépréciation pour l'ancienne méthode `read` et de la renommer en `read unchecked`, puis renommez `try read` en `read`. Assurez vous de mettre à jour toutes les utilisations dans l'ensemble de la base de code et que les tests passent. Si le chemin de migration n'est pas clair, impliquez les mainteneurs pour en définir un.
Stack technique
rust
Domaine
blockchain
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
En attente d'un mainteneur
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Familiarity with StorageKey APIUnderstanding of storage initialization
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40