FuelLabs/sway

Add a section which documents storage interaction in libraries

Open

#2,872 opened on Sep 27, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
The Sway Bookgood first issue

Description

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

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of SwayUnderstanding of storage in smart contracts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue asks to add a documentation section clarifying how libraries interact with storage in Sway. To start, review the existing documentation files in the repository (likely under the 'docs' or 'book' directory). Focus on the 'workarounds' section mentioned. Then, research how storage is currently used in library examples and test cases. The documentation should address the four specific questions: whether a library can have a `storage {}` block, accept arguments from storage directly, refer to storage without declaration, and use manual `get` and `store` functions. Provide clear answers with examples based on the Sway compiler's behavior. Look for any related discussions or PRs (none linked) for additional context.