How hirosystems/clarinet works
Main System Components
• Clarinet CLI (clarinet-cli)
• Clarity REPL (clarity-repl)
• SDK Components (clarinet-sdk)
• LSP Support (clarity-lsp)
• Network Components (stacks-network)
• Deployment Manager (clarinet-deployments)
• File System Handler (clarinet-files)
• Utilities (clarinet-utils)
• Event System (clarity-events)
Architectural Layers
User Interface Layer:
• CLI Interface
• VS Code Extension
• Jupyter Kernel Interface
Core Processing Layer:
• REPL Engine
• Contract Analysis Tools
• Deployment Manager
• Debug Adapter
Infrastructure Layer:
• Network Interfaces (Devnet/Testnet/Mainnet)
• File System
• Event System
Integration Points
Interactions with external systems:
a) Development Environment:
• VS Code Integration
• Docker Container System
• Local Development Network
b) Blockchain Networks:
• Stacks Network
• Bitcoin Network
• Hyperchain Support
Data Flow Patterns
a) Contract Development Flow:
Developer Tools → Contract Analysis → Testing → Deployment
b) Debug Flow:
VS Code/CLI → Debug Adapter → REPL Engine → Contract Execution
Key Features to Highlight
Create specific sections showing:
a) Testing Infrastructure:
• Test Runner
• Coverage Analysis
• Check Checker System
b) Development Tools:
• Contract Templates
• Project Generation
• Deployment Planning
Component Relationships
Clear relationships between:
a) Internal Components:
• CLI → REPL
• REPL → Network
• SDK → Deployment Manager
b) External Systems:
• VS Code Extension → LSP
• Clarinet → Blockchain Networks
• Developer Tools → CI/CD Systems