How fleet-sdk/fleet works
Project Type and Purpose
• This is a TypeScript monorepo SDK (“Fleet SDK”) for the Ergo blockchain.
• It provides a suite of packages for transaction building, serialization, cryptography, compilation of ErgoScript, mock-chain testing utilities, blockchain data providers, wallet/key management, plus plugins for specialized protocols (AgeUSD, Babel Fees).
File Structure
• Top-level: a pnpm workspace orchestrates multiple packages under /packages and /plugins.
• Core sub-packages under /packages:
– common (shared types & utilities)
– crypto (ECDSA, hashing, coders)
– serializer (binary serializers/parsers for Ergo data structures)
– core (transaction builder, selectors, plugin context)
– wallet (mnemonics, HD keys, provers)
– compiler (ErgoScript → bytecode)
– mock-chain (in-memory testing chain & UTXO management)
– blockchain-providers (GraphQL, other providers)
• /plugins: each plugin extends core functionality via the plugin API.
• Top-level config: tsconfig, CI, release workflows.
README
• Lists each package and its role.
• Emphasizes a “fluent, flexible” off-chain/on-chain coding model.
• Mentions plugin architecture for protocol-specific extensions.
Main Components & Relationships
a. Core Library Layer
• @fleet-sdk/common: foundational types + utils
• @fleet-sdk/crypto: low-level crypto primitives
• @fleet-sdk/serializer: binary encoding/decoding
b. Functional Layer
• @fleet-sdk/core: transaction building, plugin host
• @fleet-sdk/wallet: key/mnemonic management + prover
• @fleet-sdk/compiler: compile ErgoScript contracts
• @fleet-sdk/mock-chain: simulate blockchain for tests
• @fleet-sdk/blockchain-providers: connect to external GraphQL or REST endpoints
c. Plugin Layer
• ageusd-plugin, babel-fees-plugin: implement protocol-specific logic via the core plugin API
d. Test-Vectors Package
• _test-vectors: shared fixtures used by multiple packages
e. CI/CD & Release
• GitHub Actions workflows orchestrate builds, tests, coverage, releases
• Data Flow & Dependencies
– Core ← common, crypto, serializer
– Wallet ← common, crypto, core (for transaction construction)
– Compiler ← common (types), serializer (output formatting)
– Mock-chain ← common, serializer, crypto (to simulate tx signatures)
– Blockchain-providers ← common (types), networking utils
– Plugins ← core (pluginContext API), may use common, serializer
Architectural Patterns & Principles
• Monorepo modularization: each concern lives in its own package.
• Plugin architecture: core exposes extension points for third-party logic.
• Clear layering: low-level (crypto, serializer) → mid-level (common) → high-level (core, wallet, compiler).
• Test-driven: each package contains its own tests and shared test-vectors.