Skip to content

Commit 9e5a67c

Browse files
chore: add marketing sections to README and expand CHANGELOG
- Add "What's New" timeline near top of README for momentum narrative - Add "Why Oracle3?" comparison table vs Polymarket/agents and freqtrade - Add "Powered By" logo badges (Solana, Polymarket, Kalshi, OpenAI, Jito) - Add Star History chart with dark/light mode support - Add Community section linking to Discussions and Issues - Add Contributors visualization via contrib.rocks - Expand CHANGELOG with arbitrage suite, relation graph, SpreadExecutor, engine control, and matching pipeline details Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a0475b5 commit 9e5a67c

2 files changed

Lines changed: 72 additions & 11 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
- **8 constraint-based & statistical arbitrage strategies**: cross-market, exclusivity, implication, conditional, event-sum, structural, cointegration spread, and lead-lag — each with formal invariant, fee-aware edge, cooldown windows, and audit trail
13+
- **Market relation graph**: persistent knowledge graph (`~/.oracle3/relations.json`) with lifecycle management (discovered → validated → deployed → retired) and quantitative validation (Engle-Granger cointegration, ADF stationarity, OLS hedge ratio, OU half-life, Pearson correlation, lead-lag detection)
14+
- **SpreadExecutor**: safe multi-leg execution with automatic LIFO unwind on partial fills — no naked positions
15+
- **Engine control server**: Unix socket runtime control (pause/resume/stop/killswitch) without process restart
16+
- **Strategy portfolio registry**: lifecycle tracking (paper → live → retired), health checks, Kelly capital allocation
1217
- **8 on-chain agent capabilities**: cross-market arbitrage, on-chain risk manager, on-chain signal source, MEV protection (Jito), agent reputation, multi-agent pipeline, flash loan arbitrage, atomic multi-leg trader
1318
- **AI-powered trading** with OpenAI Agents SDK, LiteLLM multi-provider support, and 8 built-in agent tools
1419
- **Solana integration**: native transaction signing, on-chain trade logging via Memo program, Jito bundle submission, Solana Blinks
1520
- **Multi-exchange support**: Solana/DFlow (SPL tokens), Polymarket (CLOB API), Kalshi (REST API)
16-
- **Cross-platform arbitrage**: detect and trade price discrepancies across exchanges
1721
- **Live trading dashboard** at `/live` with 8 feature cards, equity chart, execution pipeline animation, and pause/resume/e-stop controls
1822
- **Classic terminal dashboard** at `/` for headless environments
19-
- **Quantitative strategies**: adaptive OB imbalance + EMA momentum with self-tuning weights
20-
- **Contributed strategies**: cross-market arbitrage, multi-agent pipeline, Solana agent, debate strategy
21-
- **Risk management**: dual-layer validation (local limits + RPC simulation), max drawdown monitoring, daily loss limits, kill switch
23+
- **Risk management**: dual-layer validation (local limits + Solana `simulateTransaction`), max drawdown monitoring, daily loss limits, kill switch
2224
- **Backtesting engine** with DFlow episode replay (parquet format)
23-
- **Coinjure matching pipeline**: cross-platform market relation discovery (implication, exclusivity, complementary)
24-
- **CLI** (`oracle3`) with commands for market browsing, paper/live trading, reputation, blinks, trade logs
25-
- **CI/CD**: pytest, ruff, mypy, codespell, MkDocs documentation site
25+
- **Coinjure matching pipeline**: cross-platform market relation discovery (implication, exclusivity, complementary) with resolution filter, volume filter, keyphrase pre-filter, confidence sizing, and tag coverage
26+
- **CLI** (`oracle3`) with commands for market browsing, paper/live trading, engine control, reputation, blinks, trade logs
27+
- **CI/CD**: pytest (553 tests), ruff, mypy, codespell, MkDocs documentation site
2628
- **Interactive demo script** (`demo.sh`)
2729

2830
[1.0.0]: https://github.com/YichengYang-Ethan/oracle3/releases/tag/v1.0.0

README.md

Lines changed: 63 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@
2929
<sub>Live trading dashboard — real-time equity curve, execution pipeline, 8 on-chain agent capabilities</sub>
3030
</p>
3131

32+
## What's New
33+
34+
| Date | Update |
35+
|------|--------|
36+
| **2026-03-09** | v1.0.0 released — 8 arbitrage strategies, market relation graph, SpreadExecutor, engine control server |
37+
| **2026-03-06** | Matching pipeline optimization — resolution filter, volume filter, confidence sizing |
38+
| **2026-03-04** | Live trading dashboard with 8 on-chain feature cards and real-time equity curve |
39+
| **2026-03-01** | Solana integration — native tx signing, Jito MEV protection, on-chain trade logging |
40+
| **2026-02-28** | Initial commit — trading engine, multi-exchange support, AI agent strategies |
41+
3242
## Why On-Chain Agents?
3343

