FuelLabs/sway

Rename storage access methods

Open

Aperta il 4 lug 2023

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Rust (61.702 star) (5421 fork)batch import
breakingcompiler: uienhancementgood first issuelib: stdstorageteam:compiler

Descrizione

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.

Guida contributor

Tech stack
rust
Dominio
blockchain
Tipo issue
refactor
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
needs maintainer response
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Familiarity with StorageKey APIUnderstanding of storage initialization
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
First, locate the `StorageKey` struct and its `read` and `try read` methods in the Sway codebase (likely in `sway core` or `sway types`). Review the comments in the issue for any proposed migration strategies. Consider implementing a deprecation warning for the old `read` method and renaming it to `read unchecked`, then renaming `try read` to `read`. Ensure all usages across the codebase are updated and tests pass. If a migration path is not clear, engage with maintainers to define one.