You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description
Add dedicated crate-level documentation for contracts/stream_contract so integrators have a single entry point covering the public API, lifecycle, fee/treasury model, event topics, and error codes.
Type of Change
🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
contract overview and stream lifecycle (create/top_up/withdraw/cancel/pause/resume)
protocol fee and treasury model details
explicit note on fee rounding-to-zero behavior
full event topic reference
StreamError code/variant table
Added package description to contracts/stream_contract/Cargo.toml.
Wired crate docs to README via #![doc = include_str!("../README.md")] in contracts/stream_contract/src/lib.rs so generated docs and source of truth stay aligned.
Testing
Test Coverage
Unit tests added/updated
Integration tests added/updated
Manual testing performed
Test Steps
Open contracts/stream_contract/README.md and verify API, fee model, events, and error table are present.
Verify contracts/stream_contract/src/lib.rs includes #![doc = include_str!("../README.md")].
Verify contracts/stream_contract/Cargo.toml includes a description field.
Breaking Changes
Breaking Changes:
None.
Checklist
My code follows the project's style guidelines
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published
I have checked for breaking changes and documented them if applicable
your branch is green, but it went conflicting after the ci fixes landed on main: #969 and #974 touched backend/Dockerfile and backend/src/workers/soroban-event-worker.ts, which this pr also edits. please rebase on main and it should be good to go: git fetch origin && git rebase origin/main && git push --force-with-lease. if any of your Dockerfile or soroban-event-worker changes overlap what #969 already did (copying prisma/ into the runner, and the import type { Prisma } from '../generated/prisma' fix), drop those now-redundant bits and keep just your actual change. i'll re-review and merge once it's rebased and ci is green.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add dedicated crate-level documentation for
contracts/stream_contractso integrators have a single entry point covering the public API, lifecycle, fee/treasury model, event topics, and error codes.Type of Change
Related Issues
Closes #798
Changes Made
contracts/stream_contract/README.mdwith:create/top_up/withdraw/cancel/pause/resume)StreamErrorcode/variant tablecontracts/stream_contract/Cargo.toml.#![doc = include_str!("../README.md")]incontracts/stream_contract/src/lib.rsso generated docs and source of truth stay aligned.Testing
Test Coverage
Test Steps
contracts/stream_contract/README.mdand verify API, fee model, events, and error table are present.contracts/stream_contract/src/lib.rsincludes#![doc = include_str!("../README.md")].contracts/stream_contract/Cargo.tomlincludes adescriptionfield.Breaking Changes
Breaking Changes:
Checklist