How intersectmbo/cardano-db-sync works
Main Components
a. External Components:
• Cardano Node (connected via Unix domain socket)
• PostgreSQL Database
• External Applications (read-only access)
b. Core Components:
• cardano-db-sync (main service)
• cardano-db (database interface layer)
• cardano-db-tool (database management)
• cardano-smash-server (pool metadata service)
Architecture Layers
a. Network Layer:
• Chain Sync Protocol Interface
• Local State Query Interface
• Unix Domain Socket Connection
b. Processing Layer:
• Block Processing
• Ledger State Management
• Transaction Processing
• Era-specific Handlers (Byron, Shelley, Alonzo, Babbage, Conway)
c. Database Layer:
• Schema Management
• Migration Handling
• Query Operations
• Data Validation
Data Flow Representation
• Data flow from Cardano Node → DB Sync
• Block/Transaction processing flow
• Database write operations
• Read queries from external applications
Component Details
a. Cardano DB Sync:
• Chain following mechanism
• Block processor
• State management
• Era-specific handlers
• Rollback handling
b. Database Layer:
• Schema versioning
• Migration management
• CRUD operations
• Validation rules
Key Interactions
Specific interactions for:
• Block synchronization
• State updates
• Database migrations
• External queries
• Pool metadata handling
Architectural Patterns
Highlight:
• Event-driven processing
• Pipeline processing
• State management
• Data validation
• Error handling
[External Cardano Node] ←→ [Unix Socket]
• ↓
[Cardano DB Sync Core]
• ↓ ↓ ↓
[Block [State [Transaction
Processor] Manager] Processor]
• ↓ ↓ ↓
[Database Interface Layer]
• ↓
[PostgreSQL Database] ←→ [External Applications]
Detailed annotations for:
• System requirements
• Data flow directions
• Component responsibilities
• Integration points
• Error handling paths
• Validation checkpoints
This design should emphasize the system's ability to:
• Follow the Cardano blockchain
• Maintain ledger state
• Process and store blockchain data
• Handle different blockchain eras
• Manage database schema evolution
• Support external application queries
• Handle rollbacks and chain reorganizations
Remember to maintain a balance between detail and clarity, focusing on the key architectural components while providing enough detail for implementation guidance.