# Introduction

## 📚 deployr Documentation

Welcome to the complete documentation for this repository. This documentation is automatically generated and maintained by Woden Docbot.

![Health: Healthy](https://img.shields.io/badge/Health-Healthy-green) ![Files Documented: 0](https://img.shields.io/badge/Files_Documented-0-blue) ![Coverage: 100](https://img.shields.io/badge/Coverage-100-green) ![Last Updated: 2026-05-11](https://img.shields.io/badge/Last_Updated-2026--05--11-gray)

### 🔗 Quick Links

[📋 Dependencies](https://github.com/Genvv77/deployr/blob/main/_docs/DEPENDENCIES.md)

***

### 📑 Documentation Sections

No documentation sections available yet.

***

### 📊 Documentation Statistics

* **Files Documented**: 0
* **Directories**: 0
* **Coverage**: 100%
* **Last Updated**: 2026-05-11

***

### 🧭 How to Navigate

> ℹ️ **INFO** Each directory has its own README.md with detailed information about that section. Use the breadcrumb navigation at the top of each page to navigate back to parent directories.

#### Navigation Features

* **Breadcrumbs** - At the top of each page, showing your current location
* **Directory READMEs** - Each folder has a comprehensive overview
* **File Documentation** - Click through to individual file documentation
* **Search** - Use GitHub's search or your IDE's search functionality

***

### 🤖 About Woden DocBot

This documentation is automatically generated and kept up-to-date by Woden DocBot, an AI-powered documentation assistant. DocBot analyzes code on every pull request and updates documentation to reflect changes.

#### Features

* **Automatic Updates** - Documentation updates on every PR
* **Comprehensive Coverage** - Files, functions, classes, and directories
* **Smart Navigation** - Breadcrumbs, related files, and parent links
* **AI-Powered** - Uses Azure GPT models for intelligent documentation generation

***

*Generated by Woden DocBot for deployr*

## Introduction

Welcome to the complete documentation for Deployr

### Quick Links

[📂 Api](/deployr/api.md), [AI processing](/deployr/launchpad.js.md), [AI Core Brain](/deployr/pipeline.js.md), [API](/deployr/api.md), [Atomic Skills & Ideas for AI Agents](/deployr/atomic-skills-and-ideas-for-ai-agents.md)

***

### Overview

Deployr is a Twitter-native token launchpad that lets users launch meme tokens on Solana and EVM chains by mentioning the bot in a tweet. It listens for Twitter mentions, parses launch intent using an LLM, generates token artwork, and executes a full on-chain launch through the Printr MCP protocol — all within a single automated pipeline.

The system is designed around financial safety: a single treasury wallet per chain funds ephemeral deployment wallets for each launch, which are drained back immediately after the token is live. Creator fees accumulate on-chain and are swept automatically on a configurable schedule, with revenue split between Deployr's treasury and the original requester.

A modular Partner API layer extends Deployr beyond Twitter, enabling external platforms and AI agents to submit structured token launches programmatically via a prepaid, API-key gated HTTP service backed by the same pipeline and treasury infrastructure.

#### Architecture

Deployr runs as two independent services sharing a single Redis instance:

```mermaid
flowchart TD
    TW[Twitter Mentions] --> BOT

    subgraph BOT[Bot Process]
        PARSE[Intent Parsing\nGroq / Llama 3]
        IMAGE[Image Generation\nOpenRouter]
        EXEC[MCP Execution\nPrintr Protocol]
        PARSE --> IMAGE --> EXEC
    end

    subgraph API[API Process]
        FEED[GET /v1/tokens\nGET /v1/terminal-feed]
        LAUNCH[POST /v1/launches]
        PARTNER[GET /v1/partners/me]
    end

    PARTNERS[Partner Platforms\nAI Agents] --> API
    LAUNCH --> EXEC
    EXEC --> REDIS[(Redis)]
    FEED --> REDIS

```

All MCP execution is serialized through a single in-process promise queue, ensuring no parallel treasury operations can cause double-spend or keystore conflicts.

#### Use Cases <a href="#user-content--use-cases" id="user-content--use-cases"></a>

* **Twitter launchpad** — Users mention `@DeployrBot launch $TOKEN on Solana` and get a live token within minutes
* **Managed supply launches** — Users pre-pay to buy a % of their own token supply at launch via managed vault wallets
* **Partner API launches** — External platforms and AI agents submit structured launch requests programmatically with prepaid balances
* **Terminal token feed** — Data consumers call `GET /v1/terminal-feed` to get a live feed of Deployr-born tokens with full provenance metadata

***

#### Tools <a href="#user-content--technologies" id="user-content--technologies"></a>

| Layer              | Technology                 |
| ------------------ | -------------------------- |
| Runtime            | Node.js (ESM, v20+)        |
| HTTP API           | Hono + `@hono/node-server` |
| Intent parsing     | Groq SDK (Llama 3)         |
| Image generation   | OpenRouter                 |
| On-chain execution | Printr MCP v0.14.0         |
| State & caching    | Redis (ioredis)            |
| Twitter            | twitter-api-v2             |
| EVM                | ethers.js                  |
| Solana             | `@solana/web3.js`, bs58    |
| Deployment         | Railway                    |

***

#### Supported Chains <a href="#user-content--supported-chains" id="user-content--supported-chains"></a>

| Chain            | Type |
| ---------------- | ---- |
| Solana           | SVM  |
| Monad            | EVM  |
| Mantle           | EVM  |
| Base             | EVM  |
| BNB Chain        | EVM  |
| Avalanche (AVAX) | EVM  |
| Ethereum         | EVM  |

***

#### Revenue Model <a href="#user-content--revenue-model" id="user-content--revenue-model"></a>

Deployr earns on two streams:

**Creator fees** — Every launched token generates bonding curve fees (1.2%) and AMM fees (0.75%) that accumulate on-chain and are swept to treasury automatically.

* Twitter-launched tokens: **50% to treasury, 50% reserved for the creator**
* API-launched tokens: **100% to treasury** (no external owner)

To claim your creator fees as a token launcher, mention `@DeployrBot` on Twitter and say *"claim fees"*. Deployr will ask for a wallet address — reply with a valid address and the payout is processed automatically.

**Partner API cost pass-through** — Partners pre-fund a prepaid balance. Each launch deducts only the actual on-chain cost (\~0.0225 SOL on Solana). No service fee markup — creator fee accumulation across all partner-launched tokens is the business model.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://printr-deployr.gitbook.io/deployr/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
