Function getChannel

  • getChannel(payload): Promise<{
        balance: string;
        channelEpoch: number;
        channelId: string;
        closureTime: number;
        destinationAddress: string;
        destinationPeerId: string;
        sourceAddress: string;
        sourcePeerId: string;
        status: "Open" | "PendingToClose" | "Closed";
        ticketIndex: string;
    }>

  • Parameters

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

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • channelId: string
      • Optional timeout?: number

        optional timeout for the requests

    Returns Promise<{
        balance: string;
        channelEpoch: number;
        channelId: string;
        closureTime: number;
        destinationAddress: string;
        destinationPeerId: string;
        sourceAddress: string;
        sourcePeerId: string;
        status: "Open" | "PendingToClose" | "Closed";
        ticketIndex: string;
    }>

Settings

Member Visibility

Theme