masterbtc / magic8bot Goto Github PK

This has been a wild and wonderful journey so far. First off, I wanted to say that I really appreciate the work that some of you have been putting in to this whether it be code, design, documentation, testing or project management contributions. Thank you all. I would have probably given up a long time ago if it wasn't for you guys.

Now, the update. M8b is ready for live testing. It's functional but limited in scope and functionality. A few users have reported making some profitable trades with the stock MACD strategy.

I've been working on the frontend aspect of the bot and exposed a lot of the data through a websocket server. That feature is still in a work in progress state but it completely gets rid of the concept of a configuration file. However, that means the bot is no longer "always on" and must be configured through a UI or at least some commands piped in through the WS connection.

As of writing, master branch is still relying on the configuration file and should be tested to make sure core components actually function like they're supposed to.

I'm hoping that the next update will be the announcement of the actual UI, which lives in it's own repo.

~notVitaliy

• This bot is NOT a sure-fire profit machine. Use it AT YOUR OWN RISK.
• Crypto-currency is still an experiment, and therefore so is this bot. Meaning, both may fail at any time.
• Running a bot, and trading in general requires careful study of the risks and parameters involved. A wrong setting can cause you a major loss.
• Never leave the bot un-monitored for long periods of time. this bot doesn't know when to stop, so be prepared to stop it if too much loss occurs.
• Often times the default trade parameters will underperform vs. a buy-hold strategy, so run some simulations and find the optimal parameters for your chosen exchange/pair before going "all-in".

this bot has a Discord chat! You can get in through this invite link.

Green: Shows directionality of instantiation

Purple: Blunt end of line is directly injected into the arrow end of line

Magic8bot can be run in a container. This is advantageous to users who don't want to install node dependencies locally or want to deploy the app on a server. The only prerequisite is Docker.

• Install Docker
• Download or clone magic8bot to your machine
• Copy src/conf.sample.ts to src/conf.ts
• In src/conf.ts change mongoconf host from localhost to mongodb
• From the root of the repo directory, execute the up command as described below

Interacting with an instance of magic8bot running in a container can be cumbersome. A Makefile is provided to simplify executing commands. WSL, Linux and Mac users will likely be able to use this feature without difficulty. Most Windows users will need to install Make.
Once make --v can be executed successfully, Docker commands can be run with the syntax make -- <command> <arguments>. The two dashes are annoying but necessary to enable arguments that begin with a hyphen. Available commands can be listed with make list. Alternatively, Docker commands can be run as listed in the make targets. For example, make up == docker-compose up -d

The following commands are supported:

# list available make commands  
make list  

# build app as defined in docker-compose.yml
make up  

# stop app without losing data  
make stop  

# start app  
make start  

# build Docker images defined in docker-compose.yml  
make build  

# ALL DATA WILL BE DELETED  
# stop and delete all Docker objects defined in docker-compose.yml  
make destroy  

# show status of Docker objects defined in docker-compose.yml  
make state  

# show Docker logs  
make logs  

# open a shell in the application container  
make shell  

# open a shell in the application container as admin user  
make shellw  

# sync clock in container with host's clock
make time-sync  

BTC: 32gjP2cSQqaoaZ25ixvtqNhM272sRhXWjA

ETH: 0xF0C99295CE430cc0B2ed6B9aa31a7fC10Cf0EaA9

Thanks!