dexbot 1.4.12 → 1.4.14

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,33 @@ 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 unlock              # Start DEXBot2
+dexbot start               # Start DEXBot2
 
-# Option C — Clone + local wrappers (no global install)
+# Option C — Clone + local (no global install, works on all platforms)
 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 unlock
+
+npx dexbot key                 # Set up master password and import keys
+npx dexbot bot                 # Create and manage bot configurations
+npx dexbot start               # Start DEXBot2
 ```
 
-Detailed setup: [Installation](#installation).
+Detailed setup: [Installation](#-installation).
+
+### First Run
+
+New to BitShares? Work through the [BitShares Onboarding Tutorial](docs/BITSHARES_ONBOARDING.md) first — it covers creating and funding an account, choosing the right key, and running your first bot.
 
 ### Disclaimer — Use At Your Own Risk
 
@@ -61,18 +67,40 @@ Detailed setup: [Installation](#installation).
 
 You'll need **Git** and **Node.js** 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.
+DEXBot needs Node.js v22.12 or newer. Most distro repos ship an outdated `nodejs` package, so install Node from [nodejs.org](https://nodejs.org/en/download).
+
+Install Git:
+
+```bash
+# Ubuntu/Debian
+sudo apt-get update
+sudo apt-get install git
+
+# Fedora/RHEL
+sudo dnf install git
+```
+
+Then install Node.js via nvm:
+
+```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
 
+DEXBot needs Node.js v22.12 or newer.
+
 Use Homebrew to install Node.js and Git:
 ```bash
 # Install Homebrew if not already installed
@@ -82,17 +110,17 @@ Use Homebrew to install Node.js and Git:
 brew install node git
 ```
 
-#### Linux Users
+#### Windows Users
 
-Use your package manager:
-```bash
-# Ubuntu/Debian
-sudo apt-get update
-sudo apt-get install nodejs npm git
+DEXBot needs Node.js v22.12 or newer.
 
-# 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
 
@@ -100,13 +128,13 @@ 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)
+# Option C — Clone + local (no global install, works on all platforms)
 git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-./dexbot               # or: npx dexbot
-./unlock               # or: npx dexbot unlock
+npx dexbot
+npx dexbot start
 ```
 
 Then set up your master password, keys and add bots:
@@ -154,7 +182,7 @@ 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 unlock` (or `dexbot pm2` for PM2).
+6. Start DEXBot2 with `dexbot start` (or `dexbot pm2` for PM2).
 7. Then tune `minPrice` / `maxPrice` for the market's volatility range.
 
 ### Bot Options Reference
@@ -204,17 +232,16 @@ Defaults in [`modules/constants.ts`](modules/constants.ts) are overridable at gl
 
 ## 🎯 Zero-Dependency Process Management
 
-`dexbot unlock` 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/restart controls apply to the whole runtime, not to individual bots.
+`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/restart controls apply to the whole runtime, not to individual bots.
 
 ```bash
-dexbot unlock              # Start all active bots
-dexbot unlock --dryrun     # Dry-run (no transactions broadcast)
-dexbot stop/start          # Stop/start the monolithic runtime
+dexbot start/stop          # Stop/start the monolithic runtime
+dexbot start --dryrun      # Dry-run (no transactions broadcast)
 dexbot restart             # Restart the monolithic runtime
 dexbot delete              # Shut down and clean up
 ```
 
-For independent per-bot process control, start isolated mode with `dexbot unlock --isolated` or use PM2 instead of the default monolithic runtime.
+First-run details and common mistakes are covered in the [BitShares Onboarding Tutorial](docs/BITSHARES_ONBOARDING.md).
 
 ## 🛠️ Bot Management
 
@@ -228,7 +255,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
@@ -238,26 +265,27 @@ dexbot default             # Reset settings to defaults
 
 ## 🎯 PM2 Process Management
 
-PM2 is optional — `dexbot unlock` is the native solution.
+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/<bot-name>.log` (errors to `<bot-name>-error.log`) in all modes.
+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
 
 ### User-Facing Workflows
 
+- **[BitShares Onboarding](docs/BITSHARES_ONBOARDING.md)** - Beginner tutorial: create and fund an account, choose the right key, and run your first bot
 - **[Market Adapter](market_adapter/README.md)** - AMA pricing, grid triggers, dynamic weights, and collateral advisory signals
 - **[MPA and Credit Usage](docs/MPA_CREDIT_USAGE.md)** - Bot-scoped debt policy, MPA borrowing, and credit offer workflows
 - **[Analysis](analysis/README.md)** - Research runners, chart generators, and tuning helpers for AMA fitting, trend detection, bot fitting, and TradingView exports