Skip to content

QUICK_INDEX.md

Latest commit

 

History

History
231 lines (161 loc) · 6.26 KB

QUICK_INDEX.md

File metadata and controls

231 lines (161 loc) · 6.26 KB

Quick Commands Index - MiTeddy Bot

Last Updated: 2025-11-15

Complete quick reference for all available commands and quick navigation links.

🗺️ Master Navigation

👉 Index of Indexes ⭐ - START HERE - Master navigation hub for all documentation

Single entry point to navigate all 200+ documents. Use this to find any documentation quickly.

🚀 Quick Commands

Essential Commands

# Start the bot
npm start

# Start with auto-restart (production)
npm run start:keep-alive

# Dry run (test without sending transactions)
npm start -- --dry-run

# Build TypeScript
npm run build

# Query wallet balance
npm run query-balance

Configuration & Setup

# Find your token IDs
npm run find-tokens

# Calculate unlock time from timer
npm run calc-unlock "HH:MM:SS"

# Verify contracts and configuration
npm run verify-contracts

# Test RPC endpoints
npm run test-rpcs

Analysis & Debugging

# Analyze successful mints
npm run analyze:mints:known

# Latency probe
npm run latency-probe

# Audit units
npm run audit:units

# Post-mortem analysis
npm run post-mortem

Testing

# Post-integration test
npm run test:post-integration

# Smoke test
npm run test:smoke

# Critical scenarios
npm run test:critical

# All test scenarios
npm run test:all

📚 Documentation Quick Links

Getting Started

Configuration

Understanding the Bot

Status & Readiness

Master Navigation ⭐

  • docs/INDEX_OF_INDEXES.md ⭐⭐ - MASTER INDEX - Single entry point for all 200+ documents
    • Indexes all other indexes (Guides, Audits, Analysis, Research, etc.)
    • Complete navigation hub with multiple discovery methods
    • Use this first to find any documentation
  • docs/DOCUMENTATION_INDEX.md - Complete documentation index

📁 Key Directories

Source Code

  • src/ - Main bot code
    • src/index.ts - Main entry point
    • src/config.ts - Configuration
    • src/lockfile.ts - Lock file management
    • src/nonceStore.ts - Nonce state management

Scripts

  • scripts/ - Utility scripts
    • scripts/query-balance.ts - Balance query
    • scripts/verify-contracts.ts - Contract verification
    • scripts/latency-probe.ts - RPC latency testing

Documentation

  • docs/ - All documentation
    • docs/guides/ - User guides (27 guides)
    • docs/audits/ - Audit reports (105+ audits)
    • docs/analysis/ - Analysis reports (86+ reports)

Configuration

  • .env - Active configuration (gitignored)
  • .env.example - Configuration template
  • env.example.battering-ram - Battering Ram mode template

🎯 Common Tasks

Check Bot Status

npm run query-balance
npm run test-rpcs

Before Mint Window

# 1. Verify configuration
npm run verify-contracts

# 2. Check balance
npm run query-balance

# 3. Test RPCs
npm run test-rpcs

# 4. Dry run
npm start -- --dry-run

# 5. Start bot
npm run start:keep-alive

Troubleshooting

📊 Current Status (2025-11-14)

Bot Readiness: ✅ READY

  • All critical fixes applied
  • Nonce management fixed
  • Gas bump logic verified
  • Lock file race condition fixed
  • State file race condition fixed

Balance: ✅ 21.37 BERA (Sufficient for Nuclear Mode)

Configuration: ⏳ Verify .env file

🔗 Quick Links

📖 Related Documentation

Master Navigation

Primary Indexes

Cross-Reference & Timeline

File-Specific Indexes

For complete documentation navigation, see: docs/INDEX_OF_INDEXES.md ⭐