Skip to content

CHANGELOG.md

Latest commit

 

History

History
252 lines (179 loc) · 9.8 KB

CHANGELOG.md

File metadata and controls

252 lines (179 loc) · 9.8 KB

Changelog

All notable changes to BinaryOptionsTools v2 will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.2.10 - 2026-03-22

Added

  • Rule macro system with DSL support for ergonomic rule definitions (#[rule({ starts_with("42") & !contains("error") })])
  • Per-language documentation macro for BinaryOptionsToolsUni crate
  • Demo test example for verifying library functionality (connection, subscriptions, candle fetching)
  • Trade state regression test
  • Documentation JSON files for API modules (error, pocket_option, raw_handler, stream, types, validator)
  • Max subscriptions configuration in State builder (default: 4)
  • Memory pruning for closed deals (limit to 1000) to prevent memory growth

Changed

  • Major core crate refactoring: Removed core-pre crate and consolidated into core crate
  • Improved SSID parsing with double-encoding detection and regex recovery for malformed JSON
  • Enhanced deals module with better Socket.IO frame handling and message pattern matching
  • Refactored historical data module for improved reliability
  • Updated README with new Python bot framework examples and corrected version support
  • Updated Python version support (dropped 3.8, 3.13, 3.14, 3.15)
  • Dependency updates across multiple directories

Fixed

  • Fixed check win functionality
  • Fixed documentation errors in Rust source
  • Fixed source distribution (sdist) build

0.2.9 - 2026-03-09

Added

  • N/a

Changed

  • Updated python support
  • Improved SSID parsing to prevent double encoded JSON msgs
  • Minor docs updates

Fixed

  • Fixed auth failure with valid SSID: Ssid::Display now returns the raw auth message (42["auth",{...}]) instead of a human-readable label, so the correct credential string is sent to the server during WebSocket handshake.
  • Balance returning -1 (possibly)
  • Unsafe unwraps

0.2.8 - 2026-02-22

Added

  • Pre-registration API on ResponseRouter to eliminate race conditions in command responses
  • SSID Fetcher UserScript for easier SSID extraction from browser
  • Framework improvements: on_balance_update now works correctly
  • Support for storing indicators in the Python framework
  • PyStrategy integration improvements

Changed (Breaking Logic)

  • Virtual Market Profit Semantics: Deal.profit now stores net gain/loss (e.g., -stake on loss, 0 on draw, stake payout % on win) instead of total payout.
  • WebSocket Event System: Unified on EventHandler trait and tuple/unit variants for WebSocketEvent. Custom handlers must update their signatures and can now provide an optional name().
  • Enhanced Client Architecture: Updated EnhancedWebSocketInner to require and store credentials, handler, and connector.
  • Context Manager Lifecycle: Exiting the PocketOption context manager now explicitly closes the internal event loop, preventing resource leaks but also preventing instance reuse.

Changed

  • Updated BinaryOptionsToolsV2.pyi to match the actual Rust return types (JSON strings/Lists instead of Dicts).
  • Updated documentation and README
  • Code quality improvements and clippy fixes
  • CI workflow updated for stable PyO3
  • Thread-safe buy() calls in synchronous client via threading.RLock()
  • Removed unused resend_connection_messages method

Fixed

  • Event loop leak in Python synchronous client by fixing __exit__ and close() logic.
  • Boxing issues in BinaryOptionsToolsError::WebsocketConnectionError variant.
  • API mismatches in client2.rs preventing successful compilation.
  • Fixed on_balance_update event handling.
  • Fixed concurrent test failures.
  • Fixed failing pytest tests.
  • Fixed pending trades test.
  • Fixed PyO3 compatibility issues with chrono::Duration.

0.2.6 - 2026-02-13

Added

  • Robust SSID parsing supporting complex PHP serialized session objects and sanitized Socket.IO frames
  • Automated asset and payout gathering (AssetsModule) upon connection
  • New wait_for_assets method to ensure library readiness before operations
  • Refactored GitHub Issue and Pull Request templates
  • Pre-registration API on ResponseRouter to eliminate race conditions in command responses
  • Real event handler removal by name in WebSocketClient2
  • Preserve original event variants when broadcasting events in WebSocketClient2

Changed (Breaking Logic)

  • Virtual Market Profit Semantics: Deal.profit now stores net gain/loss (e.g., -stake on loss, 0 on draw, stake payout % on win) instead of total payout.
  • WebSocket Event System: Unified on EventHandler trait and tuple/unit variants for WebSocketEvent. Custom handlers must update their signatures and can now provide an optional name().
  • Enhanced Client Architecture: Updated EnhancedWebSocketInner to require and store credentials, handler, and connector.
  • Context Manager Lifecycle: Exiting the PocketOption context manager now explicitly closes the internal event loop, preventing resource leaks but also preventing instance reuse.

Changed

  • Increased historical data and pending order timeouts to 30s for enhanced reliability during network congestion
  • Improved WebSocket routing rules (TwoStepRule, MultiPatternRule) to be resilient against interleaved messages
  • Updated documentation deployment workflow to include mkdocstrings dependencies (gh pages)
  • Reorganized internal project scripts
  • Updated BinaryOptionsToolsV2.pyi to match the actual Rust return types (JSON strings/Lists instead of Dicts).
  • Improved message sending priority by using biased polling in EnhancedWebSocketClient.
  • Enhanced event dispatching with concurrency limiting (semaphore) in WebSocketClient2.

Fixed

  • GitHub Pages 404 error by normalizing documentation filenames to lowercase (index.md).
  • Race conditions in history retrieval by properly pairing response messages with request indices.
  • Event loop leak in Python synchronous client by fixing __exit__ and close() logic.
  • Boxing issues in BinaryOptionsToolsError::WebsocketConnectionError variant.
  • API mismatches in client2.rs preventing successful compilation.
  • Silent Decimal to f64 conversion error in subscriptions.rs with proper error propagation.
  • Misleading connection error reporting; now returns the actual last failure from multiple URL attempts.

0.2.5 - 2026-02-08

Added

  • Files to sort into respective folders - /SortLaterOr_rm/

Changed

  • Organized - Merged /examples/ to /docs/examples/
  • Added more rules within .gitignore

Fixed

  • Prettier format
  • SSID parsing errors within demo vs real differences

0.2.4 - 2026-02-03

Added

  • Advanced candle data retrieval with get_candles and get_candles_advanced
  • Advanced validators for message filtering
  • Improved WebSocket message handling
  • Enhanced documentation in the docs/ directory

Changed

  • Improved error handling for connection management
  • Updated Python bindings for better async support
  • Enhanced type safety across Rust and Python interfaces

Fixed

  • Connection stability improvements
  • Memory leak fixes in WebSocket handlers
  • Error handling in subscription management

0.2.3 - 2023-12-XX

Added

  • Raw Handler API for advanced WebSocket control
  • Validator system for response filtering
  • Enhanced subscription management
  • Time-aligned subscription support

Changed

  • Improved reconnection logic with exponential backoff
  • Better error messages and logging
  • Updated dependencies for security patches

Fixed

  • Race conditions in message routing
  • Subscription cleanup on disconnect
  • Memory management in async operations

0.2.0 - 2023-11-XX

Added

  • Complete rewrite in Rust for performance and reliability
  • Python bindings via PyO3
  • Async and sync Python APIs
  • Real-time market data streaming
  • WebSocket connection management
  • Automatic reconnection with exponential backoff
  • Type-safe interfaces across languages

Changed

  • Architecture redesigned with Rust core
  • Improved performance (10x faster than v1)
  • Better memory management
  • Enhanced error handling

Removed

  • Python-only implementation (replaced with Rust core)
  • Legacy API endpoints (deprecated in v1)

[0.1.x] - 2023-XX-XX

Initial Release

  • Python-based implementation
  • Basic PocketOption API support
  • Trading operations (buy/sell)
  • Balance retrieval
  • Basic WebSocket connection

Version Naming Convention

  • Major version (X.0.0): Breaking changes, major architecture changes
  • Minor version (0.X.0): New features, non-breaking changes
  • Patch version (0.0.X): Bug fixes, security patches

Types of Changes

  • Added: New features
  • Changed: Changes in existing functionality
  • Deprecated: Soon-to-be removed features
  • Removed: Removed features
  • Fixed: Bug fixes
  • Security: Security vulnerability fixes

Links