For Chinese version please see README-zh.
Server-side monorepo for generating and broadcasting BFMeta transactions; listens to client requests, talks to chain nodes, and broadcasts transactions. TypeScript + Yarn workspaces with CLI packaging and production build scripts.
src/: transaction generation/validation/broadcast plus node communication, logging, config loading.config/config.json: sample config for port,chainNodeIps,broadcastTimeout,genesisInfoConfig,lang.scripts/: cleanup and production builds (buildProd.js, etc.).tsconfig*.json/lerna.json: multi-target and package management configs.
yarn install(Node 16+)- Configure service: copy & edit
config/config.json(port,chainNodeIps,genesisInfoConfig,lang). - Dev mode:
yarn dev(watch build). - Full build:
yarn rebuildoryarn build(outputsbuild/). - Production bundle:
yarn prod(clean + build + prod scripts) or quickyarn prod:dev.
- Keep type-safety: no new
any/@ts-ignore; share common logic in shared modules to stay DRY. - Update README and default validation when config fields change.
- For chain interaction changes, provide a minimal usage example or regression case; run
yarn buildbefore commit. - Branch/commit:
feature/<scope>,fix/<issue>with concise messages.