Skip to content

GUIDES_INDEX.md

Latest commit

 

History

History
321 lines (238 loc) · 9.08 KB

GUIDES_INDEX.md

File metadata and controls

321 lines (238 loc) · 9.08 KB

Guides Index

Last Updated: 2025-11-15

Complete index of all user guides, organized by category and purpose.

📋 Quick Reference

Most Used Guides

📚 Guides by Category

🚀 Getting Started

Quick Start Guides

  • Quick Start Now ⭐ - Get running in 5 minutes

    • Fastest path to running the bot
    • Essential configuration only
    • Quick verification steps

  • Quick Reference - Quick command and configuration reference

    • Common commands
    • Key configuration values
    • Quick troubleshooting

First-Time Setup

  • Getting Started Guide - Complete first-time setup

    • Full installation process
    • Detailed configuration
    • Verification steps

  • GitHub Setup - GitHub repository setup

    • Repository configuration
    • Branch management
    • Collaboration setup

⚙️ Configuration & Setup

Timing Configuration

  • Timing Guide ⭐ - Timing setup and optimization

    • Timing configuration
    • Window detection setup
    • Pre-warming timing

  • Early Start Guide - Starting the bot early

    • Early start configuration
    • Pre-warming setup
    • Timing adjustments

  • Exact Timing Setup - Precise timing configuration

    • Exact timing requirements
    • Precision setup
    • Timing verification

  • Get Timer - Timer utility guide

    • Timer functions
    • Timing calculations
    • Timer usage

  • Mint Schedule - Mint schedule configuration

    • Schedule setup
    • Recurring mints
    • Schedule management

Gas Configuration

  • Gas Limit Persistence - How gas limit hints work

    • Gas limit hint system
    • Persistence mechanism
    • Cost optimization

  • Gas Limit Defaults - Default values and selection logic

    • Default gas limits
    • Selection logic
    • Configuration options

  • Debugging 500k Gas Limit - Why 500k appears instead of 260k

    • Gas limit debugging
    • Common issues
    • Resolution steps

RPC Configuration

  • Private Transaction Setup - Private transaction configuration

    • Private RPC setup
    • Private mempool configuration
    • Private transaction usage

  • Private Option Quick Decision - Quick decision guide for private transactions

    • When to use private transactions
    • Cost/benefit analysis
    • Quick setup

🏃 Running the Bot

Runbooks

  • Runbook ⭐ - Quick start, monitoring, troubleshooting

    • Pre-run verification
    • Running the bot
    • Monitoring and troubleshooting
    • Common issues

  • Maximum Aggression Runbook - Extreme competition setup

    • Maximum aggression configuration
    • Extreme competition strategies
    • High-performance setup

  • Ultraspeed Runbook - Maximum speed configuration

    • Speed optimization
    • Latency reduction
    • Performance tuning

🔧 Troubleshooting

Issue-Specific Troubleshooting

  • Troubleshooting Balance Issues - Insufficient funds, nuclear budget verification

    • Balance checking
    • Nuclear budget issues
    • Balance cache problems
    • Resolution steps

  • Troubleshooting RPC Filtering - RPC filter errors, pre-warm configuration

    • RPC filtering issues
    • Pre-warm RPC configuration
    • Fallback behavior
    • Resolution steps

Debugging Guides

🧪 Testing & Verification

Testing Guides

  • Testing Guide - How to test the bot

    • Testing procedures
    • Test scenarios
    • Verification steps

  • How to Test - Testing procedures

    • Step-by-step testing
    • Test cases
    • Expected results

  • Quick Test - Quick testing procedures

    • Fast testing
    • Essential tests only
    • Quick verification

Integration

  • Integration Guide - Integration testing
    • Integration setup
    • Integration testing
    • Verification

On-Chain Analysis

  • Onchain Analysis Guide - On-chain transaction analysis
    • Transaction analysis
    • On-chain verification
    • Analysis tools

📊 Optimization & Performance

Optimization Guides

  • Optimization Guide - Performance optimization
    • Optimization strategies
    • Performance tuning
    • Best practices

📖 Reference Guides

System Reference

  • File System Usage - File operations and module structure

    • File system layout
    • File operations
    • Module structure

  • Node.js Requirements - Node.js version requirements

    • Version requirements
    • Upgrade guide
    • Compatibility

Development Tools

🎯 Guides by Use Case

I Want to...

Get Started Quickly

  1. Quick Start Now ⭐
  2. Quick Reference
  3. Runbook ⭐

Configure the Bot

  1. Configuration Guide
  2. Timing Guide ⭐
  3. Gas Limit Persistence
  4. Private Transaction Setup

Run in Production

  1. Runbook ⭐
  2. Maximum Aggression Runbook
  3. Ultraspeed Runbook

Troubleshoot Issues

  1. Runbook - Troubleshooting Section
  2. Troubleshooting Balance Issues
  3. Troubleshooting RPC Filtering
  4. Debugging 500k Gas Limit

Test the Bot

  1. Testing Guide
  2. How to Test
  3. Quick Test
  4. Integration Guide

Optimize Performance

  1. Optimization Guide
  2. Ultraspeed Runbook
  3. Maximum Aggression Runbook

Understand the System

  1. File System Usage
  2. Node.js Requirements
  3. Gas Limit Defaults

📖 Related Documentation

Primary Indexes

Cross-Reference & Timeline

Core Documentation

🔍 Finding Specific Guides

By Topic

Timing

  • Timing Guide
  • Early Start Guide
  • Exact Timing Setup
  • Get Timer
  • Mint Schedule

Gas

  • Gas Limit Persistence
  • Gas Limit Defaults
  • Debugging 500k Gas Limit

RPC

  • Private Transaction Setup
  • Private Option Quick Decision
  • Troubleshooting RPC Filtering

Testing

  • Testing Guide
  • How to Test
  • Quick Test
  • Integration Guide
  • Onchain Analysis Guide

Performance

  • Optimization Guide
  • Maximum Aggression Runbook
  • Ultraspeed Runbook

Total Guide Files: 27

⭐ = Highly recommended / Most used