Ethereum-NFT-Sales-Bot

NFT sales monitoring bot for the Ethereum blockchain. (erc721, erc1155)

Table of Contents

Click to expand

1. Market Coverage
2. GIF Generator
3. Live Demo
4. Getting Started
   • Prerequisites
   • Opensea API Key Is Now Optional
   • Installation
5. Configuration
   • Mandatory
   • Optional
   • Multi Monitoring
6. Update
7. Usage
8. Run Test
9. Lint Check
10. Notify Method
    • Twitter
    • Discord
11. Mindmap
12. Contributing
13. Contact
14. Acknowledgments
15. Collections
16. License

Market Coverage

• Opensea (Wyvren & Seaport)

• Looksrare

• X2Y2

• Gem

• Genie

• NFT Trader

(back to top)

GIF Generator

(back to top)

Live Demo

Twitter

• Azuki Sales
• BAYC Sales
• Murakami.Flowers Sales

Discord

• Live Demo Discord Server

(back to top)

Getting Started

Prerequisites

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

Opensea API Key Is Now Optional

• The bot now use Alchemy as the default NFT API. 🔗 Learn more

• If you set OPENSEA_API_KEY in the .env file, it will take priority over the Alchemy for NFT API.

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=
ALCHEMY_API_KEY=
ETHERSCAN_API_KEY=

Optional

OPENSEA_API_KEY=
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)

Update

Run the following command to update the source code:

npm run update

Usage

Run the following command to start the bot:

npm start

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

npm run debug -- <transaction-hash>

(back to top)

Run Test

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

npm test

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

(back to top)

Lint Check

To format code and fix linting errors, run the following command:

npm run fix

(back to top)

Notify Method

• Twitter

• Discord

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

1. Register Twitter developer account with Elevated access. 🔗 Link

2. Create a development app with OAuth 1.0a read-write permissions. 🔗 Link

3. 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

1. Open the Discord channel you want to receive sales event notifications.
2. From the channel menu, select Edit channel.
3. Select Integrations.
4. Select Create Webhook.
5. Enter the name of the bot that will post the message.
6. Copy the URL from the WEBHOOK URL field.
7. 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

kenryu.eth - @kenryu42 - ken0ryu@gmail.com

(back to top)

Acknowledgments

• @dsgriffin - NFT Sales Twitter Bot

(back to top)

Collections

Collections that using this bot.

Open a Pull Request to add your collection below!

Collection	Twitter	Discord
Murakami.Flowers	@MFTMKKUS	Murakami.Flowers

(back to top)

LICENSE

This project is MIT licensed.

(back to top)