Skip to main content

⚙️ Setup & Usage

Our Telegram bot is designed to enhance collaboration in project groups on the XRPL ecosystem. Whether you’re an admin managing group settings or a member sending tokens, this guide will help you get started.

1. Getting Started​

Adding the Bot to Your Group​

  • Invite the Bot:
    Use the standard Telegram “Add member” feature to invite the bot into your project group.

Group Registration & Settings​

  • Viewing Settings:
    Group admins can view the current configuration by using the command:

    /settings

    This command displays the group’s default token, issuer, trustline limit, and other available options.

2. Key Commands & Their Usage​

/send​

  • Purpose:
    Allows you to send XRP or supported tokens to any user in the group.
  • Usage Examples:

    • Reply Mode:
      Reply to someone’s message with:

      /send 10

      This sends 10 units of the groups default token to the user you replied to. (If defaults are not set, will send XRP instead.)

    • Direct Mention:

      /send @bob 10 RLUSD

      This sends 10 units of RLUSD to @bob (using the default issuer for RLUSD if not explicitly provided).

    • With Explicit Issuer:

      /send @alice 10 RLUSD:rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De

      This sends 10 units of RLUSD to Alice using the specified issuer.

/addtrustline​

  • Purpose:
    Establishes a trustline for the goup's token so you can receive IOUs.

In response, bot sends a message with a deeplink button to add the group's token trustline with the default limits.

  • Notes:
    The trustline deep link is constructed using hyphens as delimiters. If no issuer is provided, the bot looks up the appropriate issuer from its internal mapping. More information in #sharing-your-trustline-link

/setdefaulttoken & /setdefaultlimit​

  • Purpose:
    These commands let group admins configure default settings for trustline transactions.
  • Usage:

    • Default Token:

      /setdefaulttoken RLUSD rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De

      Sets the group’s default token and issuer.

    • Default Limit:

      /setdefaultlimit 1m

      Sets the default trustline limit (supports shorthand abbreviations like 1m, 100k, etc.).

  • Advantage:
    Once these are set, users don’t need to specify token, issuer, or limit when performing actions; the bot uses the group defaults.

/leaderboard​

  • Purpose:
    Displays a group-level leaderboard of users based on their transaction volume (or other metrics) for the default asset.

  • Usage:
    Simply type:

    /leaderboard

    This command displays a paginated leaderboard with rank, username, and volume.

3. Additional Features & Advantages​

  • Referral Rewards:
    When you share your trustline link (see #sharing-your-trustline-link), referrals are automatically linked to your account. This incentivizes you to spread the word.
  • Deep Linking & On-Chain Parameters:
    The bot leverages Telegram’s deep linking capability. For example, you can share a trustline link that includes token, limit, and even referral information—all encoded in a compact format.
  • Shorthand Notation for Large Numbers:
    Input numbers can be abbreviated using suffixes:
    • k for thousand
    • m for million
    • b for billion
    • t for trillion
    • q for quadrillion
      This keeps commands compact and easy to type.
  • Security & Validation:
    The bot ensures that only registered users with properly set-up wallets can perform actions. It validates inputs (asset codes, issuer addresses, amounts) and only permits admins to change group settings.

You can generate a trustline link to share with others. See #sharing-your-trustline-link

5. Best Practices​

  • For Group Admins:
    • Use /setdefaulttoken and /setdefaultlimit to configure group defaults.
    • Regularly check /settings to verify that your group settings are up-to-date.
  • For Users:
    • When sending funds with /send, double-check the recipient and the asset details.
    • Use the provided shorthand notations to simplify large transactions.
    • If you encounter issues with a withdrawal, ensure that you’ve set your wallet passphrase via /setpass.
  • For Referrals:
    • Share your custom trustline link to earn rewards when others use your referral code.
  • Security:
    • Keep your wallet passphrase secure.
    • The bot will always prompt for your wallet password during sensitive transactions.

6. Troubleshooting​

  • No Wallet Data:
    If you haven't set your wallet passphrase with /setpass, you won't be able to withdraw or add trustlines.
  • Invalid Input:
    The bot validates all inputs. If you receive an error about an asset or issuer, recheck the command format.
  • Referral or Trustline Issues:
    If trustline additions or referrals fail, ensure your provided issuer is valid and that you’re using the correct shorthand notation.

By following this guide, project groups can seamlessly integrate the bot into their workflow, making transactions, trustline management, and group interactions more efficient and rewarding. Enjoy the enhanced XRPL experience in your project groups!