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

Soho is a central limit order-book protocol for high frequency, gasless trades on multiple chains including Blast
https://github.com/mgnfy-view/soho-orderbook

bitmap blast documentation eip712 forge foundry multi-chain natspec orderbook smart-contracts solidity trading

Last synced: 12 days ago
JSON representation

Soho is a central limit order-book protocol for high frequency, gasless trades on multiple chains including Blast

• Host: GitHub
• URL: https://github.com/mgnfy-view/soho-orderbook
• Owner: mgnfy-view
• License: mit
• Created: 2024-08-13T13:27:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-05T12:48:30.000Z (about 1 year ago)
• Last Synced: 2025-04-19T15:54:54.732Z (6 months ago)
• Topics: bitmap, blast, documentation, eip712, forge, foundry, multi-chain, natspec, orderbook, smart-contracts, solidity, trading
• Language: Solidity
• Homepage:
• Size: 326 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






  

    

  


  
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

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Roadmap

    
Contributing

    
License

    
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

- ![Foundry](https://img.shields.io/badge/-FOUNDRY-%23323330.svg?style=for-the-badge)

- ![Solidity](https://img.shields.io/badge/Solidity-%23363636.svg?style=for-the-badge&logo=solidity&logoColor=white)

## Getting Started

### Prerequisites

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

### Installation

Clone the repo,

```shell

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

```

cd into the repo, and install the necessary dependencies

```shell

cd soho-orderbook

forge test

```

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

## Roadmap

- [x] Smart contract development

- [x] Unit tests

- [x] Write Docs

- [x] Write a good README.md

See the [open issues](https://github.com/mgnfy-view/soho-orderbook/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!

[![Linktree](https://img.shields.io/badge/linktree-1de9b6?style=for-the-badge&logo=linktree&logoColor=white)][linktree-url]

[contributors-shield]: https://img.shields.io/github/contributors/mgnfy-view/soho-orderbook.svg?style=for-the-badge

[contributors-url]: https://github.com/mgnfy-view/soho-orderbook/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/mgnfy-view/soho-orderbook.svg?style=for-the-badge

[forks-url]: https://github.com/mgnfy-view/soho-orderbook/network/members

[stars-shield]: https://img.shields.io/github/stars/mgnfy-view/soho-orderbook.svg?style=for-the-badge

[stars-url]: https://github.com/mgnfy-view/soho-orderbook/stargazers

[issues-shield]: https://img.shields.io/github/issues/mgnfy-view/soho-orderbook.svg?style=for-the-badge

[issues-url]: https://github.com/mgnfy-view/soho-orderbook/issues

[license-shield]: https://img.shields.io/github/license/mgnfy-view/soho-orderbook.svg?style=for-the-badge

[license-url]: https://github.com/mgnfy-view/soho-orderbook/blob/master/LICENSE.txt

[linktree-url]: https://linktr.ee/mgnfy.view