Skip to content

Implement contract error code documentation #558

Description

@El-swaggerito

Description

Difficulty: Hard

Type: Documentation

Summary

Document contract error codes and failure reasons.

Current Behaviour

Contract failures may be difficult for SDK and mobile consumers to interpret.

Expected Behaviour

The contracts repo should document expected errors for deposits, withdrawals, locks, balances, initialisation, and authorisation.

Suggested Implementation

Create error documentation, map errors to user-facing meanings, and link from README.

Files or Areas Likely Affected

  • docs/
  • README.md
  • contracts/
  • src/
  • tests/

Acceptance Criteria

  • Contract error code documentation is added.
  • Deposit errors are documented.
  • Withdrawal errors are documented.
  • Lock and balance errors are documented.
  • Authorisation errors are documented.
  • README links to error documentation.

Additional Notes

This supports SDK and mobile integration.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelcontractSmart contract related workdeveloper-experienceDeveloper experience workdocumentationDocumentation workhardHard difficultysorobanSoroban smart contract work

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions