FuelLabs/sway

Rename storage access methods

Open

#4,740 opened on Jul 4, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
breakingcompiler: uienhancementgood first issuelib: stdstorageteam:compiler

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 5d 4h) (19 merged PRs in 30d)

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.

Contributor guide

Research direction
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.
Tech stack
rust
Domain
blockchain
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Familiarity with StorageKey APIUnderstanding of storage initialization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40