FuelLabs/sway

Add a section which documents storage interaction in libraries

Open

#2.872 geöffnet am 27. Sept. 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (5.421 Forks)batch import
The Sway Bookgood first issue

Repository-Metriken

Stars
 (61.702 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 22h 6m) (16 gemergte PRs in 30 T)

Beschreibung

The current documentation does not state whether storage can be "used" inside a library. The cause for concern is that there are cases that work and some that do not therefore it's unclear how to proceed.

The book should have content detailing how a library may or may not interact with storage. This could be added to the "workarounds" section.

For example:

  1. Can a library have a storage {} block?
  2. Can a function inside of a library take an argument directly from storage e.g. fn name(var: storage) where var might be a StorageMap etc.
  3. Can a library simply refer to storage without it being declared anywhere e.g. fn() { storage.thing = 1; }?
  4. Can a library use storage manually via the get and store functions?

Contributor Guide

Research-Richtung
Überprüfen Sie den Abschnitt „Workarounds“ im Sway Buch und fügen Sie einen Unterabschnitt hinzu, der erklärt, wie Bibliotheken mit dem Speicher interagieren können, und beantworten Sie die vier Beispielfragen.
Tech Stack
Keine
Domain
documentationblockchain
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitSway
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75