![GitHub contributors](https://img.shields.io/github/contributors-anon/kenryu42/ethereum-nft-sales-bot) [![CI](https://github.com/kenryu42/ethereum-nft-sales-bot/actions/workflows/CI.yml/badge.svg)](https://github.com/kenryu42/ethereum-nft-sales-bot/actions/workflows/CI.yml) [![Release](https://github.com/kenryu42/ethereum-nft-sales-bot/actions/workflows/release.yml/badge.svg)](https://github.com/kenryu42/ethereum-nft-sales-bot/actions/workflows/release.yml) ![GitHub issues](https://img.shields.io/github/issues-raw/kenryu42/ethereum-nft-sales-bot) ![GitHub pull requests](https://img.shields.io/github/issues-pr/kenryu42/ethereum-nft-sales-bot) [![GitHub license](https://img.shields.io/github/license/kenryu42/ethereum-nft-sales-bot)](https://github.com/kenryu42/ethereum-nft-sales-bot/blob/main/LICENSE)

Ethereum NFT

Ethereum NFT sale events monitoring SDK with built-in Discord and Twitter notification.

# Table of Contents

Click to expand

Getting Started
Usage
- Docs
Built-in Notification
- Twitter
- Discord
Market Coverage
Live Demo
Unsupported Features
Contributing
Contact
Collections
License

# Getting Started ## Installation ```bash npm install enft ``` ## Prerequisites - Support [Node.js](https://nodejs.org) version >= 16 - Alchemy API Key - [apply here](https://auth.alchemyapi.io/signup) (**Recommended**) - **OR** - Infura NFT (Open Beta) API Key and API Key Secret - [apply here](https://www.infura.io/resources/apis/nft-api-beta-signup) - [fontconfig](https://www.freedesktop.org/software/fontconfig/fontconfig-user.html) is also required for generating image with text. If your system doesn't have it, please install it first. **Ubuntu/Debian:** ```bash sudo apt-get install fontconfig ``` **Fedora/RHEL/CentOS:** ```bash sudo yum install fontconfig ``` **Arch Linux:** ```bash sudo pacman -S fontconfig ``` **MacOS (Homebrew):** ```bash brew install fontconfig ``` **Windows (Chocolatey):** ```bash choco install fontconfig ``` ## Optional - Etherscan API Key for enabling ETH to USD conversion - [apply here](https://etherscan.io/register)

(back to top)

# Usage Subscribe to NFT sales events by calling `onItemSold` method. ```javascript import { Auth, ENFT } from 'enft'; const auth = { alchemy: { apiKey: 'YOUR_ALCHEMY_API_KEY' } }; const enft = new ENFT(auth); enft.onItemSold({ contractAddress: 'NFT_CONTRACT_ADDRESS', discordWebhook: 'DISCORD_WEBHOOK_URL', // optional etherscanApiKey: 'ETHERSCAN_API_KEY' // optional }); ``` To debug a specific transaction, call `debugTransaction` method. ```javascript enft.debugTransaction( { transactionHash: 'THE_TRANSACTION_HASH_TO_DEBUG', contractAddress: 'NFT_CONTRACT_ADDRESS', discordWebhook: 'DISCORD_WEBHOOK_URL' // optional }, (txData) => { console.log(txData); } ); ``` For more concise example, please refer to [Example](https://github.com/kenryu42/ethereum-nft-sales-bot/tree/main/example). ## Docs See the [auto-generated docs](https://github.com/kenryu42/ethereum-nft-sales-bot/tree/main/docs/classes/ENFT.md) for more info on methods and parameters.

(back to top)

# Built-in Notification Notification is optional. You can enabling it by setting the coresponding argument when calling `onItemSold` method. ```javascript enft.onItemSold({ discordWebhook: 'YOUR_DISCORD_WEBHOOK_URL', twitterConfig: { appKey: 'YOUR_TWITTER_APP_KEY', appSecret: 'YOUR_TWITTER_APP_SECRET', accessToken: 'YOUR_TWITTER_ACCESS_TOKEN', accessSecret: 'YOUR_TWITTER_ACCESS_SECRET' } }); ```

(back to top)

## Twitter 1. Register Twitter developer account with Elevated access. [🔗 Link](https://developer.twitter.com/en/portal/petition/essential/basic-info) 2. Create a development app with OAuth 1.0a read-write permissions. [🔗 Link](https://developer.twitter.com/en/docs/apps/app-permissions) 3. Install [Twurl](https://github.com/twitter/twurl) and run following command: ``` twurl authorize --consumer-key --consumer-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)

# Market Coverage

- [Opensea](https://opensea.io/) - [Looksrare](https://looksrare.org/) - [X2Y2](https://x2y2.io/) - [Gem](https://gem.xyz/) - [Genie](https://www.genie.xyz/) - [NFT Trader](https://www.nfttrader.io/) - [Sudoswap](https://sudoswap.xyz/#/) - [Blur](https://blur.io/)

(back to top)

# Live Demo

![gif_1](https://media2.giphy.com/media/sjKGGbK6CnM3AnJZ25/giphy.gif?cid=790b76110714c67c573d4cc5887b69aa0074c0b663666fbf&rid=giphy.gif&ct=g) ![gif_2](https://media0.giphy.com/media/ajlODzWh2qCuypxT1q/giphy.gif?cid=790b76114a9ed6d608c47cabda6b83300ec036eb7e4c602b&rid=giphy.gif&ct=g) ## Twitter - [ENFT SDK](https://twitter.com/enft_sdk) ## Discord - [Live Demo Discord Server](https://discord.gg/GjkH7qdP8X) - [Murakami.Flowers Discord Server](https://discord.gg/murakamiflowers)

(back to top)

# Unsupported Features - [ ] Uniswap - [ ] Sudo Swap OTC Any contributions are welcome!

(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**. For more information on how to contribute, [check out the contributing guide](https://github.com/kenryu42/ethereum-nft-sales-bot/blob/main/CONTRIBUTING.md).

(back to top)

# Contact kenryu.eth - [@kenryu42](https://twitter.com/kenryu42) - ken0ryu@gmail.com

(back to top)

# Collections Collections that using this bot. Open a Pull Request to add your collection below. | Collection | Twitter | Discord | | ---------------- | ----------------------------------------- | ------------------------------------------------------ | | Murakami.Flowers | [@MFTMKKUS](https://twitter.com/MFTMKKUS) | [Murakami.Flowers](https://discord.gg/murakamiflowers) |

(back to top)

# LICENSE This project is [MIT](https://github.com/kenryu42/ethereum-nft-sales-bot/blob/main/LICENSE) licensed.

(back to top)