forked from askmike/gekko
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes to be committed: reverted: README.md reverted: config.js reverted: core/baseTradingMethod.js reverted: core/candleManager.js reverted: core/candleStore.js reverted: core/portfolioManager.js reverted: core/util.js reverted: docs/internals/exchanges.md reverted: exchanges.js reverted: exchanges/cexio.js reverted: gekko.js reverted: methods/MACD.js reverted: methods/PPO.js reverted: methods/indicators/EMA.js reverted: package.json reverted: plugins.js reverted: plugins/adviceLogger.js reverted: plugins/trader.js reverted: plugins/tradingAdvisor.js deleted: bin/gekko_launch.sh deleted: bin/gekko_launch_screen.sh deleted: bin/gekko_log_grab.sh deleted: bin/gekko_screen_grab.sh Untracked files: LICENSE.md exchanges/bitfinex.js exchanges/cryptsy.js launcher lizard methods/ZERO.js methods/indicators/BinarySearch.js methods/indicators/ZERO.js methods/indicators/nikiehihsa.js methods/indicators/windowstats.js methods/indicators/x2EMA.js methods/indicators/x2MACD.js methods/indicators/x3EMA.js methods/indicators/x3nikiehihsa.js methods/nikiehihsa.js methods/x2MACD.js methods/x3nikiehihsa.js plugins/mandrillMailer.js plugins/smsPlivo.js
- Loading branch information
Sarah White
committed
Nov 19, 2014
1 parent
32551be
commit b31123a
Showing
23 changed files
with
640 additions
and
466 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,138 +1,126 @@ | ||
# Important note | ||
### Gekko (*origin of the name*) | ||
|
||
You are looking at the brand new and completetly different version of Gekko. We've tested it for quite a while though it might be possible that you encounter bugs. If you encounter a bug: check out in [the issues](https://github.com/askmike/gekko/issues/) if we are aware of it and if not create a new one :) | ||
#### 1987 movie "Wall Street" | ||
> *The most valuable commodity I know of is information.* | ||
> -- Gordon Gekko | ||
# Gekko [![Build Status](https://travis-ci.org/askmike/gekko.png)](https://travis-ci.org/askmike/gekko) | ||
## Gekko (*this tool / bot*) | ||
|
||
![Gordon Gekko](http://mikevanrossum.nl/static/gekko.jpg) | ||
This tool is based on [REST APIs](http://en.wikipedia.org/wiki/Representational_state_transfer), and is written the [node.js](https://github.com/joyent/node) dialect of javascript, which itself based on v8, Google's open source JavaScript engine. | ||
<p> <br> </p> | ||
**WARNING:** *Use Gekko at you own risk.* | ||
|
||
*The most valuable commodity I know of is information.* | ||
--- | ||
|
||
-Gordon Gekko | ||
### Automated reinvestment | ||
|
||
Gekko is a Bitcoin trading bot and backtesting platform that connects to popular Bitcoin exchanges. It is written in javascript and runs on [nodejs](http://nodejs.org). | ||
Gekko comes with a few [technical analysis (TA)](http://en.wikipedia.org/wiki/Technical_analysis) methods which implement a single indicator (*DEMA, MACD, RSI, and PPO*). The parameters of these indicators are all configurable and changing them changes the outcome drastically. Gekko's interface allows you to add your own trading methods. Read more about that in the [documentation](https://github.com/kuzetsa/gekko/blob/master/docs/internals/trading_methods.md). | ||
|
||
This is the open source do-it-yourself version, we are planning on running hosted Gekkos in the cloud which does not require you to download and install anything, configure any textfiles or deal with the commandline. If you are looking for such a solution, sign up at [Wizbit](http://wizb.it) and we'll let you know once it's out! | ||
**Note:** *much of this information is outdated, and/or not relevant to reinvestment-only mode.* | ||
|
||
*Use Gekko at you own risk.* | ||
### Supported exchanges | ||
|
||
## Main features | ||
Gekko reinvests cloud mining income on the following platforms: | ||
|
||
* Trading platform: | ||
* Paper trading | ||
* Live trading (trade bot) | ||
* ~~Backtester~~ | ||
* Market interface: | ||
* Emit market events | ||
* Basic IRC Bot | ||
- CEX.io (*Currently only BTC, planned support for NMC reinvestment.*) | ||
|
||
## Automated Trading platform | ||
### Plugin interface | ||
|
||
Gekko can watch the realtime markets. You can apply automated trading methods to realtime data coming in to do live or simulated trading (automated trading or paper trading). Gekko also stores the market data it sees so you can run the trading methods with simulate trades on a set of historical data to see whether they would have been profitable during that time (backtesting). | ||
|
||
Gekko, as well as the current bitcoin exchanges, are not built for HFT or anything related to being the fastest. The trading methods Gekko can do are based on indicators used by human day traders. The result is that Gekko does not look at data below the one minute timescale and (depending on configuration) and will normally not trade more than a couple of times per week (also depending on configuration). | ||
|
||
**So Gekko is not:** | ||
|
||
- A trading platform for human day traders with a GUI and charts. | ||
- A High frequency trading bot designed to operate on < minute resolution. | ||
- A fully automated trading bot that you turn on and will generate profit without you having to do anything. | ||
- An exchange. | ||
|
||
**Automated trading** | ||
|
||
Gekko comes with a couple of trading methods that implement a single indicator (DEMA, MACD, RSI and PPO). The parameters of these indicators are all configurable and changing them changes the outcome drastically. Additionally Gekko also provides an easy way to write your own trading methods in javascript. Read more about that in the [documentation](https://github.com/askmike/gekko/blob/master/docs/internals/trading_methods.md). | ||
|
||
## Market interface | ||
|
||
Gekko also has a plugin system that can do certain things whenever something happens or let Gekko communicate through more platforms. Gekko currently knows these plugins: | ||
Gekko also has a plugin system that can do certain things whenever something happens or let Gekko communicate through more platforms. Gekko implements the following example plugins: | ||
|
||
- Campfire: Enables Gekko to talk on [Campfire](https://campfirenow.com/) and report latest market data and advice. | ||
- IRC bot: Enables Gekko to talk on IRC and report latest market data and advice. | ||
- Mailer: Automatically sends email when your trading method has new advice. | ||
- Profit Simulator (paper trader): Hold a fake portfolio and simulate trades based on advice. | ||
- Redis Beacon: Broadcast events propagating through Gekko on [Redis pub/sub](http://redis.io/topics/pubsub). | ||
|
||
## Supported exchanges | ||
|
||
Gekko works on the following exchanges: | ||
|
||
- Mt. Gox | ||
- Bitstamp | ||
- CEX.io | ||
- Kraken | ||
- BTC-e | ||
- ~~Cryptsy~~ (In the [pipeline](https://github.com/askmike/gekko/pull/200)) | ||
### Installing Gekko | ||
|
||
## Installing Gekko | ||
Windows user? Here is a [step-by-step guide](https://github.com/kuzetsa/gekko/blob/master/docs/installing_gekko_on_windows.md) on how to get Gekko running on Windows. | ||
|
||
Windows user? Here is a [step-by-step guide](https://github.com/askmike/gekko/blob/master/docs/installing_gekko_on_windows.md) on how to get Gekko running on Windows. | ||
Gekko runs on [nodejs](http://nodejs.org/), once you have that installed you can either download all files in [a zip](https://github.com/kuzetsa/gekko/archive/master.zip) or clone the repository via git: | ||
|
||
Gekko runs on [nodejs](http://nodejs.org/), once you have that installed you can either download all files in [a zip](https://github.com/askmike/gekko/archive/master.zip) or clone the repository via git: | ||
|
||
git clone git://github.com/askmike/gekko.git | ||
``` | ||
git clone git://github.com/kuzetsa/gekko.git | ||
cd gekko | ||
``` | ||
|
||
You need to download Gekko's dependencies, which can easily be done with [npm](http://npmjs.org): | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
## Configuring Gekko | ||
|
||
> Configuring Gekko consists of three parts: | ||
> | ||
> - Watching a realtime market | ||
> - Automate trading advice | ||
> - Enabling plugins | ||
### Configuring Gekko / before you start | ||
|
||
Read the [configuring Gekko documentation](https://github.com/askmike/gekko/tree/master/docs/Configuring_gekko.md) for a detailed explanation. | ||
Read the [configuring Gekko documentation](https://github.com/kuzetsa/gekko/tree/master/docs/Configuring_gekko.md) for a detailed explanation. | ||
|
||
## Running Gekko | ||
### Running Gekko | ||
|
||
To run the bot you just have to start Gekko: | ||
|
||
``` | ||
node gekko | ||
``` | ||
|
||
You can also run Gekko silently or use more complex features, for examples check out the [advanced features](https://github.com/askmike/gekko/tree/master/docs/Advanced_features.md). | ||
You can also run Gekko silently or use more complex features, for examples check out the [advanced features](https://github.com/kuzetsa/gekko/tree/master/docs/Advanced_features.md). | ||
|
||
## Updating Gekko | ||
### Updating Gekko | ||
|
||
If you installed the bot via git you can easily fetch the latest updates by running: | ||
|
||
git pull && npm update | ||
``` | ||
git pull | ||
npm update | ||
``` | ||
|
||
## How does Gekko work? | ||
|
||
![Gekko 0.1.0 architecture](http://data.wizb.it/misc/gekko-0.1.0-architecture.jpg) | ||
### How does Gekko work? | ||
|
||
If you want to contribute or are interested in how Gekko works: | ||
|
||
- Read about [Gekko's overall architecture](https://github.com/askmike/gekko/tree/master/docs/internals/architecture.md). | ||
- Read on how to add [a new exchange to Gekko](https://github.com/askmike/gekko/tree/master/docs/internals/exchanges.md). | ||
- Read on how to [create your own plugin](https://github.com/askmike/gekko/tree/master/docs/internals/plugins.md). | ||
- Implement [your own trading method](https://github.com/askmike/gekko/blob/master/docs/internals/trading_methods.md) and share it back. | ||
|
||
## TODO | ||
|
||
* Backtester | ||
* More exchanges (bitfinex, btcchina) | ||
* More indicators | ||
* Webbased interface | ||
- Read about [Gekko's overall architecture](https://github.com/kuzetsa/gekko/tree/master/docs/internals/architecture.md). | ||
- Read on how to add [a new exchange to Gekko](https://github.com/kuzetsa/gekko/tree/master/docs/internals/exchanges.md). | ||
- Read on how to [create your own plugin](https://github.com/kuzetsa/gekko/tree/master/docs/internals/plugins.md). | ||
- Implement [your own trading method](https://github.com/kuzetsa/gekko/blob/master/docs/internals/trading_methods.md) and share it back. | ||
|
||
## Credits | ||
|
||
* The title is inspired by [Bateman](https://github.com/fearofcode/bateman). | ||
* This project is inspired by the [GoxTradingBot](https://github.com/virtimus/GoxTradingBot/) Chrome plugin (though no code is taken from it). | ||
* Original implementation of gekko was written by [Mike van Rossum](https://github.com/askmike/gekko) | ||
* After 2014, June 25th, reinvestment-only fork maintained by [Sarah White AKA kuzetsa](https://github.com/kuzetsa/gekko) | ||
* Credits for the reduced-lag EMA methods go to Patrick G. Mulloy for publishing<br>"Smoothing Data With Less Lag" in 1994 | ||
|
||
### License | ||
|
||
(*Legal rights and restrictions to copy and use this code*) | ||
|
||
#### [GNU Affero General Public License (AGPL) version 3](https://github.com/kuzetsa/gekko/blob/c325e25ba78fd9657dff275a4f901311755e7c67/LICENSE.md) | ||
|
||
Copyright (c) 2013-2014 Sarah White (*AKA* **kuzetsa**, *forked 2014 June 25th*) | ||
|
||
This file is part of gekko. | ||
|
||
gekko is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU Affero General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
|
||
gekko is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU Affero General Public License for more details. | ||
|
||
## Final | ||
You should have received a copy of the GNU Affero General Public License | ||
along with gekko. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
If Gekko helped you in any way, you can always leave me a tip at (BTC) 13r1jyivitShUiv9FJvjLH7Nh1ZZptumwW | ||
--- | ||
|
||
## License | ||
> I, [Sarah White (kuzetsa)](https://github.com/kuzetsa/) have personally opted to use the "sublicensing" right under the permissive MIT license to sublicense my own work. [All of my own code and documentation commits](https://github.com/kuzetsa/gekko/commits?author=kuzetsa) in this project are under the [AGPLv3 license](https://github.com/kuzetsa/gekko/blob/c325e25ba78fd9657dff275a4f901311755e7c67/LICENSE.md) | ||
The MIT License (MIT) | ||
#### The MIT License (MIT) | ||
|
||
Copyright (c) 2014 Mike van Rossum <[email protected]> | ||
Copyright (c) 2014 Mike van Rossum <[email protected]> (*original author, initial code in gekkobot*) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
|
@@ -150,4 +138,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. | ||
THE SOFTWARE. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.