yeti-discord-nft-sales-bot v1.0.3

NFT sales Discord Bot

An open source NFT sales bot for Discord.

This bot was created for the Pixelglyph Discord Server as part of the Pixelglyph DAO.

This bot was inspired by 0xEssential's OpenSea Discord Bot. Rather than polling OpenSea APIs, this package sets up an event listener and listens to transfer events directly from the blockchain and posts to a specified channel in your Discord server. It supports ETH and WETH sales.

Creating a bot

See the https://github.com/0xEssential/opensea-discord-bot README for a good explanation of setting up your bot in the Discord developer portal.

This package requires Node 16.6.0 or greater

Installation

yarn install discord-nft-sales-bot

Usage

Simple example:

import nftSalesBot from "discord-nft-sales-bot";

nftSalesBot({
  // Websocket connection to Ethereum)
  websocketURI: process.env.WEBSOCKET_URI,

  // NFT smart contract address
  contractAddress: process.env.CONTRACT_ADDRESS,

  // Bot token set up in Discord developer portal
  discordBotToken: process.env.DISCORD_BOT_TOKEN,

  // ID of channel (turn on Developer mode in Discord to get this)
  discordChannelId: process.env.DISCORD_CHANNEL_ID,
}).catch((e) => {
  // something went wrong
});

Options

The default export takes one argument which is an object with the following keys and values:

• websocketURI - Required. This is a websocket connection to Ethereum. You can easily get one of these by signing up for Infura.
• contractAddress - Required. The smart contract address for your ERC-721 smart contract.
• discordBotToken - Required. The Discord bot token for you bot. Create an application within the Discord developer portal and then create a bot within that application that can has permissions to post messages. You can reveal the token from the bot screen.
• discordChannelId - Required. The ID of the channel you want to bot to post in. You can get this by turning on Developer mode in Discord and then clicking the settings icon of the channel.
• metadataCb - Optional. A function that receives the raw NFT metadata as the first argument. Must return an object of the following type { name: string; image: string }