Skip to main content

GoyGram

GoyGram Logo

Python 3.11+ Rust Core License: AGPL v3 Telegram API Security Docs & Wiki

What is this?

Ultimate split-brain Telegram framework (Python + Rust core) built for production-grade speed, control, and maximum OpSec.

Under the hood: a Python orchestration layer drives two completely independent network transports (Bot API over aiohttp + MTProto over raw TCP with full DH key exchange), both feeding into a single async event bus. Every crypto operation — AES-256-IGE for MTProto packets, AES-256-GCM for session vaults — runs in a Rust .so compiled with LTO and opt-level=3. Hand-written TL codec, no code generation at runtime. QR code login rendering in the terminal via qrcode + Rich. SRP password proofs for 2FA. And the vault: your auth key locked to your machine-id through PBKDF2-SHA256 at 600,000 iterations.

Key Features

  • Split-brain architecture: ergonomic Python layer + blazing-fast Rust extension.
  • Session Eater: aggressive in-memory cleanup (zeroize strategy for legacy .session files after migration).
  • Vault AES-256-GCM: encrypted local session bootstrap. Key derived from machine-id + session name via PBKDF2 (or bypass with GOYGRAM_VAULT_KEY).
  • TUI auth flow: terminal-first authorization workflow — phone login with SMS code, QR code scanning in ASCII art, 2FA/SRP password challenges. All Rich-styled when a TTY is present.
  • Proxy support: SOCKS5 (with user/pass auth) and HTTP CONNECT tunneling for MTProto connections. Also respects ALL_PROXY / HTTPS_PROXY / HTTP_PROXY env vars.
  • Dual transport: Bot API (HTTP long-polling via aiohttp, multipart uploads, auto-webhook-clear on 409) + MTProto (raw TCP with AES-256-IGE, dynamic salt recovery on bad_server_salt, auto-DC migration on PHONE_MIGRATE_N) — in one app runtime.
  • Dynamic DC Routing: MTProto nodes are resolved at startup from a built-in DC map (5 Telegram DCs). Falls back to 149.154.167.50:443 (DC 2) if resolution fails.
  • Dynamic API dispatch: every Bot API method works via __getattr__sendAnimation, getUserProfilePhotos, setMyCommands, whatever. Snake_case auto-converts to CamelCase. mt_ prefix routes to MTProto.
  • Keyboard system: inline keyboards, reply keyboards, force reply, reply removal. All with to_dict() serialization that adapts per transport.
  • Forum topic management: full create/edit/close/reopen/delete lifecycle for forum topics and the General topic. Both transports supported.
  • Zero-copy event objects: MsgObj, CbObj, PollObj, MemberObj with __slots__ — no per-message dict overhead.
  • Composable filters: boolean AND/OR/NOT on Filter (filters.text & ~filters.me).
  • Multi-session: named vaults (session_name="worker_1") for farming multiple accounts from the same process. Separate auth keys, separate TCP connections, separate self_id.

Installation

pip install goygram

Requires Python 3.11+. Rust is not required — pre-built wheels ship for Linux, Windows, and macOS (x86-64 + ARM64). Installs aiohttp, pydantic, rich, and qrcode as dependencies.

Quick Start

1) Bot API (token)

import asyncio
from goygram import GoyGram, filters

app = GoyGram(bot_token="123456:ABC_TOKEN")

@app.on_msg(filt=filters.text)
async def echo(msg):
    await msg.reply("Hello from Bot API")

asyncio.run(app.run())

2) MTProto (no bot token, requires API ID + API Hash)

import asyncio
from goygram import GoyGram

app = GoyGram(api_id=123456, api_hash="0123456789abcdef0123456789abcdef")  # auto-fetches Telegram DC endpoint at startup

@app.on_cmd("ping")
async def ping(msg):
    await msg.reply("pong from MTProto (api_id/api_hash)")

asyncio.run(app.run())

3) Named MTProto sessions (multi-session in one folder)

import asyncio
from goygram import GoyGram

app = GoyGram(
    api_id=123456,
    api_hash="0123456789abcdef0123456789abcdef",
    session_name="farm_worker_1",
)

asyncio.run(app.run())
  • By default, session data is stored in default.vault.
  • With session_name="farm_worker_1", session data is stored in farm_worker_1.vault.
  • If farm_worker_1.session exists, it is migrated to farm_worker_1.vault during bootstrap (securely zeroized after).

Dynamic API & Methods

