/* * 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.Collections.Generic; using System.Linq; using QuantConnect.Benchmarks; using QuantConnect.Orders; using QuantConnect.Orders.Fees; using QuantConnect.Securities; using QuantConnect.Securities.CryptoFuture; using QuantConnect.Util; namespace QuantConnect.Brokerages; public class dYdXBrokerageModel : DefaultBrokerageModel { /// /// Gets a map of the default markets to be used for each security type /// public override IReadOnlyDictionary DefaultMarkets { get; } = GetDefaultMarkets(Market.DYDX); /// /// Initializes a new instance of the class /// /// The type of account to be modeled, defaults to public dYdXBrokerageModel(AccountType accountType = AccountType.Margin) : base(accountType) { if (accountType != AccountType.Margin) { throw new ArgumentException("dYdXBrokerageModel only supports margin accounts", nameof(accountType)); } } /// /// Gets a new buying power model for the security, returning the default model with the security's configured leverage. /// For cash accounts, leverage = 1 is used. /// /// The security to get a buying power model for /// The buying power model for this brokerage/security public override IBuyingPowerModel GetBuyingPowerModel(Security security) { return security?.Type switch { SecurityType.CryptoFuture => new SecurityMarginModel(GetLeverage(security)), _ => base.GetBuyingPowerModel(security) }; } /// /// Provides dYdX fee model /// /// /// public override IFeeModel GetFeeModel(Security security) { return security.Type switch { SecurityType.CryptoFuture => new dYdXFeeModel(), _ => base.GetFeeModel(security) }; } /// /// Gets a new margin interest rate model for the security /// /// The security to get a margin interest rate model for /// The margin interest rate model for this brokerage public override IMarginInterestRateModel GetMarginInterestRateModel(Security security) { // only applies for perpetual futures return security.Type switch { SecurityType.CryptoFuture => new dYdXFutureMarginInterestRateModel(), _ => base.GetMarginInterestRateModel(security) }; } /// /// Get the benchmark for this model /// /// SecurityService to create the security with if needed /// The benchmark for this brokerage public override IBenchmark GetBenchmark(SecurityManager securities) { var symbol = Symbol.Create("BTCUSD", SecurityType.CryptoFuture, Market.DYDX); return SecurityBenchmark.CreateInstance(securities, symbol); //todo default conversion? } /// /// Returns true if the brokerage could accept this order update. This takes into account /// order type, security type, and order size limits. dYdX can only update inverse, linear, and option orders /// /// The security of the order /// The order to be updated /// The requested update to be made to the order /// If this function returns false, a brokerage message detailing why the order may not be updated /// True if the brokerage could update the order, false otherwise public override bool CanUpdateOrder(Security security, Order order, UpdateOrderRequest request, out BrokerageMessageEvent message) { message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.OrderUpdateNotSupported); return false; } /// /// Returns true if the brokerage could accept this order. This takes into account /// order type, security type, and order size limits. /// /// /// For example, a brokerage may have no connectivity at certain times, or an order rate/size limit /// /// The security of the order /// The order to be processed /// If this function returns false, a brokerage message detailing why the order may not be submitted /// True if the brokerage could process the order, false otherwise public override bool CanSubmitOrder(Security security, Order order, out BrokerageMessageEvent message) { if (security.Type != SecurityType.CryptoFuture) { message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.UnsupportedSecurityType(this, security)); return false; } message = null; bool quantityIsValid; switch (order) { case StopLimitOrder: case StopMarketOrder: case LimitOrder: case MarketOrder: quantityIsValid = IsValidOrderSize(security, Math.Abs(order.Quantity), out message); break; default: message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.UnsupportedOrderType(this, order, [OrderType.StopMarket, OrderType.StopLimit, OrderType.Market, OrderType.Limit])); return false; } return quantityIsValid; } private static IReadOnlyDictionary GetDefaultMarkets(string marketName) { var map = DefaultMarketMap.ToDictionary(); map[SecurityType.CryptoFuture] = marketName; return map.ToReadOnlyDictionary(); } }