Bot to notify you and your community about NFT sales on Joepegs.com!
Welcome to NFT Sales Bot v2.
This README and bot is meant to be easy and straightforward to use for everyone. If you have any questions or problems, feel free to DM me.
Code wasn't reviewed and isn't deployed in production right now.
This bot enables notifying about recent sales on Joepegs marketplace on Avalanche. Relies heavily on Joepegs Open API and doesn't require any on-chain interaction.
Currently supports Discord webhook.
Would love any feedback, insights or critique.
Have fun!
SECURITY IS VERY IMPORTANT IMPORTANT IN WEB3
Storing credentials in plain text file poses great threat to you/your community security. Anyone with access to your hosting service account, computer or console will be able to use them to send arbitrary messages and trick your community into phishing sites, which happens sometimes (a lot actually) and discord hacks play a significant role too.
Accidentally uploading your webhook somewhere will have similiar effect.
There are a lot of resources in web about securing your accounts, for example OpSec SelfGuard RoadMap by Officer CIA.
- Acquire your API key for Joepegs Public API here
- Acquire Discord webhook for a channel of your choosing. Discord official guide
- Python installed locally or in cloud
- Not being overly scared by console
Use source code editor like Visual Studio Code with Python interpreter installed or PyCharm
-
Clone the repo
git clone https://github.com/pecio222/nft-sales-bot.git
-
Change current directory (cd) to folder where github repository was cloned:
cd nft-sales-bot -
Install dependencies
pip install -r requirements.txt
-
Rename
.env copyto.envand enter your credentials. Remember to be cautious with your authentication tokens.DISCORD_TEST_URL="https://discord.com/api/webhooks/..." JOEPEGS_API_KEY="123abc..." -
Configure
config.jsonto your preferences according to Configuration -
Run the program
python .\main.py
Cloud installation enables you to leave this working 24/7. In this section pythonanywhere.com will be used. Paid membership recommended (cheapest and good enough option: $5/month + taxes)
- Create account, confirm email
- Go to Dashboard -> open Bash Console
- In Bash Console:
Clone github repository into pythonanywhere:
git clone https://github.com/pecio222/nft-sales-bot.gitCreate virtual environment:
mkvirtualenv myvirtualenv --python=/usr/bin/python3.9Change current directory (cd) to folder where github repository was cloned:
cd nft-sales-botInstall dependencies:
pip install -r requirements.txt-
Go to files/nft-sales-bot/.env copy (through menu on upper right or link) (https://www.pythonanywhere.com/user/{your_username}/files/home/{your_username}/nft-sales-bot) and paste your credentials into
.env copy. Do not save - save as.env -
Go to files/nft-sales-bot/config.json and configure your bot according to Configuration
For first startup private/throwaway account recommended for testing.
Also, upon first startup bot will spit out a lot of recent sales, as lastNotifiedTransactions.json file will be empty.
- Run the program.
python main.py-
Voila! It works! Observe NFTs being sold now.
-
To make sure this task runs 24/7 without breaks, go to Task tab and in Always-on tasks paste:
python3.9 /home/<your username>/nft-sales-bot/main.py
If above looks confusing at first - for visual, very easy and straightforward setup tutorial watch Charming Data's tutorial 12:26 to 16:00 without "web app" part, we don't use it here.
On free account you might get OSError: Tunnel connection failed: 403 Forbidden
Anything other that can run Python will suffice. You can try Raspberry Pi, your local computer, even Android phone maybe. Only problem is keeping it up 24/7.
You can also use any other cloud service to host this script, like Heroku or other ones.
Bot configuration is stored in config.json file. Edit it to change parameters.
general
recentSalesAmount - Choose how many recent transactions to fetch from Joepegs API in every run. Bot stores recentSalesAmount * 2 transactions in lastNotifiedTransactions.json to avoid repeating notifications. 30-50 works just fine.
salesCallIntervalSeconds - How often bot should fetch data. 60 seconds works just fine.
oldestSaleToNotify - How old should be last sale, that bot should notify about, in seconds.
channels
You can add any amount of channels/webhooks that you want here.
turnedOn - decide if bot should send notifications to this Discord [true/false].
envWebhookName - if using .env file to store webhook URL, insert variable name here [not an actual webhook].
discordBotName - choose bot name.
filter - decide if all collections should be shown, or only chosen ones. Empty list means all collections are observed. Format - list of strings:
["collection address1", "collection address2", "collection address3", ...]
Can be lowercase or checksummed.
Simplified program flow.
graph TD;
A1[[ask_joepegs_about_recent_sales]]-->|if new_sales|B1[[ask_thegraph_avax_price]]
A1[[ask_joepegs_about_recent_sales]]-->|!new_sales|C(Wait for next cycle)
B1[[ask_thegraph_avax_price]];
B1-->B2[remove_notified_sales]
B2[remove_notified_sales]-->D(get_sales_data_from_joepegs);
D(get_sales_data_from_joepegs)
D(get_sales_data_from_joepegs)-->D1[[ask_joepegs_about_sale]]
D(get_sales_data_from_joepegs)-->D2[[ask_joepegs_about_floor]]
D1[[ask_joepegs_about_sale]]-->E(filter_and_notify)
D2[[ask_joepegs_about_floor]]-->E(filter_and_notify)
E(filter_and_notify)-->|filter_collections|E1(observer.update)
E1(observer.update)-->F(write_notified_sales_to_file)
F(write_notified_sales_to_file)-->C(Wait for next cycle)
- Better handling of rate limiting. Isn't an issue for up to ~50 notifications at once now.
- Handle sweeping (batch buys) better.
- Migrate to discord.py for easy adding bot to any server without hosting.
Known bugs/smells to handle:
- Discord not always accepts images/gifs/videos, even if they are properly sent.
See the open issues for a full list of proposed features (and known issues).
Distributed under the MIT License.
If you want to talk about this repo, DM me, would be happy to help or chat.