How collarnetworks/protocol-core works
Project Type and Purpose
• Type: Smart-contract‐only blockchain protocol (no UI layer).
• Purpose: A lending protocol using DEX swaps and option-like payoffs to offer liquidation-free, high-LTV borrowing.
Main Components
a. Core Contracts (src/base & src/interfaces)
– Core lending logic lives here.
– Interfaces define the protocol’s external API.
b. External Dependencies (lib/)
– OpenZeppelin (ERC20, AccessControl, etc.)
– Uniswap V3 core & periphery (swap router, pools).
– Custom swap-router contracts.
c. Deployment & Utility Scripts (script/)
– script/deploy: deployments to various chains.
– script/utils: batch Etherscan verification, diffs, explorer links.
– script/artifacts: stores previous deployments.
d. Testing Suite (test/)
– Unit tests (test/unit) for individual contracts.
– Integration tests (test/integration) simulating full protocol flows.
– Shared test utilities (test/utils).
e. Developer Tooling & Configuration
– Foundry (forge) setup (foundry.toml, remappings.txt).
– CI workflows (GitHub Actions in .github/workflows).
– Documentation (devdocs/, script/readme.md).
– Audit reports (audits/).
Relationships and Data Flow
• Developer → Foundry (forge) → Compiles core contracts + NatSpec docs.
• Deployment Scripts → RPC node → Deploy contracts on chain → Emit artifacts.
• Core Contracts ↔ External Dependencies (Uniswap v3, ERC20 tokens).
• Tests (unit & integration) → Local Hardhat/Anvil fork or testnet → Interact with deployed contracts & mocks.
• CI → Runs forge tests + script checks + docgen on every PR.
Architectural Patterns & Design Principles
• Modular Design: each functional domain (lending logic, swap router adaptor) is isolated in its own contract/module.
• Interface-Driven: clear contract interfaces for upgradeability or future extension.
• Dependency Injection via remappings: external protocol addresses & libraries injected at compile time.
• Continuous Verification: automated Etherscan re-verification scripts.