Discord NFT Stats Bot

• Description: A Discord bot made with @Javacord and @ProjectOpenSea API!
• Version: (Check main for release or develop for dev)
• Creator: Aaron Renner
• THIS BRANCH IS ONLY FOR STATISTICS

Table of Contents

• Introduction
• Setup "How to"
  • Run Spring-Boot
• Help
  • Setup Libraries and Examples

Introduction

This Java application is built on the Spring-Boot framework! This project interacts with Discord commands or startup objects in the application.yml to monitor NFT contracts and write stats to a Discord channel, see How-TO below for more details.

THIS BRANCH IS ONLY FOR STATISTICS

Setup

Properties

The following document formatting MUST REMAIN THE SAME, replace or add only where noted to! Tips:

• THIS BRANCH IS ONLY FOR STATISTICS
• The position of the discord and stats items below nft-bot are essential!

# Custom
nft-bot:
  apiKeyOpensea: <Required for runtime>
  discord:
    token: <DISCORD-TOKEN>
    commandPrefix: <DISCORD-COMMAND-PREFIX>
  stats:
    - contractAddress: <PLACE A ERC-721 CONTRACT ADDRESS>
      contractSlug: <for SOL. Overrides the contractAddress value above>
      interval: <PLACE INTERVAL IN MS: EX. 30000 = 30 SECONDS>
      enableHolders*: <boolean to enable the next value>
      holdersOutputChannelId*: <Discord channel id>
    - [...] <CAN SUPPORT INFINITE STATS>
    
(*) = is optional

Running PROD

Setup the SPRING_APPLICATION_JSON value in the Docker-Compose. See example docker-compose.yaml in this project.

Running the Project

Executing the project can be done in two ways, the first is by initializing using Maven which the second produces a traditional Jar file. Before attempting to run the program some setup must be done inside of the src/main/resources/application.properties, you can follow the guides.

Build with Maven

If you have Maven installed on your machine you can navigate to the root project directory with this README file and execute the following. Remember to follow the above Database setup procedures first.

mvn -B -DskipTests clean package

You can also use the built in Maven wrapper and execute the project by following this command.

./mvnw -B -DskipTests clean package

Setting up in IDE

Download Lombok to your IDE or VS Code Extension!

Use the IDE "Run Configuration" to setup the -Dspring.application.json (eclipse example) in the Environment Properties

Creating a Docker Image

To build a container that can execute the application from a safe location you can use my supplied Dockerfile to do so. You should follow the guides first to better understand some of these arguments.

CMD [ "java", \
        "-jar", \
        "discord-nft-bot.jar"]