Skip to content

[ENHANCEMENT] Add a dedicated TrustFlowClient.healthCheck() method for monitoring/status-page use cases #809

Open

Description

@meshackyaro

Description

Apps embedding the SDK server-side (e.g. a backend integration layer) want a single lightweight call to confirm "is the SDK's configured RPC and contract reachable right now" for their own health/status endpoints, without reimplementing connectivity checks themselves.

Component

core

Motivation

This directly addresses the related bug where .connect() doesn't actually verify contract existence; a dedicated, explicitly-named health check method both fixes the gap and gives a clear, intention-revealing API for monitoring use cases specifically.

Proposed Solution

Add healthCheck() returning { ok: boolean, rpcReachable: boolean, contractExists: boolean, latencyMs: number }, usable independently of (and without changing the behavior of) .connect().

Acceptance Criteria

  • Correctly reports contractExists: false for a valid-but-nonexistent contract ID
  • Reports latency for the underlying RPC round trip
  • Documented with an example wiring it into an Express/Fastify health route

Difficulty

🟢 Easy

Estimated Time

1 day

Additional Context

Complements rather than replaces fixing .connect()'s own validation gap filed as a separate bug.

Activity

  1. shobhamerabacha-star commented on Oct 29, 2026

    @shobhamerabacha-star

    Greetings,

    I looked into the details for "[ENHANCEMENT] Add a dedicated TrustFlowClient.healthCheck() method for monitoring/status-page use cases" and would like to contribute the fix.

    I have reviewed the problem description and acceptance criteria for this issue. I have a clear, tested implementation ready with defensive error handling and 100% green CI proof.

    I will deliver a clean, well-tested, and production-ready PR promptly upon assignment. Kindly assign this issue to me.

    Thank you!

  2. xtep103 commented on Oct 30, 2026

    @xtep103

    Hi maintainer,I’m interested in contributing to the task and can ensure timely delivery with clean implementation.

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions