Function redeemAllTickets

  • redeemAllTickets(payload): Promise<boolean>

  • Redeems all the unredeemed HOPR tickets owned by the HOPR node. Optionally scoped to a specific counterparty address.

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

    Parameters

    • payload: {
          address?: null | string;
          apiEndpoint: string | URL;
          apiToken: string;
          timeout?: number;
      }
      • Optional address?: null | 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<boolean>

    A Promise that resolves to a boolean indicating the success of the operation.

    Throws

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

Settings

Member Visibility

Theme