Skip to content

Add SDK account diagnostics report #444

Description

@El-swaggerito

Description

Difficulty: Expert

Type: Feature

Summary

Add an account diagnostics report for SDK consumers.

Current Behaviour

Applications may not have a single safe way to diagnose account state, network state, configuration, and payment readiness.

Expected Behaviour

The SDK should expose a redacted diagnostics report suitable for support and debugging.

Suggested Implementation

Create diagnostics types, account checks, config checks, network checks, redaction, tests, and docs.

Files or Areas Likely Affected

  • src/accounts/
  • src/diagnostics/
  • src/config/
  • src/network/
  • tests/
  • docs/

Acceptance Criteria

  • Account diagnostics report is implemented.
  • Account, network, and config states are represented.
  • Sensitive data is redacted.
  • Payment readiness is referenced where appropriate.
  • Tests verify healthy and failing diagnostics.
  • Docs explain safe sharing of diagnostics.

Additional Notes

Diagnostics must not expose secrets.

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 labelaccountsAccount related workconfigConfiguration related workdiagnosticsDiagnostics and observability workexpertExpert difficultyfeatureFeature worksdkSDK related work

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions