Quick Start¶
This guide helps you get the QuantFin Bot up and running using the web interface at https://quantfin.dexalgo.org
. Follow these steps to connect your wallet, set up the bot, and start trading.
Step 1: Connect Your Wallet¶
The bot requires a SUI wallet to interact with the Bluefin exchange. You need to connect your wallet to the frontend.
- Visit the Frontend: Open your browser and navigate to
https://quantfin.dexalgo.org
. - Connect Wallet: In the top-right corner (or bottom of the sidebar on mobile), click the Connect Wallet button. This uses the
@mysten/dapp-kit
to connect your SUI wallet (e.g., Sui Wallet, Martian Wallet). - You may need at least 1,700,000 PUMPKIN tokens to access the app, unless you're on the whitelist. The app will notify you if you don't have enough tokens.
- Authorize the Connection: Follow your wallet's prompts to authorize the connection. Once connected, your wallet address will be used as your
user_id
.
Note
Your wallet must have sufficient PUMPKIN tokens (1,700,000) or be whitelisted to proceed. If access is denied, check your token balance or contact support.
Step 2: Set Your Private Key¶
The bot needs your SUI private key to sign transactions on the Bluefin exchange. Your private key is protected with end-to-end encryption.
- Locate the Key Management Section: On the main dashboard, scroll to the SUI Key Management panel.
- Add Your Private Key:
- Click on the Private Key Required box (if no key is set) or Key Secured (to update an existing key).
- In the expanded panel, paste your SUI private key (starting with
suiprivkey...
) into the Private Key text field. - Click the eye icon to toggle visibility if needed.
- Encrypt and Save:
- Click the Encrypt & Save Key button.
- The frontend will decode your key (from Bech32 format to hex), encrypt it end-to-end, and securely store it.
- You’ll see a confirmation message like "Key saved successfully," and the panel will update to Key Secured.
Warning
Your private key is end-to-end encrypted and never accessible to system administrators in plaintext. The platform cannot view or decrypt your private key. Keep your private key secure and never share it publicly. See Security for more details.
Step 3: Add a Trading Symbol¶
Choose a trading symbol (e.g., SUI-PERP
) to configure the bot for trading on that market.
- Locate the Trading Symbols Section: On the dashboard, find the Trading Symbols panel.
- Add a New Symbol:
- Click the Add New Symbol tile (with a plus icon).
- In the dialog, select a symbol from the dropdown (e.g.,
SUI-PERP
). Available symbols includeSUI-PERP
,DEEP-PERP
,WAL-PERP
, and more. - Click Add Symbol.
- Apply the Symbol:
- The symbol will appear as a card in the Trading Symbols section.
- In the sidebar, under Trading Symbol, ensure the dropdown shows your selected symbol (e.g.,
SUI-PERP
). - Click the Apply button next to the dropdown to set the symbol. This calls the
/set_symbol
endpoint, configuring price decimals and minimum order quantities for the symbol.
Note
If the symbol card shows "No status data," applying the symbol will initialize it. You can also click the symbol card to select it as the active symbol for configuration.
Step 4: Apply a Preset Configuration¶
Presets provide predefined settings to quickly configure the bot. The frontend allows you to apply a preset like Moderate
.
- Locate the Preset Configuration:
- In the sidebar, under Preset Configuration, find the preset dropdown.
- Alternatively, scroll to the Update Config panel on the dashboard and find the Preset Config dropdown at the bottom.
- Select a Preset:
- Choose a preset from the dropdown:
Safu
,Moderate
,Aggressive
, orYachtToday
. - For beginners,
Moderate
is recommended as it balances risk and activity. - Apply the Preset:
- Click the Apply Preset button next to the dropdown.
- This calls the
/set_preset
endpoint, applying the preset's settings (e.g., grid levels, exposure limits, take-profit distance). - You’ll see a confirmation message like "Preset applied successfully."
Tip
See Presets for details on each preset. For example, Safu
is conservative, while YachtToday
is highly aggressive.
Step 5: Start the Bot¶
Now that the symbol and preset are set, you can start the bot to begin trading.
- Start the Bot:
- In the sidebar, click the Start Bot button (with a play icon).
- Alternatively, in the Trading Symbols section, click the three-dot menu on your symbol’s card and select Start Bot.
- Confirm Start:
- The bot will start, calling the
/start
endpoint for your selected symbol. - You’ll see a confirmation message like "Bot started."
- Check the Status:
- In the Bot Status panel, verify that the Running badge shows "Active."
- The bot is now placing grid orders and managing take-profit orders based on your configuration.
Step 6: Monitor the Bot¶
Keep an eye on the bot’s activity and status using the dashboard.
- Check Bot Status:
- In the Bot Status panel, monitor badges like Running, HF Mode, Dynamic Dist, and Graceful Stop.
- For example, if Dynamic Dist is "Enabled," the bot is using dynamic distribution for order sizing.
- View Logs:
- Scroll to the Console Logs panel to see real-time logs.
- Logs include INFO, WARNING, and ERROR messages about the bot’s activity (e.g., order placements, errors).
- Check the Auto-scroll box to keep the logs updated as new entries arrive.
- Refresh Data:
- The dashboard auto-refreshes every minute by default (adjustable in the top-right corner).
- To manually refresh, click the refresh icon in the top-right corner.
- The last refresh time is displayed next to the refresh icon.
Next Steps¶
- Bot Configuration: Customize advanced settings in the Update Config panel, such as grid levels, take-profit distance, and dynamic distribution.
- API Endpoints: Learn about the backend API endpoints called by the frontend (for advanced users).
- Features: Explore the bot’s features like market making, chase entry, and dynamic distribution.
- Troubleshooting: Resolve common issues, such as the bot not starting or unexpected behavior.
- Strategy Simulator: In the sidebar, click Strategy Simulator to visualize your grid configuration and simulate trades.