Skip to main content

🏧 Withdrawals

Our bot allows you to withdraw your assets (XRP or supported tokens) securely and easily. This guide will help you understand the withdrawal process and how to use it effectively.

Process Flow:

  1. Initiation & Passphrase Verification: Secure your request by verifying your wallet password.
  2. Amount Entry: Specify the withdrawal amount.
  3. Destination Address: Provide a valid destination address.
  4. Destination Tag (if needed): If the destination address requires a destination tag, you will be prompted to enter one.
  5. Transaction Processing: The system then processes your withdrawal based on the asset type.

1. Prerequisites​

Before you initiate a withdrawal, please ensure that:

  • Wallet Setup:
    You have set up your wallet password by using the /setpass command. This stores your encrypted wallet data and ensures you have a passphrase in place.
  • Trustlines:
    If you plan to withdraw tokens (IOUs) other than XRP, make sure the necessary trustlines are in place. Info on setting up trustlines can be found in trustlines.md

2. How to Initiate a Withdrawal​

Command Format​

  • Basic Format:
    To initiate a withdrawal, simply type:

    /withdraw ASSET
    • If you do not specify an asset, the system defaults to XRP.

  • Specifying an Asset:
    You can also include an asset code and, if necessary, an explicit issuer.

    • Example without explicit issuer:

      /withdraw RLUSD

      This tells the bot you wish to withdraw RLUSD using the default issuer from our internal settings.

    • Example with explicit issuer:

      /withdraw RLUSD:rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De
      /withdraw RLUSD.rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De
      /withdraw RLUSD-rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De

This instructs the bot to use the specified issuer address for the withdrawal of RLUSD.

  • Shorthand Amounts:
    When entering withdrawal amounts (later in the process), you can use shorthand notations:
    • k for thousand (e.g., 100k means 100,000)
    • m for million (e.g., 1m means 1,000,000)
    • b for billion, t for trillion, and q for quadrillion
      This makes it easier to work with large numbers without typing out the entire value.

Step-by-Step Flow​

  1. Command Input:
    You send a command like /withdraw RLUSD in your chat.
    • If you do not specify an asset, the bot assumes XRP.
    • If you provide an asset with an explicit issuer (using a colon or another delimiter), the bot will parse it and validate the issuer address.
  2. Wallet & Passphrase Verification:
    The bot checks whether you have a passphrase set (via /setpass). If not, you will be prompted to set one before continuing with your withdrawal.
  3. Prompt for Wallet Password:
    You are then prompted to enter your wallet password. This ensures that you are the rightful owner of the funds and that the withdrawal is authorized.
  4. Withdrawal Processing:
    After you reply with your password, the bot decrypts your wallet data and processes your withdrawal request on the XRPL. You will receive a confirmation message along with a link to view the transaction on an explorer if the withdrawal is successful.

3. Additional Details​

Trustline Withdrawals​

  • Token Withdrawals:
    If you are withdrawing a token (e.g., RLUSD), ensure that a trustline is already in place on the recipient wallet.

Handling Limits.​

  • Shorthand Conversion:
    The bot supports shorthand inputs for withdrawal amounts. For example, entering 1m will be treated as 1,000,000.

Security & Validation​

  • Secure Processing:
    All sensitive operations (like decrypting wallet data and sending transactions) are performed securely. The bot verifies your wallet password and only processes the withdrawal if your credentials match.
  • Input Validation:
    The bot validates all inputs including asset codes, issuer addresses, and withdrawal amounts. If an error is detected (e.g., an invalid issuer or a non-positive amount), you will receive a clear error message explaining the issue.

4. Examples​

Example 1: Withdrawing XRP​

/withdraw
  • Result:
    Initiates a withdrawal using XRP as the default asset.

Example 2: Withdrawing RLUSD Using Default Issuer​

/withdraw RLUSD
  • Result:
    The bot looks up the default issuer for RLUSD from its internal mapping and proceeds with the withdrawal.

Example 3: Withdrawing RLUSD with an Explicit Issuer​

/withdraw RLUSD:rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De
  • Result:
    The bot uses the specified issuer for the withdrawal of RLUSD.

5. Troubleshooting​

  • No Passphrase Set:
    If you haven’t set your wallet passphrase yet, the bot will instruct you to do so via /setpass before you can proceed with a withdrawal.
  • Invalid Input:
    If you enter an invalid asset or limit, the bot will return an error message with guidance on the correct format (e.g., ensure the issuer is a valid XRP address or the amount is a positive number).
  • Trustline Not Added:
    For token withdrawals, ensure you have added the trustline for the asset. If not, you may be prompted to use the /addtrustline command.

By following this guide, you’ll be able to withdraw your assets securely and efficiently. If you encounter any issues or need further assistance, please refer to our contact-us.md section. Enjoy your streamlined withdrawal experience on the XRPL!