Skip to content

tiennm99/miti99bot

Repository files navigation

miti99bot

Plug-n-play Telegram bot framework in Go. Self-hosted on Coolify + MongoDB Atlas via long polling and an in-process cron scheduler.

Modules

Module What it does
util /help, /info, /stickerid
misc /ping, /ping_stats, /random, /wheelofnames, /ff, /the_answer, /trongtruonghop + /tth, /trongtruonghopvng + /tthvng disclaimers
wordle Daily Wordle game
loldle League-of-Legends "guess the champion"
lol Pro-match schedule (/lol, /lol_tomorrow, /lol_this_week, /lol_next_week) + daily push
stock VN-stocks paper trading
gold Gold paper trading (opt-in; VNAppMob SJC buy/sell VND/luong)
coin Crypto paper trading in USD (Binance -> Coinbase -> CoinGecko price fallback)
stats /stats (top commands), /stats users, /stats user <username>, /stats cmd <command_name>

Disable modules with the MODULES environment variable.

Command discovery

Public command registrations share their description plus optional Parameters metadata between Telegram's native / menu and the bot's /help response. Telegram renders the /command separately, so /stock_buy uses this native description:

<quantity> <ticker>. Buy VN stock at market price.

/help combines the full command syntax and summary on one line. Neither discovery surface includes example invocations.

Future commands must follow the command parameter conventions. Keep command metadata, handler usage text, tests, and documentation aligned.

Stock dividend commands

Stock dividends are manual portfolio adjustments:

  • /stock_cash_dividend <vnd_per_share> <ticker> credits a positive whole-VND amount for each pre-event share held. Eg: /stock_cash_dividend 1500 TCB.
  • /stock_share_dividend <ratio(owned:new)> <ticker> adds floor(pre_event_shares × new / owned) whole shares. Eg: /stock_share_dividend 100:10 TCB.

The combined /stock_dividend shortcut was retired. Use the specialized cash and share commands above for new adjustments.

Ratios use owned:new exactly as written in the issuer notice. Equivalent unreduced ratios are accepted and the entered ratio is preserved in the reply. The bot validates syntax, tickers, and arithmetic safety. /stock_portfolio also checks SSI iBoard for cash and explicit share-dividend events published in the preceding 30 days. The portfolio is always sent first. Every retained unprocessed event is re-sent on each /stock_portfolio until it is processed or expires after 90 days: future events are informational messages without a button, while events from Record date include an Apply dividend button. Events with no Record date remain informational while the bot rechecks their original publication window for SSI updates.

Suggestions expire after 24 hours and are bound to the Telegram user who requested the portfolio, the originating chat, and the event message. Another group member cannot apply them. Acceptance calculates from the user's current holding at click time and marks the per-user event processed atomically with the portfolio change. The current position must have opened on or before Record date. SSI iBoard is an undocumented, best-effort source; failures do not prevent the portfolio from being shown. The bot does not persist dated lots, so suggestions are not legal record-date entitlement calculations. Users should verify the issuer notice.

Repeated portfolio requests can create multiple valid buttons for the same event. Processing is idempotent: the first accepted button marks the event processed, and later buttons cannot credit it again.

Normalized SSI history is retained under dividends.<ticker>.<ssi_event_id>, separate from active assets so a full sale does not permit the same event to be applied after a repurchase. Records are removed 90 days after Record date. If SSI never supplies Record date, they are removed 90 days after publication. A later SSI response that omits an event does not remove or suppress the retained per-user record.

The manual commands remain available, but they do not carry an SSI event ID. Applying an event manually and then accepting its button can therefore record the same dividend twice; use one method for a given event.

Stock and coin P&L accounting

Stock and coin portfolios embed each open position under assets.<symbol>. Both store quantity and total remaining base; stock positions additionally store an openedAt lifecycle marker. Stock cash is stored directly as vnd; coin cash remains usd. Buys add their actual spend. Partial sells remove basis using the weighted-average method and report realized P&L; full sells remove the position and its basis. Stock share dividends add shares without adding cost, which lowers the derived average price, while cash dividends do not change position basis.

/stock_portfolio and /coin_portfolio show compact aligned monospace tables with separate unrealized P&L amount and percentage columns for each priced position. Stock Avg and Now use thousand VND as their implicit unit; coin position amounts use implicit USD without a $ prefix. Account P&L remains the broader account value minus all top-ups, so it also reflects realized proceeds, dividend cash, and idle cash. If any current quote is unavailable, totals are marked partial and numeric Account P&L is withheld.

Stock dividend discovery has no per-position cursor. SSI queries use a rolling 30-day publication window and overlap the previous Asia/Saigon calendar day at the provider boundary; caller-side filtering restores the exact interval. Per-user event history provides notification state and processing idempotency. The stock-only assets.<ticker>.openedAt marker identifies the current position lifecycle, invalidates buttons after a full sale and later repurchase, and prevents a position opened after Record date from applying an older event.

Layout

cmd/server/                  entrypoint (long polling + in-process cron + HTTP health)
internal/server/             HTTP route (/ health only; cron has no HTTP route)
internal/telegram/           Telegram long-polling bot wrapper
internal/cron/               in-process cron scheduler
internal/modules/            Module framework, registry, dispatchers, modules
internal/storage/            typed DocStore[T] (Provider + Typed); mongodb runtime + memory (tests). Values persist as flattened native BSON root documents
internal/systemstate/        shared `system` collection helper for startup migration records
compose.yml                  Coolify self-host stack (single bot service)
docs/deploy-coolify-selfhosted.md    Self-host deploy and operations guide

Run locally

In-memory storage requires no database. Set the environment variables for your shell, then run the server with Go:

# PowerShell
$env:TELEGRAM_BOT_TOKEN = ""
$env:MODULES = ""
go run ./cmd/server
# POSIX shells (Linux/macOS)
export TELEGRAM_BOT_TOKEN=""
export MODULES=""
go run ./cmd/server

The bot uses long polling, so a local run talks to Telegram directly — no ngrok or public URL. The server clears any existing webhook on startup. The dev bot is created manually; its token is injected through the environment.

Persistent MongoDB locally (auto-selected when MONGO_URL is set):

docker run -d --rm --name miti99bot-mongo -p 27017:27017 mongo:8

Then set MONGO_URL=mongodb://127.0.0.1:27017 and MONGO_DATABASE=miti99bot_dev using the shell syntax above before running go run ./cmd/server. Stop the local database with docker stop miti99bot-mongo.

MongoDB integration tests use Testcontainers to start MongoDB 8 automatically. Keep Docker Desktop or another compatible Docker daemon running, then use the normal Go test command. MONGODB_TEST_URL remains available as an optional override when testing against an already-running MongoDB instance. If Docker is unavailable and no override is set, MongoDB tests skip with an explicit warning; use go test -v ./... to see individual skip reasons.

Test

go vet ./...
go test -count=1 ./...
go build ./...

CI additionally runs the test suite with Go's race detector.

Deploy

docs/deploy-coolify-selfhosted.md covers Coolify + MongoDB Atlas (free M0), long polling (no public ingress), and in-process cron. Storage auto-selects mongodb when MONGO_URL is set; the cron scheduler runs by default.

License

Apache-2.0.

About

Plug-n-play Telegram bot framework in Go, self-hosted on Coolify + MongoDB Atlas with cron, games, schedules, and paper trading modules.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors