How iexecblockchaincomputing/poco works
Project type and purpose
• This is an on-chain protocol implementation: the iExec “Proof-of-Contribution” (PoCo) smart‐contract system, written in Solidity, packaged with Hardhat/Truffle migrations, TypeScript/JavaScript deploy & test scripts, UML docs, and off‐chain tooling.
• Its goal is to manage task orders, worker staking, revealiation, and governance via a modular, upgradeable smart-contract architecture (ERC1538 modules + proxy + create2 factory).
File structure
• Top‐level dirs:
• contracts/ ← Solidity sources, organized into external interfaces, libs, modules (core PoCo logic), registries (apps, datasets, workerpools), testing tools
• build/ & build/contracts-min/ ← compiled artifacts + ABIs
• deploy/ + migrations/ ← Hardhat & Truffle deployment scripts (TypeScript & JS)
• scripts/ ← specialized tasks: module boost, ENS, factory upgrades, timelock
• test/ ← comprehensive test suite (JS/TS) covering flows, edge cases, back-to-back FullChain scenarios
• config/ ← per-chain configuration for native vs ERC20 escrow, factory salt, v3/v5 bridging
• Key config: hardhat.config.ts, .mocharc.json, slither.config.json
README for additional insights
• The README describes:
• Modular ERC1538 design (contracts split into delegates/modules behind proxy)
• create2-based factory for deterministic deployments
• Dual escrow support (native vs ERC20)
• Multi-chain support (config/config*.json)
• Provided UMLs for: high-level actor/contract architecture, sequence workflows (nominal/boost/TEE), storage layouts
• It points to comprehensive PoCo docs, solidity API docs, and UML artifacts in docs/uml.
a. Main components to show
• Off-chain environment: Hardhat/Truffle CLI, deploy & test scripts, config files, UML/tooling
• Ethereum network (public or sidechain)
• Factory contract (GenericFactory) + create2 salt → Proxy instances
• Proxy (ERC1538 upgradeable)
• Delegate modules (IexecPoco1, IexecPoco2, IexecEscrowNative/Token, IexecCategoryManager, IexecOrderManagement, IexecRelay, etc.)
• Registries: AppRegistry, DatasetRegistry, WorkerpoolRegistry
• Libraries: IexecLibCore, IexecLibOrders, SafeMath, EnumerableMap/Set
• Token contract (RLC) or native token handling
• External services: ENSIntegration, IOracle (oracle consumer)
• Off-chain data flows: test harness, score transfer v3→v5 bridge
b. Relationships & interactions
• Scripts read config → call factory.deploy() → deploy Proxy + modules
• Proxy forwards calls to modules via delegatecall (ERC1538)
• Modules invoke libraries for core logic (staking, task matching, payout)
• Registries store metadata (apps, datasets, workerpools)
• Escrow modules lock/unlock tokens/native based on PoCo events
• Oracles feed external data into contracts
• ENSIntegration modules resolve names during deployment or naming flows
c. Architectural patterns & design principles
• Modular proxy upgradeability (ERC1538): each module adds/removes functions at runtime
• Deterministic deployment (create2 factory) for multi-chain consistency
• Separation of concerns: registries vs business logic vs payment (escrow) vs metadata
• Extensibility: new modules can be added via factory or governance
d. Key technologies
• Solidity + Hardhat + Truffle migrations
• TypeScript/JavaScript deploy & test scripts
• create2 GenericFactory, ERC1538 upgrade proxy
• JSON artifacts for ABI/bytecode
Detail
• Contract family (core PoCo, boost, maintenance, relay) as separate modules
• NIexecLibOrders & NIexecLibCore libraries that underpin business logic
• Dual‐mode escrow path (ERC20 vs native) branching from PoCo modules
• Inter-module dependencies (e.g., OrderManagement calls CategoryManager & Poc oDelegate)