Crypto-Giveaway-TG-Bot

The bot for assigning tasks for users with internal points awards and verifying their completion by admins

Setup Docker:

1. Create .env file for bot (based on ./.env.example) and fill it
2. Create .env file for admin-panel (based on ./AdminPanel/inc/.env.example) in ./AdminPanel/inc/ and fill it
3. Comment/Uncomment DB data in docker-compose (Line 14 - Line 18)
4. Run docker-compose up --build

OR Manually Setup Bot:

1. Create DB
   • Import sql template ./database/bot-database.sql
2. Create .env file (based on .env.example) and fill it
3. Install packages: pip install -r requirements.txt
4. Run main.py

[OPTIONAL] Setup AdminPanel:

1. Create .env for admin-panel (based on ./AdminPanel/inc/.env.example) in ./AdminPanel/inc/ and fill it
2. Run composer install in ./AdminPanel
3. Create admin-user for login to AdminPanel in panel_accounts DB table (passwords must be hashed by https://phppasswordhash.com/)

Bot screenshots:

Admin Menu in Telegram:

Admin Panel (php+bootstrap):

Database info:

• users_bot - table for every users, who interacted with bot.
• tasks_bot - table with each created task for execution by users. Accessible only for bot-admins (command: /admin) or from admin panel.
• task_tracker_2 - table with tasks that after creation are assigned to each user in the bot (One-To-Many relationship).
• bundle_shop - table for creating bundles that users can buy to get more internal points.
• payment_logs - table with logs of bundle purchases that can be seen and used by administrators who have access to the admin panel.
• panel_accounts - table for creating an admin panel user (passwords must be hashed by https://phppasswordhash.com/).

Project structure:

• contracts - ERC-20 transactions for bot payments
• database - bot database requests (without ORM)
• handlers - Guide(Registration)/User/Admin functions
• keyboards - inline bot keyboards
• translations - RU/ENG localizations

General Bot Algorithm:

1. The user goes through 5 steps of registration:
   • Captcha (Select Language -> "Join" button -> Captcha)
   • Balance
   • Reaction (Join related channel)
   • Invite_Friend (Bot referral system; 3 negative bot-checks proceed user to the next stage)
   • Wallet (Enter your crypto wallet address)
   • Done (Completed registration/guide stage)
2. After registration user has functionality:
   • Profile
   • Active tasks
   • Buy tokens/points
3. Admin creates new task in admin menu
4. User goes to "My Tasks" and can complete the task by providing a link as the proof of completion
5. Admin verifies the completion of the task and if the task is confirmed, the user receives points

Admin-Panel functions:

• Verify submitted tasks
• View history of tasks completion
• Add/Edit/Delete Tasks
• Add/Edit/Delete Users
• Add/Edit/Delete Token Bundles
• View logs of bundle purchases

• _{(Admin-Panel on pure PHP with Bootstrap)}
• _{(Admin-Panel UI has only RU localization)}

Bot Main Menu:

1. User has a "My Profile" button
   • User internal points(tokens)
   • User wallet address
   • User referral link
   • User number of invited referrals
2. User has a "Active Tasks" button
   • Task name
   • Task reward amount
   • "Submit" button
3. User has a "Buy bundle" button
   • Bundle name
   • Amount of real currency conversion to internal points (Example: "1000 Tokens for 50$")
   • [WIP] "Buy" button

Bot Admin Menu:

1. Admin has a "Show Tasks" button
   • Task name
   • Task assigned user
   • Task user answer (proof)
   • Task status (Not Completed/Verify/Completed)
2. Admin has a "To Verify" button
   • Task name
   • Task assigned user
   • Task user answer (proof)
   • Task status (Not Completed/Verify/Completed)
   • "Approve" and "Cancel" button
3. Admin has a "Create Task" button
   • Input Task name (string)
   • How many times to complete the task (int)
   • Task reward (int)
4. Admin has a "Return to Main Menu" button.

Detailed Registration(Guide) Algorithm:

Captcha Stage

1. User initiates the first communication with bot by command: /start.
2. Bot recognizes in what language to communicate with the user [RU/ENG].
3. Bot greets the user and sends a "Join" button which will start the registration stage.
4. User clicks "Join" button.
5. Bot sends the user a generated captcha to verify the user's humanity.
6. User must enter the correct captcha otherwise the bot will generate a new one and wait for the user to respond.
7. User enters the correct captcha

Balance Stage

8. Bot sends a balance message
9. User clicks the "Balance" button

Reaction Stage

10. Bot sends a link to the channel user need to subscribe to
11. User clicks on the "Subscribed" button
12. Bot verifies through the admin access in this channel if the user is in this telegram channel

Invite_Friend(Referral) Stage

13. Bot sends the user a link with their referral link (?start=referral_id)
14. User has to click the "Invited a friend" button himself, then the user will run the bot remind scheduler to verify the friend invitation in the bot
15. If user receives a negative check 3 times, the user will be skipped to the next registration steps

Wallet Stage

16. User is asked to input address of his crypto wallet for withdrawal of funds

Done(Finished) Stage

17. User proceed to the main menu of the bot

WIP Features:

• Telegram payment
  • buy_tokens_callback_run
  • checkout
  • got_payment
• Smart contracts payment
  • token_transaction
• Smart contracts transactions from Owner-Wallet to Receiver-Wallet on Testnet
  • token_transaction

[WIP] Setup Smart Contracts:

1. Create ERC-20 Token on Testnet
2. Download and place ABI file in .json format to ./contracts
3. Set path to your ABI file in: ./contracts/token_transactions.py
4. In .env file:
   • Set PRIVATE_KEY_COIN - your private key for created Token
   • Set COIN_API - your API for ERC-20 Testnet