Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Latest commit

 

History

History
57 lines (43 loc) · 2.23 KB

README.md

File metadata and controls

57 lines (43 loc) · 2.23 KB

Squeeth Discord Bot

A Discord bot based on JDA that provides you with quick and easy access to info of the Squeeth ecosystem

Invite the Squeeth Discord Bot to your server!

Notice

As of April 5, 2023, the bot will not be updated further indefinitely. Exceptions are bug fixes and other maintenance updates as needed. Issues + PRs can still be raised and I'm open to merging a PR if necessary.

Check out Coffee Core, a Discord bot framework that is heavily based on this very same bot!

How to Use

Run /help to get a list of commands in a server it is in OR in the bot's DMs!

If you're a server owner/admin, run /settings to see how to configure your server

Features

Near real-time data of Squeeth by Laevitas

  • Live Statistics
    • Price
    • Volume
    • Funding
    • Implied Volatility
    • Normalization Factor
  • The Greeks
  • Funding Calculator
  • Crab Stats
    • Crab Rebalance Data
    • Crab Feeding Time (Auction) Notification
  • Positions Viewer
    • Long Squeeth and Crab supported
    • Shorts are not supported yet
  • Short Vault Data
    • See collateral, debt, collateralization ratio, NFT collateral, and vault greeks
  • Squiz (Squeeth Quiz)
    • Servers can randomly make them show up with leaderboard support!
    • You can play Squiz by yourself to test your Squeeths knowledge
  • More Commands Soon:tm:
    • 👀

Requirements to Self-Host

  • Java 17+
  • Discord Bot Token
  • Laevitas API Key
  • Ethereum RPC Node (self-hosted or 3rd party, preferably Alchemy)
  • A Computer That Doesn't Explode and Can Run 24/7 (hopefully)

When self-hosting, pass the path to the settings json and configure the JSON for your needs.

Example: java -jar SqueethDiscordBot.jar settings.json

A sample settings.json can be found here

Contact

If you questions, ideas, concerns, etc., feel free to leave them at Issues tab or reach out to me (AlphaSerpentis#3203) at the Opyn Discord