This repository has been archived by the owner on Feb 16, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
plugins.js
260 lines (259 loc) · 6.28 KB
/
plugins.js
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
// All plugins supported by Gekko.
//
// Required parameters per plugin.
//
// name: Name of the plugin
// slug: name of the plugin mapped to the config key. Expected
// filename to exist in `gekko/plugins/` (only if path is not
// specified)
// async: upon creating a new plugin instance, does something async
// happen where Gekko needs to wait for? If set to true, the
// constructor will be passed a callback which it should execute
// as soon as Gekko can continue.
// modes: a list indicating in what Gekko modes this plugin is
// allowed to run. Realtime is during a live market watch and
// backtest is during a backtest.
//
//
// Optional parameters per plugin.
//
// description: text describing the plugin.
// dependencies: a list of external npm modules this plugin requires to
// be installed.
// emits: events emitted by this plugin that other plugins can subscribe to.
// path: fn that returns path of file of the plugin (overwrites `gekko/plugins/{slug}`)
// when given the configuration object (relative from `gekko/plugins/`).
// greedy: if this plugin wants to subscribe to a lot of events, but can function
// properly when some events wont be emitted.
var plugins = [
{
name: 'Candle writer',
description: 'Store candles in a database',
slug: 'candleWriter',
async: true,
modes: ['realtime', 'importer'],
path: config => config.adapter + '/writer',
version: 0.1,
},
{
name: 'Trading Advisor',
description: 'Calculate trading advice',
slug: 'tradingAdvisor',
async: true,
modes: ['realtime', 'backtest'],
emits: true,
path: config => 'tradingAdvisor/tradingAdvisor.js',
},
{
name: 'IRC bot',
description: 'IRC module lets you communicate with Gekko on IRC.',
slug: 'ircbot',
async: false,
modes: ['realtime'],
dependencies: [{
module: 'irc',
version: '0.5.2'
}]
},
{
name: 'Telegram bot',
description: 'Telegram module lets you communicate with Gekko on Telegram.',
slug: 'telegrambot',
async: false,
modes: ['realtime'],
dependencies: [{
module: 'node-telegram-bot-api',
version: '0.24.0'
}]
},
{
name: 'XMPP bot',
description: 'XMPP module lets you communicate with Gekko on Jabber.',
slug: 'xmppbot',
async: false,
silent: false,
modes: ['realtime'],
dependencies: [{
module: 'node-xmpp-client',
version: '3.0.2'
}]
},
{
name: 'Pushover',
description: 'Sends pushover.',
slug: 'pushover',
async: false,
modes: ['realtime'],
dependencies: [{
module: 'pushover-notifications',
version: '0.2.3'
}]
},
{
name: 'Campfire bot',
description: 'Lets you communicate with Gekko on Campfire.',
slug: 'campfire',
async: false,
modes: ['realtime'],
dependencies: [{
module: 'ranger',
version: '0.2.4'
}]
},
{
name: 'Mailer',
description: 'Sends you an email everytime Gekko has new advice.',
slug: 'mailer',
async: true,
modes: ['realtime'],
dependencies: [{
module: 'emailjs',
version: '1.0.5'
}, {
module: 'prompt-lite',
version: '0.1.1'
}]
},
{
name: 'Advice logger',
description: '',
slug: 'adviceLogger',
async: false,
silent: true,
modes: ['realtime']
},
{
name: 'Trader',
description: 'Follows the advice and create real orders.',
slug: 'trader',
async: true,
modes: ['realtime'],
emits: true,
path: config => 'trader/trader.js',
},
{
name: 'Paper Trader',
description: 'Paper trader that simulates fake trades.',
slug: 'paperTrader',
async: false,
modes: ['realtime', 'backtest'],
emits: true,
path: config => 'paperTrader/paperTrader.js',
},
{
name: 'Performance Analyzer',
description: 'Analyzes performances of trades',
slug: 'performanceAnalyzer',
async: false,
modes: ['realtime', 'backtest'],
emits: true,
path: config => 'performanceAnalyzer/performanceAnalyzer.js',
},
{
name: 'Redis beacon',
slug: 'redisBeacon',
description: 'Publish events over Redis Pub/Sub',
async: true,
modes: ['realtime'],
dependencies: [{
module: 'redis',
version: '0.10.0'
}]
},
{
name: 'Pushbullet',
description: 'Sends advice to pushbullet.',
slug: 'pushbullet',
async: false,
modes: ['realtime'],
dependencies: [{
module: 'pushbullet',
version: '1.4.3'
}]
},
{
name: 'Kodi',
description: 'Sends advice to Kodi.',
slug: 'kodi',
async: false,
modes: ['realtime']
},
{
name: 'Candle Uploader',
description: 'Upload candles to an extneral server',
slug: 'candleUploader',
async: true,
modes: ['realtime']
},
{
name: 'Twitter',
description: 'Sends trades to twitter.',
slug: 'twitter',
async: false,
modes: ['realtime'],
dependencies: [{
module: 'twitter',
version: '1.7.1'
}]
},
{
name: 'Slack',
description: 'Sends trades to slack channel.',
slug: 'slack',
async: false,
modes: ['realtime'],
dependencies: [{
module: '@slack/client',
version: '3.13.0'
}]
},
{
name: 'IFTTT',
description: 'Sends trades to IFTTT webhook.',
slug: 'ifttt',
async: false,
modes: ['realtime']
},
{
name: 'Event logger',
description: 'Logs all gekko events.',
slug: 'eventLogger',
async: false,
modes: ['realtime', 'backtest'],
greedy: true
},
{
name: 'Backtest result export',
description: 'Exports the results of a gekko backtest',
slug: 'backtestResultExporter',
async: false,
modes: ['backtest']
},
{
name: 'Child to parent',
description: 'Relays events from the child to the parent process',
slug: 'childToParent',
async: false,
modes: ['realtime'],
greedy: true
},
{
name: 'Candle Uploader',
description: 'Upload realtime market candles to an external server',
slug: 'candleUploader',
async: true,
modes: ['realtime'],
dependencies: [{
module: 'axios',
version: '0.18.0'
}]
},
{
name: 'Blotter',
description: 'Writes all buy/sell trades to a blotter CSV file',
slug: 'blotter',
async: false,
modes: ['realtime'],
},
];
module.exports = plugins;