changelog: vibed

This commit is contained in:
nym21
2025-08-16 19:16:09 +02:00
parent b5e3262b67
commit 98cfd160ef
2 changed files with 768 additions and 0 deletions
+1
View File
@@ -28,5 +28,6 @@ flamegraph.svg
*.trace
# AI
.claude
CLAUDE.md
CLAUDE*.md
+767
View File
@@ -1,3 +1,770 @@
# Changelog
*This changelog was generated by Claude Code.*
All notable changes to the Bitcoin Research Kit (BRK) project will be documented in this file.
## Unreleased
### Documentation
- **Enhanced**: Comprehensive rewrite of all crate README files for improved clarity and developer experience
- **Updated**: Main project README with better structure and documentation
- **Standardized**: README format across all workspace crates with consistent styling
- **Improved**: Documentation structure and organization across the entire project
- **Added**: More detailed descriptions for each crate's purpose and functionality
### Computer Module
- **Refactored**: Converted ComputedFrom pattern to LazyFrom pattern for improved performance
- **Added**: New LazyVecBuilder implementation for on-demand computation
- **Restructured**: Computer module stateful operations with improved organization
- **Cleaned**: Removed hardcoded format specifications, now using defaults
- **Optimized**: Vector storage operations with lazy computation patterns
- **Refactored**: Address type handling in stateful computations
- **Reorganized**: Stateful module structure for better maintainability
- **Enhanced**: Builder patterns for grouped vector operations
- **Improved**: Memory efficiency through lazy computation strategies
### Vector Storage
- **Enhanced**: Vector storage engine development workflow
- **Optimized**: Lazy vector computation patterns for better performance
- **Improved**: Vector builder architecture with lazy evaluation
### Dependencies
- **Updated**: Rayon from 1.10.0 to 1.11.0 for improved parallel processing
- **Migrated**: vecdb from external version 0.1.0 to local development path for better development workflow
- **Reorganized**: Workspace dependency structure for consistency
### Build System
- **Added**: Rust toolchain version specification (1.89) to workspace configuration
- **Enhanced**: Development environment consistency with toolchain pinning
### Server Module
- **Improved**: API interface implementations
- **Enhanced**: File serving functionality
### Indexer Module
- **Optimized**: Integration with updated computer module patterns
## [v0.0.88] - 2025-08-10
### Website
- **Fixed**: Conditional rendering of adjusted SOPR (Adjusted Spent Output Profit Ratio) charts in website options
- **Improved**: SOPR chart options now only display adjusted SOPR when the data is available in the vector indexes
- **Enhanced**: Better error handling for missing adjusted SOPR datasets
### Build System
- **Updated**: Added `rust-version.workspace = true` to all crate Cargo.toml files
- **Updated**: Bumped all crate versions from 0.0.87 to 0.0.88
- **Added**: Minimum supported Rust version constraint (1.89) to workspace configuration
## [v0.0.87] - 2025-08-10
### Major Architecture Change
- **BREAKING**: Extracted `brk_vecs` into separate external crate `vecdb`
- **Moved**: Vector storage engine to separate [seqdb](https://github.com/seqdb/seqdb) repository
- **Updated**: All crates now use `vecdb` instead of internal `brk_vecs`
- **Improved**: Better separation of concerns with vector storage as independent library
### Storage Engine
- **Renamed**: `brk_vecs``vecdb`
- **Renamed**: `brk_vecs_macros``vecdb_derive`
- **Updated**: All vector database operations now use `vecdb::Database` instead of `brk_vecs::File`
- **Enhanced**: Vector storage is now a standalone crate with its own versioning
### Dependencies
- **Updated**: `brk_rmcp` from 0.4.1 → 0.5.0
- **Updated**: `cc` from 1.2.31 → 1.2.32
- **Updated**: `hashbrown` from 0.15.4 → 0.15.5
- **Updated**: `rapidhash` from 3.0.0 → 3.1.0
- **Updated**: `rustversion` from 1.0.21 → 1.0.22
- **Updated**: `slab` from 0.4.10 → 0.4.11
### Configuration
- **Added**: `--exchanges` flag to control whether to fetch prices from exchange APIs
- **Enhanced**: Price fetching now has two levels - BRK API and exchanges
- **Improved**: Better RPC authentication error messages with troubleshooting guidance
### Build System
- **Updated**: All crate versions from 0.0.85 to 0.0.87
- **Added**: New dependency on external `vecdb` crate with derive features
## [v0.0.85] - 2025-08-07
### MCP (Model Context Protocol)
- **Updated**: Upgraded MCP implementation
- **Changed**: Made MCP stateless mode the default (was previously stateful to avoid breaking Claude)
- **Improved**: Better MCP server configuration with stateless operations
### Logging
- **Enhanced**: Updated logging utilities in `brk_logger`
### Build System
- **Updated**: Bumped version from 0.0.84 to 0.0.85
## [v0.0.84] - 2025-08-07
### Build System
- **Added**: Per-crate `build.rs` files for better build configuration
- **Improved**: Cargo.lock file management and error handling
- **Enhanced**: Build process optimization across all crates
### Vector Storage
- **Fixed**: Compressed vector functionality restored
- **Fixed**: Race condition in vector operations
- **Improved**: Vector storage stability and performance
## [v0.0.83] - 2025-07-26
### Vector Storage
- **Added**: Linux punch hole implementation for better disk space management
- **Enhanced**: Memory-mapped file handling improvements
## [v0.0.82] - 2025-07-26
### Dependencies
- **Updated**: Cleaned up Cargo dependencies
- **Removed**: Temporarily removed rayon parallelization from computer module
- **Enhanced**: Dependency management and build optimization
### Computer Module
- **Fixed**: File initialization with minimum length and regions
- **Improved**: Memory management and performance optimizations
- **Added**: Flush and punch operations for better disk usage
## [v0.0.81] - 2025-07-17
### Vector Storage
- **Fixed**: Holes export functionality in vector storage
- **Enhanced**: Vector storage reliability
### MCP Integration
- **Updated**: Now uses `rust-rmcp` instead of `brk-rmcp` for better compatibility
### Computer Module
- **Improved**: Performance optimizations
- **Fixed**: Stateful operations
- **Enhanced**: Vector-to-store conversion process (parts 1 & 2)
## [v0.0.80] - 2025-07-13
### MCP (Model Context Protocol)
- **Removed**: Claude results examples due to dead links
- **Cleaned**: MCP example documentation
### Vector Storage
- **Added**: Local and shared `stored_len` tracking to raw vector variant
- **Enhanced**: Vector storage metadata management
### Dependencies
- **Updated**: Multiple crate upgrades for better compatibility
## [v0.0.79] - 2025-07-13
### Dependencies
- **Updated**: Upgraded multiple crates for better compatibility and performance
### Website
- **Applied**: Dataset changes to chart configurations
- **Enhanced**: Chart display with updated dataset handling
### Vector Storage
- **Fixed**: Header reading functionality for existing vector files
- **Improved**: Memory management by removing mmap storage from struct
- **Enhanced**: Vector file handling reliability
### Store Operations
- **Reverted**: Bloom filters back to default settings due to slow read performance
- **Optimized**: Memory usage for future v3 improvements
- **Fixed**: Missing store-related files
## [v0.0.78] - 2025-07-13
### Build System
- **Updated**: All crate versions bumped for version consistency across workspace
- **Enhanced**: Version consistency across workspace
### Computer Module
- **Optimized**: Reduced number of ratio datasets for some cohorts to improve performance
- **Enhanced**: Performance optimizations across computation modules
- **Improved**: Resource utilization and memory management
- **Fixed**: Coarse lazy indexes functionality
- **Removed**: Debug statements for cleaner production builds
### Global Improvements
- **Added**: Semester-based time intervals
- **Changed**: Coarser intervals now computed instead of eager evaluation
- **Fixed**: Various global module issues
- **Enhanced**: Performance and resource improvements
## [v0.0.76] - 2025-07-09
### Bundler
- **Updated**: Upgraded Rolldown dependency for better bundling performance
## [v0.0.75] - 2025-07-09
### Computer Module
- **Fixed**: Reduced parallel thread count for `compute_rest_part2` to prevent external drive crashes
- **Improved**: Better handling of external storage devices during computation
## [v0.0.74] - 2025-07-09
### Computer Module
- **Fixed**: Parallel computation crashes on external drives
- **Enhanced**: Storage device compatibility improvements
## [v0.0.73] - 2025-07-09
### Website
- **Fixed**: Chart panes now maintain equal sizes
- **Removed**: Automatic saving of pane heights preference
- **Updated**: Lightweight Charts to v5.0.8
- **Added**: TODO functionality initialization
- **Enhanced**: Website development snapshots
### Dependencies
- **Updated**: Global dependency upgrades across all crates
- **Enhanced**: System-wide dependency management
### Computer Module
- **Added**: More up-to and from datasets for enhanced analysis
- **Implemented**: Store functionality (parts 2-10)
- **Enhanced**: Data storage architecture with store-based approach
- **Replaced**: Value enum with Cow for better memory efficiency
### Global System
- **Moved**: `addressindex_to_outputindex` stores from computer to indexer module
- **Renamed**: Various stores for better organization
- **Enhanced**: Global module fixes and improvements
### Indexer
- **Renamed**: Store organization for better clarity
- **Enhanced**: Store management improvements
### Documentation
- **Added**: MCP (Model Context Protocol) README documentation
- **Enhanced**: Developer documentation
## [v0.0.71] - 2025-06-25
### MCP (Model Context Protocol)
- **Enhanced**: Small improvements to MCP functionality
- **Updated**: MCP integration refinements
## [v0.0.70] - 2025-06-25
### Fetcher Module
- **Fixed**: BRK API URL endpoints
- **Enhanced**: Price fetching reliability
## [v0.0.69] - 2025-06-24
### Vector Storage
- **Reverted**: Storing file in struct (was overwhelming system resources)
- **Improved**: Memory management for vector operations
## [v0.0.68] - 2025-06-24
### Core System
- **Increased**: Maximum open files limit for better file handling
- **Enhanced**: System resource management
## [v0.0.67] - 2025-06-24
### Server Module
- **Changed**: Now uses ETag for vectors instead of date modified for better caching
- **Enhanced**: HTTP caching strategy improvements
### Vector Storage
- **Unified**: Single file with header approach for vector storage
- **Improved**: Vector file organization and management
### MCP Integration
- **Added**: MCP part 2 implementation
- **Refactored**: Server MCP integration
- **Enhanced**: MCP functionality expansion
### Global Improvements
- **Renamed**: Various indexes for better clarity
- **Updated**: Index naming conventions
- **Fixed**: Web index type imports
### CLI
- **Removed**: Duplicate 'h' short index in query functionality
### Documentation
- **Updated**: README improvements
- **Updated**: MCP documentation
- **Updated**: Changelog titles
## [v0.0.66] - 2025-06-19
### Cointime Implementation
- **Added**: Cointime functionality part 1
- **Implemented**: Cumulative destroyed coinblocks and cointime calculations
- **Enhanced**: Bitcoin time-based analytics
### Website
- **Fixed**: Options cumulative possible vecids type issue
- **Enhanced**: Chart options handling
### Documentation
- **Merged**: Pull request #18 with typo fixes from StevenBlack
- **Improved**: Code quality and documentation accuracy
## [v0.0.65] - 2025-06-17
### Website
- **Fixed**: Hang issue when candles fetched are slightly different than before
- **Enhanced**: Chart data fetching reliability
### Documentation
- **Improved**: Minor refinements to brk_cli README
- **Enhanced**: CLI documentation clarity
## [v0.0.64] - 2025-06-17
### Datasets
- **Added**: Multiple new realized datasets and charts
- **Added**: 4-year Z-score calculations
- **Added**: 200-day Simple Moving Average (SMA)
- **Added**: Mayer's Multiple indicator
- **Enhanced**: Financial analysis capabilities
## [v0.0.63] - 2025-06-16
### Website
- **Fixed**: Web interface stutter issue (follow-up fix)
- **Added**: PWA (Progressive Web App) assets
- **Enhanced**: User experience improvements
## [v0.0.62] - 2025-06-16
### Website
- **Fixed**: Stutter on update and save default chart settings to URL parameters
- **Enhanced**: Chart settings persistence
## [v0.0.61] - 2025-06-15
### Website
- **Fixed**: Error in Safari lockdown mode
- **Improved**: Charts now update instead of setData when possible for better performance
### Computer Module
- **Fixed**: OHLC data opening when fetched from different API than previous OHLC (preparation fix)
- **Enhanced**: API data source consistency
## [v0.0.59] - 2025-06-15
### Computer Module
- **Fixed**: Open of OHLC data when fetched from different API than previous OHLC
- **Enhanced**: API data consistency handling
## [v0.0.58] - 2025-06-15
### Bundler
- **Fixed**: BRK bundler usage
- **Removed**: HTML minify crate for improved bundling
- **Deployed**: brk_rolldown bundler with edge case fixes
- **Initialized**: Working bundler version
- **Added**: Basic bundling functionality
### Server
- **Updated**: Cache control for bundled websites (continued improvements)
- **Enhanced**: Website serving performance
- **Enhanced**: Static file serving performance
## [v0.0.56] - 2025-06-13
### Computer Module
- **Enhanced**: Stateful operations now reset when blockchain reorganization detected
- **Improved**: Blockchain state management reliability
## [v0.0.55] - 2025-06-13
### Global
- **Fixed**: Multiple system-wide fixes and improvements
- **Enhanced**: Overall system stability
## [v0.0.54] - 2025-06-12
### Website
- **Enhanced**: Filter possible index choices in charts (initial implementation)
- **Enhanced**: Filter possible index choices in charts
- **Fixed**: CSS styling issues
- **Added**: Auto price series type for default website
- **Added**: Live price functionality
- **Removed**: ScrollToSelected functionality
### Vector Storage
- **Fixed**: Compressed vector functionality (ongoing improvements)
- **Fixed**: Compressed vector functionality (still has slow parallel read performance)
- **Changed**: CLI defaults to raw format for performance
- **Changed**: CLI now defaults to raw format for better performance
### Indexer
- **Enhanced**: Raw format only support
- **Limited**: Now only supports raw format
- **Fixed**: Global system fixes
- **Fixed**: Various global fixes
## [v0.0.52] - 2025-06-11
### Website
- **Fixed**: Service worker and related components
- **Enhanced**: Progressive Web App functionality
## [v0.0.51] - 2025-06-11
### Website
- **Enhanced**: Default website improvements and fixes
## [v0.0.50] - 2025-06-11
### Website
- **Fixed**: Minimum bar spacing for charts
- **Enhanced**: Chart display improvements
## [v0.0.49] - 2025-06-11
### Build System
- **Updated**: Set full version of all crates for better versioning consistency
- **Enhanced**: Cargo workspace version management
### Website
- **Updated**: Multiple default website snapshots and improvements
### Documentation
- **Updated**: README improvements
## [v0.0.48] - 2025-06-09
### Website
- **Enhanced**: Default website snapshots and continued development
## [v0.0.47] - 2025-06-08
### Server
- **Added**: Documentation for index-t-value functionality
- **Added**: Support for `/api/X-to-Y` endpoints
- **Fixed**: Query CLI functionality
- **Added**: Meta API endpoints for better API discoverability
### CLI
- **Added**: Count parameter to query functionality
## [v0.0.46] - 2025-06-08
### Server
- **Added**: DDoS protection for better server security
- **Enhanced**: Request rate limiting and protection
## [v0.0.45] - 2025-06-08
### Website
- **Moved**: Service worker to root directory
- **Updated**: Service worker functionality
- **Enhanced**: PWA capabilities
## [v0.0.44] - 2025-06-07
### Server
- **Fixed**: Existing folder endpoints functionality
- **Enhanced**: File serving reliability
## [v0.0.43] - 2025-06-07
### Website
- **Updated**: Dependencies and fixed CSS issues
- **Enhanced**: Styling and layout improvements
## [v0.0.42] - 2025-06-07
### Global System
- **Fixed**: Multiple system fixes and improvements
- **Enhanced**: System-wide stability improvements
- **Resolved**: Data accuracy issues that were causing incorrect results
### Fetcher
- **Added**: Support for new API endpoints
- **Enhanced**: Data fetching capabilities
### Computer Module
- **Fixed**: Coinblocks overflow issue
- **Enhanced**: Calculation accuracy and stability
- **Increased**: Flush frequency for better data persistence
- **Fixed**: Eager mode functionality
- **Enhanced**: Performance and reliability
### Documentation
- **Reset**: Changelog for clean organization
## [v0.0.40] - 2025-05-25
### Global System
- **Fixed**: Multiple system-wide issues
- **Enhanced**: Overall stability and performance
- **Resolved**: Data accuracy issues in global computations
## [v0.0.39] - 2025-05-25
### UTXO System
- **Implemented**: UTXO dataset functionality (initial part 1)
- **Implemented**: UTXO dataset functionality (part 1)
- **Added**: Foundation for unspent transaction output analysis
- **Added**: Unspent transaction output tracking and analysis
## [v0.0.37] - 2025-05-14
### DCA Analysis
- **Added**: Dollar-Cost Averaging (DCA) classes and analysis
- **Enhanced**: Investment strategy analytics
## [v0.0.36] - 2025-05-13
### Website
- **Added**: Price line functionality to charts
- **Enhanced**: Chart visualization capabilities
## [v0.0.35] - 2025-05-12
### Financial Analytics
- **Added**: Investment return analysis (lump sum vs DCA)
- **Added**: Average and ratio datasets
- **Added**: Market Simple Moving Averages (SMAs)
- **Enhanced**: Financial analysis tools
## [v0.0.34] - 2025-05-09
### Website
- **Added**: Market charts functionality
- **Enhanced**: Chart display and interaction
## [v0.0.33] - 2025-05-08
### Vector Storage
- **Fixed**: Computed vector eager path functionality
- **Enhanced**: Path deletion for lazy vectors
- **Improved**: Vector storage reliability
## [v0.0.32] - 2025-05-08
### Vector Storage - Lazy Computation
- **Completed**: Lazy computation implementation
- **Enhanced**: On-demand vector calculation
- **Improved**: Memory efficiency for large datasets
## [v0.0.31] - 2025-04-30
### Global System
- **Fixed**: Multiple system fixes and improvements
- **Updated**: Fixed old X (Twitter) links that directed to impersonator accounts
- **Enhanced**: Link security and accuracy
### Computer Module
- **Removed**: Last indexes in favor of count-based approach
- **Enhanced**: Index management efficiency
### Vector Storage
- **Improved**: Vector iteration with `into_iter` for range collection
- **Enhanced**: Iterator performance and memory usage
## [v0.0.30] - 2025-04-23
### Website
- **Fixed**: Chart data fetching issues
- **Enhanced**: Data loading reliability
### Global System
- **Added**: Pay-to-Anchor (P2A) support
- **Enhanced**: Bitcoin script type support
- **Improved**: Transaction parsing capabilities
### Storage System
- **Unified**: Single keyspace for all stores using fjall
- **Enhanced**: Storage efficiency and organization
### Vector Storage
- **Implemented**: Lazy/eager computation model
- **Enhanced**: Flexible computation strategies
## [v0.0.29] - 2025-04-22
### Website (Kibo)
- **Fixed**: TypeScript ignore additions for better compilation
- **Enhanced**: Database functionality (part 2)
- **Improved**: Database integration and management
## [v0.0.28] - 2025-04-19
### Website (Kibo)
- **Implemented**: Database functionality (part 1)
- **Added**: Initial database integration for kibo website
### Computer Module
- **Enhanced**: Computer + kibo integration (part 14) with fixes
- **Improved**: Cross-module functionality
## [v0.0.27] - 2025-04-18
### Distribution
- **Fixed**: Tag version formatting issues
- **Enhanced**: Release packaging improvements
## [v0.0.26] - 2025-04-18
### Distribution
- **Fixed**: Ubuntu version compatibility
- **Enhanced**: Linux distribution support
## [v0.0.25] - 2025-04-18
### Distribution
- **Updated**: Ubuntu version for better compatibility
- **Added**: Manual trigger for GitHub Actions
- **Enhanced**: CI/CD pipeline flexibility
## [v0.0.24] - 2025-04-18
### Dependencies
- **Updated**: Upgraded multiple crates for better performance
- **Enhanced**: Dependency management
### Computer Module
- **Enhanced**: Computer + kibo integration (part 13)
- **Cleanup**: Kibo-related code organization
- **Continued**: Computer module development (part 12)
### Documentation
- **Updated**: Parser README documentation
- **Enhanced**: Documentation clarity and completeness
- **Updated**: Discord community links
## [v0.0.23] - 2025-04-14
### Dependencies
- **Updated**: Dependency upgrades across the workspace
- **Enhanced**: Compatibility and performance
- **Enhanced**: System compatibility
### Computer Module
- **Enhanced**: Computer + kibo integration (parts 10-11)
- **Improved**: Cross-component functionality
- **Improved**: Cross-module functionality
## [v0.0.21] - 2025-04-11
### Computer Module
- **Enhanced**: Computer + kibo integration (part 9)
- **Continued**: Ongoing computer module development
## [v0.0.20] - 2025-04-10
### Global Cleanup
- **Cleaned**: Old files and legacy code
- **Enhanced**: Codebase organization
### Vector Storage
- **Reworked**: Vector storage implementation (parts 1-4)
- **Optimized**: Performance improvements
- **Enhanced**: Memory efficiency
## [v0.0.19] - 2025-04-07
### Computer Module
- **Enhanced**: Computer functionality (parts 5-7)
- **Improved**: Data processing capabilities
## [v0.0.18] - 2025-04-05
### Computer Module
- **Enhanced**: Computer functionality (part 4)
- **Continued**: Core computer development
## [v0.0.17] - 2025-04-05
### Distribution
- **Moved**: Configuration to `config.toml` format
- **Enhanced**: Configuration management
### Storage
- **Initialized**: Disk-based storage functionality
- **Enhanced**: Data persistence capabilities
## [v0.0.16] - 2025-04-04
### Server
- **Fixed**: Repository version path issues
- **Enhanced**: Static file serving
## [v0.0.15] - 2025-04-04
### Server
- **Fixed**: Missing 'v' in version handling
- **Enhanced**: Version management
## [v0.0.14] - 2025-04-04
### Server
- **Fixed**: Downloaded repository version path
- **Enhanced**: File path resolution
## [v0.0.13] - 2025-04-04
### Global System
- **Enhanced**: System-wide improvements and snapshots
- **Fixed**: Various stability issues
### Documentation
- **Added**: Warning notices in README
- **Enhanced**: User guidance and safety information
### Website (Kibo)
- **Fixed**: Simulation functionality
- **Enhanced**: User interface improvements
- **Converted**: TypeScript types to JSDoc for better compatibility
- **Upgraded**: Signals library to tresshaked v0.2.4
### Server
- **Added**: API documentation
- **Enhanced**: Development experience
## [v0.0.12] - 2025-04-02
### Server
- **Enhanced**: API documentation and functionality
- **Improved**: Developer experience
### Website (Kibo)
- **Enhanced**: Various improvements (parts 1-5)
- **Changed**: Font from Satoshi to Geist
- **Improved**: Typography and design
### Documentation
- **Updated**: README files with badges and shields
- **Enhanced**: Project presentation
### Dependencies
- **Updated**: Crate updates across workspace
- **Enhanced**: Compatibility and performance
## [v0.0] - 2025-02-23
### Major Project Rewrite
- **BREAKING**: Complete rewrite from legacy "kibo" to modern "BRK" (Bitcoin Research Kit)
- **New**: Modular Rust workspace architecture with separate crates
- **Added**: Modern build system with Cargo workspace
- **Created**: New vector storage engine (`brk_vecs`, later became `vecdb`)
- **Established**: Clear separation between parser, indexer, computer, and server modules
- **Added**: MCP (Model Context Protocol) integration
- **Added**: RESTful API server with multiple output formats
- **Added**: Comprehensive CLI interface
- **Enhanced**: Performance and scalability improvements
---
## Previous Releases (Legacy from kibo project)
<!--
# v0.X.Y | WIP
![Image of the kibo Web App version 0.X.Y](https://github.com/bitcoinresearchkit/brk/blob/main/assets/v0.X.Y.jpg)