https://github.com/dfnwtf/latrinebot
Public Latrine Bot monorepo: docs, SDK, widgets, calculator, CLI. Cloud automation engine for Pump.fun tokens.
https://github.com/dfnwtf/latrinebot
airdrop creator-fees holders latrine-bot openapi pump-fun pumpfun sdk solana typescript web3
Last synced: 17 days ago
JSON representation
Public Latrine Bot monorepo: docs, SDK, widgets, calculator, CLI. Cloud automation engine for Pump.fun tokens.
- Host: GitHub
- URL: https://github.com/dfnwtf/latrinebot
- Owner: dfnwtf
- License: other
- Created: 2026-05-28T04:59:26.000Z (21 days ago)
- Default Branch: main
- Last Pushed: 2026-05-28T06:11:24.000Z (21 days ago)
- Last Synced: 2026-05-28T07:08:47.799Z (21 days ago)
- Topics: airdrop, creator-fees, holders, latrine-bot, openapi, pump-fun, pumpfun, sdk, solana, typescript, web3
- Language: TypeScript
- Homepage: https://latrinebot.com
- Size: 80.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Latrine Bot
Cloud automation engine for Pump.fun tokens. Claim creator fees, buy back, optionally burn supply, and airdrop to eligible holders by tier rules. No CLI, no local node, no scripts to maintain.
[](https://latrinebot.com)
[](https://latrinebot.com/app)
[](https://api.latrinebot.com/api/health)
[](./LICENSE)
[](./LICENSE-DOCS)
This is the public side of Latrine Bot. The engine, the runner, and the operator panel are not in this repository - see [`SECURITY.md`](./SECURITY.md) for what is and is not public.
## What is in here
| Folder | What | Package |
|---|---|---|
| [`docs/`](./docs) | Public product documentation (mirrors [latrinebot.com/docs](https://latrinebot.com/docs)) | - |
| [`sdk/`](./sdk) | TypeScript client + OpenAPI 3.1 spec | [`@latrinebot/sdk`](https://www.npmjs.com/package/@latrinebot/sdk) |
| [`widgets/`](./widgets) | Embeddable live widgets (iframe, script tag, programmatic) | [`@latrinebot/widgets`](https://www.npmjs.com/package/@latrinebot/widgets) |
| [`calculator/`](./calculator) | Standalone eligibility calculator | hosted at [latrinebot.com/calculator/](https://latrinebot.com/calculator/) |
| [`cli/`](./cli) | Tiny CLI over the public API | [`@latrinebot/cli`](https://www.npmjs.com/package/@latrinebot/cli) |
## What the service does
1. **Claim** creator fees from your Pump.fun (or PumpSwap) token.
2. Reserve enough SOL for the next airdrop, then **acquire the reward** with the rest: buy back your token, swap to USDC / any SPL token via Jupiter, or keep plain SOL.
3. After buyback, **split the pool**: optionally **burn** a configured share (reduces supply) and **airdrop** the rest to eligible holders by balance share (per pool split settings).
4. **Wait** and repeat.
Eligibility is a **tiered floor** that gets easier as market cap grows, plus an **anti-whale cap**, plus a **hold-cycles** anti-sybil filter. Holders always qualify on the project token; the distributed asset is configurable (project token, SOL, USDC, or any SPL mint). Details in [`docs/eligibility.md`](./docs/eligibility.md) and [`docs/configuration.md`](./docs/configuration.md#reward-asset-what-holders-receive).
## Start using it
- Dashboard: [latrinebot.com/app](https://latrinebot.com/app)
- 5-minute walkthrough: [`docs/getting-started.md`](./docs/getting-started.md)
- Developer quick start (SDK, widgets, CLI): [`docs/developers.md`](./docs/developers.md)
- Settings reference: [`docs/configuration.md`](./docs/configuration.md)
- API reference: [`docs/api-reference.md`](./docs/api-reference.md)
## Build on top
```ts
import { LatrineClient } from "@latrinebot/sdk";
const client = new LatrineClient({
metricsKey: process.env.LATRINE_METRICS_KEY,
});
const snap = await client.metrics.get("YOUR_PROJECT_ID");
console.log(snap.stats.totalClaimedSol, "SOL claimed total");
```
Or drop a live widget on your token page:
```html
```
Or run preflight from a CI job:
```bash
npx @latrinebot/cli preflight YOUR_PROJECT_ID
```
## What is not here
These stay private by design:
- The on-chain engine: claim, buyback, burn, snapshot, distribute, hold-history, retry / fee strategy
- The runner that signs and sends mainnet transactions
- The operator panel and its admin endpoints
- Anti-MEV / RPC strategy code
- Any wallet allowlists, treasury keys, or platform-side secrets
The public surface in this repo is enough to integrate, audit the API, and understand the eligibility math. See [`SECURITY.md`](./SECURITY.md).
## Versioning
Pre-1.0, minor bumps (`0.X`) can add endpoints or settings. Breaking changes inside `0.X` are listed in [`CHANGELOG.md`](./CHANGELOG.md) under **Breaking**. Each npm package tracks the same service version - if you pin `@latrinebot/sdk` to `0.4.x` you get a client that matches `api.latrinebot.com` at the same minor.
## Contributing
Issues and PRs welcome - read [`CONTRIBUTING.md`](./CONTRIBUTING.md) first. Style rules live in [`docs/STYLE.md`](./docs/STYLE.md).
## Links
- Site: [latrinebot.com](https://latrinebot.com)
- App: [latrinebot.com/app](https://latrinebot.com/app)
- API health: [api.latrinebot.com/api/health](https://api.latrinebot.com/api/health)
- npm: [@latrinebot/sdk](https://www.npmjs.com/package/@latrinebot/sdk), [@latrinebot/widgets](https://www.npmjs.com/package/@latrinebot/widgets), [@latrinebot/cli](https://www.npmjs.com/package/@latrinebot/cli)
- X: [@Latrine_bot](https://x.com/Latrine_bot)
- Security: [`SECURITY.md`](./SECURITY.md) - latrine@atomicmail.io
## License
- Code: [MIT](./LICENSE)
- Docs (`docs/` folder): [CC BY 4.0](./LICENSE-DOCS)