Skip to content

Add SDK observability hooks design #222

Description

@El-swaggerito

Description

Difficulty: Expert

Type: Feature

Summary

Design safe observability hooks for SDK consumers to track non-sensitive operation progress.

Current Behaviour

Consumers may need progress events for payments and vault actions, but logging sensitive data is risky.

Expected Behaviour

The SDK should expose safe lifecycle events without leaking secrets.

Suggested Implementation

Design hooks for transaction stages, network calls, retries, and final outcomes with redaction rules.

Files or Areas Likely Affected

src/transactions/
src/network/
src/types/
docs/

Acceptance Criteria

  • Observability hook design is added.
  • Events avoid sensitive data.
  • Transaction lifecycle stages are covered.
  • Redaction rules are documented.
  • Examples show consumer usage.

Additional Notes

This should not become verbose logging by default.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labeldeveloper-experienceDeveloper experience 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