FuelLabs/sway

Rename storage access methods

Open

#4.740 geöffnet am 4. Juli 2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (5.421 Forks)batch import
breakingcompiler: uienhancementgood first issuelib: stdstorageteam:compiler

Repository-Metriken

Stars
 (61.702 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 4h) (19 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Zuerst suche die `StorageKey` Struktur und ihre `read` und `try read` Methoden in der Sway Codebasis (wahrscheinlich in `sway core` oder `sway types`). Überprüfe die Kommentare im Issue auf vorgeschlagene Migrationsstrategien. Erwäge, eine Veraltungswarnung für die alte `read` Methode zu implementieren und sie in `read unchecked` umzubenennen, dann benenne `try read` in `read` um. Stelle sicher, dass alle Verwendungen in der gesamten Codebasis aktualisiert werden und die Tests bestehen. Wenn der Migrationspfad nicht klar ist, beziehe die Maintainer ein, um einen zu definieren.
Tech Stack
rust
Domain
blockchain
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Wartet auf Maintainer Antwort
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Familiarity with StorageKey APIUnderstanding of storage initialization
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40