Docs 798 stream contract readme - #946
Conversation
|
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: |
|
Noted. making those changes now. |
|
I created a new pr-946-clean from upstream/main and cherry-picked only the intended PR 946 commits. Heres the link: #978. Kindly review once more. |
|
closing as superseded by #978. the contracts part (Cargo.toml, README, lib.rs docs, the rounded-zero test) is byte-identical to #978, but this pr also bundles unrelated frontend changes (it guts streams/create/page.tsx and leaves an unbalanced JSX artifact in dashboard-view.tsx from a stale merge base), which is what makes it conflict. #978 is the clean contracts-only version, so i took that. thanks! |
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