Docs 798 stream contract readme#946
Open
Killerjunior wants to merge 3 commits into
Open
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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