DEXBot2

DEXBot2 is the first open source trading bot with zero runtime dependencies and a fully adaptive market making strategy.

Contents

• Quick Start
• Installation
• Configuration
• Zero-Dependency Process Management
• Bot Management
• PM2 Process Management
• Documentation
• Contributing
• License
• Links

✨ Features

• Grid Trading — geometric order grids that rebalance as price moves
• Adaptive Signals — AMA and trend inputs tune grid placement
• Credit & MPA — credit offer and debt workflows
• Runtime Safety — replay-safe fills, sync recovery, and cleanup
• Secure Ops — encrypted keys and credential daemon

🌱 Quick Start

# Requires Node.js v22.12 or newer
npm i -g dexbot

dexbot key                 # Set up master password and import keys
dexbot bot                 # Create and manage bot configurations
dexbot start               # Start DEXBot2

Detailed setup: Installation.

First Run

New to BitShares? Work through the BitShares Onboarding Tutorial first — it covers creating and funding an account, choosing the right key, and running your first bot.

Disclaimer — Use At Your Own Risk

• This software is provided "as-is" without warranty.
• Secure your keys. Never share private keys or passwords.
• The authors and maintainers are not responsible for losses.

📥 Installation

Prerequisites

You'll need Git and Node.js v22.12 or newer installed.

Linux Users

Install Git:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install git

# Arch/Manjaro/CachyOS
sudo pacman -Syu git

# Fedora/RHEL
sudo dnf install git

Most distro repos ship an outdated nodejs package, so install Node from nodejs.org.

# e.g. via nvm (from https://nodejs.org/en/download)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.6/install.sh | bash
\. "$HOME/.nvm/nvm.sh"
nvm install 24

Verify both installations:

node --version && npm --version && git --version

macOS Users

Use Homebrew to install Node.js and Git:

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Node.js and Git
brew install node git

Windows Users

1. Install Git from git-scm.com (accept defaults, restart after)
2. Install Node.js LTS from nodejs.org (accept defaults, restart after)
3. Verify installation in Command Prompt:

   node --version && npm --version && git --version

   All three should display version numbers.

Install DEXBot2 from npm (recommended)

npm i -g dexbot

Install DEXBot2 from source (developers)

git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2
npm install
npm link

If npm link fails with EACCES or dexbot isn't found afterwards, see the first-run troubleshooting section in the onboarding guide.

Where your data lives

Both installs use the same CLI and store all user state — keys, bots.json, logs — in ~/.config/dexbot2/profiles (Windows: %USERPROFILE%\.config\dexbot2\profiles). State lives outside the repo/package tree, so it survives reinstalls and npm update -g. A source checkout that already contains a populated profiles/ directory keeps using it. Override the location with DEXBOT_PROFILE_ROOT (see the developer guide).

🔧 Configuration

Create Your Bot

1. Set up your master password and import your BitShares active key (WIF):

   dexbot key

2. Create a bot through the interactive prompts:

   dexbot bot

   This stores your configuration in bots.json in the profiles directory. The generated defaults are a good starting point — the next step walks through the few options worth tuning.

Recommended Bot Setup

Keep the default settings first, and tune these:

1. Tune targetSpreadPercent — controls profit room per completed cycle: profit ≈ spread - increment - fees. A wider spread targets more profit per cycle but trades less often.

2. Tune incrementPercent — controls order steps and order size. Smaller increments create more grid levels and smaller orders; larger increments create fewer levels and larger orders. Smaller increments cycle faster — higher profits, but more fees.

3. Tune weightDistribution (optional) — per-side sizing control. Higher weight = more funds in orders near the market price; lower weight = funds shifted toward the grid edge. Range -1 (super-valley) to 2 (super-mountain); the default { "sell": 1.0, "buy": 1.0 } suits most setups.

4. Enable AMA — new bots anchor on gridPrice: "ama3", but the market adapter only goes live once its per-bot Price flag is on. Open dexbot bot → 2) Modify bot → pick the bot → 6) Adapter and set the flags:

   • Price — on for AMA bots; without it the adapter only dry-runs
   • Weight — dynamic buy/sell weights (opt-in)
   • Range — AMA-slope range scaling (opt-in)

   To change how closely the grid center tracks the market, set gridPrice in 3) Price to "ama1"–"ama4": "ama1" reacts fastest, "ama4" slowest and steadiest (higher numbers smooth more), or "ama" for the pair's default preset.

   The flags are stored per bot in market_adapter_whitelist.json in the profiles directory and can be changed any time from the same editor section. Boolean prompts accept y/yes/true and n/no/false; Enter keeps the current value.

5. Start DEXBot2 with dexbot start. If setup is incomplete, start automatically opens dexbot key when no usable account key is configured, or dexbot bot when a valid key exists but no bot is configured.

6. Tune minPrice / maxPrice around the market's volatility range. Once AMA is active, tighten them around the maximum expected market volatility instead of an unnecessarily wide range. Use dexbot tv <bot> to see the grid range and AMA recentering against real candles.

Bot Options Reference

Configuration options from dexbot bot, stored in bots.json in the profiles directory:

