-
Notifications
You must be signed in to change notification settings - Fork 91
Implement contract error code documentation #558
Copy link
Copy link
Open
Labels
GrantFox OSSIssue tracked for GrantFox OSS contributionIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelOfficial GrantFox campaign labelcontractSmart contract related workSmart contract related workdeveloper-experienceDeveloper experience workDeveloper experience workdocumentationDocumentation workDocumentation workhardHard difficultyHard difficultysorobanSoroban smart contract workSoroban smart contract work
Description
Activity
Metadata
Metadata
Assignees
Labels
GrantFox OSSIssue tracked for GrantFox OSS contributionIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelOfficial GrantFox campaign labelcontractSmart contract related workSmart contract related workdeveloper-experienceDeveloper experience workDeveloper experience workdocumentationDocumentation workDocumentation workhardHard difficultyHard difficultysorobanSoroban smart contract workSoroban smart contract work
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
Acceptance Criteria
Additional Notes
This supports SDK and mobile integration.