|
1 | | -# Binance Pump Alerts |
| 1 | +# TelegramGoodsInbot |
| 2 | +A store with the functionality of multi-cities. |
| 3 | +Бот - магазин в Телеграм с функциональностями: |
| 4 | +- мульти-города и местонахождение покупателя. |
| 5 | +- мульти-продавцы. |
| 6 | +- карточка магазина. |
| 7 | +- индивидуальные реквизиты продавцов. |
| 8 | +- безопасная сделка и корзина. |
| 9 | +- 192 города России в справочнике |
| 10 | + |
| 11 | +**Функции для пользователя** |
| 12 | +- каталог двух уровней, категория - товар |
| 13 | +- корзина |
| 14 | +- поддержка (контакты) - ссылка в диалог с администратором |
| 15 | +- FAQ - сообщение для пользователей с HTML разметкой |
| 16 | +- подробная Статистика бота: кол-во пополнений, покупок, пользователей, позиций, категорий, чистой прибыли |
| 17 | +- определение местонахождения пользователя |
| 18 | + |
| 19 | + |
| 20 | +**Функции продавца** |
| 21 | +- управление товарами |
| 22 | +- добавление собственных реквизитов QIWI, YooMoney |
| 23 | + |
| 24 | + |
| 25 | +**Функции администратора** |
| 26 | +- режим технических работ |
| 27 | +- проверка наличия обнолвения при запуске |
| 28 | +- активация/деактивация функций продажи и оплаты |
| 29 | +- добавление неограниченного количества глобальных администраторов |
| 30 | +- согласование запросов на роль администратора магазина, управляющего своими товарами в каталоге |
| 31 | +- добавление неограниченного количества администраторов магазинов |
| 32 | +- удобная и многофункциональная админ панель |
| 33 | +- определение и хранение города нахождения товара |
| 34 | +- поиск покупателей и просмотр профилей |
| 35 | +- поиск чеков покупок |
| 36 | +- рассылка сообщений всем пользователям бота |
| 37 | +- изменение и пополнение баланса пользователя |
| 38 | +- отчет о продажах продавцов |
| 39 | + |
| 40 | + |
| 41 | +**Оплата товаров** |
| 42 | +- используется библиотеки QIWI и YooMoney |
| 43 | +- настраивается администратором бота через админку |
| 44 | +- проверка работоспособности из админки |
| 45 | +- вывод баланса кошелька QIWI |
| 46 | +- индивидуальные реквизиты у каждого продавца |
| 47 | + |
| 48 | + |
| 49 | +**Каталог и товары** |
| 50 | +- User-friendly каталог |
| 51 | +- товары имеют одно изображение |
| 52 | +- гибкое управление товарами администраторами |
| 53 | +- выгрузка всех товаров |
| 54 | + |
| 55 | + |
| 56 | +**Защита** |
| 57 | +- админ-фильтры на все хендлеры, гарантирующие приватность админ функционала |
| 58 | +- защита от оплаты в тенге при пополнении баланса |
| 59 | +- защита от неправильного HTML синтаксиса |
| 60 | +- защита от повторной выдачи баланса |
| 61 | +- защита от спама в боте (Middlewares) |
| 62 | + |
| 63 | + |
| 64 | +**Настройки settings.ini** |
| 65 | +- установить токен Бота, полученный у @BotFather |
| 66 | +- установить Telegram ID администратора |
| 67 | + |
| 68 | + |
| 69 | +**Настройка** |
| 70 | +1. Скопируйте папку бота. Перейдите в папку бота. |
| 71 | +2. Выполните в командной строке "pip install -r requirements.txt". |
| 72 | +2. Заполните файл settings.ini. |
| 73 | +3. Стартовать бот. |
| 74 | +4. Заполнить информационные поля. |
| 75 | +5. Наполнить каталог товарами. |
| 76 | +6. Привлекать пользователей в каталог. |
| 77 | + |
| 78 | + |
| 79 | +**Процесс администрирования площадки** |
| 80 | +1. Согласование продавцов |
| 81 | +2. Администрирование каталога |
| 82 | +3. Администрирование денежных средств |
| 83 | +4. Поддержка и ведение сделок, разрешение споров |
| 84 | + |
| 85 | + |
| 86 | +**Процесс покупки для покупателя** |
| 87 | +1. Выбор товара. |
| 88 | +2. Пополнение счета. |
| 89 | +3. Ожидание звонка продавца и уточнение параметров домтааки. |
| 90 | +4. Получение товара. |
| 91 | +5. Подтверждение получения. |
| 92 | +6. Отправка отзыва о покупателей. |
| 93 | + |
| 94 | + |
| 95 | +**Процесс продажи для продавца** |
| 96 | +1. Получение сообщения о заказе. |
| 97 | +2. Звонок покупателю. |
| 98 | +3. Отправка товара покупателю. |
| 99 | +4. Получение отзыва о покупателей. |
| 100 | + |
| 101 | + |
| 102 | +**PRO версия:** |
| 103 | +- карточка магазина, с логотипом, телефоном, адресом. |
| 104 | +- три режима работы площадки: real | digital | hybrid. |
| 105 | + |
2 | 106 |
|
3 | | -BPA is a simple application which gets the price data from Binance Spot or Futures API and sends Telegram messages based on parameters set used to detect pumps and dumps on the Binance Exchange. |
4 | | - |
5 | | -[Demo Telegram Channel](https://t.me/binance_pump_alerts) hosted on AWS ec2 running the 'Base Stable Version' release 24/7. |
6 | | - |
7 | | - |
8 | | - |
9 | | -## Manual Setup |
10 | | - |
11 | | -1. On the command-line, run the command `pip install -r requirements.txt` while located at folder with code. |
12 | | -1. Create a new telegram bot token from [@botfather](https://t.me/BotFather). |
13 | | -1. Get telegram `chat_id` from [@get_id_bot](https://telegram.me/get_id_bot). |
14 | | - - Alternatively, a `channel_id` can be used as well. |
15 | | -1. Add pairs to watch into the watchlist or leave it empty to monitor all tickers on Binance. |
16 | | -1. Run the script with the command `python pumpAlerts.py`. |
17 | | - |
18 | | -## Docker Setup |
19 | | - |
20 | | -1. Use environment variables in the `docker-compse.yml` file to provide your config. |
21 | | - - See `entrypoint.sh` for environment variable names and the config possibilities. |
22 | | - - You can also use a `.env` file during development. |
23 | | - - If changing the config parameters, you have to make sure that search and replace will place the right parameter in the `config.yml` |
24 | | - - Emojis are more tricky therefore defining it with some tricks e.g. `PUMP_EMOJI="! \"\\\\U0001F4B9\""` |
25 | | -1. On the command line run `docker-compose up -d --build` to create and run the docker image/container. |
26 | | - |
27 | | -## Configuration |
28 | | - |
29 | | -### Mandatory Params |
30 | | - |
31 | | -1. `telegramToken`: The token obtained from[@botfather](https://t.me/BotFather). |
32 | | -2. `telegramChatId`: The bot will send the messages to this `chat_id`. It can be a group or channel as well. |
33 | | - |
34 | | -## Main Customizable Params |
35 | | - |
36 | | -1. `chartIntervals`: Can be modified to consider other timeframes, follow the format of 's' for seconds, 'm' for minutes, 'h' for hours. |
37 | | -1. `outlierIntervals`: (0.01 -> 1% , 0.1 -> 10%), modify accordingly based on needs. Avoid setting it too low to avoid noise. |
38 | | -1. `extractInterval`: Default is `1s`, Interval at which we retrieve the price information from Binance. |
39 | | -1. `pairsOfInterest`: Default is _USDT_. Other options include BUSD, BTC, ETH etc. |
40 | | -1. `topReportIntervals`: Default is `1h`,`3h`and `6h` Intervals for top pump and dump reports to be sent, ensure it is in chartIntervals + outlierIntervals as well. |
41 | | - |
42 | | -### Optional features to enable |
43 | | - |
44 | | -1. `watchlist`: Default if left empty it'll look at ALL symbols after filtering by pairs of interest. If pairs are added to the watchlist, the application will _only track the pairs specified_. |
45 | | -1. `dumpEnabled`: If `True`, the application will alert on dumps as well. |
46 | | - |
47 | | -#### Top Pump & Dump Params |
48 | | - |
49 | | -1. `topPumpEnabled`: If `True`, the application will send the Top X pumps at the defined interval. |
50 | | -1. `topDumpEnabled`: If `True`, the application will send the Top X dumps at the defined interval. |
51 | | - - Together with pump information, if enabled. |
52 | | -1. `noOfReportedCoins`: Top X amount of coins shown, adjust to show more or less within the timeframe. |
53 | | -1. `telegramAlertChatId`: Insert the alert chat_id for top pump dump alert, if left at `0`, it'll send messages to the telegram `chat_Id`. |
54 | | - For params not indicated above, refer to comments besides parameter for its use. |
55 | | - |
56 | | -#### Debug Params (Avoid modifying if possible!) |
57 | | - |
58 | | -1. `debug`: Default is `False`. Please, only enable for debugging purposes. Default logging set to info level. |
59 | | -1. `resetInterval`: Default `12h`. It clears the array used to store data price points to prevent memory issues. |
60 | | -1. `priceRetryInterval`: Default `5s`. In the case of get price fail, this is the time delay before re-attempt |
61 | | -1. `checkNewListingEnabled`: Default `True`. Enables checking and adding of new listing pairs. |
62 | | - |
63 | | -## Todo |
64 | | - |
65 | | -1. Integrate with Binance API to make trades on pumps. |
66 | | -1. Integrate with Binance Websocket API to get volume information. |
67 | | -1. Integrate with listing-predictor to monitor movements for potential listings. |
68 | | - |
69 | | -## Completed features |
70 | | - |
71 | | -1. Telegram integration |
72 | | -1. Price update every 1s |
73 | | -1. Adjustable alert % param (outliers) |
74 | | -1. Watchlist feature |
75 | | -1. Monitor future markets |
76 | | -1. Optional alert on dumps |
77 | | -1. Customizable minimum alert interval for spam prevention |
78 | | -1. Option to disable print debugs on extraction |
79 | | -1. [Test] Volume Change Updates (TEST_VOL version) |
80 | | -1. Allows long period of running without memory issues |
81 | | -1. Send periodic Top X Pump & Dump reports |
82 | | -1. Docker integration (Thanks to [@patbaumgartner](https://github.com/patbaumgartner)) |
83 | | -1. Logging integration (Thanks to [@patbaumgartner](https://github.com/patbaumgartner)) |
84 | | -1. Major Refactoring and cleanup (Thanks to [@patbaumgartner](https://github.com/patbaumgartner)) |
| 107 | +**TODO:** |
| 108 | +- вывод средств продавцами. |
0 commit comments