Skip to content

Commit 3dc95f3

Browse files
committed
docs: update documentation for v0.2.0 features
- Update lib.rs Features section with new capabilities: - Trading operations (buy, sell, cancel, edit) - Account management (positions, summaries) - Session management (heartbeat, cancel-on-disconnect) - Typed response parsing - Update Examples section with all 22 examples organized by category: - Core examples - Trading & Account Management (v0.2.0) - Session Management (v0.2.0) - Market Data Subscriptions - Mass Quoting - Regenerate README.md from lib.rs
1 parent d286d88 commit 3dc95f3

File tree

2 files changed

+50
-4
lines changed

2 files changed

+50
-4
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ through Deribit's WebSocket API v2.
2727
- 📊 **Real-time Market Data** - Live ticker, order book, trades, and chart data streaming
2828
- 📈 **Advanced Subscriptions** - Chart data aggregation and user position change notifications
2929
- 💰 **Mass Quote System** - High-performance mass quoting with MMP (Market Maker Protection) groups
30-
- 🔐 **Authentication** - Secure API key and signature-based authentication
30+
- 🔐 **Authentication** - Secure API key and signature-based authentication with typed responses
31+
- 📝 **Trading Operations** - Full order lifecycle: buy, sell, cancel, edit orders
32+
- 💼 **Account Management** - Position queries, account summaries, order history
33+
- 🔄 **Session Management** - Heartbeat control, client identification, cancel-on-disconnect
3134
- 🛡️ **Error Handling** - Comprehensive error types with detailed recovery mechanisms
3235
-**Async/Await** - Full async support with tokio runtime for high concurrency
3336
- 🔄 **Callback System** - Flexible message processing with primary and error callbacks
@@ -137,11 +140,31 @@ let response = client.mass_quote(request).await?;
137140
### Examples
138141

139142
The crate includes comprehensive examples demonstrating:
143+
144+
#### Core Examples
140145
- **`basic_client.rs`** - Basic connection, subscription, and message handling
141146
- **`callback_example.rs`** - Advanced callback system with error handling
142147
- **`advanced_subscriptions.rs`** - Chart data and position change subscriptions
148+
149+
#### Trading & Account Management (v0.2.0)
150+
- **`trading_operations.rs`** - Buy, sell, cancel, edit orders
151+
- **`account_operations.rs`** - Get positions, account summary, order history
152+
- **`position_management.rs`** - Close positions, move positions between subaccounts
153+
154+
#### Session Management (v0.2.0)
155+
- **`session_management.rs`** - Hello, heartbeat, typed responses (AuthResponse, HelloResponse, TestResponse)
156+
- **`cancel_on_disconnect.rs`** - Enable/disable/get cancel-on-disconnect status
157+
- **`unsubscribe_all.rs`** - Public and private unsubscribe_all operations
158+
159+
#### Market Data Subscriptions
160+
- **`new_channels_subscription.rs`** - Grouped order book, incremental ticker, trades by kind
161+
- **`perpetual_subscription.rs`** - Perpetual funding rate subscriptions
162+
- **`quote_subscription.rs`** - Quote data subscriptions
163+
- **`price_index_subscription.rs`** - Price index subscriptions
164+
165+
#### Mass Quoting
143166
- **`mass_quote_basic.rs`** - Basic mass quoting with MMP group setup
144-
- **`mass_quote_advanced.rs`** - Advanced mass quoting with multiple MMP groups and monitoring
167+
- **`mass_quote_advanced.rs`** - Advanced mass quoting with multiple MMP groups
145168
- **`mass_quote_options.rs`** - Options-specific mass quoting with delta management
146169

147170
### Architecture

src/lib.rs

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@
1111
//! - 📊 **Real-time Market Data** - Live ticker, order book, trades, and chart data streaming
1212
//! - 📈 **Advanced Subscriptions** - Chart data aggregation and user position change notifications
1313
//! - 💰 **Mass Quote System** - High-performance mass quoting with MMP (Market Maker Protection) groups
14-
//! - 🔐 **Authentication** - Secure API key and signature-based authentication
14+
//! - 🔐 **Authentication** - Secure API key and signature-based authentication with typed responses
15+
//! - 📝 **Trading Operations** - Full order lifecycle: buy, sell, cancel, edit orders
16+
//! - 💼 **Account Management** - Position queries, account summaries, order history
17+
//! - 🔄 **Session Management** - Heartbeat control, client identification, cancel-on-disconnect
1518
//! - 🛡️ **Error Handling** - Comprehensive error types with detailed recovery mechanisms
1619
//! - ⚡ **Async/Await** - Full async support with tokio runtime for high concurrency
1720
//! - 🔄 **Callback System** - Flexible message processing with primary and error callbacks
@@ -144,11 +147,31 @@
144147
//! ## Examples
145148
//!
146149
//! The crate includes comprehensive examples demonstrating:
150+
//!
151+
//! ### Core Examples
147152
//! - **`basic_client.rs`** - Basic connection, subscription, and message handling
148153
//! - **`callback_example.rs`** - Advanced callback system with error handling
149154
//! - **`advanced_subscriptions.rs`** - Chart data and position change subscriptions
155+
//!
156+
//! ### Trading & Account Management (v0.2.0)
157+
//! - **`trading_operations.rs`** - Buy, sell, cancel, edit orders
158+
//! - **`account_operations.rs`** - Get positions, account summary, order history
159+
//! - **`position_management.rs`** - Close positions, move positions between subaccounts
160+
//!
161+
//! ### Session Management (v0.2.0)
162+
//! - **`session_management.rs`** - Hello, heartbeat, typed responses (AuthResponse, HelloResponse, TestResponse)
163+
//! - **`cancel_on_disconnect.rs`** - Enable/disable/get cancel-on-disconnect status
164+
//! - **`unsubscribe_all.rs`** - Public and private unsubscribe_all operations
165+
//!
166+
//! ### Market Data Subscriptions
167+
//! - **`new_channels_subscription.rs`** - Grouped order book, incremental ticker, trades by kind
168+
//! - **`perpetual_subscription.rs`** - Perpetual funding rate subscriptions
169+
//! - **`quote_subscription.rs`** - Quote data subscriptions
170+
//! - **`price_index_subscription.rs`** - Price index subscriptions
171+
//!
172+
//! ### Mass Quoting
150173
//! - **`mass_quote_basic.rs`** - Basic mass quoting with MMP group setup
151-
//! - **`mass_quote_advanced.rs`** - Advanced mass quoting with multiple MMP groups and monitoring
174+
//! - **`mass_quote_advanced.rs`** - Advanced mass quoting with multiple MMP groups
152175
//! - **`mass_quote_options.rs`** - Options-specific mass quoting with delta management
153176
//!
154177
//! ## Architecture

0 commit comments

Comments
 (0)