mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 06:39:58 -07:00
52 KiB
52 KiB
Changelog
v0.0.101 - 2025-09-07
Breaking Changes
- SOPR Data Type Migration: Migrated Spent Output Profit Ratio (SOPR) metrics from StoredF32 to StoredF64 for increased precision, requiring data recomputation and version increment for affected vectors (crates/brk_computer/src/stateful/common.rs)
New Features
- Enhanced Mathematical Operations: Added division by Dollars and Sum trait implementation to StoredF64, enabling more comprehensive financial calculations and aggregations (crates/brk_structs/src/structs/stored_f64.rs)
Website Improvements
- Mining Pool Interface Redesign: Streamlined mining pool rewards visualization by consolidating coinbase, subsidy, and fees into a unified rewards interface with improved color coding and better data organization (websites/bitview/scripts/options.js)
- Chart Label Enhancement: Updated mining dominance chart title from generic "Dominance" to specific "Mining Dominance" for better clarity
Performance Improvements
- Parameter Validation Optimization: Enhanced parameter validation limits, increasing maximum vector count from 32 to 64 and adjusting string size limits for better API performance (crates/brk_interface/src/ids.rs)
- Debug Output Cleanup: Removed debug statements from parameter validation functions for cleaner production behavior
Code Quality
- Unused Code Removal: Cleaned up commented allocation profiling code in the computer module for better code maintainability
v0.0.100 - 2025-09-07
New Features
- Performance Profiling: Added comprehensive profiling capabilities with Inferno flamegraph generation, enabling detailed performance analysis and optimization of Bitcoin data processing workflows (Cargo.lock)
- Memory Optimization: Integrated Allocative memory profiling tools across core structs and computer modules, providing detailed heap allocation tracking and memory usage analysis for large-scale blockchain processing (crates/brk_computer/Cargo.toml)
Build System
- Enhanced Git Ignore: Added
bridge/directory to gitignore patterns for cleaner repository management (.gitignore)
Performance Infrastructure
- Advanced Profiling Stack: Complete profiling infrastructure with flamegraph generation, memory allocation tracking, and performance bottleneck identification tools for production-scale Bitcoin analysis
- Memory Allocation Tracking: Deep integration of allocative derive macros throughout the codebase enabling precise memory usage monitoring during blockchain data processing
v0.0.98 - 2025-09-05
New Features
- Mining Pool Analysis: Added comprehensive mining pool detection and analysis tools with example implementation demonstrating pool identification from coinbase transaction tags (crates/brk_computer/examples/pools.rs)
- Enhanced Caching: Integrated
quick_cachedependency to the interface layer for improved performance of frequently accessed data and search results (Cargo.toml) - Advanced Chain Analytics: Added comprehensive block count target metrics for all time intervals (daily, weekly, monthly, quarterly, semester, yearly, decade) enabling analysis of Bitcoin mining performance against expected block production rates (crates/brk_computer/src/chain.rs)
Developer Experience
- Enum-based Configuration: Added
num_enumdependency to the computer module for improved type-safe configuration handling and better API ergonomics (crates/brk_computer/Cargo.toml)
v0.0.96 - 2025-09-03
New Features
- Fuzzy Search Integration: Added nucleo-matcher dependency to the interface layer, enabling fast fuzzy string matching capabilities for dataset and vector name searches (crates/brk_interface/Cargo.toml)
Development Environment
- Zed Editor Support: Added Zed editor configuration with optimized file scan exclusions for better performance when working with the codebase, excluding generated assets and large dependency files (.zed/settings.json)
- Git Ignore Enhancement: Added
/ids.txtto gitignore patterns and removed redundant editor-specific entries for cleaner repository management (.gitignore)
v0.0.95 - 2025-08-28
New Features
- Enhanced Profit/Loss Analytics: Added comprehensive unrealized profit plus loss tracking with both height-based and date-indexed vectors, enabling analysis of total unrealized positions regardless of profit or loss status (crates/brk_computer/src/stateful/common.rs)
- Cohort-Relative Market Cap Metrics: Introduced cohort-specific market cap relative metrics, calculating unrealized profit/loss percentages relative to each cohort's own market capitalization rather than total Bitcoin market cap for more accurate cohort analysis
- Profit/Loss Proportion Analysis: Added new metrics showing unrealized profit and loss relative to the cohort's own total unrealized profit plus loss, providing insight into the internal composition of unrealized positions
Performance Improvements
- Computation Optimization: Enhanced computation logic for unrealized metrics with dedicated addition operations between profit and loss vectors, improving calculation accuracy and reducing redundant operations
v0.0.94 - 2025-08-28
Breaking Changes
- Website Rebranding: Replaced "Default" website option with "Bitview" option, aligning with the new
bitview.spacebranding and updated default configuration (crates/brk_cli/src/website.rs)
New Features
- Extended Analytics: Added comprehensive 30-day exponential moving averages (EMA) for key Bitcoin metrics including Spent Output Profit Ratio (SOPR), Adjusted SOPR, and Sell Side Risk Ratio, providing enhanced trend analysis capabilities (crates/brk_computer/src/stateful/common.rs)
- Market Cap Relative Metrics: Introduced unrealized profit and loss metrics relative to market cap, enabling better understanding of market valuation extremes and profit-taking behavior
- Enhanced Block Analytics: Added comprehensive statistical analysis options (min/max, averages, percentiles) for block-related datasets including transaction counts and block sizes (crates/brk_computer/src/blocks.rs)
API Changes
- Parameter Reordering: Improved function parameter organization in stateful computations by moving
extendedparameter beforecompute_relative_to_allfor better logical flow (crates/brk_computer/src/stateful/address_cohort.rs)
Documentation
- Website Updates: Updated README to reflect new primary website URL
bitview.spaceand streamlined hosting service descriptions (README.md)
v0.0.93 - 2025-08-26
Website Frontend Enhancements
- Screenshot Mode: Added comprehensive screenshot mode functionality to the default website, enabling clean chart captures by automatically hiding interactive elements like legends, buttons, and controls when screenshot mode is activated (websites/default/index.html)
- API Migration: Updated custom website examples to use the new
bitview.spaceAPI endpoint instead of the deprecatednext.bitray.xyzendpoint (websites/custom/index.html)
Development Documentation
- TODO Cleanup: Streamlined development TODO list by removing completed or outdated items, focusing on current priorities like rollback functionality, cost basis percentiles, and oracle price datasets (TODO.md)
Package Management
- TypeScript Definitions: Added comprehensive TypeScript definitions for the uFuzzy library, enabling better type safety and development experience for fuzzy search functionality (websites/default/packages/leeoniya-ufuzzy/1.0.18/dist/uFuzzy.d.ts)
- Enhanced Ignore Patterns: Improved package directory gitignore patterns to exclude additional development files and TypeScript definitions
v0.0.91 - 2025-08-26
Performance Improvements
- Constants Module Refactoring: Major refactoring of constants computation from repetitive individual calculations to efficient loop-based processing, significantly reducing code duplication and improving maintainability (crates/brk_computer/src/constants.rs)
- Additional Constants: Added
constant_144andconstant_600vectors
Documentation Updates
- TODO Improvements: Updated TODO list with more specific terminology, changing "prices paid by percentile" to "costs basis by percentile" for better accuracy (TODO.md)
v0.0.90 - 2025-08-24
Documentation
- Release Preparation: Converted "Unreleased" section in CHANGELOG to proper v0.0.89 release entry, finalizing comprehensive documentation of all major changes including computer module refactoring, enhanced README files, and build system improvements
Build System
- CI/CD Enhancement: Added
allow-dirty = ["ci"]configuration to cargo-dist metadata, enabling more flexible CI builds when repository contains uncommitted changes during release processes (Cargo.toml)
v0.0.89 - 2025-08-24
Breaking Changes
- Changelog Format Overhaul: Complete rewrite of CHANGELOG.md with new format and comprehensive documentation of all changes, replacing previous minimal entries with detailed descriptions of functionality and impact
Development Workflow
- Git Ignore Updates: Refined git ignore patterns, changing from generic
distto specificwebsites/distfor better build artifact management, and added.claudeandCLAUDE*.mdpatterns for AI development tools (.gitignore)
Documentation
- Comprehensive Changelog: Extensively documented all changes from v0.0.88 down to v0.0.31, providing detailed descriptions of features, fixes, and improvements across all BRK components
- Historical Documentation: Added detailed explanations for vector storage improvements, MCP integration, website enhancements, build system updates, and performance optimizations from previous releases
v0.0.88 - 2025-08-10
Build System Improvements
- Rust Version Specification: Added minimum supported Rust version (MSRV) requirement of 1.89 across all workspace crates, ensuring compatibility and enabling use of latest Rust features (Cargo.toml)
Web Interface Enhancements
- Dynamic Chart Configuration: Improved Spent Output Profit Ratio (SOPR) chart rendering by implementing conditional display logic for Adjusted SOPR (ASOPR) metrics, only showing ASOPR data when available in the dataset (websites/default/scripts/options.js)
- Chart Performance Optimization: Refactored chart data filtering to reduce unnecessary rendering operations by checking data availability before creating chart series configurations
Code Quality
- Workspace Standardization: Unified
rust-versionspecification across all crate manifests, improving build consistency and enabling workspace-wide tooling optimizations
v0.0.87 - 2025-08-10
Breaking Changes
- Vector Storage Architecture Refactor: Replaced internal
brk_vecscrate with externalizedvecdbcrate, moving vector storage functionality to a separate project while maintaining the same core functionality (Cargo.toml)
Architecture Improvements
- Crate Externalization: Migrated vector storage implementation from internal
brk_vecsandbrk_vecs_macrosto externalvecdbandvecdb_derivecrates, enabling independent development and versioning of the vector storage system - Sequential Database Foundation: Added
seqdbas the underlying sequential data storage engine powering the vector database functionality - Workspace Simplification: Removed
brk_vecsandbrk_vecs_macrosfrom the workspace, reducing codebase complexity and focusing on Bitcoin-specific functionality (crates/brk/Cargo.toml)
API Changes
- Vector Interface Consistency: Updated all vector references from
brk_vecstovecdbwhile maintaining identical API surface for seamless transition (crates/brk/src/lib.rs) - Documentation Updates: Updated README and project documentation to reflect the new external vector database dependency (README.md)
Development Experience
- Modular Development: Enables independent development of vector storage functionality separate from Bitcoin analysis logic
- Local Development Support: Added commented local path configuration for easier development workflow when working on both projects simultaneously
v0.0.85 - 2025-08-07
Bug Fixes
- Logging Filter Correction: Fixed typo in logger filter configuration, changing
rmcp=offtobrk_rmcp=offto properly suppress unwanted logs from the RMCP protocol module (crates/brk_logger/src/lib.rs)
Configuration Changes
- MCP Server Configuration: Removed stateful mode setting from MCP server configuration, enabling more flexible protocol handling and improved compatibility with different client implementations (crates/brk_mcp/src/route.rs)
v0.0.84 - 2025-08-07
Breaking Changes
- Major Architecture Restructuring: Complete reorganization of the codebase with extraction of core functionality into dedicated crates (
brk_structs,brk_error) and comprehensive modularization of all components for better maintainability and reusability - Struct System Overhaul: Moved all Bitcoin-related structures from
brk_coreto newbrk_structscrate with enhanced grouping capabilities, comprehensive address types, and improved serialization support (crates/brk_structs/src/lib.rs)
New Features
- Centralized Error Handling: Introduced
brk_errorcrate providing unified error handling across all BRK components with comprehensive error types for different subsystems (crates/brk_error/src/lib.rs) - Advanced Address Analytics: Enhanced address grouping system with comprehensive filtering capabilities including by address type, amount ranges, age ranges, epochs, terms, and spendable/unspendable classifications (crates/brk_structs/src/groups/mod.rs)
- Vector Macro System: Added
brk_vecs_macroscrate providing procedural macros for automated vector trait implementations and boilerplate reduction (crates/brk_vecs_macros/src/lib.rs) - Enhanced Data Types: Comprehensive Bitcoin data type system including transaction IDs, block hashes, raw locktime, version numbers, and specialized index types for all Bitcoin primitives (crates/brk_structs/src/structs/mod.rs)
Architecture Improvements
- Modular Design: Complete separation of concerns with dedicated crates for different functionality areas, enabling better code organization and independent versioning
- Build System Enhancement: Added comprehensive build scripts across all crates with
cargo-distintegration for automated release management and distribution (.github/workflows/release.yml) - Price Analysis: New dedicated price analysis module with enhanced market data processing and price-to-amount state tracking (crates/brk_computer/src/price.rs)
Developer Experience
- Comprehensive Documentation: Added README files and examples for all major crates, providing clear usage instructions and API documentation
- Enhanced Examples: Expanded example collection demonstrating various BRK components and usage patterns across all crates
- Development Tools: Improved development workflow with better build scripts, dependency management, and testing infrastructure
Performance Improvements
- Vector System: Enhanced vector system with improved compression, better memory management, and optimized I/O operations through the redesigned
brk_vecsarchitecture - State Management: Improved state tracking with dedicated modules for block states, realized/unrealized values, supply tracking, and transaction analysis
Infrastructure
- CI/CD Enhancement: Updated GitHub Actions workflow with improved Ubuntu runner (22.04) and enhanced release automation
- Docker Improvements: Enhanced Docker configuration with better environment handling and deployment options
Social Media
- Platform Updates: Updated social media links removing outdated platforms and focusing on active community channels (README.md)
v0.0.83 - 2025-07-26
New Features
- Cross-Platform Hole Punching: Added Linux support for file hole punching operations using
fallocatesystem call, expanding platform compatibility beyond macOS for efficient sparse file management (crates/brk_vecs/src/file/mod.rs)
Performance Improvements
- Platform-Specific Optimization: Implemented platform-specific hole punching strategies with optimized system calls for both macOS (
fcntlwithF_PUNCHHOLE) and Linux (fallocate), improving storage efficiency and I/O performance on different operating systems
Internal Changes
- Code Organization: Refactored hole punching implementation with unified
punch_hole_impl()method that dispatches to platform-specific implementations, improving code maintainability and reducing duplication - Error Handling: Enhanced error handling for unsupported platforms with clear error messages for hole punching operations
v0.0.82 - 2025-07-26
Breaking Changes
- Vector System Refactoring: Replaced
brk_vecwith newbrk_vecscrate, introducing a completely redesigned vector storage system with improved file layouts, better compression, and enhanced performance characteristics (crates/brk_vecs/src/lib.rs)
New Features
- Advanced Vector Architecture: Introduced comprehensive vector system with multiple storage variants including
RawVec,CompressedVec,ComputedVec,EagerVec,LazyVec, andStampedVecfor different use cases and performance requirements (crates/brk_vecs/src/variants/mod.rs) - File-Based Storage: New file-based storage system with dedicated
FileandReaderimplementations, featuring page-based architecture and memory mapping for efficient disk I/O (crates/brk_vecs/src/file/mod.rs) - Stamped Vectors: Added timestamped vector support with
StampedVecandStampstructures for versioned data management and temporal analysis (crates/brk_vecs/src/variants/stamped/mod.rs)
Architecture Improvements
- Lazy Computation: Enhanced lazy evaluation system with support for 1, 2, and 3-source computed vectors, enabling complex data transformations with minimal memory overhead (crates/brk_vecs/src/variants/lazy/mod.rs)
- Compression Optimization: Redesigned compression system with page-based metadata management and improved compression ratios for large datasets (crates/brk_vecs/src/variants/compressed/mod.rs)
- Type System Enhancement: Improved trait system with dedicated interfaces for different vector operations, providing better type safety and performance (crates/brk_vecs/src/traits/mod.rs)
Performance Improvements
- Build Optimization: Updated build scripts to focus on release builds for better performance in production deployments (update.sh)
- Memory Management: Enhanced memory usage patterns with better file mapping strategies and reduced memory footprint for large-scale Bitcoin data processing
Infrastructure
- Comprehensive Examples: Added extensive examples demonstrating various vector types and usage patterns for better developer onboarding (crates/brk_vecs/examples/)
- Documentation: Enhanced documentation with detailed explanations of vector architectures and storage strategies
Internal Changes
- Address Handling: Improved address byte hash management and height-based indexing for better address analytics performance
- Group Processing: Enhanced address and UTXO grouping capabilities with better filtering and processing mechanisms
- Error Handling: Refined error handling throughout the vector system for more robust data operations
v0.0.81 - 2025-07-17
Breaking Changes
- Computer Module Restructuring: Major reorganization of the computer module from nested
vecsstructure to flat module layout, moving vector implementations directly into separate modules (all,blocks,cointime,constants,fetched,grouped,indexes,market,mining,stateful,transactions) for better maintainability (crates/brk_computer/src/lib.rs)
New Features
- Docker Support: Added comprehensive Docker setup with Dockerfile, docker-compose configuration, environment templates, and detailed documentation for containerized BRK deployment (docker/README.md)
- Address Index System: Implemented new address indexing architecture with
AnyAddressIndex,EmptyAddressIndex, andLoadedAddressIndexstructures for more efficient address data management (crates/brk_core/src/structs/anyaddressindex.rs) - Enhanced Address Grouping: Added comprehensive address filtering and grouping capabilities with
by_address_type,by_any_address, and flexible filter systems (crates/brk_core/src/groups/mod.rs)
Architecture Improvements
- Stateful Processing: Enhanced stateful vector processing with dedicated traits and improved address data source handling (crates/brk_computer/src/stateful/trait.rs)
- Address Analytics: Added sophisticated address counting and analysis capabilities with support for different address types and cohort analysis
- Module Organization: Flattened module hierarchy eliminating nested structures for clearer code organization and easier navigation
Infrastructure
- Container Deployment: Full Docker containerization support with multi-stage builds, environment configuration, and production-ready setup
- Build Optimization: Enhanced build scripts and profiling tools for better development workflow
Documentation
- Website Updates: Added
brekit.orgas primary domain in README alongside existing mirrors (README.md) - Docker Guide: Comprehensive Docker setup and deployment documentation with prerequisites, configuration, and usage instructions
v0.0.80 - 2025-07-13
Performance Improvements
- Vector Length Caching: Added local length caching in raw vectors with
local_stored_lenfield, reducing atomic operations and improving read performance by storing frequently accessed length values locally (crates/brk_vec/src/variants/raw.rs)
API Enhancements
- Length Management: Introduced
set_stored_len()method for direct length management, providing better control over vector metadata and synchronization between local and shared length values
Documentation
- README Cleanup: Removed detailed AI example links from main README to streamline content and focus on core functionality, improving readability and reducing maintenance overhead (README.md)
- MCP Documentation: Added dedicated README for Model Context Protocol integration with comprehensive usage examples and setup instructions (crates/brk_mcp/README.md)
Internal Changes
- Vector Architecture: Enhanced raw and compressed vector implementations with improved length tracking mechanisms for better performance and consistency
v0.0.79 - 2025-07-13
Performance Improvements
- File Handle Optimization: Reduced minimum file handle limit from 250,000 to 10,000, significantly lowering system resource requirements while maintaining adequate file access for most Bitcoin datasets (crates/brk_core/src/utils/rlimit.rs)
Breaking Changes
- Vector Memory Architecture: Replaced
ArcSwap<Mmap>withArc<AtomicUsize>for stored length tracking in raw vectors, eliminating memory mapping overhead and improving concurrent access patterns while reducing memory usage (crates/brk_vec/src/variants/raw.rs)
Internal Changes
- Vector Storage Simplification: Removed arc-swap dependency from vector variants, streamlining memory management and reducing complexity in concurrent scenarios
- Store Integration: Enhanced indexer store integration with better error handling and resource management
- Header Management: Improved vector header handling for more efficient metadata operations
v0.0.78 - 2025-07-13
New Features
- Semester Index Support: Added
SemesterIndexstruct for 6-month interval datasets, enabling bi-annual analysis of Bitcoin metrics with proper serialization and mathematical operations (crates/brk_core/src/structs/semesterindex.rs) - Enhanced Vector Architecture: Refactored vector computation infrastructure with improved
VecBuilderOptionsandSourcehandling for more flexible dataset generation (crates/brk_computer/src/vecs/grouped/builder_computed.rs)
Architecture Improvements
- Vector Builder Refactoring: Renamed
StorableVecGeneatorOptionstoVecBuilderOptionsfor better naming consistency and enhanced vector generation capabilities - Cointime Integration: Enhanced cointime computation with better indexing support and computation parameter handling
- Profiling Tools: Added dedicated flamegraph and samply profiling scripts for the computer module to aid performance analysis
Development Experience
- Documentation Updates: Expanded TODO list with additional feature requests including chopiness datasets, reused address analytics, z-score chart improvements, and HTTPS support
- Profiling Support: Added flamegraph.sh and samply.sh scripts to the computer module for better performance debugging capabilities
v0.0.76 - 2025-07-09
Build System Updates
- Rolldown Bundler: Updated
brk_rolldownfrom 0.1.0 to 0.1.1 with improvements across all bundler components including enhanced ECMAScript utilities, better plugin architecture, and improved string manipulation capabilities (crates/brk_bundler/Cargo.toml)
v0.0.75 - 2025-07-09
Performance Improvements
- Chunk Size Optimization: Adjusted parallel processing chunk size from length/4 to length/3, increasing parallelization granularity for better performance on high-end storage systems while maintaining external drive protection (crates/brk_computer/src/vecs/stateful/mod.rs)
v0.0.74 - 2025-07-09
Performance Improvements
- Parallel Processing Optimization: Refactored stateful vector computation to use chunked parallel processing with controlled chunk sizes (length/4) instead of unbounded parallelization, preventing external drive bottlenecks and improving performance on Thunderbolt 4 SSDs (crates/brk_computer/src/vecs/stateful/mod.rs)
- Thread Scope Elimination: Replaced complex thread scope management with streamlined Either-based collection processing, reducing threading overhead and improving memory usage patterns during computation
Bug Fixes
- Memory Table Rotation Logging: Fixed missing log message for memory table rotation operations, improving debugging and monitoring capabilities during store operations (crates/brk_computer/src/stores.rs)
Internal Changes
- Computation Architecture: Unified UTXO and address vector processing using Either enum for type-safe handling of different vector types while maintaining performance through parallel iteration
- Chunk-based Processing: Implemented intelligent chunking strategy to prevent overwhelming external storage devices while maintaining parallelization benefits
v0.0.73 - 2025-07-09
Breaking Changes
- Architecture Restructuring: Removed
brk_statecrate entirely, consolidating its functionality intobrk_computerwith direct store and serialization dependencies, simplifying the overall architecture and reducing module complexity - Build System Upgrade: Updated
brk_rolldownbundler from 0.0.1 to 0.1.0 with significant API changes including removal of deprecated loader utilities and addition of hot module replacement support
New Features
- Hot Module Replacement: Added HMR plugin support for improved development experience with live code updates and faster iteration cycles during bundling operations
- Advanced Hashing: Integrated Blake3 hashing algorithm for improved performance in debug operations and file integrity verification
Internal Changes
- Computer Module Enhancement: Added bincode serialization, zerocopy optimizations, and derive_deref functionality directly to the computer module for better performance
- Store Integration: Enhanced store module with logging capabilities for better debugging and monitoring
- Plugin Architecture: Expanded bundler plugin system with data URI support and improved ECMAScript utilities
v0.0.71 - 2025-06-25
New Features
- Enhanced Schema Documentation: Added comprehensive descriptions to all Index enum variants and API parameters, providing clear explanations for date/day index, height/block index, transaction indexes, address types, and time periods for better API usability (crates/brk_interface/src/index.rs, crates/brk_interface/src/params.rs)
API Changes
- MCP Tool Modernization: Upgraded Model Context Protocol implementation to use new
tool_routerandParameterswrapper for better type safety and parameter handling, replacing legacytool_boxapproach (crates/brk_mcp/src/lib.rs) - Endpoint Renaming: Renamed
get_variant_counttoget_vec_countfor better consistency with API terminology
Internal Changes
- Development Flexibility: Added commented local development path for
brk_rmcpto facilitate easier testing and development workflows
v0.0.70 - 2025-06-24
New Features
- Model Context Protocol Default: Enabled MCP (Model Context Protocol) by default for LLM integration, changing from opt-in to opt-out behavior to make AI-powered Bitcoin data analysis more accessible (crates/brk_cli/src/config.rs)
API Changes
- Simplified Endpoints: Streamlined API endpoints by replacing complex query parameters with dedicated paths (
/height-to-ohlcand/dateindex-to-ohlc) for cleaner and more intuitive data access (crates/brk_fetcher/src/brk.rs)
Internal Changes
- Module Restructuring: Flattened fetcher module structure by moving fetcher implementations directly into the main crate, eliminating nested module hierarchy for better maintainability
- Documentation: Updated API badge URL to reflect new vec-count endpoint and improved MCP tool description clarity (README.md)
- Code Cleanup: Removed commented debug code and unused file handle references from raw vector implementation
v0.0.69 - 2025-06-24
Performance Improvements
- Vector Initialization Optimization: Removed thread-based parallel initialization of indexes and fetched vectors, replacing with sequential initialization to reduce overhead and improve memory usage patterns during startup (crates/brk_computer/src/vecs/mod.rs)
- File Handle Management: Refactored vector file handling architecture to use on-demand file opening instead of persistent file handles, reducing memory footprint and file descriptor usage (crates/brk_vec/src/variants/raw.rs)
Internal Changes
- Resource Limit Adjustment: Reverted file handle limit back to 210,000 from 420,000, optimizing for more conservative resource usage
- Header Write Logic: Simplified vector header writing by removing conditional logic and always performing write operations when needed, improving code clarity and reducing potential race conditions (crates/brk_vec/src/structs/header.rs)
- Memory Map Updates: Refactored memory map update logic to accept file references directly, eliminating need for persistent file handle storage and improving resource management
- Code Cleanup: Removed unused imports and simplified vector trait implementations for better maintainability
v0.0.68 - 2025-06-24
New Features
- CLI Version Information: Added version command support to CLI configuration, enabling users to check the current version of BRK directly from the command line (crates/brk_cli/src/config.rs)
Performance Improvements
- File Handle Limits: Doubled the minimum file handle limit from 210,000 to 420,000 to accommodate larger Bitcoin datasets and prevent resource exhaustion during intensive blockchain processing operations (crates/brk_core/src/utils/rlimit.rs)
v0.0.67 - 2025-06-24
New Features
- Data Interface Layer: Added
brk_interfacecrate providing a comprehensive data interface layer with serialization, schema generation, and tabular formatting capabilities for exporting datasets in multiple formats (JSON, CSV, TSV, Markdown) - Model Context Protocol Support: Introduced
brk_mcpcrate implementing Model Context Protocol (MCP) for seamless integration with Large Language Models, enabling AI-powered Bitcoin data analysis and querying - External MCP Integration: Added
brk_rmcpexternal dependency for robust MCP client/server communication capabilities
Breaking Changes
- Dependency Restructuring: Removed direct
brk_querydependency from CLI, replaced with modularbrk_interfaceandbrk_mcparchitecture for better separation of concerns - Storage Simplification: Removed
arc-swapandfjalldependencies frombrk_state, streamlining state management architecture
Internal Changes
- Build System: Added auto-generated
vecid-to-indexes.jsfile to gitignore to prevent version control conflicts - Documentation Updates: Updated historical changelog entries to reflect correct repository URLs and asset paths, migrating from kibo-money references to bitcoinresearchkit organization
- Dependency Updates: Updated multiple core dependencies including
async-compression,autocfg,errno, andsynto their latest versions for improved performance and compatibility
v0.0.66 - 2025-06-19
New Features
- Cointime Analysis: Added comprehensive cointime economic metrics including coinblocks creation/storage tracking, liveliness and vaultedness calculations, activity ratios, and specialized price metrics (vaulted price, active price, true market mean, cointime price) with corresponding market cap calculations (crates/brk_computer/src/vecs/cointime.rs)
- Advanced Supply Analysis: Implemented vaulted and active supply tracking with dollar value computations, enabling analysis of Bitcoin storage behavior and economic activity patterns
Documentation
- CLI Documentation: Improved CLI README with better formatting, clearer installation instructions, enhanced usage examples, and restructured content with proper markdown syntax and information blocks (crates/brk_cli/README.md)
- Installation Guidance: Added prominent installation notes for Ubuntu users and improved download section formatting with better link formatting and structure
Internal Changes
- Ratio Analysis Integration: Connected cointime price metrics with ratio analysis system for comprehensive trend analysis across vaulted price, active price, true market mean, and cointime price ratios
v0.0.65 - 2025-06-17
Bug Fixes
- Chart Data Update Logic: Simplified chart data update algorithm by removing complex comparison logic and replacing it with a streamlined approach that updates all data points at or after the last known time, significantly reducing complexity and potential update conflicts (websites/default/packages/lightweight-charts/wrapper.js)
Internal Changes
- Cohort Analysis Versioning: Incremented version numbers for cumulative net realized profit/loss metrics from VERSION::TWO to VERSION::new(3), ensuring proper cache invalidation and data consistency for cohort analysis computations (crates/brk_computer/src/vecs/stateful/cohort.rs)
v0.0.64 - 2025-06-17
New Features
- 4-Year Statistical Analysis: Added comprehensive 4-year moving averages and standard deviation calculations for ratio analysis, enabling long-term trend analysis with
ratio_4y_sma,ratio_4y_sd, andratio_4y_zscoremetrics (crates/brk_computer/src/vecs/grouped/ratio_from_dateindex.rs) - Z-Score Computation Optimization: Refactored z-score calculations to use a dedicated
compute_zscore()method, improving code maintainability and performance by centralizing statistical computations
Internal Changes
- Vector Naming Convention: Renamed
ratio_standard_deviationtoratio_sdfor consistency with other abbreviated metric names - Statistical Method Extraction: Extracted z-score computation logic into reusable methods, reducing code duplication and improving mathematical accuracy
- Vector Builder Enhancement: Added conditional naming logic in grouped vector builder for better handling of sum operations with optional suffixes
v0.0.63 - 2025-06-16
New Features
- Static File Caching: Implemented intelligent HTTP caching strategy for static assets, setting immutable cache headers for long-term assets (images, fonts, JavaScript, map files) and must-revalidate headers for HTML and service worker files to ensure optimal performance and cache invalidation (crates/brk_server/src/files/file.rs)
- Progressive Web App Assets: Added comprehensive PWA assets including Apple Touch icons, splash screens for all iOS device sizes and orientations, and maskable icons for Android, enabling native app-like experience across all mobile platforms
Internal Changes
- File Extension Detection: Refactored file extension checking from string-based
ends_with()pattern matching to more robustPath::extension()method for better accuracy and maintainability - Cache Logic Simplification: Consolidated cache control logic by removing redundant file path checks and grouping related file types for cleaner code organization
v0.0.62 - 2025-06-16
Bug Fixes
- TypeScript Bridge Generation: Fixed JavaScript/TypeScript bridge generation by properly handling optional return values when reading hashed main.js entry files, preventing crashes when entry files don't exist (crates/brk_bundler/src/lib.rs)
- TypeScript Type Generation: Restructured TypeScript type definitions for VecIdToIndexes, moving typedef comments outside function declaration for proper type recognition (crates/brk_server/src/api/query/bridge.rs)
New Features
- Chart Time Scale Optimization: Improved time scale spacing for different chart time periods with more balanced bar spacing (quarters: 3→2, years: 12→6, decades: 120→60) for better visual density (websites/default/packages/lightweight-charts/wrapper.js)
- Progressive Web App Support: Added service worker scope configuration and improved PWA manifest handling for better standalone app experience
Internal Changes
- Chart Data Processing: Refactored chart data handling to use object destructuring instead of arrays, improving code clarity and type safety in effect callbacks
- HTML Standards: Updated HTML5 DOCTYPE declaration and improved syntax consistency
- Error Handling: Added try-catch protection for localStorage operations to prevent crashes in restricted environments
v0.0.61 - 2025-06-15
New Features
- OHLC Price Continuity: Added logic to maintain price continuity between days in OHLC data computation by setting today's opening price to the previous day's closing price, ensuring no gaps in price series when computing daily OHLC from fetched data (crates/brk_computer/src/vecs/fetched.rs)
Internal Changes
- Struct Mutability: Added
DerefMuttrait to all OHLC struct variants (OhlcF64, OhlcBtc, OhlcSats, OhlcUsd) enabling mutable access to underlying values - Error Handling: Improved file creation error handling in block recap export with more descriptive panic messages