mev-beta/docs/project-summary.md

MEV Bot Project Summary

This document provides a summary of the MEV bot project structure and components.

Project Structure

.
├── @prompts/                 # AI prompts for development assistance
│   ├── README.md
│   ├── arbitrum-monitoring.md
│   ├── database.md
│   ├── error-handling.md
│   ├── gas-optimization.md
│   ├── market-scanning.md
│   ├── performance-optimization.md
│   ├── security.md
│   ├── smart-contract-interaction.md
│   ├── testing-simulation.md
│   ├── testing.md
│   └── uniswap-pricing.md
├── cmd/                      # Main applications
│   └── mev-bot/
│       └── main.go
├── config/                   # Configuration files
│   ├── config.dev.yaml
│   └── config.yaml
├── data/                     # Data storage (git-ignored)
├── docs/                     # Documentation
│   ├── architecture.md
│   ├── monitoring.md
│   └── uniswap-pricing.md
├── docker-compose.yml        # Docker Compose configuration
├── Dockerfile                # Docker configuration
├── go.mod                    # Go module definition
├── go.sum                    # Go module checksums
├── internal/                 # Private application and library code
│   ├── config/
│   │   └── config.go
│   ├── logger/
│   │   └── logger.go
│   └── utils/
│       └── utils.go
├── Makefile                  # Build automation
├── pkg/                      # Library code that can be used by external projects
│   ├── monitor/
│   │   └── monitor.go
│   ├── scanner/
│   │   └── scanner.go
│   └── uniswap/
│       └── pricing.go
├── QWEN.md                   # Qwen Code context file
├── README.md                 # Project overview
└── scripts/                  # Scripts for building, testing, and deployment
    ├── build.sh
    ├── run.sh
    └── test.sh

Key Components

1. Core Packages

• pkg/monitor: Monitors the Arbitrum sequencer for transactions
• pkg/scanner: Analyzes transactions for arbitrage opportunities
• pkg/uniswap: Implements Uniswap V3 pricing calculations
• internal/config: Handles configuration loading
• internal/logger: Provides structured logging
• internal/utils: Utility functions

2. Configuration

• config/config.yaml: Production configuration
• config/config.dev.yaml: Development configuration

3. Documentation

• Architecture overview
• Uniswap V3 pricing documentation
• Monitoring system documentation

4. Development Tools

• AI prompts for various aspects of development
• Docker configuration for containerization
• Makefile for build automation
• Shell scripts for common tasks

5. Testing

• Comprehensive testing prompts
• Simulation testing approaches

Getting Started

1. Install Go 1.24 or higher
2. Run go mod tidy to install dependencies
3. Build with go build -o bin/mev-bot cmd/mev-bot/main.go
4. Run with ./bin/mev-bot start

Development

Use the prompts in the @prompts/ directory with your AI coding assistant for help with specific aspects of the project.