Skip to content

[Contracts] errors.rs error variants lack doc comments describing when each is returned #1008

Description

@grantfox-oss

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

Why this matters

errors.rs defines the StreamError enum consumed by both the contract and the indexer, but individual variants have no doc comments, so callers have to grep call sites to understand when each error fires.

Acceptance criteria

  • Add a doc comment above every StreamError variant explaining the triggering condition
  • Cross-check each comment against actual usage in lib.rs to keep it accurate

Files to touch

  • contracts/stream_contract/src/errors.rs
  • contracts/stream_contract/src/lib.rs

Out of scope

Does not add, remove, or renumber error variants.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26contractsSmart 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