pumpkit docs
nirholas / pumpkit

pumpkit

Open-source framework for building PumpFun Telegram bots on Solana

v0.1.0SEE LICENSE IN LICENSE
npm install

What it does

Capabilities documented in this repository.

Read this first no jargon

See the full documentation for details.

What is PumpKit

See the full documentation for details.

Why PumpKit

See the full documentation for details.

Who is this for

See the full documentation for details.

Architecture

See the full documentation for details.

Use a pre-built bot

See the full documentation for details.

Get started

Install it, then run your first command.

npm install
CommandRuns
npm run buildturbo build
npm run devturbo dev
npm run lintturbo lint
npm run testturbo test
npm run typecheckturbo typecheck

Read the full getting started guide

Examples

Taken directly from this repository's documentation.

┌───────────────────────────────────────────────────┐
│                  @pumpkit/core                    │
│                                                   │
│  bot/       grammy scaffolding, command router    │
│  monitor/   WebSocket + HTTP event monitors       │
│  solana/    RPC client, program IDs, decoders     │
│  formatter/ HTML message builder (Telegram)       │
│  storage/   File-based + SQLite adapters          │
│  config/    Typed env loader with validation      │
│  health/    HTTP health check server              │
│  logger/    Leveled console logger                │
│  api/       REST + SSE + webhook server           │
│  social/    Twitter/X + GitHub integrations       │
│  types/     Shared event & program types          │
└──────────┬────────────────────────┬───────────────┘
           │                        │
    ┌──────▼───────┐          ┌──────▼───────┐
    │  @pumpkit/   │          │  @pumpkit/   │
    │   monitor    │          │   tracker    │
    │              │          │              │
    │ DM commands  │          │ Group calls  │
    │ Channel feed │          │ Leaderboards │
    │ REST API     │          │ PNL cards    │
    │ Webhooks     │          │ Rankings     │
    │ SSE stream   │          │ Multi-chain  │
    └──────────────┘          └──────────────┘
pumpkit/
├── packages/
│   ├── core/              @pumpkit/core — shared framework
│   ├── monitor/           @pumpkit/monitor — monitoring bot
│   ├── channel/           @pumpkit/channel — read-only channel feed
│   ├── claim/             @pumpkit/claim — fee claim tracker
│   ├── tracker/           @pumpkit/tracker — group tracker bot
│   └── web/               @pumpkit/web — dashboard (skeleton)
├── docs/                  documentation (everything in this README is also here)
├── tutorials/             numbered, hands-on guides (45+)
├── examples/              starter dashboards & templates
├── agent-prompts/         multi-step refactor prompts
├── prompts/               one-shot workflow prompts
├── security/              audits, checklists
├── tools/                 shell + ts utilities
├── tmp/                   ephemeral scratch
└── turbo.json             monorepo build pipeline
@pumpkit/monitor ──→ @pumpkit/core
@pumpkit/tracker ──→ @pumpkit/core
@pumpkit/channel ──→ @pumpkit/core
@pumpkit/claim   ──→ @pumpkit/core

More examples

Reference