Prefer relative values — use dynamic price sources where available: "pool" (liquidity-pool price) or "book" (order-book mid) for startPrice, "ama" for gridPrice, "2x"-style multipliers for minPrice / maxPrice, and "100%"-style percentages for funds (botFunds). Relative values rescale automatically as the market moves; fixed numbers do not. The bot editor highlights these inputs live: green = relative/dynamic (recommended), red = fixed absolute value.

General Settings (Global)

General settings via dexbot bot, stored in general.settings.json in the profiles directory:

Constants and Overrides

Defaults in modules/constants.ts are overridable at global, pair, and bot level via general.settings.json, market_profiles.json, and market_adapter_settings.json in the profiles directory. See market_adapter/README.md for examples.

🎯 Zero-Dependency Process Management

dexbot start is the recommended production runtime (global install). Repo-root users can run ./unlock instead. It runs the selected bot set as one monolithic bot process, with the credential daemon and market adapter in separate helper processes. Monolithic start/stop/reload/restart controls apply to the whole runtime, not to individual bots.

dexbot start/stop          # Stop/start the monolithic runtime
dexbot start --dryrun      # Dry-run (no transactions broadcast)
dexbot reload              # Reload the runtime (leaves credential daemon untouched)
dexbot restart             # Restart the runtime (re-unlocks credential daemon)
dexbot delete              # Shut down and clean up

First-run details and common mistakes are covered in the BitShares Onboarding Tutorial.

🛠️ Bot Management

dexbot key                 # Master password/keyring
dexbot bot                 # Interactive bot configurator

dexbot reset {all|<bot>}   # Regenerate grid
dexbot disable {all|<bot>} # Disable bot in config
dexbot enable {all|<bot>}  # Enable bot in config

dexbot stat                # Runtime status (unlock or PM2)
dexbot order [<bot>]       # Analyze order grids (--export → HTML to analysis/charts/)
dexbot tv <bot|pool|A/B>   # TradingView 1h chart with AMA overlay (default: 3 months)
dexbot pnl <bot|account>   # HTML PnL report (--month N, optional --pair A/B)
dexbot credit [<bot>]      # Live summed MPA + borrowed-credit positions
dexbot export <bot>        # Export trades + settings (CSV/JSON) for analysis/

dexbot update              # Update DEXBot2
dexbot clear               # Delete log files in <profiles>/logs
dexbot default             # Reset settings to defaults
dexbot help                # Grouped command reference

🎯 PM2 Process Management

PM2 is optional — dexbot start is the native solution.

dexbot pm2 [<bot>]                         # Start with PM2
dexbot pm2 reload {all|<bot>}              # Reload managed apps, dexbot-cred untouched
dexbot pm2 restart {all|<bot>|dexbot-cred} # Safe restart
dexbot pm2 stop {all|<bot>}                # Stop (via wrapper)
dexbot pm2 delete {all|<bot>}              # Delete (via wrapper)
pm2 logs [<bot>]                           # Real-time logs

Always use dexbot pm2 restart instead of raw pm2 restart all — the wrapper safely handles the credential daemon. If the credential daemon stops, rerun dexbot pm2.

Repo-root users can use ./pm2 instead of dexbot pm2.

Logs are written to logs/ in the profiles directory in all modes: the monolithic runtime uses dexbot.log / dexbot-error.log, and per-bot output uses <bot>.log / <bot>-error.log.

📚 Documentation

User-Facing Workflows

• BitShares Onboarding - Beginner tutorial: create and fund an account, choose the right key, and run your first bot
• Market Adapter - AMA pricing, grid triggers, dynamic weights, and collateral advisory signals
• MPA and Credit Usage - Bot-scoped debt policy, MPA borrowing, and credit offer workflows
• Analysis - Research runners, chart generators, and tuning helpers for AMA fitting, trend detection, bot fitting, and TradingView exports
• Claw - Bridge setup, launcher commands, short MPA workflow, and example commands

Operational & Security

• Credential Security - Key handling, daemon-backed signing, and runtime file hardening
• Grid Recalculation - Market-adapter bootstrap/delta/slope resets, divergence correction, fund regeneration, and runtime trigger handling
• Grid Reconciliation - Startup 3-phase reconcile, offline fill detection, and stale surplus cleanup
• Logging - Logging system documentation
• Docker - Container build, release images, and secure startup

Reference Docs

• Docs Index - Main documentation hub
• Architecture - System design, fill processing pipeline, and testing strategy
• Lifecycle - End-to-end walkthrough: startup, fill-driven, and AMA-driven flows with diagrams
• Copy-on-Write Plan - Copy-on-Write grid architecture
• Fund Movement & Accounting - Fund accounting, grid topology, and rotation mechanics
• Claw API Boundary - Responsibility split between the AI layer and the DEXBot2 execution layer
• Developer Guide - Development guide, environment variables, examples, and glossary
• Workflow - Project workflow and contribution guide
• Evolution Report - Project timeline, architecture phases, and release history

🤝 Contributing

1. Fork the repository and create a feature branch
2. Make your changes and test with npm test
3. Submit a pull request

📄 License

MIT License - see LICENSE file for details

🔗 Links