Skip to content

[Contracts] storage.rs read/write helpers have no doc comments explaining TTL/bump semantics #1007

Description

@grantfox-oss

Join our community: https://t.me/+DOylgFv1jyJlNzM0

Why this matters

storage.rs centralizes ledger reads and writes for streams and config, but the functions have no rustdoc explaining storage key layout or ledger TTL bump behavior, which makes it hard for new contributors to reason about persistence costs.

Acceptance criteria

  • Add rustdoc to each public function in storage.rs describing the key it touches and any TTL bump it performs
  • Document the storage key enum/variants used across the module
  • No behavior change, comments only

Files to touch

  • contracts/stream_contract/src/storage.rs

Out of scope

Does not change storage layout or add new storage entries.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programThird CampaignCampaign: Third CampaigncontractsSmart contract related tasksdocsDocumentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions