Skip to content

CONFIGURATION_FILES_INDEX.md

Latest commit

 

History

History
185 lines (137 loc) · 5.72 KB

CONFIGURATION_FILES_INDEX.md

File metadata and controls

185 lines (137 loc) · 5.72 KB

Configuration Files Index

Last Updated: 2025-11-15

Complete index of all configuration files, templates, and environment setups.

📋 Quick Reference

Most Important Config Files

⚙️ Configuration Files by Type

Environment Files

Active Configuration

  • .env ⭐ - Active environment configuration
    • Purpose: Current bot configuration
    • Format: Key-value pairs
    • Gitignored: Yes (contains sensitive data)
    • When to Use: Bot reads this automatically
    • ⚠️ Security: Contains PRIVATE_KEY - never commit

Configuration Templates

  • .env.example ⭐ - Standard configuration template

    • Purpose: Template for new setups
    • Format: Key-value pairs with defaults
    • Gitignored: No (should be tracked)
    • When to Use: First-time setup, reference

  • env.example.battering-ram - Battering Ram mode template

    • Purpose: Maximum aggression configuration template
    • Format: Key-value pairs
    • Gitignored: No (should be tracked)
    • When to Use: Extreme competition setup

  • env.production.complete - Complete production template

    • Purpose: Full production configuration with all options
    • Format: Key-value pairs with comments
    • Gitignored: No (should be tracked)
    • When to Use: Production setup reference

  • env.txt - Text format configuration

    • Purpose: Alternative format configuration
    • Format: Text/Key-value pairs
    • Gitignored: Check .gitignore
    • When to Use: Alternative configuration format

Build Configuration

TypeScript Configuration

  • tsconfig.json - TypeScript compiler configuration
    • Purpose: TypeScript compilation settings
    • Format: JSON
    • Gitignored: No (should be tracked)
    • When to Use: Build system automatically uses this

Package Configuration

  • package.json - Node.js package configuration

    • Purpose: Dependencies, scripts, project metadata
    • Format: JSON
    • Gitignored: No (should be tracked)
    • When to Use: npm install, npm run <script>

  • package-lock.json - Dependency lock file

    • Purpose: Lock exact dependency versions
    • Format: JSON
    • Gitignored: No (should be tracked)
    • When to Use: npm install uses this automatically

Process Management

PM2 Configuration

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

Keep-Alive Script

  • keep-alive.ts - Watchdog script
    • Purpose: Auto-restart bot on crashes
    • Format: TypeScript
    • Gitignored: No (should be tracked)
    • Usage: npm run start:keep-alive
    • When to Use: Production runs

🔧 Configuration Setup

First-Time Setup

  1. Copy template: cp .env.example .env
  2. Edit .env with your values:
    • PRIVATE_KEY - Your hot wallet private key
    • TEDDY_ID - Steady Teddy token ID
    • MIBERA_ID - Mibera token ID
    • RPCS_HTTP - HTTP RPC URLs
    • RPCS_WS - WebSocket RPC URLs
  3. Verify: npm run verify-contracts

Battering Ram Mode Setup

  1. Copy template: cp env.example.battering-ram .env
  2. Edit .env with your values
  3. Verify: npm run verify-contracts

Production Setup

  1. Copy template: cp env.production.complete .env
  2. Edit .env with production values
  3. Verify: npm run verify-contracts
  4. Use keep-alive: npm run start:keep-alive

📖 Related Documentation

Primary Indexes

Cross-Reference & Timeline

Configuration Guides

🔒 Security Notes

Never Commit

  • .env - Contains PRIVATE_KEY
  • Any file with private keys or sensitive data

Safe to Commit

  • .env.example - Template only
  • env.example.battering-ram - Template only
  • env.production.complete - Template only
  • tsconfig.json - Build configuration
  • package.json - Public dependencies

🎯 Configuration File Usage

Development

  • Use .env.example as base
  • Create .env for local development
  • Never commit .env

Production

  • Use env.production.complete as reference
  • Create .env with production values
  • Use keep-alive.ts for auto-restart

Battering Ram Mode

  • Use env.example.battering-ram as base
  • Maximum aggression configuration
  • All gas settings at maximum

⭐ = Most important / Frequently used