Soho Orderbook

Soho is a central limit order-book protocol for high frequency, gasless trades on multiple chains including Blast
Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Soho is a central limit orderbook protocol to facilitate high-frequency, gasless trades on multiple chains including Blast.

The protocol consists of three main actors: a maker, a taker, and an off-chain matching engine. Users can start placing ask/sell orders on the off-chain engine after they have deposited some tokens into the on-chain settlement protocol. An ask order brings liquidity to the market, whereas a sell order takes liquidity from the market. Makers and takers can sign their respective orders off-chain. Once a mirrored maker and taker order is matched, the matching engine settles it on-chain using the Soho::settleOrders() function and the maker and taker signatures. The protocol takes a small percentage of fees from the taker's input amount, so it is necessary that takers put up some buffer amount to have their orders matched.

The protocol uses bitmaps to efficiently track the resolution status of an order, and EIP712 signatures to sign orders.

The protocol can be deployed on multiple evm-compatible chains, and is also configured for Blast.

Built With

• 
• 

Getting Started

Prerequisites

Make sure you have git and foundry installed and configured on your system.

Installation

Clone the repo,

git clone https://github.com/mgnfy-view/soho-orderbook.git

cd into the repo, and install the necessary dependencies

cd soho-orderbook
forge test

That's it, you are good to go now!

Roadmap

• Smart contract development
• Unit tests
• Write Docs
• Write a good README.md

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

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

License

Distributed under the MIT License. See LICENSE.txt for more information.

Reach Out

Here's a gateway to all my socials, don't forget to hit me up!