Changelog

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

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

[0.2.0] - 2025-01-18

Added

  • Complete documentation setup with Sphinx

  • Read the Docs integration with .readthedocs.yaml

  • Comprehensive documentation including:

    • Getting Started guide

    • Installation instructions

    • Usage examples

    • API reference

    • Code examples

    • Changelog

  • Poetry documentation dependencies management

Changed

  • Updated project documentation URLs

  • Enhanced project structure with proper docs folder

Technical Details

  • Sphinx 7.x configuration

  • MyST parser for Markdown support

  • Read the Docs theme

  • Auto-generated API documentation

[0.1.0] - 2025-01-18

Added

  • Initial release of TRC20 Monitor

  • Core monitoring functionality for TRC20 tokens on Tron blockchain

  • Support for monitoring incoming, outgoing, and bidirectional transactions

  • Multiple database adapters:

    • MemoryDB for in-memory storage

    • SQLiteDB for persistent storage

    • Abstract DatabaseAdapter for custom implementations

  • Multiple notification adapters:

    • ConsoleNotifier for console output

    • FileNotifier for file logging

    • WebhookNotifier for HTTP webhooks

    • CompositeNotifier for multiple channels

  • Command-line interface (CLI) for easy usage

  • Comprehensive test suite with pytest

  • Full async/await support for high performance

  • Transaction filtering by minimum amount

  • Configurable monitoring intervals

  • Automatic retry logic for network failures

  • Type hints throughout the codebase

  • Comprehensive documentation

Features

  • Real-time transaction monitoring

  • Flexible storage backends

  • Multiple notification channels

  • Production-ready error handling

  • Easy integration with existing systems

  • Support for all TRC20 tokens

  • Efficient batch processing capabilities

Technical Details

  • Python 3.8+ support

  • Built with aiohttp for async HTTP requests

  • SQLite support via aiosqlite

  • Optional SQLAlchemy integration

  • 100% type-annotated code

  • Comprehensive test coverage

[Unreleased]

Planned Features

  • WebSocket support for real-time updates

  • Redis cache support

  • MongoDB adapter

  • Discord notification adapter

  • Slack notification adapter

  • Advanced filtering options

  • Transaction aggregation and analytics

  • Multi-chain support (BSC, Ethereum)

  • REST API server mode

  • Prometheus metrics export

  • Grafana dashboard templates

Under Consideration

  • GraphQL API

  • Message queue integration (RabbitMQ, Kafka)

  • Advanced rate limiting strategies

  • Transaction simulation

  • Smart contract interaction

  • DeFi protocol integrations

For detailed migration guides between versions, see the Migration Guide.