V4 Monorepo Documentation

V4 Monorepo Documentation

Welcome to the comprehensive documentation for the V4 Monorepo. This site contains detailed guides, architecture documentation, and reference material for developers working with the codebase.

Start Here

Guide for New Developers

Get up to speed quickly with our onboarding guide, project structure overview, and development workflow documentation.

Get Started

Architecture Overview

Understand the system architecture, service interactions, and key design decisions that shape the platform.

Explore Architecture

Diagrams

View system architecture and workflow diagrams to understand how components work together.

View Diagrams

Key Documentation

Services

Explore the documentation for individual services that make up the platform:

• Datastream
• Funding
• Instruments
• Orderbook
• Poseidon
• Relayer
• Sequencer
• Websockets

All Services

Shared Libraries

Learn about the shared libraries that power our services:

• Commons-TS: TypeScript utilities
• Connections-TS: Database connections
• Chainpyon: Web3 Python utilities

All Libraries

Architecture Decisions

Review key architecture decisions and their rationales:

• TypeScript Configuration
• Build Policy
• NX Optimization

Popular Topics

• CI/CD Pipeline
• NX Affected Guide
• Migrating from Jest to Vitest
• README Standardization

---

!!! info "Mermaid Diagram Issues?" If you have trouble viewing the Mermaid diagrams (workflow charts, etc.), visit the Basic Diagrams page which contains guaranteed-to-display versions, or see the Fix Diagram Issues page for technical solutions.