NFT Sales Bot

About

An opensource bot that fetches NFT sales directly from the Ethereum ledger and broadcasts the information onto Twitter and Discord
Developed by TroyD41#7095, cole#9349, RT#3588, ghostrunner.eth#0001
The bot is built using Node.js and Web3.js

How does the bot work? An overview!

This bot interacts with three external components:

MongoDB Atlas: NoSQL database used to store all the sale data
Twitter: We use twitter-api-v2 to create a new tweet everytime a sale takes place!
Discord: we use discord.js to send a message to a Discord channel everytime a new sale takes place!

The bot uses a Web3 Listener using a socket connection. We use infura as the socket provider. The bot records each Transfer event for the given contract address, i.e. records everytime one NFT is transferred from one address to another (including mints). However, we funnel out mint and normal transfer transactions and only record actual sales. This is done by using two conditions: the value od the transaction and if the sender (from) was the contract address.

Once the bot detects that a sale has been made, we capture multiple datapoints from the transaction. The sample record looks like this:

{
    "value":"1.16",
    "to":"address",
    "from":"address",
    "timestamp":{"$numberInt":"165073273"},
    "tokenId":"016"
}

We then use the above record to store the transcation data in MongoDB, to create a new tweet and to send a message on a Discord channel.

Fun Fact: The bot is capable of detecting both ETH and WETH transfers for value!

Structure of the repo

server.js is the main executable file.
utils folders holds all the smaller utilities such as processing metadata for image retrieval, price converter from ETH to USD, contract ABI etc.
handlers folder holds all the required code to interact with MongoDB, Discord and Twitter using their libraries and SDKs.

Using the bot for your own project

You would need to have node and npm installed (preferrable v16 or above).

Run npm install
Create a .env file in the root folder with the following variables and put in your credentials.

MONGO_URL = "key goes here"
WEB3_PROVIDER = "key goes here"
WEB3_SOCKET_PROVIDER = "key goes here"
DATABASE = "key goes here"
COLLECTION = "key goes here"
TWTR_API_KEY= "key goes here"
TWTR_API_KEY_SECRET= "key goes here"
TWTR_ACCESS_TOKEN= "key goes here"
TWTR_ACCESS_TOKEN_SECRET= "key goes here"
DISCORD_BOT_TOKEN = 'key goes here'
DISCORD_CHANNEL_ID= 'key goes here'
CONTRACT_ADDRESS = "key goes here"

View the next section for more info on this!

Run npm start

And voila!

To run it in production, you can host this bot on Heroku or EC2 or any similar service that supports Node.js!

Preparing your applications to run the bot

To run this bot, we need a MongoDB cloud cluster, relevant keys for Twitter and Discord. You can use the following links which will take you to the official developer documentation for Twitter and Discord and to MongoDB Atlas.

Do ensure that your Twitter Application has Read and Write permissions and that your Discord bot is added to the guild.