How flare-labs-ltd/fassets works
Project type and purpose
• This is a blockchain‐focused system: a collection of Solidity smart contracts (“FAsset contracts”) plus accompanying TypeScript tooling, deployment scripts (Hardhat, Diamond Cuts), and test suites. Its purpose is to mint and manage “FAssets” (wrapped assets secured by collateral) on Flare and Songbird chains using on‐chain protocols (FTSO, FDC).
Main architectural components
a. On-chain Contracts (Solidity)
• Core modules:
• AssetManager (facets, implementation, interfaces, libraries, mocks)
• Diamond (facets, implementation, interfaces; implements EIP-2535 Diamond pattern)
• FAssetToken (implementation, interfaces, libraries, mocks)
• FDC bridge contracts
• Governance contracts (timelock, upgradeability)
• OpenZeppelin utilities (ERC20, security, EIP712, token permits)
• UserInterfaces (data types, helper contracts)
• Shared Utils (libraries, interfaces)
b. Off-chain Deployment & Tooling (TypeScript + JSON)
• Deployment scripts under /deployment: configuration schemas, chain-specific parameters, DiamondCut JSON, deploy utilities, verify scripts
• Hardhat config & tasks (hardhat.config.ts, hardhat-tasks.config.ts)
c. Off-chain Libraries & Actors
• /lib folders host:
• Domain boundaries (fasset, state, underlying-chain abstractions)
• Actor models (Challenger, LiquidationTrigger)
• Helpers (deepCopy, events formatting, blockchain adapters)
• Scripts for flattening, documentation, CLI runners
d. Test Suites
• Unit tests (per module, mocks)
• Integration tests (fasset‐simulation flows)
• Fuzzing tests (property‐based with custom actors)
• Test utilities (helpers, chain simulators)
e. Documentation
• /docs (interfaces, specs, deployment guide)
Key relationships & data flows
• Users or off-chain services (CLI, scripts, front-ends) → submit transactions to On-chain Contracts via JSON-RPC (Hardhat, Infura, local node).
• On-chain AssetManager/Diamond uses FTSO price feeds and FDC data connectors to secure minted FAssets.
• Governance contracts control upgrades (DiamondCut) and parameter modifications.
• Deployment pipeline: TypeScript scripts read JSON schemas → deploy diamond, facets, libraries → link contracts → verify on Tenderly/Etherscan.
• Test harness simulates underlying chains and FDC/FTSO behavior to drive integration/fuzzing tests.
Architectural patterns & principles
• EIP-2535 Diamond pattern (modular facets + proxy) for upgradability
• Layered separation:
• Interface contracts + implementation contracts + libraries
• On-chain vs Off-chain concerns
• Schema-driven deployment (JSON parameter schemas for each network)
• Extensive mocking for deterministic unit/fuzzing tests
Final checklist
• Clearly separated On-chain vs Off-chain vs External
• Annotations for architectural patterns: Diamond, library layering, JSON schema inputs