Skip to content

Commit d574fd4

Browse files
committed
docs: update roadmap for v1.0.0 sidecar foundation
1 parent 6b986b4 commit d574fd4

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

ROADMAP.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,39 @@
11
# Roadmap
22

3-
## v0.x.x: Foundation (Current)
4-
**Goal:** Establish the unified api interface and feature set for initial exchanges in JavaScript/TypeScript.
3+
## v0.x.x: Initial Foundation (Completed)
4+
**Goal:** Establish the unified API interface and core standardization logic for prediction markets.
55

6-
- **Core Features:**
7-
- Unified data structures for markets and orders.
8-
- Basic trading capabilities (buy/sell).
9-
- Market search and filtering.
10-
- **Exchange Support:** Initial support for key exchanges (e.g., Polymarket, Kalshi).
11-
- **Status:** Active development.
6+
- **Unified Data Structures:** Defined canonical formats for markets, orders, and positions.
7+
- **Initial Exchange Support:** Integrated Polymarket and Kalshi.
8+
- **Status:** Done.
129

13-
## v1.0.0: The "Sidecar" Expansion (Target: Q2 2026)
14-
**Goal:** Expand ecosystem support to major programming languages (Python, Java, C#) using the established core logic.
10+
## v1.0.0: The Sidecar Foundation (Current)
11+
**Goal:** Establish a robust multi-language ecosystem with a unified core and automated infrastructure.
1512

16-
- **Architecture:** Run a lightweight, local Node.js server (the "sidecar") that hosts the core aggregation and standardization logic.
17-
- **SDKs:** Provide native SDKs for **Python**, **Java**, **C#**, and more using OpenAPI. These SDKs will transparently communicate with the local Node.js process via HTTP or gRPC.
18-
- Ensures 100% consistency in behavior across all languages.
19-
- Allows rapid iteration: an update to the JS core updates all languages simultaneously.
20-
- **Exchange Support:** Expansion to **5+ Exchange Integrations** (aggregated into a unified API).
13+
- **Architecture:** Implementation of the local Node.js "sidecar" server hosting core aggregation and standardization logic.
14+
- **SDKs:**
15+
- **TypeScript:** Refactored native wrapper with automatic server management.
16+
- **Python:** Complete native SDK with automatic server lifecycle management.
17+
- **Infrastructure:** OpenAPI-based pipeline for generating any language SDK.
18+
- **Exchanges:** Support for industry leaders **Polymarket** and **Kalshi**.
19+
- **Automation:**
20+
- Comprehensive CI/CD for all packages (npm and PyPI).
21+
- Automated language-specific API documentation generation.
22+
- **Status:** In progress.
23+
24+
## v1.x.x: Ecosystem Expansion (Upcoming)
25+
**Goal:** Increase coverage, connectivity, and real-time capabilities.
26+
27+
- **WebSockets:** Implement real-time unified data streaming for orderbooks and trades.
28+
- **Exchange Support:** Expansion to **5+ Exchange Integrations** (e.g., BetOnline, Polymarket CLOB, etc.).
29+
- **SDK Library:** Release official first-party wrappers for **Java**, **C#**, and **Go**.
30+
- **Unified Authentication:** Streamlined secret management across different exchange protocols.
2131

2232
## v2.0.0: Native Performance
2333
**Goal:** Optimize for high-frequency usage and remove runtime dependencies.
2434

25-
- **Architecture:** Move to native bindings. This involves rewriting the core logic in a systems language (Rust) or using optimized FFI (Foreign Function Interface) directly, removing the need for a background Node.js process.
26-
- **Benefits:** Lower latency, simpler installation (no Node.js dependency required for Python/Java users), and better resource management.
35+
- **Architecture:** Move to native bindings. Rewrite core logic in a systems language (**Rust**) or using optimized FFI, removing the need for a background Node.js process.
36+
- **Benefits:**
37+
- Ultra-low latency for high-frequency trading.
38+
- Zero-dependency installation for Python/Java users.
39+
- Minimal resource footprint.

0 commit comments

Comments
 (0)