Merge pull request #118 from Adamant-im/dev

Chore: Merge dev for v9.0.0 release

Author: adamantmm

.dockerignore

@@ -0,0 +1,20 @@
+node_modules
+npm-debug.log
+.git
+.github
+.ai-tasks
+coverage
+logs
+config.jsonc
+config.*.jsonc
+!config.default.jsonc
+trade/settings/*
+!trade/settings/tradeParams_Default.js
+tests
+*.md
+!README.md
+.vscode
+.idea
+docker/config
+docker/trade-config
+docker/logs

.github/workflows/publish-docker.yml

@@ -0,0 +1,48 @@
+name: Publish Docker image
+
+# Runs when a GitHub Release is published (not on every push).
+# The job is skipped unless the release tag points to a commit on master.
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout release tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          fetch-depth: 0
+
+      - name: Verify release tag is on master
+        run: |
+          git fetch origin master
+          git merge-base --is-ancestor HEAD origin/master
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract version tag
+        id: meta
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          echo "version=${TAG}" >> "$GITHUB_OUTPUT"
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: |
+            ghcr.io/adamant-im/adamant-tradebot:latest
+            ghcr.io/adamant-im/adamant-tradebot:${{ steps.meta.outputs.version }}

.github/workflows/publish-npm.yml

@@ -0,0 +1,40 @@
+name: Publish npm package
+
+# Runs when a GitHub Release is published (not on every push).
+# The job is skipped unless the release tag points to a commit on master.
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout release tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          fetch-depth: 0
+
+      - name: Verify release tag is on master
+        run: |
+          git fetch origin master
+          git merge-base --is-ancestor HEAD origin/master
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish to npm with provenance
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,5 +1,9 @@
 node_modules/
 logs/
+# Docker user data (./mm init)
+docker/config/
+docker/trade-config/
+docker/logs/
 keys/
 .vscode/*
 !.vscode/settings.json
@@ -22,3 +26,4 @@ trade/settings/*
 !trade/settings/tradeParams_Default.js
 CLAUDE.md
 .ai-tasks/
+.ai-ignored/

Dockerfile

@@ -0,0 +1,23 @@
+FROM node:22-bookworm-slim
+
+WORKDIR /app
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends ca-certificates \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY package.json package-lock.json .npmrc ./
+RUN npm ci --omit=dev
+
+COPY . .
+
+RUN chmod +x docker-entrypoint.sh mm bin/mm.js \
+  && ln -sf /app/bin/mm.js /usr/local/bin/mm
+
+ENV NODE_ENV=production
+ENV MM_DOCKER=1
+
+EXPOSE 3000
+
+ENTRYPOINT ["./docker-entrypoint.sh"]
+CMD ["node", "app.js"]

README.md

@@ -158,11 +158,135 @@ The software is self-hosted. You keep control of the exchange account, API keys,
 
 For additional management options, including Telegram, CLI, and WebUI access, request a manager.
 
-### Documentation
+## Requirements
+
+- Ubuntu 20+ or CentOS 8+ (other Linux distros may work but are not tested)
+- Node.js v22.2+
+- npm v9+
+- MongoDB ([installation instructions](https://www.mongodb.com/docs/manual/administration/install-community/)
+
+## Setup
+
+```bash
+su - adamant
+git clone https://github.com/Adamant-im/adamant-tradebot
+cd adamant-tradebot
+npm i
+```
+
+## Pre-launch tuning
+
+The bot uses `config.jsonc` if present, otherwise `config.default.jsonc`.
+For named configs, use `config.<name>.jsonc` and pass `<name>` as a launch argument.
+
+```bash
+cp config.default.jsonc config.jsonc
+nano config.jsonc
+```
+
+Parameter descriptions are in comments inside `config.jsonc`.
+
+## Launching
+
+You can start the bot with `node app.js`, but a process manager is recommended.
+
+### NPM scripts
+
+```bash
+npm start                               # config.default.jsonc or config.jsonc
+npm run start:config -- <name>          # config.<name>.jsonc
+npm run start:dev                       # config.dev.jsonc
+npm run clear                           # clear DB for default config
+npm run clear:config -- <name> clear_db # clear DB for config.<name>.jsonc
+```
+
+### PM2
+
+```bash
+pm2 start app.js --name tradebot
+```
+
+With a named config:
+
+```bash
+pm2 start app.js --name tradebot-p2b -- p2b_mmtest
+```
+
+Add the process to `pm2 startup` or cron so it restarts on reboot.
+
+## Updating
+
+```bash
+su - adamant
+cd adamant-tradebot
+pm2 stop tradebot
+git pull
+npm i
+```
+
+If `config.default.jsonc` changed, merge new fields into your `config.jsonc`.
+
+Then:
+
+```bash
+pm2 restart tradebot
+```
+
+## Quick start with `mm` CLI
+
+The `mm` command simplifies install, configuration, and day-to-day operation. It works in **npm/local** mode and **Docker Compose** mode.
+
+### Install via npm
+
+```bash
+npm install -g adamant-tradebot
+mkdir my-bot && cd my-bot
+mm init
+mm doctor
+mm on
+mm status
+```
+
+Both `mm` and `adamant-tradebot` are available as CLI aliases.
+
+### Install via Docker Compose
+
+```bash
+git clone https://github.com/Adamant-im/adamant-tradebot
+cd adamant-tradebot
+./mm init
+./mm doctor
+./mm on
+./mm status
+```
+
+The stack runs `mm-app` and MongoDB (`mongo:8`). User data is stored in `./docker/config`, `./docker/trade-config`, and `./docker/logs` (gitignored).
+
+### Command reference
+
+| Command | Description |
+| --- | --- |
+| `mm init` | Interactive first-time setup wizard |
+| `mm on` | Start the bot (preflight `doctor`, no duplicate instance) |
+| `mm off` | Stop the bot (`--all` also stops MongoDB in Docker) |
+| `mm restart` | Restart the bot |
+| `mm status` | Installation, process, and health summary (`--json`, `--short`) |
+| `mm config` | View or change config parameters (`--edit`, `--restart`) |
+| `mm doctor` | Diagnose config, MongoDB, exchange API, and runtime |
+| `mm logs` | Show logs (`-f`, `--tail`, `--since`, `--level`, `--grep`) |
+| `mm update` | Update the app without touching user config (`--check`) |
+
+Use `--mode npm` or `--mode docker` when auto-detection is ambiguous.
+
+## Documentation
 
 - [Installation and usage guide](https://marketmaking.app/cex-mm/installation/)
 - [Command reference](https://marketmaking.app/cex-mm/command-reference/)
 
+## Tests & Developer tools
+
+See [CONTRIBUTING.md — Tests](CONTRIBUTING.md#tests) for Jest suites, interactive simulators, and live exchange scripts.
+
 ## Contact
 
 Want to try it for your token project or request exchange support?

bin/mm.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * ADAMANT Market-Making Software installer and maintenance CLI entrypoint.
+ *
+ * Exposed on PATH as `mm` and `adamant-tradebot` via package.json bin map.
+ * This is intentionally separate from `bin/cli.js`, which sends trading commands
+ * to an already running bot instance (`/balances`, `/start`, …).
+ *
+ * Unhandled promise rejections exit with code 3 (CLI/internal error).
+ *
+ * @module bin/mm
+ * @typedef {import('types/bot/mm').MmCliModule} MmCliModule
+ */
+
+process.env.MM_CLI = '1';
+
+require('../modules/mm/silence-diagnostics').installDiagnosticSilence();
+
+/** @type {MmCliModule} */
+const mmCli = require('../modules/mm/cli.js');
+
+mmCli.main(process.argv.slice(2)).then((code) => {
+  process.exit(typeof code === 'number' ? code : 0);
+}).catch((error) => {
+  console.error(error instanceof Error ? error.message : String(error));
+  process.exit(3);
+});

docker-compose.yaml

@@ -0,0 +1,23 @@
+#!/bin/sh
+set -e
+
+# Docker volumes use ./config/config.jsonc — link to the path configReader expects.
+if [ -f /app/config/config.jsonc ]; then
+  ln -sfn /app/config/config.jsonc /app/config.jsonc
+fi
+
+# Link trade-config files into trade/settings so runtime saves (WebUI, commands) persist
+# on the mounted volume and fs.watch sees the same path the bot reads/writes.
+if [ -d /app/trade-config ]; then
+  for file in /app/trade-config/tradeParams_*.js; do
+    [ -e "$file" ] || continue
+    ln -sfn "$file" "/app/trade/settings/$(basename "$file")"
+  done
+fi
+
+if [ "$1" = "mm" ]; then
+  shift
+  set -- node /app/bin/mm.js "$@"
+fi
+
+exec "$@"

docker-entrypoint.sh

@@ -0,0 +1,4 @@
+# User data created by `./mm init` — never commit
+config/
+trade-config/
+logs/