Discord Bot Faucet

This is a Discord Bot that dispenses Testnet ETH written in TypeScript.

Setup

Change the example.config.json into config.json, and fill in the required fields.

Create a file called .env and paste in the following lines. Make sure to fill it out with your details

WALLET_PRIVATE_KEY="<wallet-private-key>"
BOT_TOKEN="<bot-token>"
DB_USERNAME="<username>"
DB_PASSWORD="<password>"

Installation

1. If you do not have pnpm, run npm i -g pnpm.

2. Install Dependancies using pnpm install.

Optionally you can update the dependancies using pnpm update.

3. Fill in the config and run the bot : pnpm start:dev

Networks

These are the supported Networks and Tokens as of yet. Feel free to do PRs to add any other testnet networks or tokens!

Network List

• Goerli
• Mumbai
• Celo

Token List

• LINK

Adding Networks or Tokens

Adding Networks or Tokens are fairly straighforward.

1. Open up the config.json.
2. Add a network Object in the networks field ex :

   {
    "name": "networkName",
    "nativeCurrency": "kool",
    "ALCHEMY_URL": "https://rpc-url/xxx",
    "scan": "https://myscan.kool.io/tx/"
   }

3. That's literally it!
4. Make sure to do a PR into the Main Repo! (Edit the example.config.json)

Database

This BOT currently has two modes it can run, KeyV - Memory and Postgres - Storage. You can change the mode by changing the database value in the stats field of config.json like so :

Storage Mode

"database": "pg",

This sets the BOT to use storage - Postgres DB. Make sure you setup the necessary database parameters

Memory Mode

"database": "keyv",

This sets the BOT to use memory - KeyV. Use this if you want to just use the BOT without having to configure Databases. In addition, this is the default if no parameter was set into database.

Adding Features

1. Fork the project
2. Create a new branch - (Call it feature/)
3. Commit the changes
4. Yeet the changes using a PR into this!

TODO Features

• Get the Bot Working
• Convert to TypeScript
• Migrate to Postgres DB
• Beautify the code more
• Add Support for Sepolia
• Feature - Only Transferring if the user's account has low ETH

Inspired by

• DJS - Reconlx
• Typescript Faucet Template - AlanRacciatti
• Discord Bot Template - KevinNovak