Skip to content

Configuration and Usage Guide

This guide explains how to set up and configure your SUIQuant DexAlgo using the web interface. Follow these instructions to create your bot configuration, understand the meaning of each parameter, and learn how to start (or pause/stop) your bot.

Table of Contents

Overview

The SUIQuant DexAlgo is an automated trading bot built on the Sui blockchain. It allows you to configure trading pairs, define your buy/sell parameters, and choose whether to trigger trades based on time intervals or market indicators (RSI, Machine Learning signals, or Stochastic RSI). In addition, you can enable Dollar‑Cost Averaging (DCA) mode to merge multiple buys into one position.

Your settings are saved through the web interface and sent to the backend via API endpoints. Once configured, you can start the bot and monitor its performance directly on the dashboard.

Prerequisites

Before you begin, make sure you have: - A connected Sui wallet (via the Connect Button). - Your API key and SUI private key set correctly. - Sufficient token balances (for example, a minimum SUI balance for gas and any required tokens for trading).

Accessing the Configuration Panel

  1. Log In and Connect Your Wallet:
    When you first open the dashboard, use the Connect Button to connect your Sui wallet.
  2. Configuration Pane:
    Click on the "Configuration & Strategy Base" or "Bot Configuration" tab in the dashboard. You will see separate sections for selecting trading pairs and setting advanced parameters.

Configuring Trading Pairs and Strategy Parameters

Trading Pairs

  • Multi-Select Dropdown:
    In the Tokens tab, you can select one or more trading pairs from the dropdown.
  • Pair Format:
    Pairs are expressed as BASE/TARGET (e.g. SUI/PUMPKIN). The built‑in list includes common tokens, but you can also add custom pairs if needed.

Trade Amounts and Profit Margin

  • Minimum and Maximum Trade Amounts:
    For each trading pair you configure, set the minimum and maximum buy amounts. The bot will randomly choose an amount within this range for each buy order.
  • Profit Margin (%):
    This is the target profit percentage required for a sell. For example, if you set a profit margin of 10, the bot will wait until the aggregator’s sell price reaches at least 10% above your buy price before executing a sell order.

Buy Interval (Time-based Trading)

  • Buy Interval (minutes):
    In time‑based mode, you set the number of minutes between automatic buy attempts. If no trade has occurred in the specified interval, the bot will initiate a buy order.

Indicator Settings

You can choose to trigger orders based on market indicators instead of (or in addition to) time: - RSI-Based Trading:
- Toggle the RSI-based checkbox to enable RSI trading. - When enabled, the bot calculates the Relative Strength Index (RSI) using recent market data. A low RSI (for example, below 40) can trigger a buy signal. - Machine Learning (ML) Based Trading:
- Toggle the ML-based checkbox to enable ML trading. - The bot uses custom machine learning calculations to determine if market conditions are favorable (a “long” signal) or unfavorable. - Stochastic RSI Trading:
- Toggle the Stoch-based checkbox to enable Stochastic RSI trading. - This indicator compares recent price data to generate a “long” or “short” signal. - Polling on Interval:
- You can enable Poll on Interval so that the bot continuously checks the indicator at fixed intervals rather than performing a one-time check. - Timeframe Settings:
- Lookback (min): Set how many minutes of historical data the bot should consider when calculating indicators. - Resolution (sec): Choose the time resolution (in seconds) for each candlestick used in the calculations.

Dollar-Cost Averaging (DCA) Mode

  • DCA Mode Toggle:
    Enable DCA mode to merge new buy orders with existing positions. This helps smooth your entry price over multiple trades.

Advanced Parameters

  • Max Slippage (bps):
    Define the maximum allowed slippage in basis points (bps) when executing a trade via the aggregator.
  • Gas Budget (SUI):
    Enter your gas budget in SUI. This is the amount of SUI allocated for paying transaction fees (1 SUI equals 1,000,000,000 MIST).
  • API Key and Private Key:
    Make sure you enter your API key and SUI private key correctly. These are essential for secure communication with the backend and for signing transactions.

Saving Your Configuration

  1. Fill in All Fields:
    Complete all required fields in the configuration pane.
  2. Validation:
    If any required field is missing (for example, API key, private key, or trading pair details), an alert will appear in the console.
  3. Click “Save Configuration”:
    Press the Save Configuration button. The configuration is sent to the backend via an API (e.g., /api/save-config).
  4. Confirmation:
    A toast notification will confirm that your configuration has been saved. Your configuration is now ready for use.

Starting, Pausing, and Stopping Your Bot

Once your configuration is saved, you can control your bot using the buttons in the AlgoBot Controller section.

Starting the Bot

  • Start Bot Button:
    Click Start Bot. This sends your configuration (including your trading pairs, trade amounts, and indicator settings) to the backend (via /api/start-bot), where your bot instance is created and begins running.
  • Status Update:
    The bot status will update to "Running" if the bot is started successfully.

Pausing the Bot

  • Pause Button:
    Click the Pause button to temporarily halt trading. The bot remains configured but stops executing trades until resumed.

Resuming the Bot

  • Resume Bot Button:
    Click Resume Bot to restart trading using your current configuration. This does not clear your existing positions.

Stopping the Bot

  • Stop Bot Button:
    Click Stop Bot. (A two‑step confirmation process will appear.) This action stops the bot and clears all positions from memory. Use this only if you want a full shutdown.

Usage Example

Let’s say you want to trade between SUI and PUMPKIN with the following settings:

  • Trading Pair: SUI/PUMPKIN
  • Min Trade Amount: 0.1 SUI
  • Max Trade Amount: 0.2 SUI
  • Profit Margin: 10% (sell when the price is 10% above your buy price)
  • Buy Interval: 10 minutes
  • Indicator Mode:
  • Enable RSI‑based trading (checkbox checked)
  • Use Poll on Interval (checked) with a 60‑second interval
  • Lookback: 120 minutes and Resolution: 60 seconds
  • DCA Mode: Enabled

After you enter these settings in the configuration pane:

  1. Click Save Configuration.
  2. Click Start Bot.
  3. Your dashboard will update with the bot status, estimated next-buy timers, active positions, and live trade information.
  4. Use the console area to view log messages or issue commands (e.g., /bidmarket SUI/PUMPKIN 1 for a forced bid).

Troubleshooting Tips

  • Missing Fields:
    If you receive validation errors in the console, ensure that all required fields (API key, private key, trade amounts, etc.) are filled in.
  • Balance Issues:
    Make sure your wallet has enough tokens (especially SUI for gas and the tokens for trading).
  • Connection Errors:
    If your wallet isn’t connecting, check your network settings or try reloading the page.
  • Bot Not Responding:
    If the bot status remains “Idle” or shows an error, review the console logs (visible in the live console area) and double-check your configuration.
  • Configuration Not Saving:
    Confirm that your keys are in the correct format and that your API endpoint for saving configuration is reachable.

Summary

Using the configuration panel, you can customize every aspect of your trading bot—from selecting which pairs to trade, setting trade sizes and profit margins, choosing your preferred indicator strategy, and even enabling features like DCA. Once your configuration is saved, use the control buttons to start, pause, or stop your bot. The dashboard will provide live feedback on trade execution, current positions, and overall bot status.

If you have further questions, refer to other sections of this documentation or contact support.

Happy Trading!