Repository navigation
Add SDK diagnostics report for support and debugging #13
Description
Description
Difficulty: Expert
Type: Feature
Summary
Add a safe diagnostics report for SDK configuration, network status, contract registry, compliance module readiness, and recent non-sensitive errors.
Current Behaviour
Developers may struggle to debug configuration and contract interaction failures.
Expected Behaviour
The SDK should generate a non-sensitive diagnostics report that can be shared in GitHub issues.
Suggested Implementation
Create diagnostics types, config snapshot, contract registry status, network health checks, redaction, tests, and documentation.
Files or Areas Likely Affected
- src/diagnostics/
- src/config/
- src/client/
- src/soroban/
- src/errors/
- tests/
- docs/
Acceptance Criteria
- Diagnostics report type is implemented.
- Network and contract config state are included.
- Compliance module readiness is represented.
- Sensitive values are redacted.
- Tests verify diagnostics output.
- Documentation explains support usage.
Additional Notes
This should help maintainers debug contributor issues.
Activity
Ranjeet2063 commentedon Oct 3, 2026
Hi team,
Happy to tackle this. Here is how I plan to implement it:
Implementation approach:
Please assign this to me if the plan looks good. Thanks!
woahwhattheheck commentedon Oct 8, 2026
/claim #13
Original contributor and compensation claimant: @woahwhattheheck (GitHub ID 293286387). The completed issue-scoped implementation is upstream in PR #216. I am affirmatively claiming contributor credit and requesting any eligible GrantFox OSS / Official Campaign FWC26 bounty or compensation for the accepted contribution, subject to sponsor/program approval. No award or payment is asserted.