forked from QuantConnect/Lean
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFeeModelNotUsingAccountCurrency.cs
More file actions
178 lines (163 loc) · 7.31 KB
/
Copy pathFeeModelNotUsingAccountCurrency.cs
File metadata and controls
178 lines (163 loc) · 7.31 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
* 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 QuantConnect.Data;
using QuantConnect.Brokerages;
using QuantConnect.Orders.Fees;
using QuantConnect.Orders;
using QuantConnect.Interfaces;
using QuantConnect.Securities;
namespace QuantConnect.Algorithm.CSharp
{
/// <summary>
/// Regression test algorithm where custom a <see cref="FeeModel"/> does not use Account the Currency
/// </summary>
public class FeeModelNotUsingAccountCurrency : QCAlgorithm, IRegressionAlgorithmDefinition
{
private Security _security;
// Adding this so we only trade once, so math is easier and clear
private bool _alreadyTraded;
private int _initialEurCash = 10000;
private decimal _orderFeesInAccountCurrency;
/// <summary>
/// Initialise the data and resolution required, as well as the cash and start-end dates for your algorithm. All algorithms must initialized.
/// </summary>
public override void Initialize()
{
SetStartDate(2018, 4, 4); // Set Start Date
SetEndDate(2018, 4, 4); // Set End Date
// Set Strategy Cash (USD) to 0. This is required for
// SetHoldings(_security.Symbol, 1) not to fail
SetCash(0);
// EUR/USD conversion rate will be updated dynamically
// Note: the conversion rates are required in backtesting (for now) because of this issue:
// https://github.com/QuantConnect/Lean/issues/1859
SetCash("EUR", _initialEurCash, 1.23m);
SetBrokerageModel(BrokerageName.GDAX, AccountType.Cash);
_security = AddCrypto("BTCEUR");
// This is required because in our custom model, NonAccountCurrencyCustomFeeModel,
// fees will be charged in ETH (not Base, nor Quote, not account currency).
// Setting the cash allows the system to add a data subscription to fetch required conversion rates.
SetCash("ETH", 0, 0m);
_security.FeeModel = new NonAccountCurrencyCustomFeeModel();
}
/// <summary>
/// OnData event is the primary entry point for your algorithm. Each new data point will be pumped in here.
/// </summary>
/// <param name="data">Slice object keyed by symbol containing the stock data</param>
public override void OnData(Slice data)
{
if (!Portfolio.Invested && !_alreadyTraded)
{
_alreadyTraded = true;
SetHoldings(_security.Symbol, 1);
Debug("Purchased Stock");
}
else
{
Liquidate(_security.Symbol);
}
}
public override void OnOrderEvent(OrderEvent orderEvent)
{
Debug(Time + " " + orderEvent);
_orderFeesInAccountCurrency +=
Portfolio.CashBook.ConvertToAccountCurrency(orderEvent.OrderFee.Value).Amount;
}
public override void OnEndOfAlgorithm()
{
Log($"TotalPortfolioValue: {Portfolio.TotalPortfolioValue}");
Log($"CashBook: {Portfolio.CashBook}");
Log($"Holdings.TotalCloseProfit: {_security.Holdings.TotalCloseProfit()}");
// Fees will be applied to the corresponding Cash currency. 1 ETH * 2 trades
if (Portfolio.CashBook["ETH"].Amount != -2)
{
throw new Exception("Unexpected ETH cash amount: " +
$"{Portfolio.CashBook["ETH"].Amount}");
}
if (Portfolio.CashBook["USD"].Amount != 0)
{
throw new Exception("Unexpected USD cash amount: " +
$"{Portfolio.CashBook["USD"].Amount}");
}
if (Portfolio.CashBook["BTC"].Amount != 0)
{
throw new Exception("Unexpected BTC cash amount: " +
$"{Portfolio.CashBook["BTC"].Amount}");
}
if (Portfolio.CashBook.ContainsKey(Currencies.NullCurrency))
{
throw new Exception("Unexpected NullCurrency cash");
}
var closedTrade = TradeBuilder.ClosedTrades[0];
var profitInQuoteCurrency = (closedTrade.ExitPrice - closedTrade.EntryPrice)
* closedTrade.Quantity;
if (Portfolio.CashBook["EUR"].Amount != _initialEurCash + profitInQuoteCurrency)
{
throw new Exception("Unexpected EUR cash amount: " +
$"{Portfolio.CashBook["EUR"].Amount}");
}
if (closedTrade.TotalFees != _orderFeesInAccountCurrency)
{
throw new Exception($"Unexpected closed trades total fees {closedTrade.TotalFees}");
}
if (_security.Holdings.TotalFees != _orderFeesInAccountCurrency)
{
throw new Exception($"Unexpected closed trades total fees {closedTrade.TotalFees}");
}
}
internal class NonAccountCurrencyCustomFeeModel : FeeModel
{
public override OrderFee GetOrderFee(OrderFeeParameters parameters)
{
return new OrderFee(new CashAmount(1m, "ETH"));
}
}
/// <summary>
/// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
/// </summary>
public bool CanRunLocally { get; } = true;
/// <summary>
/// This is used by the regression test system to indicate which languages this algorithm is written in.
/// </summary>
public Language[] Languages { get; } = { Language.CSharp };
/// <summary>
/// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
/// </summary>
public Dictionary<string, string> ExpectedStatistics => new Dictionary<string, string>
{
{"Total Trades", "2"},
{"Average Win", "0%"},
{"Average Loss", "-6.67%"},
{"Compounding Annual Return", "-100.000%"},
{"Drawdown", "3.500%"},
{"Expectancy", "-1"},
{"Net Profit", "-6.428%"},
{"Sharpe Ratio", "-11.232"},
{"Loss Rate", "100%"},
{"Win Rate", "0%"},
{"Profit-Loss Ratio", "0"},
{"Alpha", "-16.193"},
{"Beta", "1173.18"},
{"Annual Standard Deviation", "0.721"},
{"Annual Variance", "0.52"},
{"Information Ratio", "-11.251"},
{"Tracking Error", "0.72"},
{"Treynor Ratio", "-0.007"},
{"Total Fees", "$804.33"}
};
}
}