/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Linq;
using System.Text;
using QuantConnect.Orders;
using QuantConnect.Logging;
using System.Globalization;
using QuantConnect.Securities;
using QuantConnect.Interfaces;
using System.Collections.Generic;
using QuantConnect.Securities.Option;
namespace QuantConnect.Tests.Brokerages
{
///
/// Provides test parameters and helper methods for creating combo limit orders.
///
public class ComboLimitOrderTestParameters : BaseOrderTestParameters
{
private readonly OptionStrategy _strategy;
private readonly decimal _askPrice;
private readonly decimal _bidPrice;
private readonly IOrderProperties _orderProperties;
private readonly decimal _limitPriceAdjustmentFactor;
private readonly SymbolProperties _strategyUnderlyingSymbolProperties;
///
/// The status to expect when submitting this order in most test cases.
///
public OrderStatus ExpectedStatus => OrderStatus.Submitted;
///
/// The status to expect when cancelling this order
///
public bool ExpectedCancellationResult => true;
///
/// True to continue modifying the order until it is filled, false otherwise
///
public bool ModifyUntilFilled => true;
///
/// Initializes a new instance of the class.
///
/// The Specification of the option strategy to trade.
/// The ask price used when constructing bear call spreads.
/// The bid price used when constructing bull call spreads.
///
/// A factor used to modify the limit price of the order.
/// For buy orders, the limit price is increased by this factor;
/// for sell orders, the limit price is decreased by this factor.
/// Default is 1.02 (2% adjustment).
/// Optional order properties to attach to each order.
public ComboLimitOrderTestParameters(
OptionStrategy strategy,
decimal askPrice,
decimal bidPrice,
decimal limitPriceAdjustmentFactor = 1.02m,
IOrderProperties orderProperties = null)
{
_strategy = strategy;
_askPrice = askPrice;
_bidPrice = bidPrice;
_orderProperties = orderProperties;
_limitPriceAdjustmentFactor = limitPriceAdjustmentFactor;
_strategyUnderlyingSymbolProperties = SymbolPropertiesDatabase.FromDataFolder().GetSymbolProperties(
strategy.Underlying.ID.Market, strategy.Underlying, strategy.Underlying.SecurityType, Currencies.USD);
}
///
/// Creates long combo orders (buy) for the specified quantity.
///
/// The quantity of the combo order to create.
/// A collection of combo orders representing a long position.
public IReadOnlyCollection CreateLongOrder(decimal quantity)
{
return CreateOrders(quantity, _bidPrice);
}
///
/// Creates short combo orders (sell) for the specified quantity.
///
/// The quantity of the combo order to create (will be negated internally).
/// A collection of combo orders representing a short position.
public IReadOnlyCollection CreateShortOrder(decimal quantity)
{
return CreateOrders(decimal.Negate(Math.Abs(quantity)), _askPrice);
}
///
/// Creates combo orders for a given quantity and limit price.
///
/// The quantity of each leg in the combo order.
/// The limit price to apply to the combo order.
/// A collection of instances for all legs.
private IReadOnlyCollection CreateOrders(decimal quantity, decimal limitPrice)
{
var targetOption = _strategy.CanonicalOption?.Canonical.ID.Symbol;
var legs = new List(_strategy.UnderlyingLegs);
foreach (var optionLeg in _strategy.OptionLegs)
{
var option = Symbol.CreateOption(
_strategy.Underlying,
targetOption,
_strategy.Underlying.ID.Market,
_strategy.Underlying.SecurityType.DefaultOptionStyle(),
optionLeg.Right,
optionLeg.Strike,
optionLeg.Expiration);
legs.Add(new Leg { Symbol = option, OrderPrice = optionLeg.OrderPrice, Quantity = optionLeg.Quantity });
}
var groupOrderManager = new GroupOrderManager(legs.Count, quantity, limitPrice);
return legs.Select(l => CreateComboLimitOrder(l, groupOrderManager)).ToList();
}
///
/// Modifies the limit price of an order to increase the likelihood of being filled.
///
/// The brokerage instance to apply the order update.
/// The order to modify.
/// The last observed market price of the order's underlying instrument.
/// Always returns true.
public virtual bool ModifyOrderToFill(IReadOnlyCollection orders, Func getMarketPrice)
{
var newCompositeLimitPrice = 0m;
var newPriceBuilder = new StringBuilder($"{nameof(BrokerageTests)}.{nameof(ModifyOrderToFill)}: ");
foreach (var order in orders)
{
var marketPrice = getMarketPrice(order.Symbol);
switch (order.Direction)
{
case OrderDirection.Buy:
newPriceBuilder.Append(CultureInfo.InvariantCulture, $"+ {marketPrice}{Currencies.GetCurrencySymbol(order.PriceCurrency)} ({order.Symbol.Value}) ");
newCompositeLimitPrice += marketPrice;
break;
case OrderDirection.Sell:
newPriceBuilder.Append(CultureInfo.InvariantCulture, $"- {marketPrice}{Currencies.GetCurrencySymbol(order.PriceCurrency)} ({order.Symbol.Value}) ");
newCompositeLimitPrice -= marketPrice;
break;
default:
throw new ArgumentException($"Unknown order direction: {order.Direction}");
}
}
Log.Trace(newPriceBuilder.Append(CultureInfo.InvariantCulture, $"= {newCompositeLimitPrice} - New Composite Limit Price").ToString());
var groupOrderManager = orders.First().GroupOrderManager;
var newLimitPrice = CalculateAdjustedLimitPrice(groupOrderManager.Direction, groupOrderManager.LimitPrice, newCompositeLimitPrice, _limitPriceAdjustmentFactor);
var updateFields = new UpdateOrderFields() { LimitPrice = RoundPrice(newLimitPrice, _strategyUnderlyingSymbolProperties.MinimumPriceVariation) };
ApplyUpdateOrderRequests(orders, updateFields);
return true;
}
///
/// Returns a string representation of this instance for debugging and logging purposes.
///
public override string ToString()
{
return $"{OrderType.ComboLimit}: {_strategy.Name} ({_strategy.CanonicalOption.Value})";
}
///
/// Creates a for the specified leg and direction.
///
/// The option leg to create the order for.
/// The responsible for tracking related combo orders.
/// A new for the given leg.
private ComboLimitOrder CreateComboLimitOrder(Leg leg, GroupOrderManager groupOrderManager)
{
return new ComboLimitOrder(
leg.Symbol,
((decimal)leg.Quantity).GetOrderLegGroupQuantity(groupOrderManager),
groupOrderManager.LimitPrice,
DateTime.UtcNow,
groupOrderManager,
properties: _orderProperties)
{
Status = OrderStatus.New,
PriceCurrency = _strategyUnderlyingSymbolProperties.QuoteCurrency
};
}
}
}