3444
DeFi is shifting from human-operated dashboards to **autonomous agents** that perceive, decide, and execute entirely on-chain. Prediction markets are the ideal proving ground: discrete outcomes, transparent order books, and real-money accountability force an agent to be right — not just convincing.
@@ -398,13 +408,62 @@ Oracle3 is my exploration of what that future looks like in practice. Prediction
398408

399409
The goal is not just a profitable bot, but a reference architecture for how LLM reasoning, quantitative signals, constraint-based arbitrage, and on-chain primitives can be unified into a single autonomous system.
400410

401-
## Contributing
411+
## Why Oracle3?
412+
413+
| Feature | Oracle3 | [Polymarket/agents](https://github.com/Polymarket/agents) | [freqtrade](https://github.com/freqtrade/freqtrade) |
414+
|---------|---------|-------------------|-----------|
415+
| Prediction markets | Solana/DFlow + Polymarket + Kalshi | Polymarket only | Crypto spot/futures only |
416+
| On-chain atomic execution | Solana native | Off-chain | Off-chain |
417+
| Constraint-based arbitrage | 8 strategies with formal invariants | None | None |
418+
| Statistical arbitrage | Cointegration + Lead-lag | None | FreqAI (ML-based) |
419+
| Cross-market arbitrage | 3 exchanges | Single exchange | Single exchange |
420+
| LLM agent with tools | OpenAI Agents SDK + LiteLLM | RAG pipeline | None |
421+
| Multi-leg auto-unwind | SpreadExecutor with LIFO unwind | None | None |
422+
| MEV protection | Jito Bundles | N/A | N/A |
423+
| On-chain audit trail | Solana Memo program | None | None |
424+
| Risk simulation | `simulateTransaction` pre-flight | None | None |
425+
| Live dashboard | Web + Terminal TUI | None | FreqUI |
426+
| Engine hot control | Unix socket (pause/resume/killswitch) | None | Telegram bot |
427+
428+
## Powered By
429+
430+
<p align="center">
431+
<a href="https://solana.com"><img src="https://img.shields.io/badge/Solana-9945FF?style=for-the-badge&logo=solana&logoColor=white" alt="Solana"></a>
432+
<a href="https://polymarket.com"><img src="https://img.shields.io/badge/Polymarket-0052FF?style=for-the-badge&logoColor=white" alt="Polymarket"></a>
433+
<a href="https://kalshi.com"><img src="https://img.shields.io/badge/Kalshi-000000?style=for-the-badge&logoColor=white" alt="Kalshi"></a>
434+
<a href="https://openai.com"><img src="https://img.shields.io/badge/OpenAI-412991?style=for-the-badge&logo=openai&logoColor=white" alt="OpenAI"></a>
435+
<a href="https://jito.network"><img src="https://img.shields.io/badge/Jito-00C7B7?style=for-the-badge&logoColor=white" alt="Jito"></a>
436+
</p>
437+
438+
## Star History
439+
440+
<p align="center">
441+
<a href="https://star-history.com/#YichengYang-Ethan/oracle3&Date">
442+
<picture>
443+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=YichengYang-Ethan/oracle3&type=Date&theme=dark" />
444+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=YichengYang-Ethan/oracle3&type=Date" />
445+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=YichengYang-Ethan/oracle3&type=Date" width="600" />
446+
</picture>
447+
</a>
448+
</p>
449+
450+
## Community
451+
452+
<p align="center">
453+
<a href="https://github.com/YichengYang-Ethan/oracle3/discussions"><img src="https://img.shields.io/badge/GitHub_Discussions-181717?style=for-the-badge&logo=github&logoColor=white" alt="Discussions"></a>
454+
<a href="https://github.com/YichengYang-Ethan/oracle3/issues"><img src="https://img.shields.io/badge/Issues-181717?style=for-the-badge&logo=github&logoColor=white" alt="Issues"></a>
455+
</p>
402456

403-
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
457+
- **Questions & Ideas**[GitHub Discussions](https://github.com/YichengYang-Ethan/oracle3/discussions)
458+
- **Bug Reports**[GitHub Issues](https://github.com/YichengYang-Ethan/oracle3/issues)
459+
- **Security** — see [SECURITY.md](SECURITY.md)
460+
- **Contributing** — see [CONTRIBUTING.md](CONTRIBUTING.md)
404461

405-
## Security
462+
## Contributors
406463

407-
For reporting vulnerabilities, please see [SECURITY.md](SECURITY.md).
464+
<a href="https://github.com/YichengYang-Ethan/oracle3/graphs/contributors">
465+
<img src="https://contrib.rocks/image?repo=YichengYang-Ethan/oracle3" alt="Contributors" />
466+
</a>
408467

409468
## License
410469

0 commit comments

Comments
 (0)