Interface ObservableCardanoNode

Hierarchy

  • ObservableCardanoNode

Properties

eraSummaries$: Observable<EraSummary[]>
genesisParameters$: Observable<Cardano.CompactGenesis>
healthCheck$: Observable<HealthCheckResponse>

Methods

  • Find a common point between your local state and the node.

    Keeps the observable active until unsubscribed, as this client could potentially switch to another node due to connection errors. If you only need to find intersection once, make sure to combine this with an appropriate operator (e.g. take(1))

    chainSync$ in the emitted object is an independent Observable, which keeps track of subscriber's cursor (starting from initial intersection) and can opaquely switch to another node (tracks this client).

    Throws

    CardanoNodeErrors.CardanoClientErrors.IntersectionNotFoundError when intersection point is not found by the node (probably due to a rollback). User is expected to handle the rollback and call findIntersect with a different set of points.

    Throws

    CardanoNodeErrors.CardanoClientErrors.ConnectionError after reaching reconnection maxAttempts

    Throws

    CardanoNodeErrors.CardanoClientErrors.UnknownResultError if server response doesn't match client's expectations (version mismatch?)

    Throws

    CardanoNodeErrors.UnknownCardanoNodeError on any other unexpected/unhandled errors

    Parameters

    Returns Observable<ObservableChainSync>

Generated using TypeDoc