Skip to content

V4 Monorepo Documentation

Overview

V4 Monorepo Documentation

Home
Documentation Guide
Getting Started
Getting Started
Development Guides
Development Guides
- Building
  Building
  - CI/CD Guide
- Development
  Development
  - NX Affected Guide
  - NX Tag Strategy
- Git Workflow
  Git Workflow
  - Branch Strategy
  - Visual Branch Flow
- Migration
  Migration
  - Jest to Vitest
  - Shared Libraries
Technology Primers
Technology Primers
Architecture
Architecture
- Visualization
- Repository Structure
- Design Decisions
  Design Decisions
Reference
Reference
- Service Documentation
  Service Documentation
  - Overview
  - Services
    Services
    
    Datastream
    
    Funding
    
    Instruments
    
    Orderbook
    
    Poseidon
    
    Relayer
    
    Sequencer
    
    Websockets
  - Libraries
    Libraries
    
    Chainpyon
    
    Commons
    
    Commons-TS
    
    Connections-TS
    
    Mock Data
    
    Tools
- API Documentation
  API Documentation
  - Orderbook API
  - OpenAPI Spec
- Command Reference
- Standards
  Standards
  - README Standards
- Templates
  Templates
  - Project README Template
  - README Template
- Examples
  Examples
  - Library README
  - Service README
- Tools
  Tools
  - Tools Categorization
Service Diagrams
Service Diagrams
- Data Services
  Data Services
- Trading
  Trading
  - RFQ
  - Sequencer
    Sequencer
    
    Overview
    
    Expiration
    
    Risk Check
- Risk Management
  Risk Management
  - Liquidation Engine
  - Position Selection
- User Operations
  User Operations
  - Deposit
  - Withdraw
  - Cancel All
  - Cancel By ID
  - Smart Account
  - Trading
    Trading
    
    Limit Orders
    
    Market Orders

Migration Guides

This directory contains guides for migrating between technologies and approaches in the v4-monorepo.

Available Guides

Migrating Jest to Vitest - Guide for migrating from Jest to Vitest
Shared Libraries Migration - Plan for migrating to shared libraries