Документация

Документация робота WhiteBox™

Содержание

Документация пока еще пишется.

 

  • Требования — минимальные системные требования к ПК
  • Первый запуск — для тех кто впервые
  • Безопасность — чтобы никто не смог Вас обокрасть
  • Настройки — про окно настроек робота
  • Интерфейс — про главное окно робота

Минимальные системные требования к ПК

Есть версия только для Windows, версий для других ОС нет и не планируется. Разумнее всего использовать робота на арендованном виртуальном сервере (VPS, не VDS — стоят от $2 в месяц), а не на домашнем ПК. При этом для эксперимента пробовать на домашнем ПК вполне рационально. Из-за того что робота желательно держать на сервере мы решили что версий для других ОС делать не имеет смысла.

 

  • Windows 7 и старше (либо Windows Server 2008 и старше)
  • Разрешение экрана от 1024×600 (адаптирован)
  • Надёжное соединение с Интернетом ЛЮБОЙ скорости
  • От 512 Mb оперативной памяти (желательно 1 Gb и более)
  • От 500 Mb дискового пространства
  • Любой процессор CPU, любая видеокарта GPU

 

Робот сможет нормально работать на самом дешевом нетбуке из магазина, если там Windows 7 или старше. На ОС Andriod робот работать не будет!

На ПК с работающим роботом можно комфортно запускать требовательные компьютерные игры, это не будет мешать.

Первый запуск

Здесь очень краткая пошаговая инструкция для тех кто запускает робота WhiteBox в первый раз. Описано далеко не всё, здесь лишь необходимый минимум.

Портативный

Робот не требует установки, его можно переносить с компьютера на компьютер со всеми настройками. Так задумано для удобства в первую очередь.

Для биржи BitMEX.com

Другие биржи пока не поддерживает, но будут добавлены в будущем. Для запуска у Вас должен быть аккаунт на бирже BitMEX.com и хотя бы минимальное количество средств на счёте (даже 1 доллара может хватить для тестирования).

Создание API-ключа

Робот никак не сможет работать без API-ключей. Биржи API-ключи для того и сделали, чтобы различные программы (например, роботы) могли подключаться к биржевому аккаунту и управлять торговлей.

Пример приводится на русскоязычном интерфейсе сайта. Язык можно сменить нажав на флаг наверху страницы.

  • Шаг 1. Войдите в личный кабинет на BitMEX.com
  • Шаг 2. Нажмите «Аккаунт»
  • Шаг 3. Нажмите «Ключи API»

Далее не обязательные шаги, их можно пропустить.

  • Шаг 4. Введите название API-ключа на английском в поле «Имя»
  • Шаг 5. Введите IP-адрес Вашего ПК для безопасности в поле «CIDR»

Если Вы не знаете свой IP-адрес, то просто введите в любом поисковике «Узнать мой IP-адрес». Имейте ввиду, что Ваш IP-адрес должен быть статическим (постоянным), но не динамическим (значит меняется). Если Вы не знаете статический у Вас IP-адрес или динамический, то Вы можете это узнать на сайте Вашего интернет-провайдера или же позвонить им в службу поддержки. Поле не обязательное.

Роботу обязательно нужно право «Ордер» (право создавать и отменять ордеры). Но НЕ нужно право вывода средств (не ставьте эту галку в целях безопасности).

  • Шаг 6. Поставьте право ордера
  • Шаг 7. Нажмите кнопку «Создать ключ API»

Внизу должны появиться 2 длинных кода API-ключа как на снимке экрана ниже, именно их нужно передать роботу. Он их сразу зашифрует.

Далее нужно запустить робота (если еще не запущен) и установить ему API-ключ от биржевого аккаунта.

  • Шаг 8. Запустите робота
  • Шаг 9. Нажмите кнопку «Settings» («Настройки»)

Переключим язык на русский. Если вставить коды API-ключа (нужно оба) то пока Вы не закроете окно ключи будут видны Вам, но после закрытия окна настроек ключи навсегда зашифруются, и больше их посмотреть будет нельзя. То есть если посторонний человек получит Вашу копию робота WhiteBox, то он не сможет посмотреть или скопировать Ваш API-ключ (поэтому можно спокойно держать копию робота на чужом сервере, например).

  • Шаг 10. Меняем язык в выпадающем списке
  • Шаг 11. Вставляем коды ключа

В нижнем левом углу есть кнопка «Проверка», нажмите. Если проверка сообщает о проблемах значит что-то неверно сделано.

  • Шаг 12. Нажмите кнопку «Проверка»
  • Шаг 13. Закройте окно настроек

Теперь можно настроить торговые параметры. Для этого есть файлы готовых настроек (пресеты). Эти файлы можно открывать простым текстовым редактором Windows («Блокнотом»), если Вам это будет зачем то нужно. Большая кнопка с коробкой это кнопка «Открыть файл». При этом сразу откроется нужная папка, менять папку не нужно.

  • Шаг 14. Нажмите большую кнопку с коробкой
  • Шаг 15. Выберете файл (например, «BitMEX (any)-USD.ini»)
  • Шаг 16. Выберете нужную Вам пару (например, XBTUSD)
  • Шаг 17. В левом верхнем углу нажмите кнопку «Запуск»

Если на бирже появились 2 ордера на выбранной Вами паре, то Вы всё сделали правильно. Для проверки Вы можете на бирже отменить один ордер или оба, и тогда робот их выставит снова. Если робот снова выставил отмененный Вами ордер, то значит всё работает правильно.

Меры безопасности

