How symbioticfi/rewards works
Main components
• On-Chain Core Modules:
• Reward Interfaces (src/interfaces/…)
• Default Implementations (src/contracts/defaultOperatorRewards, src/contracts/defaultStakerRewards)
• Core Symbiotic Protocol contracts (lib/core)
• External Libraries (lib/openzeppelin-contracts, lib/openzeppelin-contracts-upgradeable, lib/forge-std)
• Off-Chain Tooling:
• CLI Data Generators (cli/defaultOperatorRewards/*.js with distribution.json, trees.json, proofs, roots)
• Deployment Scripts (script/deploy, script/deploy/genesis)
• Tests & Mocks (test/…, test/integration, test/mocks)
• Build & CI:
• Foundry toolchain (foundry.toml, forge build/test/fmt/snapshot)
• GitHub Actions workflows (.github/workflows/lint.yml, test.yml)
• External Services:
• Ethereum RPC providers (ETH_RPC_URL, ETH_RPC_URL_HOLESKY)
• Etherscan API (ETHERSCAN_API_KEY)
• Documentation & Audit Links
Relationships and data flows
• Off-Chain → On-Chain:
• CLI scripts read distribution.json → generate Merkle trees, proofs, roots → these roots are passed as constructor/initializer params to reward contracts during deployment.
• Deployment scripts use RPC endpoint & forge to deploy reward modules.
• On-Chain:
• Reward contracts implement standard interfaces → interact with Core Symbiotic modules.
• Contracts rely on OpenZeppelin libraries for security (upgradeability, access control).
• Build & CI:
• GitHub Actions trigger forge build/test/lint → publish artifacts to out/ → ensure contracts pass audits and tests.
• External Services:
• Etherscan API used for contract verification after deployment.
• RPC endpoints serve as the blockchain node for deploy & tests.
Architectural patterns and design principles
• Modular Smart-Contract Design:
• Separation of Interface vs Implementation.
• Pluggable default modules (OperatorRewards, StakerRewards).
• Merkle-Tree Off-Chain Computation:
• Precompute reward distribution off-chain for gas efficiency.
• Standardized Build/Test Pipeline:
• Foundry for local development, CI for automated checks.
• Declarative Configuration:
• .env for environment-specific endpoints and keys.
• Documentation & Auditing:
• Specs/ folder for design docs; audits/ for security reviews.