GasWatch

A bot to alert a role when Ethereum's GAS price drops below a specified value.
Invite here: coming soon

About The Project

The GasWatch bot is built to watch Ethereum's gas price and act accordingly based on values defined by its config. The bot will take the value defined by cooldown and gasvalue and ping users who have a certain role whenever the API returns a value below gasvalue, as long as it is occurring after the time defined by cooldown has passed.

Built With

The GasWatch bot is built with Discord.js V13. It uses Axios for the API requests.

The value for Ethereum's current GAS used for the alerts, and the values used for the gas tracker in the activity section and for the alerts are fetched from https://docs.spice.xyz/api/ethereum/gas-fees

Getting Started

Invite the bot here: coming soon

If you would like to host your own local version, you can follow the steps below. Please note that the self-hosted version is different to the public one hosted. The self-hosted version is built to be used on one specific server while the public version is built for hundreds of servers to use at once.

Prerequisites

• Node.js
• NPM

Installation

1. Clone the GitHub repo

git clone https://github.com/Adamt20054/GasWatch.git

2. Make sure you have the latest Node.js and NPM version installed and then go into the folders directory, open a terminal and install the packages required in package.json by doing

   npm install

   Your node_modules folder should populate after NPM has installed the packages it needs. If you get an error, make sure you are in the right directory (The same directory as the package.json) and try deleting package-lock.json if the error continues.

3. Get a bot token by creating an application at https://discord.com/developers/applications

   • Make sure you enable the "message content" intent to use the commands.

4. Paste the token into /src/Data/config.json in the "token" value.

5. Choose a prefix you want your bot to use, and then put it in the prefix value.

6. Grab the Channel ID of the channel you want users to be pinged in, and then put it in the "ChannelID" value.

7. Grab the Role ID of the role you want to be pinged, and then put it in the RoleID value.

8. Run the bot by going into the main directory and running

     node index.js

Usage

Once the bot is running, and you have invited it to your server, you can use

{prefix}gasvalue {value}

to make the bot ping users when the GWEI is below that level. Eg, if you wanted users to be pinged when the GAS is below 70 GWEI, you'd do

-gasvalue 70

You can also change the time between pings so users don't get spammed using

{prefix}cooldown {value in ms}

The program checks the API every 15minutes, so without this cool-down the role would be pinged every 15 minutes. If you want the time between pings to be at least 1hour, you'd do

-cooldown 3600000

The cool-down command uses Milliseconds for the value given.

As default, the bot has a 1Hour cool-down and is triggered when the GWEI gas value drops below 200

Contributing

Contributions are what make the open source community such an amazing place to be learned, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

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

License

Distributed under the GNU GPLv3 License. See LICENSE for more information.

Authors

• Adam O'neill - A-level student - program developer.

Acknowledgements

• Pat - Code master who helps me solve issues <3