Skip to content

Error code reference (tabular + SDK / CLI / indexer coverage) #121

Description

@truthixify

Tier: S (1-2 days) | Type: reference

Context. guides/stellar-troubleshooting.mdx already documents 20 failure modes across 6 categories (Account & Balance, Network, Signing, Stealth-Specific, Soroban Contract, plus more) as narrative subheadings. Two things are missing: (a) a normative tabular view suitable for grep and citation, and (b) coverage of SDK Error subclasses, CLI errors, and indexer errors, which the troubleshooting page does not touch. Support keeps re-typing SDK error explanations in Discord because they are not linkable.

Scope.

  • New reference/error-codes.mdx as a normative flat table.
  • One table per source: Stellar contract errors, SDK errors, indexer errors, CLI errors.
  • Each row: code, symbolic name, human meaning, most common cause, fix, cross-link to stellar-troubleshooting.mdx where the narrative version exists.
  • Cross-link back from every entry in stellar-troubleshooting.mdx to the corresponding tabular row.
  • Auto-generation note in scripts/ if source-of-truth lives in a repo constant.

Acceptance.

  • Every Error subclass exported from @wraith-protocol/sdk appears
  • Every contract Error variant in reference/stellar/contracts/ appears
  • Every category / subheading in stellar-troubleshooting.mdx is cross-linked to a matching row
  • Renders in mint dev
  • Passes Compile docs snippets CI
  • Nav entry under Reference

Files. reference/error-codes.mdx (new), guides/stellar-troubleshooting.mdx, docs.json (nav).

Activity

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocsDocumentationdripsFunded via Drips Networkhelp wantedExtra attention is neededreferenceAuto-created for Wave 8stellar-waveAuto-created for Wave 8wave-8Auto-created for Wave 8writing

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions