orderflow

an experimental order matching and filling engine in Rust

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Testing
• Roadmap
• Contributing
  • Creating A Pull Request
• Authors

About The Project

This is a simple order matching and filling engine in Rust as an experiment in how Rust handles ownership and lifetimes in a complex and asynchronous process.

Built With

Built with Rust 🦀

Getting Started

Prerequisites

• Rust
• Cargo

Installation

1. Clone the repo

2. Run the tests

cargo test

3. Run the application

cargo run

4. Build the binary

cargo build

Usage

Don't use this in production, please. For experimentation only.

Testing

To test the API, cargo run and then, in another terminal, fire off these curl commands to test post and get requests of the server.

• Create an order POST /orders

curl -X POST http://127.0.0.1:8080/orders -H "Content-Type: application/json" -d '{"is_buy": true, "price": 100, "quantity": 10, "priority": 1, "owner_id": 123}'

• GET a list of the open orders GET /orders

# TODO

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Authors

• d7t - - d7t -