🛠️ Developer Docs

For contributors and smart contract developers building on top of the protocol.

---

📦 Tech Stack

• Solidity – Core contracts (vaults, strategies, automation owner)
• TypeScript – AI agent (agent/) and frontend app (frontend/)
• Chainlink Automation – For scheduled and reactive execution
• ElizaOS – AI agent plugin framework + key-value (KV) storage
• Foundry – Smart contract development & testing
• MkDocs – Documentation site

---

🧰 Developer Tooling

Here’s what you need to install to contribute or test the system locally:

🔗 Smart Contract Dev Tools

• Foundry (Forge) – For testing, deployment, and debugging

curl -L https://foundry.paradigm.xyz | bash
foundryup

• Solidity (>=0.8.0)

• Node.js (>=18)

• Yarn (recommended over npm)

npm install -g yarn

🤖 AI Agent Tools

• ElizaOS CLI – Plugin development environment

npm install -g eliza

• .env file with API keys:

• COINGECKO_API_KEY

• DEFI_LLAMA_API_KEY (optional)
• KV_AUTH_TOKEN (from ElizaOS dashboard)

🌐 Frontend Dev

• React + Vite + Tailwind (inside frontend/)

cd frontend
yarn install
yarn dev

📘 Documentation Dev

• MkDocs + Material theme

pip install mkdocs-material
mkdocs serve

---

📁 Project Structure

.
├── contracts/             # Vaults, strategies (Solidity)
├── agent/                 # ElizaOS plugin (TypeScript)
├── frontend/              # Web UI (Vite + Tailwind)
├── automation-owner/      # Chainlink Automation owner
├── docs-site/             # This MkDocs documentation site

---

🧪 Local Testing

Run Agent:

cd agent
yarn start

Run Contracts:

cd contracts
forge build
forge test

Run Docs:

cd docs-site
mkdocs serve

---

🔐 Secrets & Env Setup

• .env required in agent/, frontend/, and contracts/ folders.
• Do not commit .env to git.