Skip to content

Add SDK diagnostics and observability hooks with strict redaction #276

Description

@El-swaggerito

Description

Difficulty: Expert

Type: Feature

Summary

Implement SDK diagnostics and observability hooks for configuration, network state, transaction lifecycle, wallet capability, and vault readiness.

Current Behaviour

Apps need debug information, but diagnostics can leak secret keys, raw payloads, or sensitive transaction material.

Expected Behaviour

The SDK should expose opt-in diagnostics with strict redaction and safe lifecycle events.

Suggested Implementation

Create diagnostics report types, event hook interfaces, redaction rules, module integrations, fixtures, tests, and documentation.

Files or Areas Likely Affected

  • src/diagnostics/
  • src/config/
  • src/network/
  • src/transactions/
  • src/wallet/
  • src/vault/
  • src/errors/
  • tests/
  • docs/

Acceptance Criteria

  • Diagnostics report model is implemented.
  • Lifecycle hooks are opt-in.
  • Secrets and sensitive values are redacted.
  • Configuration and network state are represented safely.
  • Tests verify redaction behaviour.
  • Documentation explains safe support workflows.

Additional Notes

This should support debugging without compromising user safety.

Activity

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

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labeldiagnosticsDiagnostics and observability workexpertExpert difficultyfeatureFeature worksdkSDK related worksecuritySecurity sensitive work

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions