Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sneilan authored Nov 22, 2023
1 parent 7c1f109 commit b7094c7
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,32 +77,6 @@ response = sock.recv(1024)
print("Connected!")
```

### Authentication

_or lack thereof_

There is no authentication currently.

You will be assigned a User ID however on connection that is not told
to the client except on trade notifications. Your "user id" is the socket number.

The exchange supports up to 30 concurrent clients.
First user to connect will have user id 0, second 1 and so one. If User 1 disconnects and a new user reconnects,
the new user will have user id 1 also. It's not great but it works for a demo. You do not need to authenticate

### What is traded

Currently the exchange trades one unnamed symbol. The name of the symbol
is whatever you want. To trade multiple symbols, start up multiple exchanges.

### Balances

Trade balances are infinite. Wallets and balances will come later.

### Risk Controls

No risk controls at the moment. Place as many trades as you like.

### Sending a trade

After connecting, send a trade by submitting 9 bytes.
Expand Down Expand Up @@ -181,6 +155,32 @@ Check out scripts/loadTest.py for an example trading client.

You can paste these protocols into Chat GPT and produce trading frontends in your preferred language.

### Authentication

_or lack thereof_

There is no authentication currently.

You will be assigned a User ID however on connection that is not told
to the client except on trade notifications. Your "user id" is the socket number.

The exchange supports up to 30 concurrent clients.
First user to connect will have user id 0, second 1 and so one. If User 1 disconnects and a new user reconnects,
the new user will have user id 1 also. It's not great but it works for a demo. You do not need to authenticate

### What is traded

Currently the exchange trades one unnamed symbol. The name of the symbol
is whatever you want. To trade multiple symbols, start up multiple exchanges.

### Balances

Trade balances are infinite. Wallets and balances will come later.

### Risk Controls

No risk controls at the moment. Place as many trades as you like.

### Market Data

This is not implemented yet. This is a high priority on the roadmap.
Expand Down

0 comments on commit b7094c7

Please sign in to comment.