Epic: Soroban stream storage, events, and errors

[ogazboiz]

Summary

Strengthen how StreamContract stores data, defines keys, emits events, and surfaces errors so that off chain indexers and clients can reliably interpret stream state.

Scope

• Introduce a DataKey enum or similar pattern for:
  • Global stream id counter.
  • Individual stream records.
• Replace ad hoc storage keys with a single convention.
• Ensure all public methods use the same storage helpers.
• Extend StreamError to cover:
  • Missing stream.
  • Inactive stream.
  • Unauthorized sender or recipient.
• Ensure events are emitted for create, top up, withdraw, and cancel with all relevant fields.

Acceptance Criteria

• No duplicate helper functions like get_stream or top_up_stream.
• All storage access goes through a centralized key strategy.
• Tests assert on error variants for invalid operations.
• Events can be filtered by stream id and event type in indexers.

[drips-wave]

This issue has been added to the Stellar Wave Program and is worth 200 Points.

🧑‍💻 Interested in contributing? Apply to work on this issue on Drips Wave, earn points, and receive rewards.

Warning

Only applications submitted via the apply link above will be considered. Please do not apply by commenting on the issue or opening a PR directly.

🤠 Repo maintainers: You can manage this issue's Points and Complexity on your Maintainer Dashboard here. Please keep an eye on applications and respond quickly 💙

ℹ️ Learn more about Drips Wave

[Wilfred007]

@Wilfred007 has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hi maintainer will you be kind enough to assign this issue to me?

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Wilfred007 to this issue.

[Properprogress1]

@Properprogress1 has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hey maintainer,
I’d love to take on #124 — the big cleanup for how FlowFi stores stream data, sends updates, and handles mistakes.
Right now things are a bit messy inside the contract, which makes it hard for apps, wallets and indexers to understand what’s happening with each stream. I want to fix that so everything feels reliable and professional.
Why I’m a good fit:

I’ve worked on several payment and streaming contracts on Soroban — I know how to organize things so outside tools can easily follow along.
I care about making life easier for indexers and front-ends (no more guessing what an event means).

What I’ll do (simple steps):

Create one clear system for all storage keys (like a single address book for every stream and the global counter) — no more random or repeated ways of saving things.

Use the same helper functions everywhere so there’s only one correct way to read/write stream data — no duplicate code.

Add better, more specific error messages (e.g. “stream not found”, “you’re not allowed”, “stream already cancelled”) so it’s obvious why something failed.

Make sure every important action (create, add money, withdraw, cancel) sends a clear event with all the useful details (stream ID, amount, who did it, etc.) — easy for indexers to filter and show in apps.

Write tests that prove:
the new organized storage is used everywhere
wrong actions give the right error
events come out correctly so tools can listen for them

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Properprogress1 to this issue.

[Arowolokehinde]

@Arowolokehinde has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

can i work on this issue @ogazboiz?
i have the necessary expertise needed to work on this

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Arowolokehinde to this issue.

[drips-wave]

Congratulations, @Arowolokehinde! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on February 26, 2026.

🧑‍💻 @Arowolokehinde: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are issued when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊

[drips-wave]

This issue has been completed by @Arowolokehinde as part of the Stellar Wave Program's 2nd Wave 🥳

😎 @Arowolokehinde: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.