Skip to content

Commit eef68fc

Browse files
committed
updates README
1 parent 2fd1f9f commit eef68fc

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,21 @@ Files changed by the build script are:
8080

8181
## <span style="color: #A29BFE;">Components</span>
8282

83-
### <span style="color: #FD79A8;">1. ExchangeStream</span>
83+
### <span style="color: #FDCB6E;">1. Exchange</span>
84+
85+
#### Exchange
86+
87+
Wrapper around exchange stream to handle websocket sinks and other functionality
88+
89+
#### ExchangeStream
8490

8591
Runs both http snapshot streams and websocket streams. Can handle retriggering the http snapshot stream
8692
but it currently is not implemented in the Orderbook/DepthDriver.
8793

8894
Future work: Ideally these streams are done purely on the stack but this must be verified. Correct
8995
sequencing of orderbook snapshots and depth updates through their timestamps
9096

91-
### <span style="color: #FDCB6E;">2. Exchange</span>
92-
93-
Wrapper around exchange stream to handle websocket sinks and other functionality
94-
95-
### <span style="color: #6C5CE7;">3. DepthDriver</span>
97+
### <span style="color: #6C5CE7;">2. DepthDriver</span>
9698

9799
Provides a controlling interface to all exchange streams that push depths.
98100

@@ -103,7 +105,7 @@ retriggering with correct sequencing (https://github.com/binance/binance-spot-ap
103105

104106
(2) Exchange Stream websocket failure states.
105107

106-
### <span style="color: #E17055;">4. Orderbook</span>
108+
### <span style="color: #E17055;">3. Orderbook</span>
107109

108110
Handles orderbook writing and reading.
109111

@@ -124,7 +126,7 @@ Has 2 states:
124126

125127
(4) Use fixed library for floats https://docs.rs/fixed/latest/fixed/
126128

127-
### <span style="color: #00CEC9;">5. Quote GRPC Server</span>
129+
### <span style="color: #00CEC9;">4. Quote GRPC Server</span>
128130

129131
Takes the spread and provides the best ten deals and asks to a grpc client
130132

0 commit comments

Comments
 (0)