bnqkl-swap (English)

For Chinese version please see README-zh.

Overview

Monorepo for Bnqkl/BFMeta swap backend built with NestJS. Provides quote/routing/order services plus background jobs.

Architecture

• Workspaces packages/: app (HTTP API), backgroud (background workers), core (domain logic, DTOs, utilities), test.
• Tooling: lerna.json, pnpm-workspace.yaml, tsconfig*.json; scripts under scripts/.
• Config: check packages/app / packages/backgroud for env examples.

Getting Started

pnpm install
pnpm run start:dev   # dev watch
pnpm run start:prod  # production build/run
pnpm run test        # unit
pnpm run test:e2e    # e2e

Contribution Guide

• Layer 2A (GPLv3). Keep controllers thin; put domain logic in core (SRP/DRY).
• Document required env vars (DB, RPC endpoints, secrets) near the package configs.
• Add tests in packages/test (or package-local) for new routes/handlers; keep API errors typed.
• Branch: feature/<scope> / fix/<issue>; concise commits.