FuelLabs/sway

Rename storage access methods

Open

#4.740 aberto em 4 de jul. de 2023

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (5.421 forks)batch import
breakingcompiler: uienhancementgood first issuelib: stdstorageteam:compiler

Métricas do repositório

Stars
 (61.702 stars)
Métricas de merge de PR
 (Mesclagem média 5d 4h) (19 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Primeiro, localize a struct `StorageKey` e seus métodos `read` e `try read` na base de código do Sway (provavelmente em `sway core` ou `sway types`). Revise os comentários na issue para quaisquer estratégias de migração propostas. Considere implementar um aviso de depreciação para o método antigo `read` e renomeá lo para `read unchecked`, depois renomeie `try read` para `read`. Certifique se de atualizar todos os usos em toda a base de código e que os testes passem. Se o caminho de migração não estiver claro, envolva os mantenedores para definir um.
Pilha de tecnologia
rust
Domain
blockchain
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Aguardando mantenedor
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Familiarity with StorageKey APIUnderstanding of storage initialization
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40