Если Вы предпримете все нижеперечисленные меры безопасности, то обокрасть Вас никто не сможет, и мы тоже (если бы пожелали).

  • Не давайте ключи. Никому не передавайте Ваши ключи API или пару логин/пароль от биржевого аккаунта, даже если попросим мы (злоумышленники умеют выдавать себя за других, в том числе благодаря взлому аккаунта нужного человека).
  • Не разрешайте вывод. Не давайте API ключу право вывода денежных средств с Вашего биржевого аккаунта. Роботу это право совершенно не нужно для работы.
  • Двух-факторная верификация. Используйте её если Ваша биржа имеет такую функцию.
  • Белый список IP-адресов. У многих криптовалютных бирж есть функция создания «белого списка» IP-адресов (например у BitMEX.com это называется CIDR). Это значит что подключиться по ключу API к Вашему аккаунту получится только с IP-адреса из Вашего списка (там обычно один адрес делают). Кроме того, злоумышленник даже если как-то смог получить Ваш API-ключ, то IP-адрес ему просто не известен.
  • Используйте антивирус. Каждый раз скачивая новую версию робота (обновление) используйте антивирусную программу. Если на Вашем ПК нет антивируса, то воспользуйтесь онлайн-антивирусами — это просто, быстро и бесплатно.
  • Используйте FireWall. Вы можете запретить роботу делать любые подключения, кроме подключения к бирже, через запрет в VPN или программами типа FireWall. Эта мера гарантирует Вам что робот не будет отправлять Ваши API-ключи куда не следует. То есть это защита скорее от нас. А что? Уверенность — приятное чувство, оно не лишнее.
  • Проконсультируйтесь. Если здесь Вам что-то не совсем понятно и Вы сомневаетесь в полной безопасности предложенной схемы работы, то Вы можете проконсультироваться со специалистами (системный администратор вполне подойдет). Покажите специалисту эту страницу, и разобравшись он подтвердит что при такой схеме работы, приняв все меры безопасности, украсть Ваши средства становится уже технически невозможно.

Настройки

Далее всё на примере русскоязычного интерфейса. В окне настроек имеется панель «Интерфейс».

  • Тип лота — в чём будет измеряться размер лота, в процентах от депозита, или в валюте пары.
  • Цены — как будут отображаться цены в интерфейсе, в биткойнах (типа 0,00004000) или в Сатоши (типа 4000).
  • Слайдер — какое количество делений будет у слайдера при торговле.
  • Автозапуск торговли — если галка стоит, то при запуске робота сразу же запускается торговля с последним выбранным файлом пресета, что полезно для автостарта вместе с Windows или при использовании рестартера (о нём позже).

Остальные настройки интуитивно-понятны и не нуждаются в объяснении.

Интерфейс

Верхние кнопки и галки

  • Запуск — запускает торговлю (заменяется на кнопку «Стоп»)
  • Стоп — останавливает торговлю
  • Стратегия / Пара — переключает интерфейс на выбор стратегии / пары
  • Таблицы — включает/отключает таблицы справа в интерфейсе
  • Поверх — интерфейс будет поверх всех окон
  • Звук — включает/отключает звуковые оповещения

Пресеты

Слева панели отображается полный путь к текущему выбранному файлу готовых настроек (пресету). Файл-пресет можно открывать текстовым редактором Windows («Блокнотом»).

  • Большая кнопка с коробкой — открыть файл-пресет
  • Запись — записать измененные настройки стратегии в выбранный файл
  • Копия — создать отдельную копию файла-пресета

Инструмент

Какую пару и на какой бирже будет торговать? Лучше выбирать по порядку сверху вниз. То есть сначала биржу, потом валюту, потом пару. Все валюты и пары автоматически сортируются в алфавитном порядке для удобства. Все пары и валюты автоматически подгружаются с биржи. То есть новые пары, которые биржа добавит в будущем робот сможет видеть и нормально с ними работать без специальных обновлений.

Параметр «Цены» устанавливается автоматически в момент выбора пары, и означает количество знаков после запятой. Вручную его менять не нужно. Это сделано на случай если биржа изменит количество знаков после запятой у пары (это вряд ли будет, но такое возможно). Если биржа изменит количество знаков после запятой, то придется устанавливать его вручную.

Стратегия

Панель стратегии появляется если нажать верхнюю кнопку «Стратегия». Запускать торговлю можно и без стратегии — для торговли вручную, что удобно для получения премии мейкера и борьбы с загруженностью биржи.

  • Галки лонг/шорт — разрешаем ли лонг и шорт.
  • Страт. — торговая стратегия по которой будет торговать.
  • Корр. — корректор для вмешательства в торговлю вручную. Как он будет выглядеть: как слайдер (ползунок), или как поле ввода. Корректор отображается в верхнем левом углу интерфейса после запуска торговли.
  • ТФ — таймфрейм.

Торговля

Лот измеряется либо в процентах от депозита, либо в количестве валюты, смотря что Вы выбрали в настройках робота (кнопка «Настройки» > панель «Интерфейс» > «Тип лота»). По умолчанию в процентах. Тогда 100 означает торговлю на 100% от депозита (плечо 1 к 1). Чтобы торговать с плечом 3 к 1 нужно соответственно выставить лот 300.

Пирамидинг не используется в стратегии ShiftMA.

«Откр.» и «Закр.» — это режимы выставления ордера. Пока работает только лимитный режим.

К сожалению, документация (мануал) пока еще не готова и постепенно пишется. Вопросы можете задать в Telegram-чате.