bbgo_origin/pkg/bbgo/activeorderbook.go

482 lines
12 KiB
Go
Raw Normal View History

package bbgo
import (
"context"
"encoding/json"
"sync"
"time"
"github.com/pkg/errors"
2020-11-10 06:19:33 +00:00
log "github.com/sirupsen/logrus"
"github.com/c9s/bbgo/pkg/sigchan"
"github.com/c9s/bbgo/pkg/types"
)
2023-12-13 06:00:53 +00:00
const DefaultCancelOrderWaitTime = 20 * time.Millisecond
// ActiveOrderBook manages the local active order books.
//
//go:generate callbackgen -type ActiveOrderBook
type ActiveOrderBook struct {
2023-01-10 12:15:51 +00:00
Symbol string
orders *types.SyncOrderMap
newCallbacks []func(o types.Order)
2022-12-04 03:39:43 +00:00
filledCallbacks []func(o types.Order)
canceledCallbacks []func(o types.Order)
pendingOrderUpdates *types.SyncOrderMap
// sig is the order update signal
// this signal will be emitted when a new order is added or removed.
C sigchan.Chan
mu sync.Mutex
2023-12-13 06:00:53 +00:00
cancelOrderWaitTime time.Duration
}
func NewActiveOrderBook(symbol string) *ActiveOrderBook {
return &ActiveOrderBook{
Symbol: symbol,
orders: types.NewSyncOrderMap(),
pendingOrderUpdates: types.NewSyncOrderMap(),
C: sigchan.New(1),
2023-12-13 06:00:53 +00:00
cancelOrderWaitTime: DefaultCancelOrderWaitTime,
}
}
2023-12-13 06:00:53 +00:00
func (b *ActiveOrderBook) SetCancelOrderWaitTime(duration time.Duration) {
b.cancelOrderWaitTime = duration
}
func (b *ActiveOrderBook) MarshalJSON() ([]byte, error) {
orders := b.Backup()
return json.Marshal(orders)
}
func (b *ActiveOrderBook) Backup() []types.SubmitOrder {
2022-06-05 10:12:26 +00:00
return b.orders.Backup()
}
func (b *ActiveOrderBook) BindStream(stream types.Stream) {
2020-11-11 15:18:53 +00:00
stream.OnOrderUpdate(b.orderUpdateHandler)
}
func (b *ActiveOrderBook) waitClear(
ctx context.Context, order types.Order, waitTime, timeout time.Duration,
) (bool, error) {
if !b.orders.Exists(order.OrderID) {
return true, nil
}
timeoutC := time.After(timeout)
for {
select {
case <-time.After(waitTime):
case <-b.C:
}
clear := !b.orders.Exists(order.OrderID)
select {
case <-timeoutC:
return clear, nil
case <-ctx.Done():
return clear, ctx.Err()
default:
if clear {
return clear, nil
}
}
}
}
// waitAllClear waits for the order book be clear (meaning every order is removed)
// if err != nil, it's the context error.
func (b *ActiveOrderBook) waitAllClear(ctx context.Context, waitTime, timeout time.Duration) (bool, error) {
clear := b.NumOfOrders() == 0
if clear {
return clear, nil
}
timeoutC := time.After(timeout)
for {
select {
case <-time.After(waitTime):
case <-b.C:
}
// update clear flag
clear = b.NumOfOrders() == 0
select {
case <-timeoutC:
return clear, nil
case <-ctx.Done():
return clear, ctx.Err()
default:
if clear {
return clear, nil
}
}
}
}
2022-11-02 04:27:36 +00:00
// FastCancel cancels the orders without verification
// It calls the exchange cancel order api and then remove the orders from the active orderbook directly.
2022-11-02 04:25:34 +00:00
func (b *ActiveOrderBook) FastCancel(ctx context.Context, ex types.Exchange, orders ...types.Order) error {
// if no orders are given, set to cancelAll
2023-08-04 10:02:24 +00:00
hasSymbol := b.Symbol != ""
if len(orders) == 0 {
orders = b.Orders()
} else {
// simple check on given input
for _, o := range orders {
2023-08-04 10:02:24 +00:00
if hasSymbol && o.Symbol != b.Symbol {
2022-11-02 04:27:36 +00:00
return errors.New("[ActiveOrderBook] cancel " + b.Symbol + " orderbook with different order symbol: " + o.Symbol)
}
}
}
2022-11-02 04:27:36 +00:00
// optimize order cancel for back-testing
if IsBackTesting {
return ex.CancelOrders(context.Background(), orders...)
}
2022-11-02 04:25:34 +00:00
log.Debugf("[ActiveOrderBook] no wait cancelling %s orders...", b.Symbol)
// since ctx might be canceled, we should use background context here
if err := ex.CancelOrders(context.Background(), orders...); err != nil {
log.WithError(err).Errorf("[ActiveOrderBook] no wait can not cancel %s orders", b.Symbol)
}
2022-11-02 04:25:34 +00:00
for _, o := range orders {
b.orders.Remove(o.OrderID)
}
return nil
}
// GracefulCancel cancels the active orders gracefully
func (b *ActiveOrderBook) GracefulCancel(ctx context.Context, ex types.Exchange, specifiedOrders ...types.Order) error {
cancelAll := false
orders := specifiedOrders
// if no orders are given, set to cancelAll
if len(specifiedOrders) == 0 {
orders = b.Orders()
cancelAll = true
} else {
// simple check on given input
2023-08-04 10:02:24 +00:00
hasSymbol := b.Symbol != ""
for _, o := range orders {
2023-08-04 10:02:24 +00:00
if hasSymbol && o.Symbol != b.Symbol {
return errors.New("[ActiveOrderBook] cancel " + b.Symbol + " orderbook with different symbol: " + o.Symbol)
}
}
}
// optimize order cancel for back-testing
if IsBackTesting {
return ex.CancelOrders(context.Background(), orders...)
}
log.Debugf("[ActiveOrderBook] gracefully cancelling %s orders...", b.Symbol)
2023-12-13 06:00:53 +00:00
waitTime := b.cancelOrderWaitTime
orderCancelTimeout := 5 * time.Second
startTime := time.Now()
// ensure every order is canceled
for {
// Some orders in the variable are not created on the server side yet,
// If we cancel these orders directly, we will get an unsent order error
// We wait here for a while for server to create these orders.
// time.Sleep(SentOrderWaitTime)
// since ctx might be canceled, we should use background context here
if err := ex.CancelOrders(context.Background(), orders...); err != nil {
2024-03-04 14:40:25 +00:00
log.WithError(err).Warnf("[ActiveOrderBook] can not cancel %d %s orders", len(orders), b.Symbol)
}
2024-03-04 14:40:25 +00:00
log.Debugf("[ActiveOrderBook] waiting %s for %d %s orders to be cancelled...", waitTime, len(orders), b.Symbol)
if cancelAll {
clear, err := b.waitAllClear(ctx, waitTime, orderCancelTimeout)
2023-12-13 08:29:07 +00:00
if err != nil {
if !errors.Is(err, context.Canceled) {
log.WithError(err).Errorf("order cancel error")
}
break
}
if clear {
2024-03-04 14:40:25 +00:00
log.Debugf("[ActiveOrderBook] %d %s orders are canceled", len(orders), b.Symbol)
break
}
2024-03-04 14:40:25 +00:00
log.Warnf("[ActiveOrderBook] %d/%d %s orders are not cancelled yet", b.NumOfOrders(), len(orders), b.Symbol)
b.Print()
} else {
existingOrders := b.filterExistingOrders(orders)
if len(existingOrders) == 0 {
2023-12-13 08:29:07 +00:00
log.Debugf("[ActiveOrderBook] orders are canceled")
break
}
}
// verify the current open orders via the RESTful API
log.Warnf("[ActiveOrderBook] using open orders API to verify the active orders...")
2023-12-13 06:00:53 +00:00
var symbolOrdersMap = categorizeOrderBySymbol(orders)
var errOccurred bool
2023-12-13 06:00:53 +00:00
var leftOrders types.OrderSlice
for symbol, symbolOrders := range symbolOrdersMap {
openOrders, err := ex.QueryOpenOrders(ctx, symbol)
if err != nil {
errOccurred = true
log.WithError(err).Errorf("can not query %s open orders", symbol)
break
}
2023-12-13 06:00:53 +00:00
openOrderMap := types.NewOrderMap(openOrders...)
for _, o := range symbolOrders {
2023-12-13 06:00:53 +00:00
// if it's not on the order book (open orders),
// we should remove it from our local side
if !openOrderMap.Exists(o.OrderID) {
b.Remove(o)
} else {
2023-12-13 06:00:53 +00:00
leftOrders.Add(o)
}
}
}
2023-08-04 10:02:24 +00:00
// if an error occurs, we cannot update the orders because it will result in an empty order slice.
if !errOccurred {
// update order slice for the next try
orders = leftOrders
}
}
log.Debugf("[ActiveOrderBook] all %s orders are cancelled successfully in %s", b.Symbol, time.Since(startTime))
return nil
}
func (b *ActiveOrderBook) orderUpdateHandler(order types.Order) {
b.Update(order)
2020-11-11 15:18:53 +00:00
}
func (b *ActiveOrderBook) Print() {
orders := b.orders.Orders()
orders = types.SortOrdersByPrice(orders, true)
orders.Print()
}
// Update updates the order by the order status and emit the related events.
// When order is filled, the order will be removed from the internal order storage.
// When order is New or PartiallyFilled, the internal order will be updated according to the latest order update.
// When the order is cancelled, it will be removed from the internal order storage.
func (b *ActiveOrderBook) Update(order types.Order) {
2023-08-17 08:28:42 +00:00
hasSymbol := len(b.Symbol) > 0
if hasSymbol && order.Symbol != b.Symbol {
return
}
b.mu.Lock()
2023-08-17 08:28:42 +00:00
if !b.orders.Exists(order.OrderID) {
log.Debugf("[ActiveOrderBook] order #%d %s does not exist, adding it to pending order update", order.OrderID, order.Status)
2023-08-17 08:28:42 +00:00
b.pendingOrderUpdates.Add(order)
b.mu.Unlock()
2023-08-17 08:28:42 +00:00
return
}
2023-08-17 09:31:24 +00:00
// if order update time is too old, skip it
if previousOrder, ok := b.orders.Get(order.OrderID); ok {
// the arguments ordering is important here
// if we can't detect which is newer, isNewerOrderUpdate returns false
// if you pass two same objects to isNewerOrderUpdate, it returns false
if !isNewerOrderUpdate(order, previousOrder) {
log.Infof("[ActiveOrderBook] order #%d updateTime %s is out of date, skip it", order.OrderID, order.UpdateTime)
2023-08-17 09:31:24 +00:00
b.mu.Unlock()
return
}
}
switch order.Status {
case types.OrderStatusFilled:
// make sure we have the order and we remove it
removed := b.orders.Remove(order.OrderID)
b.mu.Unlock()
if removed {
2023-09-17 10:25:21 +00:00
log.Infof("[ActiveOrderBook] order #%d is filled: %s", order.OrderID, order.String())
b.EmitFilled(order)
}
b.C.Emit()
case types.OrderStatusPartiallyFilled:
2023-08-17 09:31:24 +00:00
b.orders.Update(order)
b.mu.Unlock()
case types.OrderStatusNew:
2023-08-17 09:31:24 +00:00
b.orders.Update(order)
b.mu.Unlock()
b.C.Emit()
case types.OrderStatusCanceled, types.OrderStatusRejected:
// TODO: note that orders transit to "canceled" may have partially filled
log.Debugf("[ActiveOrderBook] order is %s, removing order %s", order.Status, order)
b.orders.Remove(order.OrderID)
b.mu.Unlock()
if order.Status == types.OrderStatusCanceled {
b.EmitCanceled(order)
}
b.C.Emit()
default:
b.mu.Unlock()
log.Warnf("[ActiveOrderBook] unhandled order status: %s", order.Status)
}
}
func (b *ActiveOrderBook) Add(orders ...types.Order) {
2022-06-05 10:12:26 +00:00
hasSymbol := len(b.Symbol) > 0
2023-08-04 10:02:24 +00:00
for _, order := range orders {
if hasSymbol && b.Symbol != order.Symbol {
continue
}
b.add(order)
}
}
2023-11-22 09:44:41 +00:00
func isNewerOrderUpdate(a, b types.Order) bool {
// compare state first
switch a.Status {
case types.OrderStatusCanceled, types.OrderStatusRejected: // canceled is a final state
switch b.Status {
case types.OrderStatusNew, types.OrderStatusPartiallyFilled:
return true
}
case types.OrderStatusPartiallyFilled:
switch b.Status {
case types.OrderStatusNew:
return true
case types.OrderStatusPartiallyFilled:
// unknown for equal
if a.ExecutedQuantity.Compare(b.ExecutedQuantity) > 0 {
return true
}
}
case types.OrderStatusFilled:
switch b.Status {
case types.OrderStatusFilled, types.OrderStatusPartiallyFilled, types.OrderStatusNew:
return true
}
}
2023-11-22 09:44:41 +00:00
return isNewerOrderUpdateTime(a, b)
}
2023-11-22 09:44:41 +00:00
func isNewerOrderUpdateTime(a, b types.Order) bool {
au := time.Time(a.UpdateTime)
bu := time.Time(b.UpdateTime)
if !au.IsZero() && !bu.IsZero() && au.After(bu) {
return true
}
if !au.IsZero() && bu.IsZero() {
return true
}
return false
}
// add the order to the active order book and check the pending order
func (b *ActiveOrderBook) add(order types.Order) {
if pendingOrder, ok := b.pendingOrderUpdates.Get(order.OrderID); ok {
// if the pending order update time is newer than the adding order
// we should use the pending order rather than the adding order.
2023-12-11 09:59:02 +00:00
// if the pending order is older, then we should add the new one, and drop the pending order
log.Debugf("found pending order update: %+v", pendingOrder)
2023-11-22 09:44:41 +00:00
if isNewerOrderUpdate(pendingOrder, order) {
log.Debugf("pending order update is newer: %+v", pendingOrder)
order = pendingOrder
}
b.orders.Add(order)
b.pendingOrderUpdates.Remove(pendingOrder.OrderID)
// when using add(order), it's usually a new maker order on the order book.
// so, when it's not status=new, we should trigger order update handler
if order.Status != types.OrderStatusNew {
// emit the order update handle function to trigger callback
b.Update(order)
}
2023-02-17 11:50:46 +00:00
} else {
b.orders.Add(order)
}
}
func (b *ActiveOrderBook) Exists(order types.Order) bool {
b.mu.Lock()
defer b.mu.Unlock()
2022-06-05 10:12:26 +00:00
return b.orders.Exists(order.OrderID)
2021-05-22 09:44:07 +00:00
}
2023-02-17 11:50:46 +00:00
func (b *ActiveOrderBook) Get(orderID uint64) (types.Order, bool) {
return b.orders.Get(orderID)
}
func (b *ActiveOrderBook) Remove(order types.Order) bool {
b.mu.Lock()
defer b.mu.Unlock()
2022-06-05 10:12:26 +00:00
return b.orders.Remove(order.OrderID)
}
func (b *ActiveOrderBook) NumOfOrders() int {
2022-06-05 10:12:26 +00:00
return b.orders.Len()
2021-05-13 11:41:05 +00:00
}
func (b *ActiveOrderBook) Orders() types.OrderSlice {
2022-06-05 10:12:26 +00:00
return b.orders.Orders()
}
2022-12-20 09:33:53 +00:00
func (b *ActiveOrderBook) Lookup(f func(o types.Order) bool) *types.Order {
return b.orders.Lookup(f)
}
2023-12-13 06:00:53 +00:00
func (b *ActiveOrderBook) filterExistingOrders(orders []types.Order) (existingOrders types.OrderSlice) {
for _, o := range orders {
if b.Exists(o) {
existingOrders.Add(o)
}
}
return existingOrders
}
2023-12-13 06:00:53 +00:00
func categorizeOrderBySymbol(orders types.OrderSlice) map[string]types.OrderSlice {
orderMap := map[string]types.OrderSlice{}
for _, order := range orders {
orderMap[order.Symbol] = append(orderMap[order.Symbol], order)
}
return orderMap
}