Skip to content

SCRIPTS_INDEX.md

Latest commit

 

History

History
202 lines (149 loc) · 6.54 KB

SCRIPTS_INDEX.md

File metadata and controls

202 lines (149 loc) · 6.54 KB

Scripts Index

Complete index of all utility scripts and their purposes.

Last Updated: 2025-11-13

📋 Quick Reference

Most Used Scripts

🔧 Scripts by Category

RPC Testing & Analysis

Latency Testing

  • latency-probe.ts ⭐ - Test RPC latency and health
    • Purpose: Measure RPC response times and identify fastest RPCs
    • Usage: npm run latency-probe
    • Output: Latency metrics for all configured RPCs
    • When to Use: Before mint windows, when troubleshooting RPC issues

RPC Health

  • test-rpc-latency.ts - Test RPC latency (legacy)
    • Purpose: Basic RPC latency testing
    • Note: Consider using latency-probe.ts instead

Contract & Mint Analysis

Mint Analysis

  • analyze-known-mints.ts ⭐ - Analyze successful mint transactions
    • Purpose: Fetch and analyze gas/timing data for successful mints
    • Usage: npm run analyze:mints:known
    • Output: mint-insights.json with detailed transaction analysis
    • When to Use: Research gas strategies, verify winning transactions

Contract Verification

  • verify-contracts.ts ⭐ - Verify contract addresses and nonce
    • Purpose: Verify contract addresses, check nonce, validate configuration
    • Usage: npm run verify-contracts
    • Output: Contract verification and nonce status
    • When to Use: Before mint windows, when troubleshooting nonce issues

Gas Analysis

  • gas-insights.ts - Gas insights analysis
    • Purpose: Analyze gas usage patterns
    • Usage: npm run gas-insights (if available)
    • When to Use: Gas strategy research

Audit & Verification

Unit Auditing

  • audit-units.ts - Audit time unit bugs
    • Purpose: Check for milliseconds vs seconds bugs across codebase
    • Usage: npm run audit:units
    • Output: List of potential time unit issues
    • When to Use: After code changes, before releases

Documentation Checking

  • check-ascii-docs.ts - Check ASCII documentation
    • Purpose: Verify documentation encoding
    • Usage: npm run check-ascii-docs (if available)
    • When to Use: Documentation maintenance

Analysis & Parsing

Log Parsing

  • parse-balance-warnings.ts - Parse balance warnings from logs
    • Purpose: Extract and analyze balance warnings from log files
    • Usage: npm run parse-balance-warnings (if available)
    • When to Use: Post-mortem analysis, balance troubleshooting

Testing

  • test-alchemy-fee-cap.ts - Test Alchemy fee cap
    • Purpose: Test Alchemy RPC fee cap behavior
    • Usage: npm run test-alchemy-fee-cap (if available)
    • When to Use: RPC provider testing

📊 Scripts by Purpose

Pre-Mint Verification

  1. verify-contracts.ts - Verify contracts and nonce
  2. latency-probe.ts - Test RPC health

Post-Mint Analysis

  1. analyze-known-mints.ts - Analyze successful mints
  2. parse-balance-warnings.ts - Parse balance issues

Code Quality

  1. audit-units.ts - Check for time unit bugs
  2. check-ascii-docs.ts - Verify documentation

RPC Testing

  1. latency-probe.ts - RPC latency testing
  2. test-alchemy-fee-cap.ts - Provider-specific testing

🎯 Script Usage Guide

Before a Mint Window

# 1. Verify contracts and nonce
npm run verify-contracts

# 2. Test RPC latency
npm run latency-probe

# 3. Audit for time unit bugs
npm run audit:units

After a Mint Window

# 1. Analyze successful mints
npm run analyze:mints:known

# 2. Parse balance warnings (if any)
npm run parse-balance-warnings

During Development

# Check for time unit bugs
npm run audit:units

# Verify documentation
npm run check-ascii-docs

📖 Related Documentation

Primary Indexes

Cross-Reference & Timeline

Related Guides

🔍 Script Details

latency-probe.ts

  • Location: scripts/latency-probe.ts
  • Command: npm run latency-probe
  • Purpose: Measure RPC latency and identify fastest RPCs
  • Output: Console output with latency metrics
  • Dependencies: RPC configuration from .env

verify-contracts.ts

  • Location: scripts/verify-contracts.ts
  • Command: npm run verify-contracts
  • Purpose: Verify contract addresses, check nonce, validate configuration
  • Output: Contract verification status, nonce comparison
  • Dependencies: RPC configuration, contract addresses

analyze-known-mints.ts

  • Location: scripts/analyze-known-mints.ts
  • Command: npm run analyze:mints:known
  • Purpose: Analyze successful mint transactions
  • Output: mint-insights.json with transaction analysis
  • Dependencies: RPC configuration, transaction hashes

audit-units.ts

  • Location: scripts/audit-units.ts
  • Command: npm run audit:units
  • Purpose: Check for milliseconds vs seconds bugs
  • Output: List of potential time unit issues
  • Dependencies: TypeScript source files

Last Updated: 2025-11-13
Total Scripts: 8

⭐ = Most used / Recommended