ROOT_FILES_INDEX.md

Root Files Index

Last Updated: 2025-11-15

Complete index of files in the repository root directory.

---

📋 Quick Reference

Most Important Root Files

• README.md ⭐ - Project overview and quickstart
• AGENTS.md ⭐ - Repository guidelines for AI agents
• package.json ⭐ - Node.js package configuration

---

📚 Root Files by Category

Documentation

Main Documentation

• README.md ⭐ - Project overview and quickstart
  • Purpose: Main project documentation
  • Content: Quickstart, configuration, troubleshooting, safety warnings
  • When to Use: First point of contact for new users

Repository Guidelines

• AGENTS.md ⭐ - Repository guidelines for AI agents
  • Purpose: Guidelines for AI agents working on this repository
  • Content: Project structure, coding style, testing guidelines, commit guidelines
  • When to Use: AI agents should read this before making changes

Documentation Directory

• docs/ - Complete documentation directory
  • Purpose: All detailed documentation
  • Index: Index of Indexes ⭐
  • When to Use: Deep dive into specific topics

---

Configuration

Package Configuration

• package.json ⭐ - Node.js package configuration

  • Purpose: Dependencies, scripts, project metadata
  • Format: JSON
  • When to Use: npm install, npm run <script>

• package-lock.json - Dependency lock file

  • Purpose: Lock exact dependency versions
  • Format: JSON
  • When to Use: Automatically used by npm install

TypeScript Configuration

• tsconfig.json - TypeScript compiler configuration
  • Purpose: TypeScript compilation settings
  • Format: JSON
  • When to Use: Build system automatically uses this

Environment Files

• See Configuration Files Index for complete list
• .env - Active configuration (gitignored)
• .env.example - Configuration template

---

Process Management

PM2 Configuration

• ecosystem.config.cjs - PM2 ecosystem configuration
  • Purpose: PM2 process management configuration
  • Format: CommonJS
  • When to Use: PM2 process management (if used)

Keep-Alive Script

• keep-alive.ts - Watchdog script
  • Purpose: Auto-restart bot on crashes
  • Format: TypeScript
  • Usage: npm run start:keep-alive
  • When to Use: Production runs

---

Data Files

Analysis Data

• mint-insights.json - Successful mint transaction analysis
  • Purpose: Stores analysis of successful mint transactions
  • Generated By: npm run analyze:mints:known
  • When to Use: Gas strategy research

State Files

• .miteddy-state.json - Bot state persistence

  • Purpose: Stores bot state for crash recovery
  • Auto-Generated: Yes (by bot)
  • Gitignored: Yes

• .miteddy.lock - Single-instance lock

  • Purpose: Prevents multiple bot instances
  • Auto-Generated: Yes (by bot)
  • Gitignored: Yes

---

Indexes & Documentation

Root-Level Indexes

• DATA_FILES_INDEX.md - Index of data files
• CONFIGURATION_FILES_INDEX.md - Index of configuration files
• ROOT_FILES_INDEX.md - This file

Directory Indexes

• docs/INDEX_OF_INDEXES.md ⭐ - Master documentation navigation
• scripts/SCRIPTS_INDEX.md - Scripts index
• src/UTILITY_FILES_INDEX.md - Source utility files index

---

Temporary Files

Log Files (Should be cleaned up)

• tmp_analyze.log - Temporary analysis log
• tmp_layer7.log - Temporary layer7 log

Test Files

• test.bat - Test batch file
  • Purpose: Windows batch file for testing
  • When to Use: Windows testing

---

🎯 Quick Navigation

For New Users

1. Start with README.md ⭐
2. Then see docs/INDEX_OF_INDEXES.md for detailed docs

For AI Agents

1. Read AGENTS.md ⭐ first
2. Follow repository guidelines
3. Check coding style and conventions

For Configuration

1. See CONFIGURATION_FILES_INDEX.md
2. Copy .env.example to .env
3. Fill in your values

For Scripts

1. See scripts/SCRIPTS_INDEX.md
2. Use npm run <script> commands

For Data Files

1. See DATA_FILES_INDEX.md
2. Understand state files and analysis data

---

📖 Related Documentation

Primary Indexes

• Index of Indexes ⭐ - Master navigation hub for all indexes
• Documentation Index - Complete documentation index
• Audit Index - Complete audit index (80+ audits)
• Analysis Index - Complete analysis index (80+ reports)
• Guides Index - Complete guides index (27 guides)
• Research Index - Research documents index

Cross-Reference & Timeline

• Cross-Reference Map - Relationships between documents
• Timeline Index - Chronological index (117+ cross-references)
• Changelog - All changes (67+ cross-references)

File-Specific Indexes

• Configuration Files Index - Configuration reference
• Data Files Index - Data files reference
• Scripts Index - Scripts reference
• Utility Files Index - Source utility files index

---

🔒 Gitignore Status

Should Be Gitignored (Already in .gitignore)

• .env - Contains PRIVATE_KEY
• .miteddy-state.json - Bot state
• .miteddy.lock - Lock file
• logs/ - Log files
• data/ - Analysis data
• dist/ - Compiled output
• node_modules/ - Dependencies
• tmp_*.log - Temporary logs

Should Be Tracked

• README.md - Main documentation
• AGENTS.md - Repository guidelines
• package.json, package-lock.json - Dependencies
• tsconfig.json - Build configuration
• .env.example* - Configuration templates
• All documentation files
• All index files

---

⭐ = Most important / Frequently used