Interface NodeExtension

interface NodeExtension {
    node: {
        node: ((address) => Promise<undefined | Node>);
        nodes: ((status, pagination?) => Promise<QueryNodesResponse>);
        nodesForPlan: ((id, status, pagination?) => Promise<QueryNodesForPlanResponse>);
        params: (() => Promise<undefined | Params>);
    };
}

Properties

node

Properties

Readonly node

node: {
    node: ((address) => Promise<undefined | Node>);
    nodes: ((status, pagination?) => Promise<QueryNodesResponse>);
    nodesForPlan: ((id, status, pagination?) => Promise<QueryNodesForPlanResponse>);
    params: (() => Promise<undefined | Params>);
}

Type declaration

  • node: ((address) => Promise<undefined | Node>)
      • (address): Promise<undefined | Node>

      • Parameters

        • address: string

        Returns Promise<undefined | Node>

  • nodes: ((status, pagination?) => Promise<QueryNodesResponse>)

    Query nodes by status.

    NOTE: Sentinel chain v3 does not return pagination.next_key for this query even when results are truncated. To enumerate all nodes reliably, do not loop on next_key or rely on offset: current mainnet queries can return no results for a non-zero offset. Use a sufficiently large limit in a single call instead.

    Reproducible against mainnet: a status=ACTIVE query that has more than limit matching nodes still returns next_key=null.

      • (status, pagination?): Promise<QueryNodesResponse>

      • Query nodes by status.

        NOTE: Sentinel chain v3 does not return pagination.next_key for this query even when results are truncated. To enumerate all nodes reliably, do not loop on next_key or rely on offset: current mainnet queries can return no results for a non-zero offset. Use a sufficiently large limit in a single call instead.

        Reproducible against mainnet: a status=ACTIVE query that has more than limit matching nodes still returns next_key=null.

        Parameters

        Returns Promise<QueryNodesResponse>

  • nodesForPlan: ((id, status, pagination?) => Promise<QueryNodesForPlanResponse>)

    Query nodes joined to a plan by status. Same next_key caveat as nodes() — chain v3 does not emit it on truncation and non-zero offsets are not reliable. Use a sufficiently large limit in one call.

      • (id, status, pagination?): Promise<QueryNodesForPlanResponse>

      • Query nodes joined to a plan by status. Same next_key caveat as nodes() — chain v3 does not emit it on truncation and non-zero offsets are not reliable. Use a sufficiently large limit in one call.

        Parameters

        Returns Promise<QueryNodesForPlanResponse>

  • params: (() => Promise<undefined | Params>)
      • (): Promise<undefined | Params>

      • Returns Promise<undefined | Params>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc