Skip to content

Commit a0475b5

Browse files
chore: prepare v1.0.0 release — docs, CI, and GitHub presence cleanup
- Add CHANGELOG.md and SECURITY.md for release readiness - Update CI workflows from actions v2 to v4/v5 (Node.js 16 deprecation) - Fix CONTRIBUTING.md clone URL (your-org → YichengYang-Ethan) - Fix pyproject.toml classifier (Alpha → Beta to match v1.0.0) - Rewrite docs/index.md and PROJECT_SPECIFICATION.md (remove outdated Social World Model references, align with current Solana architecture) - Update mkdocs.yml site_description to match on-chain agent focus - Add Release badge and Contributing/Security sections to README - Remove internal issue templates (codebase_reorg, exp_record, writing_task) - Remove unused assets/readme_title.svg - Disable empty GitHub wiki Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b9cf611 commit a0475b5

16 files changed

Lines changed: 251 additions & 409 deletions

.github/ISSUE_TEMPLATE/codebase_reorg.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/exp_record.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/writing_task.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

.github/workflows/codespell.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ jobs:
1717
matrix:
1818
python-version: ["3.10"]
1919
steps:
20-
- uses: actions/checkout@v2
20+
- uses: actions/checkout@v4
2121
- name: Set up Python ${{ matrix.python-version }}
22-
uses: actions/setup-python@v2
22+
uses: actions/setup-python@v5
2323
with:
2424
python-version: ${{ matrix.python-version }}
2525
- name: Install dependencies

.github/workflows/mypy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
python-version: ["3.10"]
2020

2121
steps:
22-
- uses: actions/checkout@v2
22+
- uses: actions/checkout@v4
2323
- name: Set up Python ${{ matrix.python-version }}
24-
uses: actions/setup-python@v2
24+
uses: actions/setup-python@v5
2525
with:
2626
python-version: ${{ matrix.python-version }}
2727
- name: Install dependencies

.github/workflows/pytest.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
python-version: ["3.10"]
2020

2121
steps:
22-
- uses: actions/checkout@v2
22+
- uses: actions/checkout@v4
2323
- name: Set up Python ${{ matrix.python-version }}
24-
uses: actions/setup-python@v2
24+
uses: actions/setup-python@v5
2525
with:
2626
python-version: ${{ matrix.python-version }}
2727
- name: Install dependencies

.github/workflows/ruff.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ jobs:
1717
matrix:
1818
python-version: ["3.10"]
1919
steps:
20-
- uses: actions/checkout@v2
20+
- uses: actions/checkout@v4
2121
- name: Set up Python ${{ matrix.python-version }}
22-
uses: actions/setup-python@v2
22+
uses: actions/setup-python@v5
2323
with:
2424
python-version: ${{ matrix.python-version }}
2525
- name: Install dependencies

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2026-03-09
9+
10+
### Added
11+
12+
- **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
13+
- **AI-powered trading** with OpenAI Agents SDK, LiteLLM multi-provider support, and 8 built-in agent tools
14+
- **Solana integration**: native transaction signing, on-chain trade logging via Memo program, Jito bundle submission, Solana Blinks
15+
- **Multi-exchange support**: Solana/DFlow (SPL tokens), Polymarket (CLOB API), Kalshi (REST API)
16+
- **Cross-platform arbitrage**: detect and trade price discrepancies across exchanges
17+
- **Live trading dashboard** at `/live` with 8 feature cards, equity chart, execution pipeline animation, and pause/resume/e-stop controls
18+
- **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
22+
- **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
26+
- **Interactive demo script** (`demo.sh`)
27+
28+
[1.0.0]: https://github.com/YichengYang-Ethan/oracle3/releases/tag/v1.0.0

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Thanks for your interest in contributing! Here is everything you need to get sta
55
## Setup
66

77
```bash
8-
git clone https://github.com/your-org/oracle3.git
8+
git clone https://github.com/YichengYang-Ethan/oracle3.git
99
cd oracle3
1010
poetry install --with dev,test
1111
```

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
<img src="https://img.shields.io/badge/python-3.10%2B-blue?logo=python&logoColor=white" alt="Python">
1515
<img src="https://img.shields.io/badge/solana-mainnet--beta-9945FF?logo=solana&logoColor=white" alt="Solana">
1616
<img src="https://img.shields.io/badge/license-Apache%202.0-green" alt="License">
17+
<a href="https://github.com/YichengYang-Ethan/oracle3/releases"><img src="https://img.shields.io/github/v/release/YichengYang-Ethan/oracle3?color=orange" alt="Release"></a>
1718
</p>
1819

1920
<p align="center">
@@ -397,6 +398,14 @@ Oracle3 is my exploration of what that future looks like in practice. Prediction
397398

398399
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.
399400

401+
## Contributing
402+
403+
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
404+
405+
## Security
406+
407+
For reporting vulnerabilities, please see [SECURITY.md](SECURITY.md).
408+
400409
## License
401410

402411
Apache 2.0 — see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)