Skip to content

docs: fix issue citations, document all contracts, add obligation ABI… - #632

Open
dripscodes wants to merge 1 commit into
stellar-vortex-protocol:mainfrom
dripscodes:docs/fix-524-525-526-527
Open

dripscodes wants to merge 1 commit into
stellar-vortex-protocol:mainfrom
dripscodes:docs/fix-524-525-526-527

Conversation

@dripscodes

Copy link
Copy Markdown

…, extend local testing guide

Closes #524
closes #525
closes #526
closes #527

Summary

Related issue

Type of change

  • Bug fix
  • New feature
  • Refactor
  • Documentation
  • CI / tooling

Component

  • Contract (vortex-contract)
  • Backend (vortex-backend)
  • Frontend (vortex-frontend)

Checklist

  • My code follows the project's style and conventions
  • I ran lint / type-check / build locally and they pass
  • I added or updated tests where appropriate
  • I updated documentation where appropriate
  • My commits follow Conventional Commits

Screenshots / notes

…, extend local testing guide

Closes stellar-vortex-protocol#524, stellar-vortex-protocol#525, stellar-vortex-protocol#526, stellar-vortex-protocol#527

- GOVERNANCE.md: replace wrong stellar-vortex-protocol#35/stellar-vortex-protocol#43 citations for set_config timelock
  with the correct tracking issue stellar-vortex-protocol#220; also fix the Reference section footer
- README.md: add ### subsections for all 9 previously undocumented contracts
  (solver_registry, proof_registry, reputation_badge, governor, backstop_vault,
  fee_router, intent_periphery, timelock, treasury_streams) with full public ABI
- docs/solver-registry-interface.md: document lock_obligation, release_obligation,
  get_open_obligations, has_obligation in §2.3 and §3; add obligation-tracking
  explanation paragraph
- docs/local-integration-testing.md: extend build step and Deploy All Contracts
  script to cover all 10 crates; add Testing the Newer Contracts section with
  CLI examples for governor, backstop_vault, fee_router, intent_periphery,
  treasury_streams
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants