dexbot 1.4.13 → 1.4.15

package/README.md

@@ -19,7 +19,7 @@ DEXBot2 is the first open source trading bot with zero runtime dependencies and
 - [License](#-license)
 - [Links](#-links)
 
-## 🚀 Features
+## ✨ Features
 
 - **Grid Trading** — geometric order grids that rebalance as price moves
 - **Adaptive Signals** — AMA and trend inputs tune grid placement
@@ -27,27 +27,22 @@ DEXBot2 is the first open source trading bot with zero runtime dependencies and
 - **Runtime Safety** — replay-safe fills, sync recovery, and cleanup
 - **Secure Ops** — encrypted keys and credential daemon
 
-## 🔥 Quick Start
+## 🌱 Quick Start
 
 ```bash
-# Option A — Global install (`dexbot` works everywhere)
+# Requires Node.js v22.12 or newer
+# Option A — Global install
 npm i -g dexbot
 
-# Option B — Clone + npm link (`dexbot` works everywhere)
+# Option B — Clone + npm link
 git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install && npm link
 
 dexbot key                 # Set up master password and import keys
 dexbot bot                 # Create and manage bot configurations
 dexbot start               # Start DEXBot2
-
-# Option C — Clone + local wrappers (no global install)
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-./dexbot key               # or: npx dexbot key
-./dexbot bot               # or: npx dexbot bot
-./unlock                   # or: npx dexbot start
 ```
 
-Detailed setup: [Installation](#installation).
+Detailed setup: [Installation](#-installation).
 
 ### First Run
 
@@ -63,17 +58,35 @@ New to BitShares? Work through the [BitShares Onboarding Tutorial](docs/BITSHARE
 
 ### Prerequisites
 
-You'll need **Git** and **Node.js** installed.
+You'll need **Git** and **Node.js** v22.12 or newer installed.
 
-#### Windows Users
+#### Linux Users
 
-1. Install **Node.js LTS** from [nodejs.org](https://nodejs.org/) (accept defaults, restart after)
-2. Install **Git** from [git-scm.com](https://git-scm.com/) (accept defaults, restart after)
-3. Verify installation in Command Prompt:
-   ```bash
-   node --version && npm --version && git --version
-   ```
-   All three should display version numbers.
+Install Git:
+
+```bash
+# Ubuntu/Debian
+sudo apt-get update
+sudo apt-get install git
+
+# Fedora/RHEL
+sudo dnf install git
+```
+
+Most distro repos ship an outdated `nodejs` package, so install Node from [nodejs.org](https://nodejs.org/en/download).
+
+```bash
+# 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:
+
+```bash
+node --version && npm --version && git --version
+```
 
 #### macOS Users
 
@@ -86,17 +99,15 @@ Use Homebrew to install Node.js and Git:
 brew install node git
 ```
 
-#### Linux Users
-
-Use your package manager:
-```bash
-# Ubuntu/Debian
-sudo apt-get update
-sudo apt-get install nodejs npm git
+#### Windows Users
 
-# Fedora/RHEL
-sudo dnf install nodejs npm git
-```
+1. Install **Git** from [git-scm.com](https://git-scm.com/install/windows) (accept defaults, restart after)
+2. Install **Node.js LTS** from [nodejs.org](https://nodejs.org/en/download) (accept defaults, restart after)
+3. Verify installation in Command Prompt:
+   ```cmd
+   node --version && npm --version && git --version
+   ```
+   All three should display version numbers.
 
 ### Install
 
@@ -104,51 +115,46 @@ sudo dnf install nodejs npm git
 # Option A — Install globally via npm
 npm i -g dexbot
 
-# Option B — Clone + npm link (`dexbot` works everywhere)
+# Option B — Clone + npm link
 git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install && npm link
-
-# Option C — Clone + local wrappers (no global install)
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-./dexbot               # or: npx dexbot
-./unlock               # or: npx dexbot start
 ```
 
-Then set up your master password, keys and add bots:
+## 🔧 Configuration
+
+### Create Your Bot
 
-```bash
-dexbot key
-dexbot bot
-```
+1. Set up your master password and import your BitShares **active** key (WIF):
 
-## 🔧 Configuration
+   ```bash
+   dexbot key
+   ```
 
-### Recommended Bot Setup
+2. Create a bot through the interactive prompts:
+
+   ```bash
+   dexbot bot
+   ```
 
-Keep the generated defaults and tune only these first:
+   This stores your configuration in `profiles/bots.json`. The generated
+   defaults are a good starting point — the next step walks through the few
+   options worth tuning.
 
-1. `targetSpreadPercent`
-2. `incrementPercent`
-3. `gridPrice: "ama"`
-4. `minPrice` / `maxPrice`
+### Recommended Bot Setup
 
-`targetSpreadPercent` controls profit room per completed cycle. A wider spread
-targets more profit per cycle but trades less often.
+Keep the default settings first, and tune these:
 
-`incrementPercent` controls grid density and order size. Smaller increments
-create more grid levels and smaller orders; larger increments create fewer
-levels and larger orders.
+1. **Tune `targetSpreadPercent`** — controls profit room per completed cycle. A
+   wider spread targets more profit per cycle but trades less often.
 
-Use `gridPrice: "ama"` so the market adapter can center the grid on AMA. Once
-AMA is active, tighten `minPrice` / `maxPrice` around the maximum expected
-market volatility instead of using an unnecessarily wide range.
+2. **Tune `incrementPercent`** — controls grid density and order size. Smaller
+   increments create more grid levels and smaller orders; larger increments
+   create fewer levels and larger orders.
 
-### Simple AMA Workflow
+3. **Set `gridPrice` to `"ama"`** — so the market adapter can center the grid
+   on AMA. Pick a specific preset if desired: `"ama1"` is the fastest,
+   `"ama4"` the slowest, and `"ama"` uses the pair's default preset.
 
-1. Create the bot with `dexbot bot`.
-2. Leave defaults unchanged.
-3. Tune `targetSpreadPercent` and `incrementPercent`.
-4. Set `gridPrice` to `ama`.
-5. Generate the market-adapter whitelist:
+4. **Generate the market-adapter whitelist:**
 
    ```bash
    dexbot white
@@ -158,8 +164,11 @@ market volatility instead of using an unnecessarily wide range.
    live writes and range scaling. Use `dexbot white --dynamic-weight` for
    newly generated dynamic-weight entries; existing entries are preserved.
 
-6. Start DEXBot2 with `dexbot start` (or `dexbot pm2` for PM2).
-7. Then tune `minPrice` / `maxPrice` for the market's volatility range.
+5. **Start DEXBot2** with `dexbot start`.
+
+6. **Tune `minPrice` / `maxPrice`** around the market's volatility range. Once
+   AMA is active, tighten them around the maximum expected market volatility
+   instead of using an unnecessarily wide range.
 
 ### Bot Options Reference
 
@@ -231,7 +240,7 @@ 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               # Analyze order grids
+dexbot order [<bot>]       # Analyze order grids
 dexbot order --export      # Export as HTML to root folder
 
 dexbot update              # Update DEXBot2
@@ -244,18 +253,18 @@ dexbot default             # Reset settings to defaults
 PM2 is optional — `dexbot start` is the native solution.
 
 ```bash
-dexbot pm2 [<bot-name>]                    # Start with PM2
+dexbot pm2 [<bot>]                         # Start with PM2
 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-name>]                      # Real-time logs
+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 `profiles/logs/` in all modes: the monolithic runtime uses `dexbot.log` / `dexbot-error.log`, and per-bot output uses `<bot-name>.log` / `<bot-name>-error.log`.
+Logs are written to `profiles/logs/` in all modes: the monolithic runtime uses `dexbot.log` / `dexbot-error.log`, and per-bot output uses `<bot>.log` / `<bot>-error.log`.
 
 ## 📚 Documentation