Golang高性能限价订单簿撮合引擎插件库orderbook的使用

Go orderbook

改进的用Go(Golang)编写的撮合引擎

特性

• 标准的价格-时间优先级
• 支持市价单和限价单
• 支持订单取消
• 高性能(每秒超过30万笔交易)
• 最优内存使用
• JSON序列化和反序列化
• 计算指定数量的市场价格

使用

要开始使用orderbook，你需要创建一个对象：

import (
  "fmt" 
  ob "github.com/muzykantov/orderbook"
)

func main() {
  orderBook := ob.NewOrderBook()
  fmt.Println(orderBook)
}

然后你可以使用以下主要功能：

func (ob *OrderBook) ProcessLimitOrder(side Side, orderID string, quantity, price decimal.Decimal) (done []*Order, partial *Order, err error) { ... }

func (ob *OrderBook) ProcessMarketOrder(side Side, quantity decimal.Decimal) (done []*Order, partial *Order, quantityLeft decimal.Decimal, err error) { .. }

func (ob *OrderBook) CancelOrder(orderID string) *Order { ... }

关于主要功能

ProcessLimitOrder

// ProcessLimitOrder 将新订单放入订单簿
// 参数:
//      side     - 你想做什么(ob.Sell 或 ob.Buy)
//      orderID  - 深度中的唯一订单ID
//      quantity - 你想卖出或买入的数量
//      price    - 不超过这个价格(或不低于这个价格)
//      * 要创建新的十进制数，你应该使用decimal.New()函数
// 返回:
//      error   - 如果数量(或价格)小于或等于0，则不为nil。或者如果给定ID的订单已存在
//      done    - 如果你的订单完成了另一个订单，这个订单将被添加到"done"切片中。如果你的订单也完成了，它也会被放到这个数组中
//      partial - 如果你的订单已完成但顶部订单未完全完成，则不为nil。或者如果你的订单部分完成并放入订单簿而没有全部数量 - partial将包含你的订单与剩余数量
//      partialQuantityProcessed - 如果partial订单不为nil，这个结果包含从partial订单处理的量
func (ob *OrderBook) ProcessLimitOrder(side Side, orderID string, quantity, price decimal.Decimal) (done []*Order, partial *Order, err error) { ... }

例如：

ProcessLimitOrder(ob.Sell, "uinqueID", decimal.New(55, 0), decimal.New(100, 0))

asks: 110 -> 5      110 -> 5
      100 -> 1      100 -> 56
--------------  ->  --------------
bids: 90  -> 5      90  -> 5
      80  -> 1      80  -> 1

done    - nil
partial - nil

ProcessMarketOrder

// ProcessMarketOrder 立即以市场价格从订单簿中获取指定数量
// 参数:
//      side     - 你想做什么(ob.Sell 或 ob.Buy)
//      quantity - 你想卖出或买入的数量
//      * 要创建新的十进制数，你应该使用decimal.New()函数
// 返回:
//      error        - 如果价格小于或等于0，则不为nil
//      done         - 如果你的市价单完成了其他订单，这个订单将被添加到"done"切片中
//      partial      - 如果你的订单已完成但顶部订单未完全完成，则不为nil
//      partialQuantityProcessed - 如果partial订单不为nil，这个结果包含从partial订单处理的量
//      quantityLeft - 如果没有足够的订单来处理所有数量，则大于零
func (ob *OrderBook) ProcessMarketOrder(side Side, quantity decimal.Decimal) (done []*Order, partial *Order, quantityLeft decimal.Decimal, err error) { .. }

例如：

ProcessMarketOrder(ob.Sell, decimal.New(6, 0))

asks: 110 -> 5      110 -> 5
      100 -> 1      100 -> 1
--------------  ->  --------------
bids: 90  -> 5      80 -> 1
      80  -> 2

done         - 2 (or more orders)
partial      - 1 order with price 80
quantityLeft - 0

CancelOrder

// CancelOrder 从订单簿中移除给定ID的订单
func (ob *OrderBook) CancelOrder(orderID string) *Order { ... }

例如：

CancelOrder("myUinqueID-Sell-1-with-100")

asks: 110 -> 5
      100 -> 1      110 -> 5
--------------  ->  --------------
bids: 90  -> 5      90  -> 5
      80  -> 1      80  -> 1
                    
done         - 2 (or more orders)
partial      - nil
quantityLeft - 4

完整示例

package main

import (
	"fmt"
	ob "github.com/muzykantov/orderbook"
	"github.com/shopspring/decimal"
)

func main() {
	// 创建新的订单簿
	orderBook := ob.NewOrderBook()

	// 添加限价买单
	done, partial, err := orderBook.ProcessLimitOrder(
		ob.Buy, 
		"buy-order-1", 
		decimal.New(10, 0),  // 数量 10
		decimal.New(100, 0), // 价格 100
	)
	if err != nil {
		fmt.Println("Error placing buy order:", err)
		return
	}
	fmt.Printf("Buy order placed. Done: %v, Partial: %v\n", done, partial)

	// 添加限价卖单
	done, partial, err = orderBook.ProcessLimitOrder(
		ob.Sell,
		"sell-order-1",
		decimal.New(5, 0),   // 数量 5
		decimal.New(105, 0), // 价格 105
	)
	if err != nil {
		fmt.Println("Error placing sell order:", err)
		return
	}
	fmt.Printf("Sell order placed. Done: %v, Partial: %v\n", done, partial)

	// 执行市价买单
	done, partial, left, err := orderBook.ProcessMarketOrder(
		ob.Buy,
		decimal.New(7, 0), // 数量 7
	)
	if err != nil {
		fmt.Println("Error processing market order:", err)
		return
	}
	fmt.Printf("Market buy order processed. Done: %v, Partial: %v, Left: %v\n", done, partial, left)

	// 取消订单
	cancelled := orderBook.CancelOrder("sell-order-1")
	fmt.Printf("Cancelled order: %v\n", cancelled)
}

许可证

MIT许可证