Function cashOut

  • cashOut(payload): Promise<{
        hopr?: string;
        native?: string;
    }>

  • Withdraw all funds from the node. Does not include funds locked in open channels. This is a long running function and may take a more than 5 minutes to run

    Parameters

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

    The transaction receipts for the cash out transactions.

Settings

Member Visibility

Theme