FuelLabs/sway

Rename storage access methods

Open

#4,740 opened on 2023年7月4日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Rust (61,702 stars) (5,421 forks)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
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.