nodejs-order-book 8.0.0

package/dist/cjs/orderbook.js

@@ -0,0 +1,850 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderBook = void 0;
+/* node:coverage ignore next - Don't know why first and last line of each file count as uncovered */
+var errors_1 = require("./errors");
+var order_1 = require("./order");
+var orderside_1 = require("./orderside");
+var stopbook_1 = require("./stopbook");
+var types_1 = require("./types");
+var validTimeInForce = Object.values(types_1.TimeInForce);
+var OrderBook = /** @class */ (function () {
+    /**
+     * Creates an instance of OrderBook.
+     * @param {OrderBookOptions} [options={}] - Options for configuring the order book.
+     * @param {JournalLog} [options.snapshot] - The orderbook snapshot will be restored before processing any journal logs, if any.
+     * @param {JournalLog} [options.journal] - Array of journal logs (optional).
+     * @param {boolean} [options.enableJournaling=false] - Flag to enable journaling. Default to false
+     * @param {boolean} [options.experimentalConditionalOrders=false] - Flag to enable experimental Conditional Order (Stop Market, Stop Limit and OCO orders). Default to false
+     */
+    function OrderBook(_a) {
+        var _b = _a === void 0 ? {} : _a, snapshot = _b.snapshot, journal = _b.journal, _c = _b.enableJournaling, enableJournaling = _c === void 0 ? false : _c, _d = _b.experimentalConditionalOrders, experimentalConditionalOrders = _d === void 0 ? false : _d;
+        var _this = this;
+        this.orders = {};
+        this._lastOp = 0;
+        this._marketPrice = 0;
+        /**
+         * Create a stop market order. See {@link StopMarketOrderOptions} for details.
+         *
+         * @param options
+         * @param options.side - `sell` or `buy`
+         * @param options.size - How much of currency you want to trade in units of base currency
+         * @param options.stopPrice - The price at which the order will be triggered.
+         * @returns An object with the result of the processed order or an error. See {@link IProcessOrder} for the returned data structure
+         */
+        this.stopMarket = function (options) {
+            /* node:coverage ignore next 4 - We don't need test for this */
+            if (!_this.experimentalConditionalOrders)
+                throw new Error("In order to use conditional orders you need to instantiate the order book with the `experimentalConditionalOrders` option set to true");
+            return _this._stopMarket(options);
+        };
+        /**
+         * Create a stop limit order. See {@link StopLimitOrderOptions} for details.
+         *
+         * @param options
+         * @param options.side - `sell` or `buy`
+         * @param options.id - Unique order ID
+         * @param options.size - How much of currency you want to trade in units of base currency
+         * @param options.price - The price at which the order is to be fullfilled, in units of the quote currency
+         * @param options.stopPrice - The price at which the order will be triggered.
+         * @param options.timeInForce - Time-in-force type supported are: GTC, FOK, IOC. Default is GTC
+         * @returns An object with the result of the processed order or an error. See {@link IProcessOrder} for the returned data structure
+         */
+        this.stopLimit = function (options) {
+            /* node:coverage ignore next 4 - We don't need test for this */
+            if (!_this.experimentalConditionalOrders)
+                throw new Error("In order to use conditional orders you need to instantiate the order book with the `experimentalConditionalOrders` option set to true");
+            return _this._stopLimit(options);
+        };
+        /**
+         * Create an OCO (One-Cancels-the-Other) order.
+         * OCO order combines a `stop_limit` order and a `limit` order, where if stop price
+         * is triggered or limit order is fully or partially fulfilled, the other is canceled.
+         * Both orders have the same `side` and `size`. If you cancel one of the orders, the
+         * entire OCO order pair will be canceled.
+         *
+         * For BUY orders the `stopPrice` must be above the current price and the `price` below the current price
+         * For SELL orders the `stopPrice` must be below the current price and the `price` above the current price
+         *
+         * See {@link OCOOrderOptions} for details.
+         *
+         * @param options
+         * @param options.side - `sell` or `buy`
+         * @param options.id - Unique order ID
+         * @param options.size - How much of currency you want to trade in units of base currency
+         * @param options.price - The price of the `limit` order at which the order is to be fullfilled, in units of the quote currency
+         * @param options.stopPrice - The price at which the `stop_limit` order will be triggered.
+         * @param options.stopLimitPrice - The price of the `stop_limit` order at which the order is to be fullfilled, in units of the quote currency.
+         * @param options.timeInForce - Time-in-force of the `limit` order. Type supported are: GTC, FOK, IOC. Default is GTC
+         * @param options.stopLimitTimeInForce - Time-in-force of the `stop_limit` order. Type supported are: GTC, FOK, IOC. Default is GTC
+         * @returns An object with the result of the processed order or an error. See {@link IProcessOrder} for the returned data structure
+         */
+        this.oco = function (options) {
+            /* node:coverage ignore next 4 - We don't need test for this */
+            if (!_this.experimentalConditionalOrders)
+                throw new Error("In order to use conditional orders you need to instantiate the order book with the `experimentalConditionalOrders` option set to true");
+            return _this._oco(options);
+        };
+        /**
+         * Modify an existing order with given ID. When an order is modified by price or quantity,
+         * it will be deemed as a new entry. Under the price-time-priority algorithm, orders are
+         * prioritized according to their order price and order time. Hence, the latest orders
+         * will be placed at the back of the matching order queue.
+         *
+         * @param orderID - The ID of the order to be modified
+         * @param orderUpdate - An object with the modified size and/or price of an order. The shape of the object is `{size, price}`.
+         * @returns An object with the result of the processed order or an error
+         */
+        this.modify = function (orderID, orderUpdate) {
+            var _a, _b, _c;
+            var order = _this.orders[orderID];
+            if (order === undefined) {
+                return {
+                    done: [],
+                    activated: [],
+                    partial: null,
+                    partialQuantityProcessed: 0,
+                    quantityLeft: 0,
+                    err: (0, errors_1.CustomError)(errors_1.ERROR.ORDER_NOT_FOUND),
+                };
+            }
+            if ((orderUpdate === null || orderUpdate === void 0 ? void 0 : orderUpdate.price) !== undefined || (orderUpdate === null || orderUpdate === void 0 ? void 0 : orderUpdate.size) !== undefined) {
+                var newPrice = (_a = orderUpdate.price) !== null && _a !== void 0 ? _a : order.price;
+                var newSize = (_b = orderUpdate.size) !== null && _b !== void 0 ? _b : order.size;
+                if (newPrice > 0 && newSize > 0) {
+                    var response = _this.getProcessOrderResponse(newSize);
+                    _this._cancelOrder(order.id, true);
+                    _this.createLimitOrder(response, order.side, order.id, newSize, newPrice, order.postOnly, types_1.TimeInForce.GTC);
+                    if (_this.enableJournaling) {
+                        response.log = {
+                            opId: ++_this._lastOp,
+                            ts: Date.now(),
+                            op: "u",
+                            o: { orderID: orderID, orderUpdate: orderUpdate },
+                        };
+                    }
+                    return response;
+                }
+            }
+            // Missing one of price and/or size, or the provided ones are not greater than zero
+            return {
+                done: [],
+                activated: [],
+                partial: null,
+                partialQuantityProcessed: 0,
+                quantityLeft: (_c = orderUpdate === null || orderUpdate === void 0 ? void 0 : orderUpdate.size) !== null && _c !== void 0 ? _c : 0,
+                err: (0, errors_1.CustomError)(errors_1.ERROR.INVALID_PRICE_OR_QUANTITY),
+            };
+        };
+        /**
+         * Remove an existing order with given ID from the order book
+         *
+         * @param orderID - The ID of the order to be removed
+         * @returns The removed order if exists or `undefined`
+         */
+        this.cancel = function (orderID) {
+            return _this._cancelOrder(orderID);
+        };
+        /**
+         * Get an existing order with the given ID
+         *
+         * @param orderID - The ID of the order to be returned
+         * @returns The order if exists or `undefined`
+         */
+        this.order = function (orderID) {
+            return _this.orders[orderID];
+        };
+        // Returns price levels and volume at price level
+        this.depth = function () {
+            var asks = [];
+            var bids = [];
+            _this.asks.priceTree().forEach(function (levelPrice, level) {
+                asks.push([levelPrice, level.volume()]);
+            });
+            _this.bids.priceTree().forEach(function (levelPrice, level) {
+                bids.push([levelPrice, level.volume()]);
+            });
+            return [asks, bids];
+        };
+        this.toString = function () {
+            /* node:coverage ignore next - Don't know what is the uncovered branch here */
+            return "".concat(_this.asks.toString(), "\r\n------------------------------------").concat(_this.bids.toString());
+        };
+        // Returns total market price for requested quantity
+        // if err is not null price returns total price of all levels in side
+        this.calculateMarketPrice = function (side, size) {
+            var price = 0;
+            var err = null;
+            var level;
+            var iter;
+            var quantity = size;
+            if (side === types_1.Side.BUY) {
+                level = _this.asks.minPriceQueue();
+                iter = _this.asks.greaterThan;
+            }
+            else {
+                level = _this.bids.maxPriceQueue();
+                iter = _this.bids.lowerThan;
+            }
+            while (quantity > 0 && level !== undefined) {
+                var levelVolume = level.volume();
+                var levelPrice = level.price();
+                if (_this.greaterThanOrEqual(quantity, levelVolume)) {
+                    price += levelPrice * levelVolume;
+                    quantity -= levelVolume;
+                    level = iter(levelPrice);
+                }
+                else {
+                    price += levelPrice * quantity;
+                    quantity = 0;
+                }
+            }
+            if (quantity > 0) {
+                err = (0, errors_1.CustomError)(errors_1.ERROR.INSUFFICIENT_QUANTITY);
+            }
+            return { price: price, err: err };
+        };
+        this.snapshot = function () {
+            var bids = [];
+            var asks = [];
+            _this.bids.priceTree().forEach(function (price, orders) {
+                bids.push({ price: price, orders: orders.toArray() });
+            });
+            _this.asks.priceTree().forEach(function (price, orders) {
+                asks.push({ price: price, orders: orders.toArray() });
+            });
+            return { bids: bids, asks: asks, ts: Date.now(), lastOp: _this._lastOp };
+        };
+        this._market = function (options, incomingResponse) {
+            var response = incomingResponse !== null && incomingResponse !== void 0 ? incomingResponse : _this.validateMarketOrder(options);
+            if (response.err != null)
+                return response;
+            var quantityToTrade = options.size;
+            var iter;
+            var sideToProcess;
+            if (options.side === types_1.Side.BUY) {
+                iter = _this.asks.minPriceQueue;
+                sideToProcess = _this.asks;
+            }
+            else {
+                iter = _this.bids.maxPriceQueue;
+                sideToProcess = _this.bids;
+            }
+            var priceBefore = _this._marketPrice;
+            while (quantityToTrade > 0 && sideToProcess.len() > 0) {
+                // if sideToProcess.len > 0 it is not necessary to verify that bestPrice exists
+                var bestPrice = iter();
+                var _a = _this.processQueue(bestPrice, quantityToTrade), done = _a.done, partial = _a.partial, partialQuantityProcessed = _a.partialQuantityProcessed, quantityLeft = _a.quantityLeft;
+                response.done = response.done.concat(done);
+                response.partial = partial;
+                response.partialQuantityProcessed = partialQuantityProcessed;
+                quantityToTrade = quantityLeft;
+            }
+            response.quantityLeft = quantityToTrade;
+            _this.executeConditionalOrder(options.side, priceBefore, response);
+            if (_this.enableJournaling) {
+                response.log = {
+                    opId: ++_this._lastOp,
+                    ts: Date.now(),
+                    op: "m",
+                    o: { side: options.side, size: options.size },
+                };
+            }
+            return response;
+        };
+        this._limit = function (options, incomingResponse) {
+            var _a, _b;
+            var response = incomingResponse !== null && incomingResponse !== void 0 ? incomingResponse : _this.validateLimitOrder(options);
+            if (response.err != null)
+                return response;
+            var order = _this.createLimitOrder(response, options.side, options.id, options.size, options.price, (_a = options.postOnly) !== null && _a !== void 0 ? _a : false, (_b = options.timeInForce) !== null && _b !== void 0 ? _b : types_1.TimeInForce.GTC, options.ocoStopPrice);
+            if (_this.enableJournaling && order != null) {
+                response.log = {
+                    opId: ++_this._lastOp,
+                    ts: Date.now(),
+                    op: "l",
+                    o: {
+                        side: order.side,
+                        id: order.id,
+                        size: order.size,
+                        price: order.price,
+                        timeInForce: order.timeInForce,
+                    },
+                };
+            }
+            return response;
+        };
+        this._stopMarket = function (options) {
+            var response = _this.validateMarketOrder(options);
+            if (response.err != null)
+                return response;
+            var stopMarket = order_1.OrderFactory.createOrder(__assign(__assign({}, options), { type: types_1.OrderType.STOP_MARKET }));
+            return _this._stopOrder(stopMarket, response);
+        };
+        this._stopLimit = function (options) {
+            var _a;
+            var response = _this.validateLimitOrder(options);
+            if (response.err != null)
+                return response;
+            var stopLimit = order_1.OrderFactory.createOrder(__assign(__assign({}, options), { type: types_1.OrderType.STOP_LIMIT, timeInForce: (_a = options.timeInForce) !== null && _a !== void 0 ? _a : types_1.TimeInForce.GTC }));
+            return _this._stopOrder(stopLimit, response);
+        };
+        this._oco = function (options) {
+            var _a;
+            var response = _this.validateLimitOrder(options);
+            /* node:coverage ignore next - Already validated with limit test */
+            if (response.err != null)
+                return response;
+            if (_this.validateOCOOrder(options)) {
+                // We use the same ID for Stop Limit and Limit Order, since
+                // we check only on limit order for duplicated ids
+                _this._limit({
+                    id: options.id,
+                    side: options.side,
+                    size: options.size,
+                    price: options.price,
+                    timeInForce: options.timeInForce,
+                    ocoStopPrice: options.stopPrice,
+                }, response);
+                /* node:coverage ignore next - Already validated with limit test */
+                if (response.err != null)
+                    return response;
+                var stopLimit = order_1.OrderFactory.createOrder({
+                    type: types_1.OrderType.STOP_LIMIT,
+                    id: options.id,
+                    side: options.side,
+                    size: options.size,
+                    price: options.stopLimitPrice,
+                    stopPrice: options.stopPrice,
+                    timeInForce: (_a = options.stopLimitTimeInForce) !== null && _a !== void 0 ? _a : types_1.TimeInForce.GTC,
+                    isOCO: true,
+                });
+                _this.stopBook.add(stopLimit);
+                response.done.push(stopLimit);
+            }
+            else {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_CONDITIONAL_ORDER);
+            }
+            return response;
+        };
+        this._stopOrder = function (stopOrder, response) {
+            if (_this.stopBook.validConditionalOrder(_this._marketPrice, stopOrder)) {
+                _this.stopBook.add(stopOrder);
+                response.done.push(stopOrder);
+            }
+            else {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_CONDITIONAL_ORDER);
+            }
+            return response;
+        };
+        this.restoreSnapshot = function (snapshot) {
+            _this._lastOp = snapshot.lastOp;
+            for (var _i = 0, _a = snapshot.bids; _i < _a.length; _i++) {
+                var level = _a[_i];
+                for (var _b = 0, _c = level.orders; _b < _c.length; _b++) {
+                    var order = _c[_b];
+                    _this.orders[order.id] = order;
+                    _this.bids.append(order);
+                }
+            }
+            for (var _d = 0, _e = snapshot.asks; _d < _e.length; _d++) {
+                var level = _e[_d];
+                for (var _f = 0, _g = level.orders; _f < _g.length; _f++) {
+                    var order = _g[_f];
+                    _this.orders[order.id] = order;
+                    _this.asks.append(order);
+                }
+            }
+        };
+        /**
+         * Remove an existing order with given ID from the order book
+         * @param orderID The id of the order to be deleted
+         * @param internalDeletion Set to true when the delete comes from internal operations
+         * @returns The removed order if exists or `undefined`
+         */
+        this._cancelOrder = function (orderID, internalDeletion) {
+            if (internalDeletion === void 0) { internalDeletion = false; }
+            var order = _this.orders[orderID];
+            if (order === undefined)
+                return;
+            delete _this.orders[orderID];
+            var side = order.side === types_1.Side.BUY ? _this.bids : _this.asks;
+            var response = {
+                order: side.remove(order),
+            };
+            // Delete OCO Order only when the delete request comes from user
+            if (!internalDeletion && order.ocoStopPrice !== undefined) {
+                response.stopOrder = _this.stopBook.remove(order.side, orderID, order.ocoStopPrice);
+            }
+            if (_this.enableJournaling) {
+                response.log = {
+                    opId: internalDeletion ? _this._lastOp : ++_this._lastOp,
+                    ts: Date.now(),
+                    op: "d",
+                    o: { orderID: orderID },
+                };
+            }
+            return response;
+        };
+        this.getProcessOrderResponse = function (size) {
+            return {
+                done: [],
+                activated: [],
+                partial: null,
+                partialQuantityProcessed: 0,
+                quantityLeft: size,
+                err: null,
+            };
+        };
+        this.createLimitOrder = function (response, side, orderID, size, price, postOnly, timeInForce, ocoStopPrice) {
+            var quantityToTrade = size;
+            var sideToProcess;
+            var sideToAdd;
+            var comparator;
+            var iter;
+            if (side === types_1.Side.BUY) {
+                sideToAdd = _this.bids;
+                sideToProcess = _this.asks;
+                comparator = _this.greaterThanOrEqual;
+                iter = _this.asks.minPriceQueue;
+            }
+            else {
+                sideToAdd = _this.asks;
+                sideToProcess = _this.bids;
+                comparator = _this.lowerThanOrEqual;
+                iter = _this.bids.maxPriceQueue;
+            }
+            if (timeInForce === types_1.TimeInForce.FOK) {
+                var fillable = _this.canFillOrder(sideToProcess, side, size, price);
+                if (!fillable) {
+                    response.err = (0, errors_1.CustomError)(errors_1.ERROR.LIMIT_ORDER_FOK_NOT_FILLABLE);
+                    return;
+                }
+            }
+            var bestPrice = iter();
+            var priceBefore = _this._marketPrice;
+            while (quantityToTrade > 0 &&
+                sideToProcess.len() > 0 &&
+                bestPrice !== undefined &&
+                comparator(price, bestPrice.price())) {
+                if (postOnly) {
+                    response.err = (0, errors_1.CustomError)(errors_1.ERROR.LIMIT_ORDER_POST_ONLY);
+                    return;
+                }
+                var _a = _this.processQueue(bestPrice, quantityToTrade), done = _a.done, partial = _a.partial, partialQuantityProcessed = _a.partialQuantityProcessed, quantityLeft = _a.quantityLeft;
+                response.done = response.done.concat(done);
+                response.partial = partial;
+                response.partialQuantityProcessed = partialQuantityProcessed;
+                quantityToTrade = quantityLeft;
+                response.quantityLeft = quantityToTrade;
+                bestPrice = iter();
+            }
+            _this.executeConditionalOrder(side, priceBefore, response);
+            var order;
+            var takerQty = size - quantityToTrade;
+            var makerQty = quantityToTrade;
+            if (quantityToTrade > 0) {
+                order = order_1.OrderFactory.createOrder(__assign({ type: types_1.OrderType.LIMIT, id: orderID, side: side, size: quantityToTrade, origSize: size, price: price, time: Date.now(), timeInForce: timeInForce, postOnly: postOnly, takerQty: takerQty, makerQty: makerQty }, (ocoStopPrice !== undefined ? { ocoStopPrice: ocoStopPrice } : {})));
+                if (response.done.length > 0) {
+                    response.partialQuantityProcessed = size - quantityToTrade;
+                    response.partial = order;
+                }
+                _this.orders[orderID] = sideToAdd.append(order);
+            }
+            else {
+                var totalQuantity_1 = 0;
+                var totalPrice_1 = 0;
+                response.done.forEach(function (order) {
+                    totalQuantity_1 += order.size;
+                    totalPrice_1 += order.price * order.size;
+                });
+                if (response.partialQuantityProcessed > 0 && response.partial !== null) {
+                    totalQuantity_1 += response.partialQuantityProcessed;
+                    totalPrice_1 +=
+                        response.partial.price * response.partialQuantityProcessed;
+                }
+                order = order_1.OrderFactory.createOrder({
+                    id: orderID,
+                    type: types_1.OrderType.LIMIT,
+                    side: side,
+                    size: size,
+                    origSize: size,
+                    price: totalPrice_1 / totalQuantity_1,
+                    time: Date.now(),
+                    timeInForce: timeInForce,
+                    postOnly: postOnly,
+                    takerQty: takerQty,
+                    makerQty: makerQty,
+                });
+                response.done.push(order);
+            }
+            // If IOC order was not matched completely remove from the order book
+            if (timeInForce === types_1.TimeInForce.IOC && response.quantityLeft > 0) {
+                _this._cancelOrder(orderID, true);
+            }
+            return order;
+        };
+        this.executeConditionalOrder = function (side, priceBefore, response) {
+            if (!_this.experimentalConditionalOrders)
+                return;
+            var pendingOrders = _this.stopBook.getConditionalOrders(side, priceBefore, _this._marketPrice);
+            if (pendingOrders.length > 0) {
+                var toBeExecuted_1 = [];
+                // Before get all orders to be executed and clean up the stop queue
+                // in order to avoid that an executed limit/market order run against
+                // the same stop order queue
+                pendingOrders.forEach(function (queue) {
+                    while (queue.len() > 0) {
+                        var headOrder = queue.removeFromHead();
+                        if (headOrder !== undefined)
+                            toBeExecuted_1.push(headOrder);
+                    }
+                    // Queue is empty now so remove the priceLevel
+                    _this.stopBook.removePriceLevel(side, queue.price);
+                });
+                toBeExecuted_1.forEach(function (stopOrder) {
+                    if (stopOrder.type === types_1.OrderType.STOP_MARKET) {
+                        _this._market({
+                            id: stopOrder.id,
+                            side: stopOrder.side,
+                            size: stopOrder.size,
+                        }, response);
+                    }
+                    else {
+                        if (stopOrder.isOCO) {
+                            _this._cancelOrder(stopOrder.id, true);
+                        }
+                        _this._limit({
+                            id: stopOrder.id,
+                            side: stopOrder.side,
+                            size: stopOrder.size,
+                            price: stopOrder.price,
+                            timeInForce: stopOrder.timeInForce,
+                        }, response);
+                    }
+                    response.activated.push(stopOrder);
+                });
+            }
+        };
+        this.replayJournal = function (journal) {
+            for (var _i = 0, journal_1 = journal; _i < journal_1.length; _i++) {
+                var log = journal_1[_i];
+                switch (log.op) {
+                    case "m": {
+                        var _a = log.o, side = _a.side, size = _a.size;
+                        if (side == null || size == null) {
+                            throw (0, errors_1.CustomError)(errors_1.ERROR.INVALID_JOURNAL_LOG);
+                        }
+                        _this.market({ side: side, size: size });
+                        break;
+                    }
+                    case "l": {
+                        var _b = log.o, side = _b.side, id = _b.id, size = _b.size, price = _b.price, timeInForce = _b.timeInForce;
+                        if (side == null || id == null || size == null || price == null) {
+                            throw (0, errors_1.CustomError)(errors_1.ERROR.INVALID_JOURNAL_LOG);
+                        }
+                        _this.limit({
+                            side: side,
+                            id: id,
+                            size: size,
+                            price: price,
+                            timeInForce: timeInForce,
+                        });
+                        break;
+                    }
+                    case "d":
+                        if (log.o.orderID == null)
+                            throw (0, errors_1.CustomError)(errors_1.ERROR.INVALID_JOURNAL_LOG);
+                        _this.cancel(log.o.orderID);
+                        break;
+                    case "u":
+                        if (log.o.orderID == null || log.o.orderUpdate == null) {
+                            throw (0, errors_1.CustomError)(errors_1.ERROR.INVALID_JOURNAL_LOG);
+                        }
+                        _this.modify(log.o.orderID, log.o.orderUpdate);
+                        break;
+                    default:
+                        throw (0, errors_1.CustomError)(errors_1.ERROR.INVALID_JOURNAL_LOG);
+                }
+            }
+        };
+        /**
+         * OCO Order:
+         *    Buy: price < marketPrice < stopPrice
+         *    Sell: price > marketPrice > stopPrice
+         */
+        this.validateOCOOrder = function (options) {
+            var response = false;
+            if (options.side === types_1.Side.BUY &&
+                options.price < _this._marketPrice &&
+                _this._marketPrice < options.stopPrice) {
+                response = true;
+            }
+            if (options.side === types_1.Side.SELL &&
+                options.price > _this._marketPrice &&
+                _this._marketPrice > options.stopPrice) {
+                response = true;
+            }
+            return response;
+        };
+        this.greaterThanOrEqual = function (a, b) {
+            return a >= b;
+        };
+        this.lowerThanOrEqual = function (a, b) {
+            return a <= b;
+        };
+        this.processQueue = function (orderQueue, quantityToTrade) {
+            var response = {
+                done: [],
+                activated: [],
+                partial: null,
+                partialQuantityProcessed: 0,
+                quantityLeft: quantityToTrade,
+                err: null,
+            };
+            if (response.quantityLeft > 0) {
+                while (orderQueue.len() > 0 && response.quantityLeft > 0) {
+                    var headOrder = orderQueue.head();
+                    if (headOrder !== undefined) {
+                        if (response.quantityLeft < headOrder.size) {
+                            response.partial = order_1.OrderFactory.createOrder(__assign(__assign({}, headOrder.toObject()), { size: headOrder.size - response.quantityLeft }));
+                            _this.orders[headOrder.id] = response.partial;
+                            response.partialQuantityProcessed = response.quantityLeft;
+                            orderQueue.update(headOrder, response.partial);
+                            response.quantityLeft = 0;
+                        }
+                        else {
+                            response.quantityLeft = response.quantityLeft - headOrder.size;
+                            var canceledOrder = _this._cancelOrder(headOrder.id, true);
+                            /* node:coverage ignore next - Unable to test when order is undefined */
+                            if ((canceledOrder === null || canceledOrder === void 0 ? void 0 : canceledOrder.order) !== undefined) {
+                                response.done.push(canceledOrder.order);
+                            }
+                        }
+                        // Remove linked OCO Stop Order if any
+                        if (_this.experimentalConditionalOrders &&
+                            headOrder.ocoStopPrice !== undefined) {
+                            _this.stopBook.remove(headOrder.side, headOrder.id, headOrder.ocoStopPrice);
+                        }
+                        _this._marketPrice = headOrder.price;
+                    }
+                }
+            }
+            return response;
+        };
+        this.canFillOrder = function (orderSide, side, size, price) {
+            return side === types_1.Side.BUY
+                ? _this.buyOrderCanBeFilled(orderSide, size, price)
+                : _this.sellOrderCanBeFilled(orderSide, size, price);
+        };
+        this.buyOrderCanBeFilled = function (orderSide, size, price) {
+            if (orderSide.volume() < size) {
+                return false;
+            }
+            var cumulativeSize = 0;
+            orderSide.priceTree().forEach(function (_, level) {
+                if (price >= level.price() && cumulativeSize < size) {
+                    cumulativeSize += level.volume();
+                }
+                else {
+                    return true; // break the loop
+                }
+            });
+            return cumulativeSize >= size;
+        };
+        this.sellOrderCanBeFilled = function (orderSide, size, price) {
+            if (orderSide.volume() < size) {
+                return false;
+            }
+            var cumulativeSize = 0;
+            orderSide.priceTree().forEach(function (_, level) {
+                if (price <= level.price() && cumulativeSize < size) {
+                    cumulativeSize += level.volume();
+                }
+                else {
+                    return true; // break the loop
+                }
+            });
+            return cumulativeSize >= size;
+        };
+        this.validateMarketOrder = function (order) {
+            var response = _this.getProcessOrderResponse(order.size);
+            if (![types_1.Side.SELL, types_1.Side.BUY].includes(order.side)) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_SIDE);
+                return response;
+            }
+            if (typeof order.size !== "number" || order.size <= 0) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INSUFFICIENT_QUANTITY);
+                return response;
+            }
+            return response;
+        };
+        this.validateLimitOrder = function (options) {
+            var response = _this.getProcessOrderResponse(options.size);
+            if (![types_1.Side.SELL, types_1.Side.BUY].includes(options.side)) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_SIDE);
+                return response;
+            }
+            if (_this.orders[options.id] !== undefined) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.ORDER_ALREDY_EXISTS);
+                return response;
+            }
+            if (typeof options.size !== "number" || options.size <= 0) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_QUANTITY);
+                return response;
+            }
+            if (typeof options.price !== "number" || options.price <= 0) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_PRICE);
+                return response;
+            }
+            if (options.timeInForce &&
+                !validTimeInForce.includes(options.timeInForce)) {
+                response.err = (0, errors_1.CustomError)(errors_1.ERROR.INVALID_TIF);
+                return response;
+            }
+            return response;
+        };
+        this.bids = new orderside_1.OrderSide(types_1.Side.BUY);
+        this.asks = new orderside_1.OrderSide(types_1.Side.SELL);
+        this.enableJournaling = enableJournaling;
+        this.stopBook = new stopbook_1.StopBook();
+        this.experimentalConditionalOrders = experimentalConditionalOrders;
+        // First restore from orderbook snapshot
+        if (snapshot != null) {
+            this.restoreSnapshot(snapshot);
+        }
+        // Than replay from journal log
+        if (journal != null) {
+            if (!Array.isArray(journal))
+                throw (0, errors_1.CustomError)(errors_1.ERROR.INVALID_JOURNAL_LOG);
+            // If a snapshot is available be sure to remove logs before the last restored operation
+            if (snapshot != null && snapshot.lastOp > 0) {
+                journal = journal.filter(function (log) { return log.opId > snapshot.lastOp; });
+            }
+            this.replayJournal(journal);
+        }
+    }
+    Object.defineProperty(OrderBook.prototype, "marketPrice", {
+        // Getter for the market price
+        get: function () {
+            return this._marketPrice;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(OrderBook.prototype, "lastOp", {
+        // Getter for the lastOp
+        get: function () {
+            return this._lastOp;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    OrderBook.prototype.createOrder = function (typeOrOptions, side, size, price, orderID, timeInForce, stopPrice, stopLimitPrice, stopLimitTimeInForce, postOnly) {
+        if (timeInForce === void 0) { timeInForce = types_1.TimeInForce.GTC; }
+        if (stopLimitTimeInForce === void 0) { stopLimitTimeInForce = types_1.TimeInForce.GTC; }
+        var options;
+        // We don't want to test the deprecated signature.
+        /* node:coverage disable */
+        if (typeof typeOrOptions === "string" &&
+            side !== undefined &&
+            size !== undefined) {
+            options = {
+                type: typeOrOptions,
+                side: side,
+                size: size,
+                // @ts-expect-error
+                price: price,
+                id: orderID,
+                timeInForce: timeInForce,
+                // @ts-expect-error
+                stopPrice: stopPrice,
+                // @ts-expect-error
+                stopLimitPrice: stopLimitPrice,
+                stopLimitTimeInForce: stopLimitTimeInForce,
+                postOnly: postOnly,
+            };
+            /* node:coverage enable */
+        }
+        else if (typeof typeOrOptions === "object") {
+            options = typeOrOptions;
+            /* node:coverage disable */
+        }
+        else {
+            throw new Error("Invalid arguments.");
+        }
+        /* node:coverage enable */
+        switch (options.type) {
+            case types_1.OrderType.MARKET:
+                return this.market(options);
+            case types_1.OrderType.LIMIT:
+                return this.limit(options);
+            case types_1.OrderType.STOP_MARKET:
+                return this.stopMarket(options);
+            case types_1.OrderType.STOP_LIMIT:
+                return this.stopLimit(options);
+            case types_1.OrderType.OCO:
+                return this.oco(options);
+            default:
+                return {
+                    done: [],
+                    activated: [],
+                    partial: null,
+                    partialQuantityProcessed: 0,
+                    quantityLeft: 0,
+                    err: (0, errors_1.CustomError)(errors_1.ERROR.INVALID_ORDER_TYPE),
+                };
+        }
+    };
+    OrderBook.prototype.market = function (sideOrOptions, size) {
+        // We don't want to test the deprecated signature.
+        /* node:coverage disable */
+        if (typeof sideOrOptions === "string" && size !== undefined) {
+            return this._market({ side: sideOrOptions, size: size });
+            /* node:coverage enable */
+        }
+        if (typeof sideOrOptions === "object") {
+            return this._market(sideOrOptions);
+            /* node:coverage disable */
+        }
+        throw new Error("Invalid arguments.");
+        /* node:coverage enable */
+    };
+    OrderBook.prototype.limit = function (sideOrOptions, orderID, size, price, timeInForce) {
+        if (timeInForce === void 0) { timeInForce = types_1.TimeInForce.GTC; }
+        // We don't want to test the deprecated signature.
+        /* node:coverage disable */
+        if (typeof sideOrOptions === "string" &&
+            orderID !== undefined &&
+            size !== undefined &&
+            price !== undefined) {
+            return this._limit({
+                id: orderID,
+                side: sideOrOptions,
+                size: size,
+                price: price,
+                timeInForce: timeInForce,
+            });
+            /* node:coverage enable */
+        }
+        if (typeof sideOrOptions === "object") {
+            return this._limit(sideOrOptions);
+            /* node:coverage disable */
+        }
+        throw new Error("Invalid arguments.");
+        /* node:coverage enable */
+    };
+    return OrderBook;
+}());
+exports.OrderBook = OrderBook;