Quick Start

TL;DR

# Clone, install, configure, run
git clone https://github.com/yourusername/wallet-protect.git
cd wallet-protect
pnpm install
cp .env.example .env

# Edit .env with your configuration
pnpm prisma:generate
pnpm prisma:migrate:dev
pnpm backfill  # IMPORTANT: Run before first start
pnpm dev

Step-by-Step Guide

1

Clone the Repository

git clone https://github.com/yourusername/wallet-protect.git
cd wallet-protect
2

Install Dependencies

pnpm install

Don't have pnpm? Install it with npm install -g pnpm

3

Configure Environment

cp .env.example .env

Edit .env with your settings:

# Required settings
DATABASE_URL="postgresql://postgres:password@localhost:5432/wallet_protect"
TARGET_HANDLE="your_twitter_handle"
DEPLOYER_PRIVATE_KEY="[1,2,3,...]"
X_SCRAPER_COOKIES="auth_token=xxx; ct0=yyy"
TOKEN_DESCRIPTION="Protected by Wallet Protect 🛡️"
LOGO_PATH="assets/logo.png"
LOG_LEVEL="info"
4

Setup Database

# Generate Prisma client
pnpm prisma:generate

# Run migrations
pnpm prisma:migrate:dev
5

Backfill Existing Followers

CRITICAL: Run this before starting the engine to prevent launching tokens for all existing followers!

pnpm backfill

This marks all current followers as "skipped" so only NEW followers trigger launches.

6

Start the Engine

pnpm dev

You should see:

═══════════════════════════════════════════════════════════════════
🛡️ WALLET PROTECT - Token Launch Engine
═══════════════════════════════════════════════════════════════════
✅ Database connection established
🌐 Server online at http://0.0.0.0:3000
🔥 Engine running - watching for followers
   Target: @your_twitter_handle
   Poll Interval: 60000ms
═══════════════════════════════════════════════════════════════════
🛡️ WALLET PROTECT ONLINE
═══════════════════════════════════════════════════════════════════
7

Verify It's Working

curl http://localhost:3000/health

Expected response:

{
  "status": "operational",
  "engine": "wallet-protect",
  "version": "1.0.0",
  "timestamp": "2024-01-15T12:00:00.000Z",
  "checks": {
    "database": "healthy",
    "engine": "running"
  }
}

What Happens Next?

Once running, Wallet Protect will:

  1. Poll your X account every 60 seconds (configurable)

  2. Detect any new followers

  3. Generate unique token metadata

  4. Upload metadata to IPFS

  5. Deploy the token on pump.fun

  6. Record everything in the database

Check the status:

Docker Quick Start

Prefer Docker? Even faster:

Next Steps

📋 Full Configuration

Learn about all available configuration options

🔐 Authentication Deep Dive

Understand X authentication methods

🐳 Production Deployment

Deploy to production with best practices

🎨 Custom Branding

Customize token names, symbols, and logos

PreviousFeaturesNextChangelog