Skip to content

Commit cb07b28

Browse files
author
conditional-team
committed
docs: professional README, Arbitrum defaults, root .env.example
- Rewrote README with architecture diagram, layer breakdown, component tables - Moved .env from core/ to project root (gitignored) - Created root .env.example with all config vars documented - Updated Go config defaults for Arbitrum (250ms blocks, 128 reorg depth) - Fixed config test for new Arbitrum defaults
1 parent 0ed6ade commit cb07b28

4 files changed

Lines changed: 307 additions & 75 deletions

File tree

.env.example

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# ═══════════════════════════════════════════════════════════════════════════════
2+
# MEV PROTOCOL — ENVIRONMENT CONFIGURATION
3+
# Copy to .env and fill in your values. Never commit real keys.
4+
# ═══════════════════════════════════════════════════════════════════════════════
5+
6+
# ┌─────────────────────────────────────────────────────────────────────────────┐
7+
# │ PRIVATE KEYS │
8+
# └─────────────────────────────────────────────────────────────────────────────┘
9+
PRIVATE_KEY=
10+
FLASHBOTS_SIGNER_KEY=
11+
12+
# ┌─────────────────────────────────────────────────────────────────────────────┐
13+
# │ RPC ENDPOINTS │
14+
# └─────────────────────────────────────────────────────────────────────────────┘
15+
ARBITRUM_RPC_URL=https://arb-mainnet.g.alchemy.com/v2/YOUR_KEY
16+
ARBITRUM_WS_URL=wss://arb-mainnet.g.alchemy.com/v2/YOUR_KEY
17+
ARBITRUM_RPC_BACKUP=https://arb1.arbitrum.io/rpc
18+
19+
# Go network node (comma-separated for multi-endpoint pool)
20+
MEV_RPC_ENDPOINTS=wss://arb-mainnet.g.alchemy.com/v2/YOUR_KEY
21+
22+
# ┌─────────────────────────────────────────────────────────────────────────────┐
23+
# │ CONTRACT ADDRESSES │
24+
# └─────────────────────────────────────────────────────────────────────────────┘
25+
FLASH_ARBITRAGE_CONTRACT=0x0000000000000000000000000000000000000000
26+
BALANCER_VAULT=0xBA12222222228d8Ba445958a75a0704d566BF2C8
27+
28+
# ┌─────────────────────────────────────────────────────────────────────────────┐
29+
# │ STRATEGY │
30+
# └─────────────────────────────────────────────────────────────────────────────┘
31+
MIN_PROFIT_BPS=10
32+
MAX_GAS_PRICE_GWEI=1
33+
SLIPPAGE_BPS=50
34+
SCAN_AMOUNTS_ETH=0.1,0.5,1,5,10
35+
MAX_POSITION_ETH=50
36+
37+
# ┌─────────────────────────────────────────────────────────────────────────────┐
38+
# │ GO NETWORK NODE │
39+
# └─────────────────────────────────────────────────────────────────────────────┘
40+
MEV_RPC_MAX_CONNS=10
41+
MEV_RPC_TIMEOUT=5s
42+
MEV_RPC_HEALTH_INTERVAL=30s
43+
MEV_MEMPOOL_BUFFER=10000
44+
MEV_MEMPOOL_FILTER=true
45+
MEV_MEMPOOL_MIN_VALUE=100000000000000000
46+
MEV_PIPELINE_WORKERS=4
47+
MEV_PIPELINE_BUFFER=5000
48+
MEV_METRICS_ENABLED=true
49+
MEV_METRICS_ADDR=:9090
50+
MEV_FLASHBOTS_URL=https://relay.flashbots.net
51+
# Note: Flashbots is Ethereum mainnet only.
52+
# On Arbitrum, bundles go direct to the sequencer — relay is kept for future multi-chain.
53+
MEV_RELAY_MAX_CONCURRENT=3
54+
MEV_RELAY_REQUIRE_SIM=true
55+
FLASHBOTS_SIGNING_KEY=
56+
57+
# ┌─────────────────────────────────────────────────────────────────────────────┐
58+
# │ PERFORMANCE │
59+
# └─────────────────────────────────────────────────────────────────────────────┘
60+
DETECTOR_THREADS=4
61+
SIMULATOR_THREADS=2
62+
POOL_REFRESH_MS=100
63+
RPC_TIMEOUT_MS=5000
64+
65+
# ┌─────────────────────────────────────────────────────────────────────────────┐
66+
# │ LOGGING │
67+
# └─────────────────────────────────────────────────────────────────────────────┘
68+
LOG_LEVEL=info
69+
LOG_JSON=true
70+
LOG_FILE=logs/mev-engine.log
71+
METRICS_PORT=9090
72+
73+
# ┌─────────────────────────────────────────────────────────────────────────────┐
74+
# │ API KEYS │
75+
# └─────────────────────────────────────────────────────────────────────────────┘
76+
ARBISCAN_API_KEY=
77+
ETHERSCAN_API_KEY=
78+
MORALIS_API_KEY=
79+
80+
# ┌─────────────────────────────────────────────────────────────────────────────┐
81+
# │ TELEGRAM (OPTIONAL) │
82+
# └─────────────────────────────────────────────────────────────────────────────┘
83+
TELEGRAM_BOT_TOKEN=
84+
TELEGRAM_CHAT_ID=

0 commit comments

Comments
 (0)