ethereum-nft-sales-bot: A JavaScript repository from sterlingcrispin

Ethereum-NFT-Sales-Bot

NFT sales monitoring bot for the Ethereum blockchain. (ERC721, ERC1155)

Contents

Market Coverage
GIF Generator
Live Demo
Getting Started
- Prerequisites
- Installation
Configuration
Run Test
Usage
Notify Method
- Twitter
- Discord
Mindmap
Contributing
Contact
Acknowledgments
License

Market Coverage

Opensea (Wyvren & Seaport)
Looksrare
X2Y2
Gem
Genie
NFT Trader

(back to top)

GIF Generator

(back to top)

Live Demo

Twitter

Discord

Live Demo Discord Server

(back to top)

Getting Started

Prerequisites

Install Node.js version 16
- If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
Opensea API Key - apply here
Alchemy API Key - apply here
Etherscan API Key - apply here

Installation

npm install

(back to top)

Configuration

Create an .env file in the root directory of the project with the following contents:

Mandatory

CONTRACT_ADDRESS=
OPENSEA_API_KEY=
ALCHEMY_API_KEY=
ETHERSCAN_API_KEY=

Optional

TWITTER_ENABLED=
TWITTER_API_KEY=
TWITTER_API_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_SECRET=
DISCORD_ENABLED=
WEBHOOK_URL=

Multi Monitoring

For monitoring multiple NFTs at the same time, use CONTRACT_ADDRESSES in the .env file.

Example:

CONTRACT_ADDRESSES=["0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D","0x60E4d786628Fea6478F785A6d7e704777c86a7c6"]

If CONTRACT_ADDRESS and CONTRACT_ADDRESSES are both set, CONTRACT_ADDRESSES will take the priority.

🚨🚨🚨 Do not commit/include your .env file in your repository. 🚨🚨🚨

(back to top)

Run Test

To ensure your configuration(.env) is correct, run the following command:

npm test

The test should take less than a minute to run. If it fails, either APIs are down or your configuration is incorrect.

(back to top)

Usage

Run the following command to start the bot:

node app.js

To test a certain transaction for debugging purposes, run the following command:

node app.js -t <transaction-hash>

(back to top)

Notification is optional. You can turn it on in the ./.env file by setting the TWITTER_ENABLED or DISCORD_ENABLED value to 1.

For example:

TWITTER_ENABLED=1
DISCORD_ENABLED=1

(back to top)

Twitter

Register Twitter developer account with Elevated access. 🔗 Link
Create a development app with OAuth 1.0a read-write permissions. 🔗 Link
Install Twurl and run following command:
```
twurl authorize --consumer-key <your-app-key> --consumer-secret <your-app-secret>
```
This will return an URL that you should open up in your browser. Authenticate to Twitter, and then enter the returned PIN back into the terminal.

This should create a file called .twurlrc in your home directory with all the necessary information.

(back to top)

Discord

Open the Discord channel you want to receive sales event notifications.
From the channel menu, select Edit channel.
Select Integrations.
Select Create Webhook.
Enter the name of the bot that will post the message.
Copy the URL from the WEBHOOK URL field.
Click Save.

(back to top)

Mindmap

OTC Events
Add NFT Trader
Add Sudo Swap

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Please make sure to update tests as appropriate. Don't forget to give the project a star! Thanks again!