Skip to content

[Docs] stream_contract crate has no README documenting public API, events, errors, and fee model #798

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

There is no README anywhere under contracts/stream_contract and Cargo.toml has no description field. New integrators have no single entry point describing the create/top_up/withdraw/cancel/pause/resume lifecycle, the fee/treasury model (MAX_FEE_RATE_BPS=1000), the emitted events, or the StreamError codes.

Acceptance criteria

  • Add contracts/stream_contract/README.md covering the public entrypoints, the protocol-fee/treasury model, the event topics, and the StreamError table
  • Optionally add a description to Cargo.toml

Files to touch

  • contracts/stream_contract/Cargo.toml
  • contracts/stream_contract/src/lib.rs

Out of scope

  • Repo-root README or CONTRIBUTING.md

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions