Technical documentation for developers evaluating, forking, or contributing to Just The Tips. Read these before running, after running, or whenever a chain or platform question comes up. small project, small docs. both deliberate.
Throughout these docs, ⓘ means this explains a term — tap for a short definition that stays on this page. ⓐ means this has more — tap to expand a longer section inline or jump to the detailed treatment.
Three audiences, three reading paths:
How to audit this codebase. Three reading depths (5 minutes, 30 minutes, an afternoon). AI review tools are explicitly welcome — we'll tell you how to use them.
Read →Threat model, data handling, dependency pinning policy, and how to report vulnerabilities. Covers what we protect against, what we don't, and what's stored (nothing persistent).
Read →Top-down map of how the bot works. Two listeners, four chain adapters, two platform adapters, one status registry. What's where, why, and what's deliberately not included.
Read →
The chain-adapter interface and how to add a new chain. Documented in src/chains/types.ts today; a dedicated page may come if enough people want one.
The chat-platform adapter interface and how to add a new platform. Similar interface to chain adapters. Source is self-documenting; a standalone page is future work.
Not yet publishedNot strictly a doc, but worth knowing: the configurator is how users build a personalized bot bundle without touching a terminal. The bundle includes the full bot source.
Open →You're trying to answer: "is it safe to run this code?" or "does this do what it claims?"
Start here:
The bot is about 3000 lines of TypeScript across 24 files. You can read all of it in an afternoon. You can get the gist in 30 minutes.
You want to modify the bot, add a chain, add a platform, or understand a design decision.
Start here:
src/chains/types.ts — the chain adapter contract. ~30 lines of interfaces.src/adapters/discord/adapter.ts — the platform adapter pattern.tests/ — every test is small and readable; they document expected behavior.As of 0.2.0-alpha.1, the project is feature-complete relative to its originally-scoped four-chain, four-platform surface. New chains or platforms aren't planned for the canonical release, but forks are explicitly welcome — BSL 1.1 allows fork and modification, and the adapter pattern makes adding a chain or platform a matter of one new file rather than a refactor.
You want to read the bot's output from elsewhere (a dashboard, another bot, a monitoring service) or understand its HTTP surface.
There are three HTTP routes:
GET /healthz — returns {"ok": true} when the server is up. No auth. Standard health check.GET /tip — HTML signing page, multi-chain. Used by tippers via links from chat.GET /check — HTML status page showing the state of every chain and platform. Useful for humans and for scraping.No other HTTP surface. No REST API for third-party integration. No webhooks. The bot is a self-contained process — if you want events from it, either run it yourself and read its logs, or fork it and add what you need.