GoyGram now supports all Telegram methods out of the box with dynamic dispatch:

  • Call Bot API methods directly even if they are not explicitly hardcoded:
    • await app.sendDocument(chat_id=..., document=...)
    • await app.getChat(chat_id=...)
    • await app.getUpdates(timeout=30)
  • Snake-case also works and is converted to Bot API method names:
    • await app.send_document(chat_id=..., document=...) -> sendDocument
  • MTProto actions (authorized with API ID/API Hash) are available with mt_ prefix:
    • await app.mt_get_dialogs(limit=50)
    • await app.mt_get_chat_full(chat_id=...)

This behavior is implemented through dynamic method resolution in the client core (__getattr__) and transport-aware request routing.

Authentication & Security

Interactive Login

On first run with MTProto, GoyGram launches a Rich-powered TUI:

GoyGram Interactive Login

? Choose login method:
  > QR Code Login
    Phone Number Login

Choose QR code (scan with any Telegram client) or phone number (SMS code). 2FA password is handled automatically via SRP proofs. The resulting session is stored as default.vault — AES-256-GCM encrypted, keyed to your machine.

Vault Encryption

  • Algorithm: AES-256-GCM (authenticated encryption via Rust's aes-gcm crate)
  • Key derivation: PBKDF2-HMAC-SHA256, 600,000 iterations, key material = {machine-id}:{session_name}
  • Override: GOYGRAM_VAULT_KEY env var (base64-encoded 32 bytes) bypasses PBKDF2 entirely
  • Plain JSON fallback: if decryption fails, tries reading as plain JSON (auto-re-encrypts on next save)

Session Migration

Telethon/Pyrogram .session files are auto-detected, read from SQLite, migrated to .vault, and securely zeroized (overwrite + fsync + unlink).

Developer Tools (Help)

Use built-in introspection tools:

app.help()            # pretty DX overview in console
print(dir(app))       # inspect available shortcuts + dynamic entries

or:

from goygram.utils import print_methods
print_methods(app)

With type hints on key event objects (MsgObj, CbObj, MemberObj, PollObj) and filter primitives, modern IDE autocomplete works much better out of the box.

Filters

goygram.filters supports composable boolean operators:

from goygram import filters

smart_filter = filters.text & ~filters.me
another = filters.text | filters.me

@app.on_msg(filt=smart_filter)
async def handler(msg):
    await msg.reply("Filtered")

Built-in filters: filters.text (message has text), filters.me (message from current account/bot). Compose with &, |, ~. Custom filters: Filter(lambda e: ...).

Transport Routing

Messages can be routed explicitly by transport:

# Force Bot API
await app.send_msg("bot:123456789", "via bot", via="bot")

# Force MTProto
await app.send_msg("mt:123456789", "via mt", via="mt")

Chat ID prefixes (bot: / mt:) are auto-resolved. When replying, the transport source is preserved automatically — reply to a Bot API message, it goes back via Bot API.

Event Pipeline

BotNet.spin() ──→ bus.push("bot", data)
                                          ──→ Disp.consume() → your handlers
MTNet.spin() ──→ bus.push("mt", data)

Single asyncio.Queue → typed event objects (MsgObj/CbObj/PollObj/MemberObj) → handler lists in registration order. Per-handler error isolation — one crashing handler never takes down the dispatcher.

Logging

GOYGRAM_LOG=DEBUG python app.py   # verbose (raw MTProto packet dumps)
GOYGRAM_LOG=INFO python app.py    # default (startup, errors)
GOYGRAM_LOG=WARNING python app.py # quiet

Logger hierarchy: goygram.app, goygram.botapi, goygram.mtproto, goygram.disp, goygram.security, goygram.dc.

Architecture at a Glance

┌─────────────────────────────────────────────┐
│             GoyGram (Public API)             │  ← User-facing facade
├─────────────────────────────────────────────┤
│        AppCore (Internal Engine)             │  ← Config, hooks, routing
├──────────────────┬──────────────────────────┤
│ BotNet (aiohttp) │   MTNet (TCP/MTProto)    │  ← Independent transports
├──────────────────┴──────────────────────────┤
│          Bus → Disp (Event Pipeline)         │  ← asyncio.Queue + dispatcher
├─────────────────────────────────────────────┤
│  goygram.ext (Rust .so) — AES-IGE/AES-GCM   │  ← Native crypto (LTO, opt=3)
└─────────────────────────────────────────────┘

Wiki

📚 55 pages of documentation... Every line of GoyGram, explained. 👉 Check out the Official GoyGram Docs!

License

See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

goygram-0.7.20.tar.gz (485.4 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

goygram-0.7.20-cp311-abi3-win_amd64.whl (711.0 kB view details)

Uploaded CPython 3.11+Windows x86-64

goygram-0.7.20-cp311-abi3-manylinux_2_34_x86_64.whl (798.2 kB view details)

Uploaded CPython 3.11+manylinux: glibc 2.34+ x86-64

goygram-0.7.20-cp311-abi3-macosx_11_0_arm64.whl (768.9 kB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

File details

Details for the file goygram-0.7.20.tar.gz.

File metadata

  • Download URL: goygram-0.7.20.tar.gz
  • Upload date:
  • Size: 485.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.15.0

File hashes

Hashes for goygram-0.7.20.tar.gz
Algorithm Hash digest
SHA256 37eeb00021cc21221959ece450a950a604b36ae4d5f41a98855e469cbde8a3a8
MD5 41e409d1ed4525e7b862facf9fdd973b
BLAKE2b-256 2bdacad6995ad36eee34aa8ae792fa2b9fc6d570c9b9503a9f5d4be3caafb880

See more details on using hashes here.

File details

Details for the file goygram-0.7.20-cp311-abi3-win_amd64.whl.

File metadata

  • Download URL: goygram-0.7.20-cp311-abi3-win_amd64.whl
  • Upload date:
  • Size: 711.0 kB
  • Tags: CPython 3.11+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.15.0

File hashes

Hashes for goygram-0.7.20-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 1a69ae20b1712033104b61e63b8817fccc0f50edd13d8aeec563ec2f54c9eb95
MD5 171523e5fedf2ea07bee56c03294d812
BLAKE2b-256 a779978417fce101b7152de3b40ee091f6d8b8d851e97f24e8e8936983e29cab

See more details on using hashes here.

File details

Details for the file goygram-0.7.20-cp311-abi3-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for goygram-0.7.20-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 c47b59e5d56dce0bd0311a45b89ac8e530196038b73a6277475b54c16ac9a3f7
MD5 65489a693a9bd0d1de6fe4eb326312fb
BLAKE2b-256 5ccadafbbd7f4e618f18f888625c2029914b993fa958c4c7d05fea6300d669c1

See more details on using hashes here.

File details

Details for the file goygram-0.7.20-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for goygram-0.7.20-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 13290e737025c46bf26b433b5562683581eeccb0b9372052050504a7712ab543
MD5 d5ce7f47f14831adc27c62bab561d6f8
BLAKE2b-256 2d3ed46398f6fd99cb9ea507546b6209336250cfb2085fa08a34292ea9494bd3

See more details on using hashes here.

Release history Release notifications | RSS feed

0.7.63

4 files

0.7.62

4 files

0.7.61

4 files

0.7.60

4 files

0.7.59

4 files

0.7.58

4 files

0.7.57

4 files

0.7.56

4 files

0.7.55

4 files

0.7.54

4 files

0.7.53

4 files

0.7.52

4 files

0.7.51

4 files

0.7.50

4 files

0.7.49

4 files

0.7.48

4 files

0.7.47

4 files

0.7.46

4 files

0.7.45

4 files

0.7.35

4 files

0.7.34

4 files

0.7.33

4 files

0.7.32

4 files

0.7.31

4 files

0.7.30

4 files

0.7.29

4 files

0.7.28

4 files

0.7.27

4 files

0.7.26

4 files

0.7.25

4 files

0.7.24

4 files

0.7.23

4 files

0.7.22

4 files

0.7.21

4 files

This release

0.7.20 This release

4 files

0.7.19

4 files

0.7.18

4 files

0.7.17

4 files

0.7.16

4 files

0.7.15

4 files

0.7.14

4 files

0.7.13

4 files

0.7.12

4 files

0.7.11

4 files

0.7.10

4 files

0.7.9

4 files

0.7.8

4 files

0.7.7

4 files

0.7.6

4 files

0.7.5

4 files

0.7.4

4 files

0.7.3

4 files

0.7.2

4 files

0.7.1

4 files

0.7.0

4 files

0.6.9

4 files

0.6.8

4 files

0.6.7

4 files

0.6.6

4 files

0.6.5

4 files

0.6.4

4 files

0.6.3

4 files

0.6.2

4 files

0.6.1

4 files

0.6.0

4 files

0.5.7

4 files

0.5.6

4 files

0.5.5

4 files

0.5.3

4 files

0.5.1

4 files

0.5.0

4 files

0.4.9

4 files

0.4.8

4 files

0.4.7

4 files

0.4.2

4 files

0.4.1

4 files

0.4.0

4 files

0.3.9

4 files

0.3.8

4 files

0.3.7

4 files

0.3.6

4 files

0.3.5

4 files

0.3.4

4 files

0.3.2

4 files

0.3.0

4 files

0.1.0

4 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page