Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 2.52 KB

File metadata and controls

50 lines (39 loc) · 2.52 KB

Polyterm Documentation

This directory is the source of truth for the project. You can understand the whole platform — and every bot version — from these documents alone.

Read in this order

  1. architecture.md — how the platform fits together: the Version Manager, the kernel, the strategy-plugin framework, the shared infrastructure (feeds, detection, brokers, scout), and the data flow.
  2. configuration.md.env, runtime-config.json, the ⚙ CONFIG panel, every setting, and the full go-live procedure.

Bot versions

Each bot has its own document with: what it does, how it works (with the math where relevant), its settings, its dashboard, its limitations, and its full version history.

Doc Bot Status
v1-copy-bot.md Copy Bot (v1.x) + Target/Market Scout ✅ implemented
v2-strategy-bot.md Strategy Bot (v2.x) — own signal ✅ implemented
v3-market-maker.md Market Maker (v3.0) 🚧 planned
v4-cross-platform-arb.md Cross-Platform Arbitrage (v4.0) 🚧 planned
v5-ai-news.md AI / News (v5.0) 🚧 planned
v9-predictor.md Predictor (v9.0) — TA ensemble + EV gate, live charts ✅ implemented (paper)

Versioning convention

  • Major version = the bot's identity (v1 Copy, v2 Strategy, …). Each major version is an independent plugin with its own UI and its own P&L ledger.
  • Minor version = a feature update to that bot (v1.0 → v1.1 → … → v1.5). Version history tables in each doc track what changed and when.

The Version Manager always shows the current version of each bot. The engine guards against a stale saved version (it falls back to the latest implemented build), so an old runtime-config.json never breaks startup.

Glossary

  • Window — one Up/Down market instance (e.g. a single 15-minute BTC market). Resolves Up if price(close) ≥ price(open), else Down.
  • Clip — one order the bot places.
  • Copy / mirror — replicate a target wallet's trade.
  • Sell-to-recycle — sell a position near close for instant cash instead of holding to resolution + on-chain redeem.
  • CTF — Conditional Tokens Framework; Polymarket outcome tokens are CTF ERC-1155 tokens. A BUY transfers them to the wallet, a SELL from it.
  • pUSD — Polymarket's collateral token (post-April-2026 migration from USDC.e).