Function getChannels

  • getChannels(payload): Promise<{
        all: {
            balance: string;
            channelEpoch: number;
            channelId: string;
            closureTime: number;
            destinationAddress: string;
            destinationPeerId: string;
            sourceAddress: string;
            sourcePeerId: string;
            status: "Open" | "PendingToClose" | "Closed";
            ticketIndex: string;
        }[];
        incoming: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
        outgoing: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
    }>

  • Parameters

    • payload: {
          apiEndpoint: string | URL;
          apiToken: string;
          fullTopology?: boolean;
          includingClosed?: boolean;
          timeout?: number;
      }
      • apiEndpoint: string | URL

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • Optional fullTopology?: boolean
      • Optional includingClosed?: boolean
      • Optional timeout?: number

        optional timeout for the requests

    Returns Promise<{
        all: {
            balance: string;
            channelEpoch: number;
            channelId: string;
            closureTime: number;
            destinationAddress: string;
            destinationPeerId: string;
            sourceAddress: string;
            sourcePeerId: string;
            status: "Open" | "PendingToClose" | "Closed";
            ticketIndex: string;
        }[];
        incoming: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
        outgoing: {
            balance: string;
            id: string;
            peerAddress: string;
            status: "Open" | "PendingToClose" | "Closed";
        }[];
    }>

Settings

Member Visibility

Theme