Function getPeer

  • getPeer(payload): Promise<{
        announcedSources: {
            multiaddress: string;
            origin: "chain" | "dht";
        }[];
        incomingChannel?: null | {
            balance: string;
            id: string;
            status: string;
        };
        observed: string[];
        outgoingChannel?: null | {
            balance: string;
            id: string;
            status: string;
        };
        qos?: null | {
            averageLatency?: null | number;
            lastUpdate: number;
            probeRate: number;
            score: number;
        };
    }>

  • Parameters

    • payload: {
          address: string;
          apiEndpoint: string | URL;
          apiToken: string;
          timeout?: number;
      }
      • address: string
      • apiEndpoint: string | URL

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • Optional timeout?: number

        optional timeout for the requests

    Returns Promise<{
        announcedSources: {
            multiaddress: string;
            origin: "chain" | "dht";
        }[];
        incomingChannel?: null | {
            balance: string;
            id: string;
            status: string;
        };
        observed: string[];
        outgoingChannel?: null | {
            balance: string;
            id: string;
            status: string;
        };
        qos?: null | {
            averageLatency?: null | number;
            lastUpdate: number;
            probeRate: number;
            score: number;
        };
    }>

Settings

Member Visibility

Theme