For Chinese version please see README-zh.
TypeScript monorepo for BFMeta core chain logic (blocks, transactions, crypto, helpers) managed with Lerna + Yarn workspaces and bdk tooling. Provides reusable building blocks for nodes, SDKs, and tooling.
packages/model-*/transaction*: block & transaction models, serialization, validation pipelines.packages/crypto*,helper-*,util-*: key/signature utilities, time/config/migration helpers.packages/core,transaction_logic_verifier: core verification/forging composition layer.scripts/: cleanup, publishing, and tsconfig generation (bdk-mono,bdk-tsc).
yarn install- Sync tsconfig:
yarn mono && yarn lsts - Dev build:
yarn devoryarn dev:all - Prod build:
yarn rebuild
- Node 16+; Yarn only. Keep TS strict, avoid
any/@ts-ignore. - SRP/DRY: place shared logic in
helper-*/util-*; evaluate reuse before creating new packages. - Document API/type changes with comments or examples; leave contextual
TODO/FIXMEfor known gaps. - Run
yarn build(or targetedbdk-tsc --build) before committing to ensurebuild/artifacts. - Branches:
feature/<scope>,fix/<issue>; concise verb-based commits.