Function closeChannel

  • closeChannel(payload): Promise<{
        channelStatus: "Open" | "PendingToClose" | "Closed";
        receipt: string;
    }>

  • Closes a HOPR channel given a payload that specifies the API endpoint of the HOPR node, the peerId and the direction of the channel.

    This operation may take more than 5 minutes to complete as it involves on-chain operations.

    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<{
        channelStatus: "Open" | "PendingToClose" | "Closed";
        receipt: string;
    }>

    A Promise that resolves with the response of the close channel operation.

    Throws

    APIError - If the operation fails. The error object contains the status code and the error message.

Settings

Member Visibility

Theme