Skip to content

docs: add contract error codes reference for off-chain clients - #570

Open
LouisDeconinck wants to merge 1 commit into
UnityChainxx:mainfrom
LouisDeconinck:main
Open

LouisDeconinck wants to merge 1 commit into
UnityChainxx:mainfrom
LouisDeconinck:main

Conversation

@LouisDeconinck

Copy link
Copy Markdown

Add comprehensive error codes documentation for stellar_hunts and
stellar_hunts_nft contracts. Includes numeric discriminants, entry points
that raise each error, and descriptions for off-chain client integration.

Changes

  • Created onchain/docs/error-codes.md with error code tables for both contracts
  • Updated README.md to reference the new documentation
  • Updated RELEASE.md to include error codes documentation in release process
  • Generated error mapping by analyzing Error enums with sed command and mapping error usages to functions

Documentation Coverage

  • stellar_hunts: 12 error codes with entry points and descriptions
  • stellar_hunts_nft: 6 error codes with entry points and descriptions
  • Includes reserved/legacy code notes and off-chain client integration guidance

Fixes #469

Add comprehensive error codes documentation for stellar_hunts and
stellar_hunts_nft contracts. Includes numeric discriminants, entry points
that raise each error, and descriptions for off-chain client integration.

Generated by analyzing Error enums with sed command and mapping error
usages to functions based on line numbers.

Fixes UnityChainxx#469
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.

Document the contract error code surface for off-chain clients

1 participant