rugmuncher-backend / AGENTS.md
cryptorugmunch
merge: chore/cleanup-remove-bloat-and-secrets into main
bde2f3a
|
Raw
History Blame Contribute Delete
3.45 kB
## 🚨 CRITICAL RULES (enforced by gitleaks pre-commit hook)
1. **No nested repos.** Don't commit other complete project trees inside this one.
2. **No secrets.** Never commit `.secrets/`, `.env`, `*.pem`, `*.key`, `*.crt`, cookie jars.
3. **No data blobs.** Don't commit `*.zip`, `*.parquet`, model weights, sqlite files.
4. **No broken files.** Shell heredoc accidents must be caught before commit.
5. **No duplicate scaffolds.** If a `backend/` or `frontend/` subdir exists at root,
it's either THE app or bloat β€” investigate before adding more.
See [CLEANUP.md](CLEANUP.md) for cleanup history.
---
# AGENTS.md β€” rmi-backend
# Every AI agent working on backend code reads this first.
# Last updated: 2026-06-29
## What This Is
rmi-backend β€” FastAPI crypto intelligence backend. 757+ routes, 221 MCP tools,
89 DataBus chains, 39.4M wallet labels, 21 SENTINEL scanner modules.
## Before You Start
Read these files in order:
1. ~/AGENTS.md β€” fleet-wide contract, product table, git policy
2. ~/CONVENTIONS.md β€” shared patterns (coding, naming, testing)
3. ./AGENTS.md (this) β€” backend-specific instructions
4. ./README.md β€” full project overview
5. ~/STANDARDS.md β€” linting, testing, quality gates
6. ~/TOOLCHAIN.md β€” developer tool inventory
## The Server
ALL work happens on netcup (100.100.18.18).
```
ssh netcup
cd /root/backend
docker logs rmi-backend --tail 100
docker restart rmi-backend
curl localhost:8000/health
```
Code in /root/backend is Docker volume-mounted β€” changes go live on restart.
## Testing
```
docker exec rmi-backend pytest -p no:pytest-brownie -v
docker exec rmi-backend pytest tests/unit/test_X.py -p no:pytest-brownie -v
```
The `-p no:pytest-brownie` is mandatory β€” eth-brownie tries to connect to ganache.
## Linting
```
ruff check app/ --fix
ruff format app/
mypy app/ --strict
```
## MCP Tools
mcp_discover, status_check, analytics_query, wallet_labels,
eth_labels_tool, token_security, scam_intel, news_search,
rag_query, report_generate, x402_marketplace (+ 210 more)
List: GET /mcp/tools Call: POST /mcp/call/{tool_id} Info: GET /mcp/info
## Adding a New Scanner Module
1. Create app/scanners/my_detector.py (fetches from first-party APIs only)
2. Add import to app/scanners/__init__.py
3. Add runner function in app/scanners/sentinel_pipeline.py
4. Add endpoint to app/routers/x402_tools.py
5. Add pricing to x402_enforcement.py
CRITICAL: Never call our own x402 endpoints internally.
## Adding a New DataBus Chain
1. Create provider in app/databus/providers/
2. Register in app/databus/chains.py
3. Register provider class in app/databus/registry.py
## Rules
1. All data through DataBus β€” never call providers directly
2. Type everything β€” Pydantic v2 + mypy strict
3. Async for all I/O β€” httpx.AsyncClient, asyncpg, asyncio
4. Never bare except β€” always log + re-raise
5. Use env vars β€” never hardcode hosts or secrets
6. Add tests for new code β€” coverage > 80%
7. Conventional commits β€” feat:/fix:/chore:/docs:/refactor:/test:
8. No secrets in git β€” vault.py is the only storage
9. No circular API calls β€” scanner modules don't call our own endpoints
10. Don't add to main.py (28 lines, by design) β€” use app/mount.py
## Git
Internal primary: `root@talos:/srv/git/rmi-backend.git`
Push `talos main` on every commit.
External remotes: GitHub (LLC), GitLab, HuggingFace (see ~/AGENTS.md)