docs
Changelog

Changelog

All notable changes to GSwarm will be documented in this file.

The format is based on Keep a Changelog (opens in a new tab), and this project adheres to Semantic Versioning (opens in a new tab).

[2.0.0] - 2025-01-XX

🚀 Major Release - Telegram Monitoring Focus

This release represents a major shift in GSwarm's focus from process supervision to dedicated Telegram monitoring for Gensyn AI blockchain activity.

✨ Added

  • Dedicated Telegram Monitoring Service: Complete rewrite focusing on blockchain monitoring
  • GenRL-Swarm Contract Support: Updated to monitor new contract address 0xFaD7C5e93f28257429569B854151A1B8DCD404c2
  • Peer ID Auto-Detection: Automatically detects and monitors all peer IDs associated with your EOA address
  • Change Detection: Only sends notifications when values actually change
  • Per-Peer Breakdown: Detailed breakdown of votes and rewards per peer ID
  • Interactive Setup: Guided setup process for Telegram configuration
  • Local Configuration Storage: Secure local storage of bot tokens and settings
  • Welcome Messages: Initial setup confirmation via Telegram
  • Continuous Monitoring: 5-minute interval monitoring loop

🔄 Changed

  • Go Version Requirement: Updated to Go 1.24+ for improved performance and features
  • Contract Address: Updated to new GenRL-Swarm contract address
  • Focus Shift: From process supervision to blockchain monitoring
  • Configuration Format: Simplified JSON-based configuration
  • Command Line Interface: Streamlined for Telegram monitoring use cases

🗑️ Deprecated

  • Process Supervision: Removed RL Swarm process management functionality
  • Python Dependency Management: No longer manages Python environments
  • HuggingFace Integration: Removed model pushing capabilities
  • Complex Configuration: Simplified to focus on Telegram monitoring
  • Old Contract Addresses: Previous contract addresses no longer supported

🐛 Fixed

  • Configuration Management: Improved error handling for invalid configurations
  • Network Resilience: Better handling of network timeouts and errors
  • Telegram API: Enhanced error handling for Telegram Bot API
  • Data Validation: Improved validation of EOA addresses and peer IDs

🔧 Technical

  • Codebase Refactor: Complete rewrite focusing on monitoring functionality
  • Dependency Updates: Updated all dependencies to latest versions
  • Error Handling: Comprehensive error handling and user feedback
  • Logging: Improved logging for debugging and monitoring

[1.5.0] - 2024-12-XX

✨ Added

  • Telegram Monitoring: Real-time blockchain activity notifications
  • Change Detection: Only notify when values actually change
  • Peer ID Monitoring: Track all peer IDs associated with EOA address
  • Interactive Setup: Guided configuration process
  • Local Storage: Secure configuration file storage

🔄 Changed

  • Enhanced Logging: Improved log format and detail
  • Error Handling: Better error messages and recovery
  • Configuration: Simplified configuration management

🐛 Fixed

  • Process Restart: Fixed edge cases in process restart logic
  • Dependency Installation: Improved Python dependency handling
  • Network Timeouts: Better handling of network issues

[1.4.0] - 2024-11-XX

✨ Added

  • Environment Variable Support: All flags can be set via environment variables
  • Custom Requirements: Support for custom requirements files
  • CPU-Only Mode: Force CPU-only operation
  • Model Size Selection: Support for different model sizes (0.5, 1.5, 7, 32, 72)

🔄 Changed

  • Configuration Priority: Environment variables take precedence over flags
  • Error Messages: More descriptive error messages
  • Help System: Enhanced help and documentation

🐛 Fixed

  • Path Issues: Fixed PATH configuration problems
  • Permission Errors: Better handling of file permissions
  • Process Management: Improved process supervision

[1.3.0] - 2024-10-XX

✨ Added

  • Non-Interactive Mode: Full command-line configuration support
  • YAML Configuration: Support for YAML configuration files
  • Advanced Logging: Structured logging with timestamps
  • Signal Handling: Graceful shutdown on system signals

🔄 Changed

  • Default Behavior: Interactive mode is now default
  • Log Format: Improved log readability
  • Error Recovery: Better error recovery mechanisms

🐛 Fixed

  • Process Restart: Fixed infinite restart loops
  • Dependency Issues: Better Python dependency resolution
  • Configuration Loading: Improved configuration file handling

[1.2.0] - 2024-09-XX

✨ Added

  • Interactive Mode: Prompts for missing configuration
  • HuggingFace Integration: Support for model pushing
  • Multiple Game Types: Support for gsm8k and dapo games
  • Testnet Support: Connect to Gensyn testnet

🔄 Changed

  • Configuration Flow: Simplified configuration process
  • Error Handling: More user-friendly error messages
  • Documentation: Enhanced documentation and examples

🐛 Fixed

  • Process Management: Fixed process supervision issues
  • Logging: Improved log file management
  • Dependencies: Better Python environment handling

[1.1.0] - 2024-08-XX

✨ Added

  • Automatic Restart: Restart process on errors
  • Dependency Management: Automatic Python dependency installation
  • Comprehensive Logging: Detailed logs with timestamps
  • Performance Monitoring: Real-time output streaming

🔄 Changed

  • Process Supervision: Improved process management
  • Error Detection: Better error pattern recognition
  • Log Format: Enhanced log readability

🐛 Fixed

  • Startup Issues: Fixed various startup problems
  • Log Rotation: Improved log file management
  • Signal Handling: Better process termination

[1.0.0] - 2024-07-XX

✨ Initial Release

  • Process Supervision: Basic process management for RL Swarm
  • Logging: Basic logging functionality
  • Configuration: Simple configuration management
  • Error Handling: Basic error detection and handling

Version Compatibility

Go Version Requirements

  • v2.0.0+: Go 1.24+
  • v1.0.0 - v1.5.0: Go 1.21+

Breaking Changes

  • v2.0.0: Complete rewrite focusing on Telegram monitoring
  • v1.5.0: Added Telegram monitoring capabilities
  • v1.3.0: Changed default to interactive mode
  • v1.2.0: Added interactive configuration prompts

Migration Guide

From v1.x to v2.0.0

  1. Update Go: Ensure Go 1.24+ is installed
  2. Reinstall GSwarm: go install github.com/Deep-Commit/gswarm/cmd/gswarm@latest
  3. New Configuration: Set up Telegram monitoring via interactive prompts
  4. Remove Old Configs: Old supervisor configurations are no longer used

From v1.4.x to v1.5.0

  1. Install Update: go install github.com/Deep-Commit/gswarm/cmd/gswarm@latest
  2. Setup Telegram: Run gswarm --telegram to configure Telegram monitoring
  3. Optional: Continue using supervisor functionality alongside Telegram monitoring

Future Plans

Upcoming Features (v2.1.0)

  • Custom Monitoring Intervals: Configurable check intervals
  • Multiple Address Support: Monitor multiple EOA addresses
  • Advanced Filtering: Custom notification filters
  • Historical Data: Track and display trends

Long-term Roadmap

  • Web Dashboard: Visual monitoring interface
  • Mobile App: Native mobile monitoring app
  • API Integration: REST API for external integrations
  • Multi-Platform Support: Support for additional messaging platforms

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Support

For support and questions:

License

This project is licensed under the MIT License - see the LICENSE file for details.