Complexity / points: Medium (150 points) - maintainer label: points-150-medium
PR must include:
Problem
The repo has one root Readme.md, but there are no contract-specific README files under contracts/invoice-escrow, contracts/invoice-token, or contracts/payment-distributor.
That makes it harder for contributors/integrators to:
- find the contract’s purpose
- find example call flows
- understand each contract’s inputs, auth expectations, and error cases
Proposed change
Add per-contract README files with a small, consistent structure.
Acceptance criteria
Dependencies
Recommended after [Docs] Add missing docs/API.md for contract public methods so the per-contract docs can link to a single source of truth.
Complexity / points: Medium (150 points) - maintainer label: points-150-medium
PR must include:
Closes #16in the PR descriptionunwrap()in production Soroban contract paths (project convention)cargo testpasses locally; match CI (cargo fmt,cargo clippy -D warnings) when touching RustProblem
The repo has one root
Readme.md, but there are no contract-specific README files undercontracts/invoice-escrow,contracts/invoice-token, orcontracts/payment-distributor.That makes it harder for contributors/integrators to:
Proposed change
Add per-contract README files with a small, consistent structure.
Acceptance criteria
contracts/invoice-escrow/README.mdcontracts/invoice-token/README.mdcontracts/payment-distributor/README.md(documenting current stub status if still unimplemented)docs/API.md(once created)Dependencies
Recommended after
[Docs] Add missing docs/API.md for contract public methodsso the per-contract docs can link to a single source of truth.