# nickchal1/matchingengine0 architecture

> Architecture diagram of the GitHub repository nickchal1/matchingengine0, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nickchal1/matchingengine0
- Repository: https://github.com/nickchal1/matchingengine0
- Video tour (about a minute): https://gitdiagram.com/nickchal1/matchingengine0/video

## Overview

MatchingEngine0 is a single-instrument limit order book with a TCP demo interface. The main workflow generates NewOrder messages in the client, encodes them, sends them to the server, decodes complete messages, submits them to the book, and displays trades and book state. The engine also supports cancellation and book queries through its API, though the demo server does not expose those operations. Edges reflect the sampled source and README; the documented cancellation/query capabilities are included without guessing at unsampled callers.

Main entry points: [`server.cpp`](https://github.com/nickchal1/matchingengine0/blob/main/server.cpp) (TCP Server), [`engine/OrderBook.h`](https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.h) (Order Book API), [`client.cpp`](https://github.com/nickchal1/matchingengine0/blob/main/client.cpp) (Order Generator), [`protocol/Protocol.cpp`](https://github.com/nickchal1/matchingengine0/blob/main/protocol/Protocol.cpp) (Message Codec)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_demo["Networked Demo"]
  node_client["Order Generator<br/>[client.cpp]"]
  node_server["TCP Server<br/>[server.cpp]"]
  node_scripted_demo["Scripted Book Demo<br/>[main.cpp]"]
end

subgraph group_wire["Binary Protocol"]
  node_protocol_codec["Message Codec<br/>[Protocol.cpp]"]
  node_protocol_types["Wire Message Types<br/>[Protocol.h]"]
end

subgraph group_engine["Matching Engine"]
  node_book_api["Order Book API<br/>[OrderBook.h]"]
  node_matching["Validation and Matching<br/>[OrderBook.cpp]"]
  node_resting_state[("Resting Book State<br/>[OrderBook.cpp]")]
end

subgraph group_domain["Order Domain"]
  node_order["Order Types<br/>[Order.h]"]
  node_submission["Submission Result<br/>[SubmissionResult.h]"]
  node_trade["Trade Record<br/>[Trade.h]"]
end

node_user(("Demo Operator"))

node_user -->|"runs demo"| node_client
node_client -->|"encodes orders"| node_protocol_codec
node_protocol_codec -->|"serializes fields"| node_protocol_types
node_client -->|"sends TCP bytes"| node_server
node_server -->|"decodes messages"| node_protocol_codec
node_server -->|"submits orders"| node_book_api
node_book_api -->|"validates and matches"| node_matching
node_matching -->|"updates book state"| node_resting_state
node_book_api -->|"returns results"| node_submission
node_submission -->|"contains trades"| node_trade
node_server -->|"prints book"| node_book_api
node_user -->|"runs demo"| node_scripted_demo

click node_client "https://github.com/nickchal1/matchingengine0/blob/main/client.cpp"
click node_server "https://github.com/nickchal1/matchingengine0/blob/main/server.cpp"
click node_protocol_codec "https://github.com/nickchal1/matchingengine0/blob/main/protocol/Protocol.cpp"
click node_protocol_types "https://github.com/nickchal1/matchingengine0/blob/main/protocol/Protocol.h"
click node_book_api "https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.h"
click node_matching "https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.cpp"
click node_resting_state "https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.cpp"
click node_order "https://github.com/nickchal1/matchingengine0/blob/main/engine/Order.h"
click node_submission "https://github.com/nickchal1/matchingengine0/blob/main/engine/SubmissionResult.h"
click node_trade "https://github.com/nickchal1/matchingengine0/blob/main/engine/Trade.h"
click node_scripted_demo "https://github.com/nickchal1/matchingengine0/blob/main/main.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client,node_server,node_scripted_demo toneBlue
class node_protocol_codec,node_protocol_types toneAmber
class node_book_api,node_matching,node_resting_state toneMint
class node_order,node_submission,node_trade toneRose
class node_user toneIndigo
```

## Components

### Networked Demo

- [Order Generator](https://github.com/nickchal1/matchingengine0/blob/main/client.cpp): `client.cpp`
- [TCP Server](https://github.com/nickchal1/matchingengine0/blob/main/server.cpp): `server.cpp`
- [Scripted Book Demo](https://github.com/nickchal1/matchingengine0/blob/main/main.cpp): `main.cpp`

### Binary Protocol

- [Message Codec](https://github.com/nickchal1/matchingengine0/blob/main/protocol/Protocol.cpp): `protocol/Protocol.cpp`
- [Wire Message Types](https://github.com/nickchal1/matchingengine0/blob/main/protocol/Protocol.h): `protocol/Protocol.h`

### Matching Engine

- [Order Book API](https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.h): `engine/OrderBook.h`
- [Validation and Matching](https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.cpp): `engine/OrderBook.cpp`
- [Resting Book State](https://github.com/nickchal1/matchingengine0/blob/main/engine/OrderBook.cpp): `engine/OrderBook.cpp`

### Order Domain

- [Order Types](https://github.com/nickchal1/matchingengine0/blob/main/engine/Order.h): `engine/Order.h`
- [Submission Result](https://github.com/nickchal1/matchingengine0/blob/main/engine/SubmissionResult.h): `engine/SubmissionResult.h`
- [Trade Record](https://github.com/nickchal1/matchingengine0/blob/main/engine/Trade.h): `engine/Trade.h`

### Other components

- **Demo Operator**

## Connections

- Demo Operator → Order Generator: runs demo (evidence: `README.md`)
- Order Generator → Message Codec: encodes orders (evidence: `client.cpp`)
- Message Codec → Wire Message Types: serializes fields (evidence: `protocol/Protocol.cpp`)
- Order Generator → TCP Server: sends TCP bytes (evidence: `README.md`)
- TCP Server → Message Codec: decodes messages (evidence: `server.cpp`)
- TCP Server → Order Book API: submits orders (evidence: `server.cpp`)
- Order Book API → Validation and Matching: validates and matches (evidence: `engine/OrderBook.cpp`)
- Validation and Matching → Resting Book State: updates book state (evidence: `engine/OrderBook.cpp`)
- Order Book API → Submission Result: returns results (evidence: `engine/OrderBook.h`)
- Submission Result → Trade Record: contains trades (evidence: `engine/SubmissionResult.h`)
- TCP Server → Order Book API: prints book (evidence: `server.cpp`)
- Demo Operator → Scripted Book Demo: runs demo (evidence: `README.md`)
