Skip to content
This repository has been archived by the owner on Feb 18, 2020. It is now read-only.

Commit

Permalink
Add Claim Bot configuration to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Sánchez committed Feb 27, 2019
1 parent 7831d5c commit 5bf7a8f
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
3 changes: 2 additions & 1 deletion source/bots-market-making.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ Create a config file for the bots, like the one in
* `BALANCE_CHECK_BOT`: [Configuration for balance check bot](./bots-types.html#balance-check-bot-configuration)
* `HIGH_SELL_VOLUME_BOT`: [Configuration for high sell volume bot](./bots-types.html#high-sell-volume-bot-configuration)
* `WATCH_EVENTS_BOT`: [Configuration for watch events bot](./bots-types.html#watch-events-bot)
* `DEPOSIT_BOT`: [Configuration for deposit Bot](./bots-types.html#deposit-bot-configuration)
* `DEPOSIT_BOT`: [Configuration for deposit bot](./bots-types.html#deposit-bot-configuration)
* `CLAIM_BOT`: [Configuration for claim bot](./bot-types.html#claim-bot-configuration)

WARNING: When creating a new configuration file you may name it as you wish,
but make sure you update
Expand Down
15 changes: 15 additions & 0 deletions source/bots-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,21 @@ bot will handle the rest.
* **inactivityPeriods**: a list of from-to time periods in which the bot will not deposit funds (useful when you want to withdraw)
* **checkTimeInMilliseconds**: the time between bot checking to deposit funds

## Claim Bot
This bot will check periodically for unclaimed balances in the configured markets
and will automatically claim all of them. This is useful so the bot can recover
on his own funds used on previous auctions.

### Claim Bot configuration
* `CLAIM_BOT`:
* **name**: The name to display in notifications and messages
* **factory**: The factory to create the bot. You can create your own bot if you want!
* **markets**: An object selecting the markets to watch (as explained [here](./bots-market-making.html#create-the-config-file-for-the-bots))
* **accountIndex**: The accountIndex from the accounts generated from the `MNEMONIC` that is going to be used by this bot
* **notifications**: The notification system to be used by the bot. For now only `slack` is available
* **autoClaimAuctions**: the number of previous auctions you want the bot to check (ex. 90 will correspond to aprox 3 weeks of auctions if around 4 auctions each day)
* **cronSchedule**: You can select using crontab style a time schedule for the claim. You can check [here](https://crontab.guru/#0_02,06,10,14,18,22_*_*_*) if you have doubts.

## Watch Events Bot
This bot can watch for events in market auctions to operate immediately once an auction
has closed.
Expand Down

0 comments on commit 5bf7a8f

Please sign in to comment.