Setup basic keyv for ratelimiting

events/interactionCreate.js

@@ -9,7 +9,7 @@ const feedback_handle = require("../modals/feedback_handle");
 
 module.exports = {
   name: "interactionCreate",
-  async execute(client, interaction) {
+  async execute(keyv, client, interaction) {
     try {
       // Get the Log Channel
       const errorchannel = await client.channels.cache.get(channels.error);
@@ -25,7 +25,7 @@ module.exports = {
         } else if (interaction.commandName === "balance") {
           require("../responses/balance_response")(interaction);
         } else if (interaction.commandName === "faucet") {
-          require("../responses/faucet_response")(interaction);
+          require("../responses/faucet_response")(keyv, interaction);
         }
         // Invalid Chat command passed
         else {

events/ready.js

@@ -8,19 +8,20 @@ module.exports = {
   once: true,
   async execute(client) {
     try {
-      // Morning Print of Waking Up
+      // Setting Status of Bot
+      client.user.setActivity("LearnWeb3DAO", {
+        type: ActivityType.Watching,
+      });
+      client.user.setStatus("online");
+
+      //Morning Print of Waking Up
       // const logchannel = await client.channels.cache.get(channels.log);
       // logchannel.send(
       //   `[LOGIN/RESTART]\n${new Date(
       //     Date.now()
       //   ).toUTCString()}\nFaucet Bot Woken`
       // );
 
-      // Setting Status of Bot
-      client.user.setActivity("LearnWeb3DAO", {
-        type: ActivityType.Watching,
-      });
-      client.user.setStatus("online");
       console.log(`Ready! Logged in as ${client.user.tag}`);
     } catch (error) {
       console.error(`Error Starting BOT in ready : ${error}`);

example.config.json

@@ -8,9 +8,7 @@
     "log": "0000000000000",
     "error": "0000000000000"
   },
-  "roles": {
-    "admin": "0000000000000"
-  },
+  "bypassRoles": ["0000000000000"],
   "networks": {
     "goerli": {
       "nativeCurrency": "eth",
@@ -36,7 +34,8 @@
   "stats": {
     "walletAddress": "xxxxxxxx",
     "dailyEth": 1,
-    "maxFee": 95000000000
+    "maxFee": 95000000000,
+    "coolDownTime": 60000
   },
   "secrets": {
     "walletPrivateKey": "xxxxxxxxx",

index.js

@@ -1,10 +1,18 @@
 // Starting Point of the project : run `node .`
 const fs = require("node:fs");
 const path = require("node:path");
+const Keyv = require("keyv");
 const { Collection } = require("discord.js");
 const { secrets } = require("./config.json");
 const client = require("./client"); // Get Client
 
+// KeyV Creation and Handling
+const keyv = new Keyv();
+keyv.on("error", (err) => {
+  console.error("Keyv connection error:", err);
+  throw new Error("Error KEYV: ", err);
+});
+
 // Run the Events
 const eventsPath = path.join(__dirname, "events");
 const eventFiles = fs
@@ -17,7 +25,7 @@ for (const file of eventFiles) {
   if (event.once) {
     client.once(event.name, (...args) => event.execute(...args));
   } else {
-    client.on(event.name, (...args) => event.execute(client, ...args));
+    client.on(event.name, (...args) => event.execute(keyv, client, ...args));
   }
 }
 

package.json

@@ -16,6 +16,7 @@
     "discord-api-types": "^0.37.3",
     "discord.js": "^14.2.0",
     "dotenv": "^16.0.1",
-    "ethers": "^5.7.0"
+    "ethers": "^5.7.0",
+    "keyv": "^4.4.1"
   }
 }

responses/balance_response.js

@@ -36,18 +36,6 @@ module.exports = async (interaction) => {
     await interaction.editReply(
       `[${networkName.toUpperCase()}] [${balancefinal}] [${tokenName.toUpperCase()}]`
     );
-
-    // Log out the transaction
-    // const logchannel = await interaction.client.channels.cache.get(
-    //   channels.log
-    // );
-    // logchannel.send(
-    //   `[BALANCE]\n${new Date(
-    //     Date.now()
-    //   ).toUTCString()}\nNetwork : ${networkName.toUpperCase()}\nToken : ${tokenName.toUpperCase()}\nBy : ${
-    //     interaction.user.username
-    //   }`
-    // );
   } catch (error) {
     console.error(`Error [RESPONCE - BALANCE] : ${error}`);
     const errorchannel = await interaction.client.channels.cache.get(

responses/faucet_response.js

@@ -4,13 +4,24 @@ const ethers = require("ethers");
 const getProvider = require("../utils/getProvider");
 const getBalance = require("../utils/getBalance");
 const transfer = require("../utils/transfer");
-const { stats, networks, channels } = require("../config.json");
+const {
+  stats,
+  networks,
+  tokens,
+  channels,
+  bypassRoles,
+} = require("../config.json");
 
 // TODO : Apply Rate Limiting
 // TODO : Make sure only verified members can do this (or any other role)
-// BUG : Find why mumbai transfers doesnt work
+// TODO : Return with user input if the needed variables are not there, like below :
+/*
+	if (!PRIVATE_KEY || !FROM_ADDRESS || !ALCHEMY_RINKEBY_URL) {
+		return ({ status: 'error', message: 'Missing environment variables, please ask human to set them up.' });
+	}
+*/
 
-module.exports = async (interaction) => {
+module.exports = async (keyv, interaction) => {
   // Initial Responce to client
   await interaction.reply({ content: "🤖 Mining....", fetchReply: true });
   try {
@@ -31,6 +42,25 @@ module.exports = async (interaction) => {
       return;
     }
 
+    //* Rate Limiting for non Admins
+    if (bypassRoles.some((role) => interaction.member.roles.cache.has(role))) {
+      const lastReqTime = await keyv.get(interaction.user.id);
+      if (lastReqTime) {
+        // CoolDownTime is set in Miliseconds.
+        if (Date.now() - lastReqTime < stats.coolDownTime) {
+          // Divide this by 60 if you want to shift to minutes
+          const timeLeft = Math.floor(
+            (stats.coolDownTime - (Date.now() - lastReqTime)) / 1000
+          );
+          await interaction.editReply(
+            `😎 Cool people waits for ${timeLeft} seconds`
+          );
+          return;
+        }
+      } else {
+        await keyv.set(interaction.user.id, Date.now());
+      }
+    }
     // Get the Provider based on the network
     const provider = getProvider(networkName);
 
@@ -56,6 +86,14 @@ module.exports = async (interaction) => {
     }
     //* Non Native Transfer (ERC-20)
     else {
+      // If there is no contract address for that token
+      if (!tokens[tokenName][networkName]) {
+        await interaction.editReply(
+          `😱 Token unavailable for network : ${networkName.toUpperCase()}`
+        );
+        return;
+      }
+
       // If the balance is too low (curBalance is in a float)
       const curBalance = await getBalance(provider, tokenName, networkName);
       if (curBalance < stats.dailyEth) {