From 80e2570edeb564d82067f10c124dd3ff6eabec9c Mon Sep 17 00:00:00 2001 From: Codi West Date: Fri, 9 Jun 2017 01:16:06 -0500 Subject: [PATCH 1/7] Added FAQ.md --- docs/FAQ.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/FAQ.md diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 0000000000..9c633e24c6 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,59 @@ +## Frequently Asked Questions + +Here are a few questions that have been asked often as well as answers from the community. + +If you have a question that is not answered here, feel free to ask in the Discord chat and suggest it to be placed here. + +Thanks! + + +## Will I make money with Zenbot? + +That depends… a lot. Different configurations and strategies will yield different results. + +The current default config and parameters will likely lose you money, so proceed with caution. Try running simulations and paper trading first to see how the bot acts (see warning below). + + +## Why do simulations, paper trading, and live trading all yield different results? + +Simulations and paper trading almost always give overly optimistic results compared to live trading. This is because simulations and paper trading both make assumptions about when/if an order is filled. + +Because Zenbot currently only supports Limit orders (which often lessen fees), there tends to be much more slippage (the difference between when the bot decides to buy and when it actually buys) in live trading. Due to this, live trading is almost always worse than sims and paper trading. + +Also, remember that past results do not guarantee future returns. + + +## Why should I use simulations or paper trading if they do not reflect live trading? + +Simulations are more optimistic than paper trading. +Paper trading is more optimistic than live trading. +Therefore, if a simulation does not yield good results, odds are that neither will paper trading or (by extension) live trading. + + +## Is Docker necessary when installing Zenbot? + +No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Ubuntu, CentOS, etc.) without Docker. + +If running Zenbot on Windows, Docker may be needed. + + +## Why does Zenbot only use Limit orders? + +On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. + +Check your exchange for fees. + + +## Will Zenbot ever support Market orders? + +The option to trade using Market orders may be added in the future. + + +## Is there a community to get involved with Zenbot? + +Of course! Check out our Discord channel: + +[![zenbot logo](https://rawgit.com/carlos8f/zenbot/master/assets/discord.png)](https://discord.gg/ZdAd2gP) + +There is also a shared Google Doc spreadsheet containing community sim results and variable descriptions: +[Click here for the Google Sheet](https://docs.google.com/spreadsheets/d/1WjFKRUY4KpkdIJiA3RVvKqiyNkMe9xtgLSfYESFXk1g/edit#gid=70204991). From 3132d148c1b80b317005c5dc558a082be0911b69 Mon Sep 17 00:00:00 2001 From: Codi West Date: Fri, 9 Jun 2017 01:17:39 -0500 Subject: [PATCH 2/7] FAQ.md - Additional spacing --- docs/FAQ.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/FAQ.md b/docs/FAQ.md index 9c633e24c6..a913dc9f12 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -30,6 +30,7 @@ Paper trading is more optimistic than live trading. Therefore, if a simulation does not yield good results, odds are that neither will paper trading or (by extension) live trading. + ## Is Docker necessary when installing Zenbot? No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Ubuntu, CentOS, etc.) without Docker. @@ -37,6 +38,7 @@ No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenb If running Zenbot on Windows, Docker may be needed. + ## Why does Zenbot only use Limit orders? On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. @@ -44,11 +46,13 @@ On most exchanges, Limit orders result in lower fees than Market orders. For ins Check your exchange for fees. + ## Will Zenbot ever support Market orders? The option to trade using Market orders may be added in the future. + ## Is there a community to get involved with Zenbot? Of course! Check out our Discord channel: From a6597198b4852292aec660a33e82096bb164a227 Mon Sep 17 00:00:00 2001 From: Codi West Date: Fri, 9 Jun 2017 02:25:40 -0500 Subject: [PATCH 3/7] Added Anchor Links & Formatting --- docs/FAQ.md | 50 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index a913dc9f12..9dea660b3a 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,15 +6,39 @@ If you have a question that is not answered here, feel free to ask in the Discor Thanks! +[Will I make money with Zenbot?](#money) -## Will I make money with Zenbot? +[Is Docker necessary when installing Zenbot?](#docker) + +[Why do simulations, paper trading, and live trading all yield different results?](#sim-live-differences) +[Why should I use simulations or paper trading if they do not reflect live trading?](#why-sim) + +[Why does Zenbot only use Limit orders?](#limit) +[Will Zenbot ever support Market orders?](#market-orders) + +[Is there a community to get involved with Zenbot?](#community) + +Errors +[Why do I keep getting a this "Nonce" error?](#error-1) + + +** Will I make money with Zenbot? ** That depends… a lot. Different configurations and strategies will yield different results. The current default config and parameters will likely lose you money, so proceed with caution. Try running simulations and paper trading first to see how the bot acts (see warning below). -## Why do simulations, paper trading, and live trading all yield different results? + +** Is Docker necessary when installing Zenbot? ** + +No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Ubuntu, CentOS, etc.) without Docker. + +If running Zenbot on Windows, Docker may be needed. + + + +** Why do simulations, paper trading, and live trading all yield different results? ** Simulations and paper trading almost always give overly optimistic results compared to live trading. This is because simulations and paper trading both make assumptions about when/if an order is filled. @@ -23,7 +47,7 @@ Because Zenbot currently only supports Limit orders (which often lessen fees), t Also, remember that past results do not guarantee future returns. -## Why should I use simulations or paper trading if they do not reflect live trading? +** Why should I use simulations or paper trading if they do not reflect live trading? ** Simulations are more optimistic than paper trading. Paper trading is more optimistic than live trading. @@ -31,15 +55,7 @@ Therefore, if a simulation does not yield good results, odds are that neither wi -## Is Docker necessary when installing Zenbot? - -No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Ubuntu, CentOS, etc.) without Docker. - -If running Zenbot on Windows, Docker may be needed. - - - -## Why does Zenbot only use Limit orders? +** Why does Zenbot only use Limit orders? ** On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. @@ -47,13 +63,13 @@ Check your exchange for fees. -## Will Zenbot ever support Market orders? +** Will Zenbot ever support Market orders? ** The option to trade using Market orders may be added in the future. -## Is there a community to get involved with Zenbot? +** Is there a community to get involved with Zenbot? ** Of course! Check out our Discord channel: @@ -61,3 +77,9 @@ Of course! Check out our Discord channel: There is also a shared Google Doc spreadsheet containing community sim results and variable descriptions: [Click here for the Google Sheet](https://docs.google.com/spreadsheets/d/1WjFKRUY4KpkdIJiA3RVvKqiyNkMe9xtgLSfYESFXk1g/edit#gid=70204991). + +### Errors + +** Why do I keep getting this "Nonce" error? How do I solve it? ** + +* Answer coming soon * \ No newline at end of file From fca4c369b41672bcfcaef305441365388e44ca7f Mon Sep 17 00:00:00 2001 From: Codi West Date: Fri, 9 Jun 2017 02:28:27 -0500 Subject: [PATCH 4/7] Formatting --- docs/FAQ.md | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 9dea660b3a..ffd16b564b 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,23 +6,17 @@ If you have a question that is not answered here, feel free to ask in the Discor Thanks! -[Will I make money with Zenbot?](#money) +* [Will I make money with Zenbot?](#money) +* [Is Docker necessary when installing Zenbot?](#docker) +* [Why do simulations, paper trading, and live trading all yield different results?](#sim-live-differences) +* [Why should I use simulations or paper trading if they do not reflect live trading?](#why-sim) +* [Why does Zenbot only use Limit orders?](#limit) +* [Will Zenbot ever support Market orders?](#market-orders) +* [Is there a community to get involved with Zenbot?](#community) +*[Why do I keep getting a this "Nonce" error?](#error-1) -[Is Docker necessary when installing Zenbot?](#docker) -[Why do simulations, paper trading, and live trading all yield different results?](#sim-live-differences) -[Why should I use simulations or paper trading if they do not reflect live trading?](#why-sim) - -[Why does Zenbot only use Limit orders?](#limit) -[Will Zenbot ever support Market orders?](#market-orders) - -[Is there a community to get involved with Zenbot?](#community) - -Errors -[Why do I keep getting a this "Nonce" error?](#error-1) - - -** Will I make money with Zenbot? ** +**Will I make money with Zenbot?** That depends… a lot. Different configurations and strategies will yield different results. @@ -30,7 +24,7 @@ The current default config and parameters will likely lose you money, so proceed -** Is Docker necessary when installing Zenbot? ** +**Is Docker necessary when installing Zenbot?** No, Docker is often not necessary to run Zenbot. It is often simpler to run Zenbot on a Linux machine (Ubuntu, CentOS, etc.) without Docker. @@ -38,7 +32,7 @@ If running Zenbot on Windows, Docker may be needed. -** Why do simulations, paper trading, and live trading all yield different results? ** +**Why do simulations, paper trading, and live trading all yield different results?** Simulations and paper trading almost always give overly optimistic results compared to live trading. This is because simulations and paper trading both make assumptions about when/if an order is filled. @@ -47,7 +41,7 @@ Because Zenbot currently only supports Limit orders (which often lessen fees), t Also, remember that past results do not guarantee future returns. -** Why should I use simulations or paper trading if they do not reflect live trading? ** +**Why should I use simulations or paper trading if they do not reflect live trading?** Simulations are more optimistic than paper trading. Paper trading is more optimistic than live trading. @@ -55,7 +49,7 @@ Therefore, if a simulation does not yield good results, odds are that neither wi -** Why does Zenbot only use Limit orders? ** +**Why does Zenbot only use Limit orders?** On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. @@ -63,13 +57,13 @@ Check your exchange for fees. -** Will Zenbot ever support Market orders? ** +**Will Zenbot ever support Market orders?** The option to trade using Market orders may be added in the future. -** Is there a community to get involved with Zenbot? ** +**Is there a community to get involved with Zenbot?** Of course! Check out our Discord channel: @@ -80,6 +74,6 @@ There is also a shared Google Doc spreadsheet containing community sim results a ### Errors -** Why do I keep getting this "Nonce" error? How do I solve it? ** +**Why do I keep getting this "Nonce" error? How do I solve it?** -* Answer coming soon * \ No newline at end of file +*Answer coming soon* \ No newline at end of file From bc71d15d4cb14d224ada5e9238d39232db79fee5 Mon Sep 17 00:00:00 2001 From: Codi West Date: Fri, 9 Jun 2017 02:30:11 -0500 Subject: [PATCH 5/7] Update FAQ.md --- docs/FAQ.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index ffd16b564b..f3d324cf41 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -13,7 +13,7 @@ Thanks! * [Why does Zenbot only use Limit orders?](#limit) * [Will Zenbot ever support Market orders?](#market-orders) * [Is there a community to get involved with Zenbot?](#community) -*[Why do I keep getting a this "Nonce" error?](#error-1) +* [Why do I keep getting a this "Nonce" error?](#error-1) **Will I make money with Zenbot?** @@ -76,4 +76,4 @@ There is also a shared Google Doc spreadsheet containing community sim results a **Why do I keep getting this "Nonce" error? How do I solve it?** -*Answer coming soon* \ No newline at end of file +*Answer coming soon* From 933fa297da237d4a04a92ae105957f8c43689e06 Mon Sep 17 00:00:00 2001 From: Codi West Date: Fri, 9 Jun 2017 19:22:46 -0500 Subject: [PATCH 6/7] Create FAQ.md --- docs/FAQ.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index f3d324cf41..4bf7fc1970 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,12 +6,15 @@ If you have a question that is not answered here, feel free to ask in the Discor Thanks! + +### Contents + * [Will I make money with Zenbot?](#money) * [Is Docker necessary when installing Zenbot?](#docker) * [Why do simulations, paper trading, and live trading all yield different results?](#sim-live-differences) * [Why should I use simulations or paper trading if they do not reflect live trading?](#why-sim) -* [Why does Zenbot only use Limit orders?](#limit) -* [Will Zenbot ever support Market orders?](#market-orders) +* [Does Zenbot use Limit orders or Market orders?](#limit-market-orders) +* [Why does Zenbot use Limit orders by default?](#limit-orders) * [Is there a community to get involved with Zenbot?](#community) * [Why do I keep getting a this "Nonce" error?](#error-1) @@ -36,11 +39,12 @@ If running Zenbot on Windows, Docker may be needed. Simulations and paper trading almost always give overly optimistic results compared to live trading. This is because simulations and paper trading both make assumptions about when/if an order is filled. -Because Zenbot currently only supports Limit orders (which often lessen fees), there tends to be much more slippage (the difference between when the bot decides to buy and when it actually buys) in live trading. Due to this, live trading is almost always worse than sims and paper trading. +Because Zenbot defaults to using Limit orders (which often lessen fees), there tends to be much more slippage (the difference between when the bot decides to buy and when it actually buys) in live trading. Due to this, live trading is almost always worse than sims and paper trading. Also, remember that past results do not guarantee future returns. + **Why should I use simulations or paper trading if they do not reflect live trading?** Simulations are more optimistic than paper trading. @@ -49,17 +53,17 @@ Therefore, if a simulation does not yield good results, odds are that neither wi -**Why does Zenbot only use Limit orders?** +**Does Zenbot use Limit orders or Market orders?** -On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. +By default, Zenbot will use Limit orders, but support for Market orders has been added. -Check your exchange for fees. +**Why does Zenbot use Limit orders by default?** -**Will Zenbot ever support Market orders?** +On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. -The option to trade using Market orders may be added in the future. +Check your exchange for fees. @@ -76,4 +80,4 @@ There is also a shared Google Doc spreadsheet containing community sim results a **Why do I keep getting this "Nonce" error? How do I solve it?** -*Answer coming soon* +This error may occur when multiple instances of Zenbot are used with the same API key. To avoid this, use a different API key for each concurrent instance of Zenbot. From 6c119d20d78e4c59928fa12cbe3628c0f060a832 Mon Sep 17 00:00:00 2001 From: Codi West Date: Sat, 10 Jun 2017 17:12:41 -0500 Subject: [PATCH 7/7] Updated FAQ --- docs/FAQ.md | 62 ++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 52 insertions(+), 10 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 4bf7fc1970..68a72bb89c 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -2,7 +2,7 @@ Here are a few questions that have been asked often as well as answers from the community. -If you have a question that is not answered here, feel free to ask in the Discord chat and suggest it to be placed here. +If you have a question that is not answered here, feel free to ask in the [Discord](#community) chat and suggest it to be placed here. Thanks! @@ -14,14 +14,16 @@ Thanks! * [Why do simulations, paper trading, and live trading all yield different results?](#sim-live-differences) * [Why should I use simulations or paper trading if they do not reflect live trading?](#why-sim) * [Does Zenbot use Limit orders or Market orders?](#limit-market-orders) -* [Why does Zenbot use Limit orders by default?](#limit-orders) * [Is there a community to get involved with Zenbot?](#community) +* [Can I install Zenbot on Windows?](#windows) +* [How do I update Zenbot?](#update) * [Why do I keep getting a this "Nonce" error?](#error-1) + **Will I make money with Zenbot?** -That depends… a lot. Different configurations and strategies will yield different results. +That depends… Different configurations and strategies will yield different results. The current default config and parameters will likely lose you money, so proceed with caution. Try running simulations and paper trading first to see how the bot acts (see warning below). @@ -53,15 +55,9 @@ Therefore, if a simulation does not yield good results, odds are that neither wi -**Does Zenbot use Limit orders or Market orders?** - -By default, Zenbot will use Limit orders, but support for Market orders has been added. - - - **Why does Zenbot use Limit orders by default?** -On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. +On most exchanges, Limit orders result in lower fees than Market orders. For instance, on GDAX there is no fee for a Limit order trade compared to a 0.25% (BTC) or 0.3% (ETH & LTC) trade fee on a Market order. Check your exchange for fees. @@ -76,8 +72,54 @@ Of course! Check out our Discord channel: There is also a shared Google Doc spreadsheet containing community sim results and variable descriptions: [Click here for the Google Sheet](https://docs.google.com/spreadsheets/d/1WjFKRUY4KpkdIJiA3RVvKqiyNkMe9xtgLSfYESFXk1g/edit#gid=70204991). + + +**Can I install Zenbot on Windows?** + +Yes, Zenbot can be installed on Windows, although it is recommended that Linux or macOS is used instead. + +To install Zenbot on Windows: + +1. Install the "Bash on Windows subsystem" (see https://msdn.microsoft.com/en-us/commandline/wsl/about for more information) + +> Note: This will change soon, seeing that Microsoft decided to have Ubuntu, Fedora and OpenSUSE available. They will also drop the requirement for requiring dev mode enabled on windows soon. Source: https://blogs.msdn.microsoft.com/commandline/2017/05/11/new-distros-coming-to-bashwsl-via-windows-store/ and https://blogs.msdn.microsoft.com/commandline/2017/06/08/developer-mode-no-longer-required-for-windows-subsystem-for-linux/ + +2. Open the terminal window, your disks will now be mounted under `/mnt/*`. So for example navigate to your directory (example: `cd /mnt/c/zenbot`) + +3. Install node (`curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -; sudo apt-get install nodejs`) + +4. Run zenbot as you would otherwise + + + +**How do I update Zenbot?** + +Without Docker: + +``` +git pull +npm install +./zenbot.sh trade --paper +``` + + +With Docker: + +'``` +git pull +docker-compose down +docker rmi zenbot_server +docker-compose build +docker-compose up -d +``` + + + + ### Errors **Why do I keep getting this "Nonce" error? How do I solve it?** This error may occur when multiple instances of Zenbot are used with the same API key. To avoid this, use a different API key for each concurrent instance of Zenbot. + +This could also occur if the Zenbot server's time is not correct. Using NTP will keep the time current and help avoid this error.