dexbot 1.4.14 → 1.4.16

package/README.md

@@ -31,22 +31,13 @@ DEXBot2 is the first open source trading bot with zero runtime dependencies and
 
 ```bash
 # Requires Node.js v22.12 or newer
-# Option A — Global install
 npm i -g dexbot
 
-# 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 (no global install, works on all platforms)
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-
-npx dexbot key                 # Set up master password and import keys
-npx dexbot bot                 # Create and manage bot configurations
-npx dexbot start               # Start DEXBot2
+# Developing on DEXBot2? See Install from source below — same commands, same data.
 ```
 
 Detailed setup: [Installation](#-installation).
@@ -65,12 +56,10 @@ 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.
 
 #### Linux Users
 
-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
@@ -82,7 +71,7 @@ sudo apt-get install git
 sudo dnf install git
 ```
 
-Then install Node.js via nvm:
+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)
@@ -99,8 +88,6 @@ 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
@@ -112,8 +99,6 @@ brew install node git
 
 #### Windows Users
 
-DEXBot needs Node.js v22.12 or newer.
-
 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:
@@ -122,72 +107,78 @@ DEXBot needs Node.js v22.12 or newer.
    ```
    All three should display version numbers.
 
-### Install
+### Install from npm
 
 ```bash
-# Option A — Install globally via npm
-npm i -g dexbot
-
-# Option B — Clone + npm link
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install && npm link
-
-# Option C — Clone + local (no global install, works on all platforms)
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-npx dexbot
-npx dexbot start
+npm i -g dexbot   # stable release from the npm registry
 ```
 
-Then set up your master password, keys and add bots:
+### Install from source (developers)
 
 ```bash
-dexbot key
-dexbot bot
+git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2
+npm install
+npm link          # optional: exposes `dexbot` from your checkout
 ```
 
+### 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](docs/developer_guide.md)).
+
 ## 🔧 Configuration
 
-### Recommended Bot Setup
+### Create Your Bot
 
-Keep the generated defaults and tune only these first:
+1. Set up your master password and import your BitShares **active** key (WIF):
 
-1. `targetSpreadPercent`
-2. `incrementPercent`
-3. `gridPrice: "ama"`
-4. `minPrice` / `maxPrice`
+   ```bash
+   dexbot key
+   ```
+
+2. Create a bot through the interactive prompts:
+
+   ```bash
+   dexbot bot
+   ```
+
+   This stores your configuration in `bots.json` in the [profiles directory](#where-your-data-lives). The generated
+   defaults are a good starting point — the next step walks through the few
+   options worth tuning.
 
-`targetSpreadPercent` controls profit room per completed cycle. A wider spread
-targets more profit per cycle but trades less often.
+### Recommended Bot Setup
 
-`incrementPercent` controls grid density and order size. Smaller increments
-create more grid levels and smaller orders; larger increments create fewer
-levels and larger orders.
+Keep the default settings first, and tune these:
 
-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.
+1. **Tune `targetSpreadPercent`** — controls profit room per completed cycle. A
+   wider spread targets more profit per cycle but trades less often.
 
-### Simple AMA Workflow
+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.
 
-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:
+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.
+
+4. **Generate the market-adapter whitelist:**
 
    ```bash
    dexbot white
    ```
 
-   This writes `profiles/market_adapter_whitelist.json`. New AMA bots get AMA
+   This writes `market_adapter_whitelist.json` in the profiles directory. New AMA bots get AMA
    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
 
-Configuration options from `dexbot bot`, stored in `profiles/bots.json`:
+Configuration options from `dexbot bot`, stored in `bots.json` in the profiles directory:
 
 <details><summary><mark>Full parameter reference (click to expand)</mark></summary>
 
@@ -214,7 +205,7 @@ Configuration options from `dexbot bot`, stored in `profiles/bots.json`:
 
 ### General Options (Global)
 
-Global settings via `dexbot bot`, stored in `profiles/general.settings.json`:
+Global settings via `dexbot bot`, stored in `general.settings.json` in the profiles directory:
 
 <details><summary><mark>Global settings reference (click to expand)</mark></summary>
 
@@ -228,7 +219,7 @@ Global settings via `dexbot bot`, stored in `profiles/general.settings.json`:
 
 ### Constants and Overrides
 
-Defaults in [`modules/constants.ts`](modules/constants.ts) are overridable at global, pair, and bot level via `profiles/general.settings.json`, `profiles/market_profiles.json`, and `profiles/market_adapter_settings.json`. See [market_adapter/README.md](market_adapter/README.md#settings-and-overrides) for examples.
+Defaults in [`modules/constants.ts`](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](market_adapter/README.md#settings-and-overrides) for examples.
 
 ## 🎯 Zero-Dependency Process Management
 
@@ -279,7 +270,7 @@ Always use `dexbot pm2 restart` instead of raw `pm2 restart all` — the wrapper
 
 > 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>.log` / `<bot>-error.log`.
+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