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.