Tidal Docs

Tidal is Yearn's auction operations stack. It scans strategy and fee-burner inventories, caches balances and prices in SQLite, exposes that state through a FastAPI control plane, and lets CLI clients prepare and broadcast auction transactions with local wallet signing.

Read This First

• New to the system: start with Architecture
• Setting up a workstation: go to Local Development
• Operating as a CLI client against a remote API: go to CLI Client Guide
• Running the server and daemons: go to Server Operator Guide
• Understanding config files and role-specific settings: go to Configuration

System At A Glance

Component	What it does	Main code
Scanner	Discovers strategies, fee burners, balances, prices, and auction mappings	tidal/scanner/
Transaction service	Shortlists candidates, prepares kicks, computes lot pricing, and records results	tidal/transaction_service/
Control plane API	Serves dashboard/log data and prepares action payloads	tidal/api/
CLI client	Calls the API, signs locally, broadcasts locally, and reports receipts	tidal/cli.py
Dashboard UI	Displays cached state and logs, and drives CLI client actions	ui/
Contracts	Foundry project for the on-chain AuctionKicker helper	contracts/

Reading Paths

Backend contributor

1. Architecture
2. Local Development
3. Configuration
4. Pricing
5. Kick Selection

CLI client

1. CLI Client Guide
2. CLI Client Overview
3. CLI Client: tidal kick
4. Configuration
5. Pricing

Server operator

1. Server Operator Guide
2. Server Operator CLI Overview
3. Configuration
4. API Reference

Reference

• CLI Overview
• CLI Client Overview
• Server Operator CLI Overview
• API Reference
• Configuration
• Glossary

Source Of Truth

These docs are meant to explain the current system, not preserve historical plans. When behavior disagrees with prose, prefer the code:

• CLI surface: tidal --help and tidal-server --help
• API surface: FastAPI routes in tidal/api/routes/
• Config schema: tidal/config.py