nikola-dex (English)

For Chinese version please see README-zh.

Overview

Monorepo DEX backend for Bnqkl/BFMeta (NestJS). Handles order routing, liquidity, and settlement with background workers.

Architecture

• Workspaces packages/: app (HTTP/gateway API), backgroud (workers), core (domain, DTOs, services), test (integration/e2e).
• Tooling: lerna.json, pnpm-workspace.yaml, tsconfig.base.json; scripts in scripts/.
• Config: see config/ for network/DB/RPC settings; adjust before prod.

Getting Started

pnpm install
pnpm run start:dev   # dev watch
pnpm run start:prod  # production
pnpm run test        # unit/e2e (if configured)

Contribution Guide

• Layer 2A (GPLv3). Keep controllers thin; domain logic lives in core (SRP/DRY).
• Document required env vars (DB, RPC endpoints, keys) and keep sample env updated.
• Add tests in packages/test for new routes/flows; TS strict, avoid any.
• Branches: feature/<scope> / fix/<issue>; concise commits.