FuelLabs/sway

Rename storage access methods

Open

#4,740 建立於 2023年7月4日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Rust (61,702 star) (5,421 fork)batch import
breakingcompiler: uienhancementgood first issuelib: stdstorageteam:compiler

描述

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.

貢獻者指南

技術棧
rust
領域
blockchain
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Familiarity with StorageKey APIUnderstanding of storage initialization
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.