Description
- Document approval and pull flows for integrators with sequence diagrams.
Requirements and context
- Must be secure, tested, and documented.
- Should be efficient and easy to review for auditors and integrators.
- Scope is Predictify Hybrid Soroban smart contracts in
predictify-contracts only (no frontend or backend services).
Suggested execution
- Fork the repository and create a branch:
git checkout -b feature/token-allowance-docs
- Implement changes:
- Contract / module: update logic in
contracts/predictify-hybrid/src/tokens.rs and related modules as required.
- Tests: extend or add
custom_token_tests.rs (and supporting test utilities under contracts/predictify-hybrid/src/tests/ when applicable).
- Documentation: update or add
docs/api/API_DOCUMENTATION.md; add a link from docs/README.md when adding new top-level docs.
- Comments: use Rust doc comments (
///, //!) on all new or changed public contract API — equivalent discipline to NatSpec for Solidity.
Primary touchpoints: contracts/predictify-hybrid/src/tokens.rs, contracts/predictify-hybrid/src/balances.rs
Test and commit
- Run
cargo test -p predictify-hybrid and narrow with filters while iterating.
- Add regression tests for every bug or ambiguity found during review.
- In the PR, include summarized test output and short security notes (threat model, invariants proven, explicit non-goals).
Example commit message
docs(contract): token allowance patterns
Guidelines
- Target ≥ 95% line coverage on modules touched (e.g.
cargo llvm-cov / cargo tarpaulin per repo conventions).
- Documentation must be sufficient for an external integrator without reading all Rust internals.
- Timeframe: 96 hours from assignment.
Description
Requirements and context
predictify-contractsonly (no frontend or backend services).Suggested execution
git checkout -b feature/token-allowance-docscontracts/predictify-hybrid/src/tokens.rsand related modules as required.custom_token_tests.rs(and supporting test utilities undercontracts/predictify-hybrid/src/tests/when applicable).docs/api/API_DOCUMENTATION.md; add a link fromdocs/README.mdwhen adding new top-level docs.///,//!) on all new or changed public contract API — equivalent discipline to NatSpec for Solidity.Primary touchpoints:
contracts/predictify-hybrid/src/tokens.rs,contracts/predictify-hybrid/src/balances.rsTest and commit
cargo test -p predictify-hybridand narrow with filters while iterating.Example commit message
Guidelines
cargo llvm-cov/cargo tarpaulinper repo conventions).