Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dancespiele/spielcrypto_worker
https://github.com/dancespiele/spielcrypto_worker
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dancespiele/spielcrypto_worker
- Owner: dancespiele
- License: other
- Created: 2020-09-13T14:37:51.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-27T18:04:54.000Z (almost 4 years ago)
- Last Synced: 2024-10-10T05:35:23.475Z (28 days ago)
- Language: Rust
- Size: 101 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-PARITY.md
Awesome Lists containing this project
README
# Spielcrypto Worker
Spielcrypto Worker is an cron job task application that add stop loss order in exchange cryptoconcurrency platforms.
## How it works
First you need to set the increment percent of your current coins price that you wish to put a stop loss using [Spielcrypto API](https://github.com/dancespiele/spielcrypto_api).
For example imagine that you have `ETH` in [Kraken](https://www.kraken.com/) and its current price is `300 EUR` and you set in [Spielcrypto API](https://github.com/dancespiele/spielcrypto_api) the parameter `new_stop_loss` an increment of `0.20` (20%) then `ETH` increase to `370 EUR` (more than 20%) in the future, the Spielcrypto Worker will add automatically a stop loss with a price of `354 EUR` (always 2% less than the stop loss set) guaranteeing a benefit of `54 EUR`, now you set the paremeter `next_stop_loss` to `0.10` (10%) and `ETH` increase to `410` (more than 10%), the application will set a stop loss of `398,86 €` based in the increment from the previous stop loss and it will continue setting new stop loss each time that price increase more than 10%.
## Requirements
* Rustup
* Account in some of the supported exchange platform (for now only support [Kraken](https://www.kraken.com/))
## How to run the application
1. Install [Spielcrypto API](https://github.com/dancespiele/spielcrypto_api)
2. `git clone https://github.com/dancespiele/spielcrypto_worker.git`
3. `cd spielcrypto_worker`
4. add the .env file:
```
SLED_URL=[PATH WHERE YOU WANT THE SLED DB FILE. NOTICE THAT THE DB IS SHARING WITH Spielcrypto API]
AMPQ_ADDR=[YOUR AMPQ ADDRESS]
SECRET=[YOUR SECRET FOR THE API]
API_URL=[Spielcrypto API URL]
EMAIL=[YOUR EMAIL TO GET THE NOTIFICATION OF THE ORDER]
TRADING_AGREEMENT=agree // FOR RESIDENTS IN GERMANY
```
5. add the keys.json file
```json
{
"account_kraken": {
"exchange" : "kraken",
"api_key" : "REMOVE THIS FOR YOUR KRAKEN API KEY",
"api_secret": "REMOVE THIS FOR YOUR KRAKEN API SECRET"
}
}
```
6. execute:
`cargo run`
7. Enjoy!
**Note:** Before to execute Spielcrypto API you need to run the RabbitMQ server first
**Note:** Spielcrypto worker will check the coin prices every 2 minutes in case that it add a stop limit order you will be notified by email if Spielcrypto API and your email server are correctly set
## Do you like Dancespiele apps?
If you like Dancespiele apps, help me supporting the projects:
- Sending coins to the address **0x619d3FA3bD7CF497d9899Ccd4d7b5663Ff318e52**
- BAT rewards in case that you use [Brave Browser](https://brave.com/)
- [Github Sponsors](https://github.com/sponsors/dancespiele)
- Burst coins to the address BURST-DPN6-2AT3-FCRL-9BBKG
## License
Spielcrypto Worker is [LICENSE PARITY](LICENSE-PARITY.md) and [LICENSE PATRON](LICENSE-PATRON.md) licensed. If you need a comercial license, sponsor to Dancespiele in the right tier or contact to `[email protected]`
**Warning:** Each functionality has unit test to avoid bugs however the author of this app is not responsible for all the issues and losses that can happen using it. Please, read the licenses.