Files
mev-beta/docs/1_getting_started/QUICK_START.md
Krypto Kajun 850223a953 fix(multicall): resolve critical multicall parsing corruption issues
- Added comprehensive bounds checking to prevent buffer overruns in multicall parsing
- Implemented graduated validation system (Strict/Moderate/Permissive) to reduce false positives
- Added LRU caching system for address validation with 10-minute TTL
- Enhanced ABI decoder with missing Universal Router and Arbitrum-specific DEX signatures
- Fixed duplicate function declarations and import conflicts across multiple files
- Added error recovery mechanisms with multiple fallback strategies
- Updated tests to handle new validation behavior for suspicious addresses
- Fixed parser test expectations for improved validation system
- Applied gofmt formatting fixes to ensure code style compliance
- Fixed mutex copying issues in monitoring package by introducing MetricsSnapshot
- Resolved critical security vulnerabilities in heuristic address extraction
- Progress: Updated TODO audit from 10% to 35% complete

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-17 00:12:55 -05:00

1.7 KiB
Raw Permalink Blame History

Quick Start Guide

This guide gets you from a fresh clone to a locally running MEV Bot instance and points you toward deeper documentation.

Prerequisites

  • Go 1.24 or newer (go version to verify)
  • Access to an Arbitrum RPC/WebSocket endpoint
  • OpenSSL (for generating encryption keys)

Environment Setup

# Clone and enter the repository
git clone <repository-url>
cd mev-beta

# Provision default environment files and directories
./setup-env.sh

# Generate a 32-byte encryption key and export connection secrets
export MEV_BOT_ENCRYPTION_KEY="$(openssl rand -base64 32)"
export ARBITRUM_RPC_ENDPOINT="wss://..."
export ARBITRUM_WS_ENDPOINT="wss://..."

Update .env with the Ethereum key material described in docs/5_development/CONFIGURATION.md before running transactions.

Install Dependencies & Build

# Sync Go modules and vendor checksums
go mod tidy

# Compile the bot binary (writes to bin/mev-bot)
make build

Run & Verify

# Execute the service binary
./bin/mev-bot start

# Alternatively run without rebuilding
go run cmd/mev-bot/main.go
# Format, lint, and vet code before committing
make fmt
make lint
make vet

# Run the full test suite with coverage
make test
make test-coverage

Where to Go Next

  • docs/INDEX.md Navigation for all documentation categories
  • PROJECT_SPECIFICATION.md High-level architecture and requirements
  • docs/5_development/TESTING_BENCHMARKING.md Testing strategy and performance validation

Keep this doc purposely actionable; consult the broader documentation sections for architecture deep dives, deployment practices, and security hardening.