Function redeemChannelTickets

  • redeemChannelTickets(payload): Promise<boolean>

  • Redeems all the unredeemed HOPR tickets in a 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<boolean>

    A Promise that resolves to a boolean indicating the success of the operation. True if the operation is successful, false otherwise.

    Throws

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

Settings

Member Visibility

Theme