Skip to content

Getting Started

Prerequisites

  • Node.js >= 20.0.0
  • pnpm >= 9.0.0
  • A Solana RPC endpoint (Helius, QuickNode, or public RPC)
  • A Jupiter API key (optional, for higher rate limits)

Installation

bash
# Clone the repository
git clone https://github.com/natebag/Trenchtools.git
cd Trenchtools

# Install dependencies
pnpm install

# Start the UI dev server
pnpm start

The dashboard will open at http://localhost:5173.

First-Time Setup

1. Configure Your RPC

Navigate to Settings (gear icon in sidebar) and enter your Solana RPC URL. The default public RPC works but has rate limits. For production use, get a dedicated endpoint from:

2. Set Your Network

Click the network badge in the header to toggle between Devnet and Mainnet.

WARNING

Start on Devnet to test all features with free SOL before using real funds on Mainnet.

3. Create Your Wallet Vault

Navigate to Wallets and create a new vault password. This password encrypts all your private keys in the browser using Web Crypto API + Argon2.

DANGER

If you lose your vault password, your keys are unrecoverable. Back up your wallets using the export feature.

4. Generate Wallets

In the Wallets page:

  1. Click Add Sub-Wallet
  2. Choose a wallet type: Treasury, Sniper, or Burner
  3. Name your wallet
  4. Click Generate

You'll need at least:

  • 1 Treasury wallet (holds your main SOL)
  • 1+ Sniper wallets (for sniping tokens)

5. Fund Your Treasury

Send SOL to your treasury wallet address from any external wallet (Phantom, Solflare, etc.). On devnet, use the Solana Faucet.

Quick Test: Snipe a Token

  1. Go to the Sniper tab
  2. Paste a token CA (contract address)
  3. Set your buy amount in SOL
  4. Configure slippage (default 10% is fine for most tokens)
  5. Click Snipe

TrenchTools will auto-detect whether the token is on PumpFun or Jupiter and route the trade accordingly.

Build for Production

bash
# Build all packages
pnpm build

# Or build just the UI
npx turbo run build --filter=@trenchtools/ui --force

The production build outputs to packages/ui/dist/ — a static site you can host anywhere.

Project Structure

TrenchTools-OS/
├── packages/
│   ├── core/          # TypeScript library (wallet, trading, P&L, shield)
│   ├── ui/            # React dashboard (the main app)
│   ├── docs/          # This documentation site
│   ├── landing/       # Landing page (trenchtools.io)
│   ├── bot/           # Bot package
│   ├── bot-telegram/  # Telegram bot integration
│   ├── cli/           # CLI tool
│   └── snipe/         # Standalone sniper package
├── package.json       # Workspace root
├── pnpm-workspace.yaml
└── turbo.json

Released under the MIT License.