Skip to content

docs(dx): add unified error code catalog with CI validation - #170

Merged
truthixify merged 2 commits into
wraith-protocol:developfrom
amosleoamadi:fix/doc
Aug 27, 2026
Merged

docs(dx): add unified error code catalog with CI validation#170
truthixify merged 2 commits into
wraith-protocol:developfrom
amosleoamadi:fix/doc

Conversation

@amosleoamadi

@amosleoamadi amosleoamadi commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Closes #168


  • Add stellar/ERRORS.md with a table per contract listing every ContractError variant:
    Code | Name | Meaning | Introduced in
    Cross‑reference each row to the line in source where the variant is defined.
  • Add a Code allocation policy section that reserves disjoint numeric ranges per contract to prevent future collisions.
  • Add a CI step (.github/workflows/ci.yml) that greps all ContractError enums in the source and fails if any variant is missing from ERRORS.md.
  • Link to the catalog from stellar/README.md and from each contract’s README.md for discoverability.

@drips-wave

drips-wave Bot commented Aug 25, 2026

Copy link
Copy Markdown

@amosleoamadi Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@truthixify

Copy link
Copy Markdown
Contributor

Thanks @amosleoamadi. #169 just merged and it created the six per-contract READMEs that this PR adds cross-link lines to, so five files now conflict:

governance, stealth-announcer, stealth-batch-sender, stealth-vault, wraith-asset-policy READMEs.

When you rebase, keep both sides: their new README body plus your ERRORS.md cross-link line at the bottom.

git fetch origin
git rebase origin/develop

stellar/ERRORS.md and the CI validation step are clean, only the READMEs collide. The catalog check script itself looks good.

@truthixify
truthixify merged commit cf6bddb into wraith-protocol:develop Aug 27, 2026
13 checks passed
@truthixify

Copy link
Copy Markdown
Contributor

Merged. Thanks for turning the rebase around @amosleoamadi, and for keeping both sides on the README conflicts rather than clobbering. The catalog check script is the durable part here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consolidated error-code catalog (stellar/ERRORS.md)

2 participants