adding roles

Author: pi0neerpat

README.md

@@ -13,7 +13,7 @@
 - **API server** RedwoodJS API in `/api`
 - **(incomplete) Frontend** RedwoodJS web app in `/web`
 
-## Usage
+## Fork it & make your own
 
 ### Create a new Discord Bot
 
@@ -39,10 +39,11 @@ cd bot && yarn start
 
 ### Add the bot to your server
 
-In the Discord Application, in "General Information", copy the `CLIENT ID`. Insert it in this URL, and send it to the server admin.
+In the Discord Application, in "General Information", copy the `CLIENT ID`. Insert it in this URL, and have the server administrator open it.
 
 ```
-https://discord.com/oauth2/authorize?client_id=<clientID>&scope=bot
+# Add the bot with role management permissions
+https://discord.com/oauth2/authorize?client_id=<clientID>&scope=bot&permissions=268435456
 ```
 
 ### Going to Production - Heroku
@@ -77,6 +78,10 @@ source .env
 docker-compose up -d
 ```
 
+## Notes
+
+Helpful discord docs for making a "emoji-reaction" menu https://discordjs.guide/popular-topics/reactions.html#awaiting-reactions
+
 ## Author
 
 👤 **Patrick Gallagher**

bot/.template.env

@@ -1,4 +1,3 @@
 DISCORD_TOKEN=
-INVOCATION_STRING=!verify
-REDIS_URL=
-REDIS_PASSWORD=
+INVOCATION_STRING=!unlock
+API_URL=http://localhost:8911/graphql

bot/src/apiMgr.js

@@ -3,15 +3,13 @@ const { InMemoryCache } = require('apollo-cache-inmemory')
 const { HttpLink } = require('apollo-link-http')
 const fetch = require('cross-fetch')
 const { userByDiscordId } = require('./graphql-operations/queries')
-const DEFAULT_URL = 'http://localhost:8911/graphql'
 
 class ApiMgr {
   constructor() {
-    const url = DEFAULT_URL
     const debug = true
     const cache = new InMemoryCache()
     const link = new HttpLink({
-      uri: url,
+      uri: process.env.API_URL,
       fetch,
     })
     this.client = new ApolloClient({

bot/src/bot.js

@@ -15,50 +15,105 @@ const {
   DISCORD_APPROVE_CONSENT,
   DISCORD_DENY_CONSENT,
   DISCORD_CONSENT_TIMEOUT,
+  DISCORD_INVALID_PERMISSIONS,
+  DISCORD_ALREADY_HAVE_ROLE,
 } = require('./textContent')
 
+const UNLOCKED_ROLE = 'Unlocked-Holder'
+
 discordClient.once('ready', async () => {
   console.log('Ready!')
 })
 
+const checkNftAndAssignRoles = async ({ message, guildMember, roleId }) => {
+  await message.reply(DISCORD_APPROVE_CONSENT)
+  console.log(guildMember)
+  const { nfts, error } = await apiMgr.getNfts(guildMember.id)
+  if (error) return message.reply(error)
+  // if (!nfts) return message.reply(DISCORD_FAIL)
+  guildMember.roles.add(roleId)
+  await message.reply(DISCORD_SUCCESS)
+}
+
 discordClient.on('message', async (message) => {
-  if (message.content === process.env.INVOCATION_STRING) {
-    // console.log(message);
-    message.reply(DISCORD_REPLY)
-    const sentMessage = await message.author.send(DISCORD_INITIAL_PROMPT)
-    await sentMessage.react('❌')
-    await sentMessage.react('✅')
-    const filter = (reaction, user) => {
-      return (
-        ['❌', '✅'].includes(reaction.emoji.name) &&
-        user.id === message.author.id
-      )
+  try {
+    if (message.content === process.env.INVOCATION_STRING) {
+      // console.log(message)
+
+      // Check bot is set up properly
+      if (!message.guild.me.hasPermission(['MANAGE_ROLES']))
+        return message.channel.send(DISCORD_INVALID_PERMISSIONS)
+
+      // Check user already has role
+      const guild = message.guild
+      const guildMember = message.member
+      const role = guild.roles.cache.find((role) => role.name === UNLOCKED_ROLE)
+      if (guildMember.roles.cache.has(role.id))
+        return message.reply(`${DISCORD_ALREADY_HAVE_ROLE} "${UNLOCKED_ROLE}"`)
+
+      // Tell user to check DMs
+      message.reply(DISCORD_REPLY)
+
+      // Start DM with user
+      const sentMessage = await message.author.send(DISCORD_INITIAL_PROMPT)
+      await sentMessage.react('❌')
+      await sentMessage.react('✅')
+
+      // Wait for Emoji reply
+      const filter = (reaction, user) => {
+        return (
+          ['❌', '✅'].includes(reaction.emoji.name) &&
+          user.id === message.author.id
+        )
+      }
+      sentMessage
+        .awaitReactions(filter, { max: 1, time: 60000, errors: ['time'] })
+        .then((collected) => {
+          const reaction = collected.first()
+          if (reaction.emoji.name === '✅') {
+            // Approved consent
+            checkNftAndAssignRoles({
+              message: sentMessage,
+              guildMember,
+              roleId: role.id,
+            })
+          } else {
+            // Denied consent
+            sentMessage.reply(DISCORD_DENY_CONSENT)
+          }
+        })
+        .catch((collected) => {
+          console.log(`Timeout for emoji response ${sentMessage.author}`)
+          sentMessage.reply(DISCORD_CONSENT_TIMEOUT)
+        })
     }
-    // APPROVED CONSENT
-    sentMessage
-      .awaitReactions(filter, { max: 1, time: 60000, errors: ['time'] })
-      .then((collected) => {
-        const reaction = collected.first()
-        if (reaction.emoji.name === '✅') {
-          checkNftAndAssignRoles(sentMessage, message.author.id)
-        } else {
-          sentMessage.reply(DISCORD_DENY_CONSENT)
-        }
-      })
-      .catch((collected) => {
-        console.log(`Timeout for emoji response ${sentMessage.author}`)
-        sentMessage.reply(DISCORD_CONSENT_TIMEOUT)
-      })
+  } catch (e) {
+    console.log(e)
+    message.reply(DISCORD_SERVER_ERROR)
   }
 })
 
-const checkNftAndAssignRoles = async (message, authorId) => {
-  await message.reply(DISCORD_APPROVE_CONSENT)
-  const { nfts, error } = await apiMgr.getNfts(authorId)
-  if (error) return message.reply(error)
-  if (!nfts) return message.reply(DISCORD_FAIL)
-  // TODO: assign roles in server
-  await message.reply(DISCORD_SUCCESS)
-}
+discordClient.on('guildMemberUpdate', (oldMember, newMember) => {
+  // If the role(s) are present on the old member object but no longer on the new one (i.e role(s) were removed)
+  const removedRoles = oldMember.roles.cache.filter(
+    (role) => !newMember.roles.cache.has(role.id)
+  )
+  if (removedRoles.size > 0)
+    console.log(
+      `The roles ${removedRoles.map((r) => r.name)} were removed from ${
+        oldMember.displayName
+      }.`
+    )
+  // If the role(s) are present on the new member object but are not on the old one (i.e role(s) were added)
+  const addedRoles = newMember.roles.cache.filter(
+    (role) => !oldMember.roles.cache.has(role.id)
+  )
+  if (addedRoles.size > 0)
+    console.log(
+      `The roles ${addedRoles.map((r) => r.name)} were added to ${
+        oldMember.displayName
+      }.`
+    )
+})
 
 discordClient.login(process.env.DISCORD_TOKEN)

bot/src/textContent.js

@@ -1,16 +1,17 @@
-const DISCORD_SERVER_ERROR = 'Whoops... we had an internal issue'
-const DISCORD_SUCCESS = `🤩 What fantastic NFTs you have!
-I gave you some new roles. Head back to your server to use them. 👋 See ya`
-const DISCORD_FAIL = `🤔 We couldn't find the relevant NFTs in your wallet. If you believe this is an error, contact us: https://twitter.com/pi0neerpat`
+const DISCORD_SERVER_ERROR = `⛈️ Sorry, something went wrong.`
+const DISCORD_SUCCESS = `Success! What fantastic NFTs you have 🤩
+I gave you a new role, enjoy!`
+const DISCORD_FAIL = `🤔 I couldn't find the relevant NFTs in your wallet. If you believe this is an error, contact us: https://twitter.com/pi0neerpat`
 const DISCORD_REPLY = `Please check your DMs`
 const DISCORD_INITIAL_PROMPT = `👋 Hi there! Let's take a look at your NFTs.\n\nIn order to continue, you need to give the following permissions to the Unlock Protocol Bot:
 \n\`- Fetch your wallet address from your CollabLand account\`
 \n*Unlock Protocol Bot is a community-maintained project by @pi0neerpat*
 \nMake your choice by clicking a button:`
 const DISCORD_APPROVE_CONSENT = `Searching...`
 const DISCORD_DENY_CONSENT = `Ok, no problem. Goodbye!`
-const DISCORD_CONSENT_TIMEOUT = `👻 Ghosted! If you'd like to continue, you'll need to start over.
-In your server, type "${process.env.INVOCATION_STRING}"`
+const DISCORD_CONSENT_TIMEOUT = `👻 Ghosted! If you want to continue, you'll need to start over. In your server, type "${process.env.INVOCATION_STRING}"`
+const DISCORD_INVALID_PERMISSIONS = `⛈️ Sorry, I'm powerless. The admin must give me permission to manage roles.`
+const DISCORD_ALREADY_HAVE_ROLE = `👍 You already have the role `
 
 module.exports = {
   DISCORD_SERVER_ERROR,
@@ -21,4 +22,6 @@ module.exports = {
   DISCORD_APPROVE_CONSENT,
   DISCORD_DENY_CONSENT,
   DISCORD_CONSENT_TIMEOUT,
+  DISCORD_INVALID_PERMISSIONS,
+  DISCORD_ALREADY_HAVE_ROLE,
 }