Skip to content

DATA_FILES_INDEX.md

Latest commit

 

History

History
206 lines (155 loc) · 6.54 KB

DATA_FILES_INDEX.md

File metadata and controls

206 lines (155 loc) · 6.54 KB

Data Files Index

Last Updated: 2025-11-15

Complete index of all data files, their purposes, and usage.

📋 Quick Reference

Most Important Data Files

📊 Data Files by Location

Root Directory

State Files

  • .miteddy-state.json ⭐ - Bot state persistence
    • Purpose: Stores bot state for crash recovery
    • Contents:
      • nonce: Current nonce
      • lastTxHash: Last transaction hash
      • gasLimitHint: Gas limit hint from successful mints (string format)
      • windowOpen: Window open status
      • lastError: Last error message
    • Format: JSON
    • Auto-Generated: Yes (by bot)
    • Gitignored: Yes (should be)
    • When to Use: Bot automatically loads on startup

Analysis Data

  • mint-insights.json ⭐ - Successful mint transaction analysis
    • Purpose: Stores analysis of successful mint transactions
    • Contents: Transaction hashes, gas usage, priority fees, timing data
    • Format: JSON
    • Generated By: npm run analyze:mints:known
    • Gitignored: Check .gitignore
    • When to Use: Gas strategy research, competitive analysis

Lock Files

  • .miteddy.lock - Single-instance lock
    • Purpose: Prevents multiple bot instances from running
    • Format: PID:12345\nTimestamp:1734048000000
    • Auto-Generated: Yes (by bot)
    • Gitignored: Yes (should be)
    • When to Use: Bot automatically manages this

data/ Directory

Analysis Output

  • analysis-output.txt - Analysis output text
    • Purpose: Text output from analysis scripts
    • Format: Plain text
    • Gitignored: Yes (should be)
    • When to Use: Review analysis results

Timing Analysis

  • mint-timing-analysis.json - Mint timing analysis

    • Purpose: Timing analysis of mint windows
    • Format: JSON
    • Gitignored: Yes (should be)
    • When to Use: Timing research

  • time-estimation-results.json - Time estimation results

    • Purpose: Results from time estimation scripts
    • Format: JSON
    • Gitignored: Yes (should be)
    • When to Use: Timing calibration

  • time-samples-temp.json - Temporary time samples

    • Purpose: Temporary time sampling data
    • Format: JSON
    • Gitignored: Yes (should be)
    • When to Use: Temporary data (can be deleted)

  • temp-samples.json - Temporary samples

    • Purpose: Temporary sampling data
    • Format: JSON
    • Gitignored: Yes (should be)
    • When to Use: Temporary data (can be deleted)

Mint Analysis

  • successful-mints-analysis.json - Successful mints analysis
    • Purpose: Analysis of successful mint transactions
    • Format: JSON
    • Gitignored: Yes (should be)
    • When to Use: Mint success analysis

logs/ Directory

Bot Logs

  • Pattern: bot-YYYY-MM-DD_HH-MM-SS-SSS_PST.log
  • Purpose: Detailed bot execution logs
  • Format: Text/JSON (depending on logging mode)
  • Gitignored: Yes
  • When to Use: Post-mortem analysis, troubleshooting, debugging

Detailed Logs

  • Pattern: detailed-YYYY-MM-DD_HH-MM-SS-SSS_PST.json
  • Purpose: Structured JSON logs with full telemetry
  • Format: JSON
  • Gitignored: Yes
  • When to Use: Deep analysis, performance metrics

🔍 Data File Usage

State Management

.miteddy-state.json

  • Created By: Bot automatically
  • Updated By: Bot automatically
  • Read By: Bot on startup
  • Manual Edit: Not recommended (bot manages this)
  • Backup: Optional (for recovery)

.miteddy.lock

  • Created By: Bot on startup
  • Removed By: Bot on exit (or manually if stale)
  • Purpose: Single-instance enforcement
  • Manual Edit: Not recommended

Analysis Files

mint-insights.json

  • Created By: npm run analyze:mints:known
  • Updated By: Re-run analysis script
  • Read By: Gas policy analysis, research
  • Manual Edit: Can add transaction hashes to analyze
  • Location: Root directory

Analysis Output Files

  • Created By: Various analysis scripts
  • Updated By: Scripts
  • Read By: Manual review, other scripts
  • Manual Edit: Not recommended
  • Location: data/ directory

📖 Related Documentation

Primary Indexes

Cross-Reference & Timeline

Related Guides

🎯 Data File Maintenance

Regular Cleanup

  • Temporary Files: data/temp-*.json, data/time-samples-temp.json can be deleted
  • Old Logs: Archive or delete old log files periodically
  • State Files: .miteddy-state.json and .miteddy.lock are auto-managed

Backup Recommendations

  • State File: Backup .miteddy-state.json before major changes
  • Analysis Data: Keep mint-insights.json for historical reference
  • Logs: Archive important log files before deletion

🔒 Gitignore Status

Should Be Gitignored

  • .miteddy-state.json - Contains sensitive state
  • .miteddy.lock - Runtime lock file
  • logs/ - All log files
  • data/ - Analysis data (temporary)
  • mint-insights.json - May contain transaction data

Should Be Tracked

  • Configuration examples (.env.example.*)
  • Documentation files
  • Scripts

⭐ = Most important / Frequently used