Skip to content

Commit

Permalink
adds mermaid architecture graph
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanlott committed Jun 28, 2023
1 parent c8b7141 commit 0592f9f
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,37 @@ The final implementation that applies the design points learned from the previou

## Architecture

```mermaid
---
title: Orderbook
---
flowchart LR
subgraph golem[golem]
server[server]
subgraph orderbook[orderbook]
buy[buy orders]
sell[sell orders]
accounts
end
server -- POST /ORDERS --> in
server -- GET /ORDERS --> status[status monitor]
in --> orderbook
orderbook --> status[status monitor]
orderbook -- matches --> out
out --> history
subgraph engine[engine]
in
out
status
end
end
```

The two main packages are `accounts` and `orderbook`. Accounts holds an interface and an in-memory adapter for testing and use by other modules. Persistence via some KV store is on the roadmap for this project.

Orders are handled in the following process
Expand Down

0 comments on commit 0592f9f

Please sign in to comment.