Merge pull request #62 from Eniamza/master

Fix : Use RegEx based splitting instead of space character

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "env": {
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "globals": {},
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "rules": {
+    "quotes": [
+      "warn",
+      "single"
+    ],
+    "semi": [
+      "warn",
+      "always"
+    ]
+  }
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "deepscan.enable": true
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 LBRY <filip@lbry.io>
+Copyright (c) 2018-2020 LBRY <filip@lbry.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# Bot for [LBRY's Discord](https://discord.gg/tgnNHf5)
+# Bot for [LBRY's Discord](https://chat.lbry.com)
 (This README will be updated along with bot updates)
 Features:
 
@@ -9,17 +9,63 @@ Features:
 
 ## Requirements
 
-- node > 8.0.0
+- node > 12.0.x
-- npm > 0.12.x
+- yarn
+- node-typescript
+- LBRYCrd 0.17.x (https://github.com/lbryio/lbrycrd/)
 
+## Install the prerequisites
+### NodeJS & Typescript
+
+Install NodeJS v12 for the Operating system you are running.
+[NodeJS Documentation link](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions-enterprise-linux-fedora-and-snap-packages)
+
+```
+sudo apt install nodejs-typescript
+```
+### Install Yarn Globally
+```
+sudo npm install -g yarn
+```
+### Download LBRYCRD
+Download the latest 0.17 release of LBRYcrd from the [Github](https://github.com/lbryio/lbrycrd/releases)
 
 ## Installation
 
-Create a bot and get the bot's API Token: https://discordapp.com/developers/applications/me
+Install LBRYCrd
+```
+$ unzip ~/lbrycrd-linux.zip
+```
+Follow the instructions on the LBRYCrds GitHub Repository to create a lbrycrd.conf and remember the username and password.
 
-Edit and rename default.json.example in /config, then run:
+Start LBRYCrd 
+```
+./lbrycrdd -server -daemon
+```
+
+Create a bot and get the bot's API Token: https://discordapp.com/developers/applications/me - ![](https://i.imgur.com/gM8EpJe.png)
+
+Make sure the bot has "bot" flags in OAuth2
 
 ```
-npm install
+$ cd lbry-tipbot/config
-node bot.js
+```
-```
+Then
+```
+$ vim default.json.example
+```
+Input your bot's token, the channel ID for your bot command channel, and the username & password for LBRYCrd
+.  Then, Rename the configuration file to "default.json" with
+
+```
+$ mv default.json.example default.json
+```
+
+Then run yarn install from within lbry-tipbot directory
+```
+yarn install
+yarn start
+```
+
+## License
+[MIT](https://github.com/lbryio/lbry-tipbot/blob/master/LICENSE)

config/default.json.example

@@ -2,7 +2,16 @@
   "bot": {
     "token": "discordbottoken",
     "prefix": "!",
-    "debug": false
+    "debug": true,
+    "intents": [
+      "guilds",
+      "guildEmojis",
+      "guildMembers",
+      "guildMessages",
+      "guildMessageReactions",
+      "directMessages",
+      "directMessageReactions"
+    ]
   },
   "lbrycrd": {
     "port": 9245,

package.json

@@ -1,35 +1,33 @@
 {
   "dependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-preset-node8": "^1.2.0",
     "bitcoin": "^3.0.1",
-    "chrono-node": "^1.3.5",
+    "chrono-node": "^2.1.9",
-    "config": "^1.30.0",
+    "config": "^3.3.2",
-    "discord.js": "^11.3.2",
+    "discord.js": "^12.4.1",
-    "embed-creator": "^1.2.3",
+    "jsonpath": "^1.0.2",
-    "jsonpath": "^1.0.0",
+    "moment": "^2.29.1",
-    "moment": "^2.22.1",
+    "needle": "^2.5.2",
-    "mongoose": "^5.0.17",
     "node-config": "^0.0.2",
-    "numeral": "^2.0.6",
+    "numeral": "^2.0.6"
-    "regex": "^0.1.1",
-    "request": "^2.85.0"
   },
   "scripts": {
     "prettier": "prettier --write '{bot,.}/**/*.{js,json}' --single-quote --print-width 240",
-    "build": "babel bot -d dist",
+    "build": "tsc",
-    "prod": "babel bot -d dist & node dist/bot.js",
+    "start": "tsc && node dist/bot.js",
     "lint": "prettier --write '{bot,.}/**/*.{js,json}' --single-quote --print-width 240",
     "precommit": "prettier --write '{bot,.}/**/*.{js,json}' --single-quote --print-width 240"
   },
   "devDependencies": {
-    "prettier": "^1.12.1"
+    "@types/config": "^0.0.36",
+    "@types/node": "^14.14.7",
+    "prettier": "^2.1.2",
+    "typescript": "latest"
   },
   "name": "lbry-tipbot",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "LBRYs tipbot for Discord",
-  "main": "app.js",
+  "main": "dist/bot.js",
   "repository": "https://github.com/lbryio/lbry-tipbot",
-  "author": "filipnyquist <filip@lbry.io>",
+  "author": "filipnyquist <filip@lbry.com>",
   "license": "MIT"
 }

src/bot.ts

@@ -1,16 +1,14 @@
-'use strict';
+import Discord from 'discord.js';
+import config from 'config';
+import { BotConfig } from './typings';
 
-// Load up libraries
+let botConfig: BotConfig = config.get('bot');
-const Discord = require('discord.js');
-// Load config!
-let config = require('config');
-let botConfig = config.get('bot');
 let commands = {};
 
 const bot = new Discord.Client();
 
-bot.on('ready', function() {
+bot.on('ready', () => {
-  console.log(`Logged in! Serving in ${bot.guilds.array().length} servers`);
+  console.log(`Logged in! Serving in ${bot.guilds.cache.size} servers`);
   require('./plugins.js').init();
   console.log(`type ${botConfig.prefix}help in Discord for a commands list.`);
   bot.user.setActivity(botConfig.prefix + 'tip');
@@ -21,16 +19,16 @@ bot.on('disconnected', function() {
   process.exit(1); //exit node.js with an error
 });
 
-function checkMessageForCommand(msg) {
+bot.on('message', msg => {
   //check if message is a command
   if (msg.author.id !== bot.user.id && msg.content.startsWith(botConfig.prefix)) {
     console.log(`treating ${msg.content} from ${msg.author} as command`);
-    let cmdTxt = msg.content.split(' ')[0].substring(botConfig.prefix.length);
+    let cmdTxt = msg.content.split(/ +/)[0].substring(botConfig.prefix.length);
     let suffix = msg.content.substring(cmdTxt.length + botConfig.prefix.length + 1); //add one for the ! and one for the space
-    if (msg.isMentioned(bot.user)) {
+    if (msg.mentions.has(bot.user)) {
       try {
-        cmdTxt = msg.content.split(' ')[1];
+        cmdTxt = msg.content.split(/ +/)[1];
-        suffix = msg.content.substring(bot.user.mention().length + cmdTxt.length + botConfig.prefix.length + 1);
+        suffix = msg.content.substring(bot.user.toString().length + cmdTxt.length + botConfig.prefix.length + 1);
       } catch (e) {
         //no command
         return msg.channel.send('Yes?');
@@ -55,14 +53,8 @@ function checkMessageForCommand(msg) {
     if (msg.author === bot.user) {
       return;
     }
-
-    if (msg.author !== bot.user && msg.isMentioned(bot.user)) {
-      msg.channel.send('yes?'); //using a mention here can lead to looping
-    }
   }
-}
+});
-
-bot.on('message', msg => checkMessageForCommand(msg));
 
 exports.addCommand = function(commandName, commandObject) {
   try {

src/modules/tipbot.ts

@@ -1,11 +1,10 @@
-'use strict';
+import { LBRYCrdConfig } from '../typings';
+import config from 'config';
+const Bitcoin = require('bitcoin');
 
-const bitcoin = require('bitcoin');
+let spamchannel: string = config.get('sandboxchannel');
-let config = require('config');
+let lbrycrdConfig: LBRYCrdConfig = config.get('lbrycrd');
-let spamchannel = config.get('sandboxchannel');
+const lbry = new Bitcoin.Client(lbrycrdConfig);
-let regex = require('regex');
-let lbrycrdConfig = config.get('lbrycrd');
-const lbry = new bitcoin.Client(lbrycrdConfig);
 const helpmsg = {
   embed: {
     description:
@@ -13,19 +12,18 @@ const helpmsg = {
       '**Balance**: `!tip balance`\n' +
       '**Deposit Address**: `!tip deposit`\n' +
       '**Withdraw**: `!tip withdraw <address> <amount>`\n' +
-      '**Private Tip**: `!privatetip <user> <amount>`\n\n' +
+      '**Private Tip**: `!tip private <user> <amount>`\n\n' +
       '__**ROLE TIPS**__ Use this to tip everyone in a role.\n\n' +
       '**Role Tip**: `!roletip <role> <amount>`\n' +
       '**Private Role Tip**: `!privatetip <role> <amount>`\n\n' +
-      '__**MULTI TIPS**__ Use this to tip multiple people at once\n\n' +
+      '__**MULTI TIPS**__ Use this to tip multiple people at once.\n\n' +
       '**Multi Tip**: `!multitip <user> <user> <amount>`\n' +
       '**Private Multi Tip** `!multitip private <user> <user> <amount>`\n' +
       '**Note**: Multi tips can contain any amount of users to tip.\n\n' +
       '__**FURTHER INFORMATION**__\n\n' +
       '**Help**: `!tip help` *Get this message.\n' +
-      'Read our [Tipbot FAQ](https://lbry.io/faq/tipbot-discord) for a more details',
+      'Read our [Tipbot FAQ](<https://lbry.com/faq/tipbot-discord>) for more details',
-    color: 1109218,
+    color: 1109218
-    author: { name: '!tip' }
   }
 };
 
@@ -34,10 +32,10 @@ exports.tip = {
   usage: '<subcommand>',
   description: 'Tip a given user with an amount of LBC or perform wallet specific operations.',
   process: async function(bot, msg, suffix) {
-    let tipper = msg.author.id.replace('!', ''),
+    let tipper = msg.author.id,
       words = msg.content
         .trim()
-        .split(' ')
+        .split(/ +/)
         .filter(function(n) {
           return n !== '';
         }),
@@ -49,7 +47,7 @@ exports.tip = {
         privateOrSandboxOnly(msg, channelwarning, doHelp, [helpmsg]);
         break;
       case 'balance':
-        doBalance(msg, tipper);
+        privateOrSandboxOnly(msg, channelwarning, doBalance, [tipper]);
         break;
       case 'deposit':
         privateOrSandboxOnly(msg, channelwarning, doDeposit, [tipper]);
@@ -70,7 +68,7 @@ exports.multitip = {
     let tipper = msg.author.id.replace('!', ''),
       words = msg.content
         .trim()
-        .split(' ')
+        .split(/ +/)
         .filter(function(n) {
           return n !== '';
         }),
@@ -90,12 +88,12 @@ exports.multitip = {
 
 exports.roletip = {
   usage: '<subcommand>',
-  description: 'Tip every user in a given role the same amount of LBC.',
+  description: 'Tip all users in a specified role an amount of LBC.',
   process: async function(bot, msg, suffix) {
     let tipper = msg.author.id.replace('!', ''),
       words = msg.content
         .trim()
-        .split(' ')
+        .split(/ +/)
         .filter(function(n) {
           return n !== '';
         }),
@@ -115,7 +113,7 @@ exports.roletip = {
 
 exports.tips = {
   usage: '',
-  description: 'Lists all available tipbot commands with brief descriptions for each one.',
+  description: 'Lists all available tipbot commands with brief descriptions for each command.',
   process: async function(bot, msg, suffix) {
     msg.reply(helpmsg);
   }
@@ -133,12 +131,13 @@ function doHelp(message, helpmsg) {
   message.author.send(helpmsg);
 }
 
-function doBalance(message, tipper) {
+async function doBalance(message, tipper) {
   lbry.getBalance(tipper, 1, function(err, balance) {
     if (err) {
-      message.reply('Error getting balance.').then(message => message.delete(5000));
+      console.error(err);
+      message.reply('Error getting balance.').then(message => message.delete({timeout: 5000}));
     } else {
-      message.reply(`You have *${balance}* LBC`);
+      message.reply(`You have *${balance}* LBC. This may not reflect recent balance changes. Please wait a couple minutes and try again.`);
     }
   });
 }
@@ -146,7 +145,8 @@ function doBalance(message, tipper) {
 function doDeposit(message, tipper) {
   getAddress(tipper, function(err, address) {
     if (err) {
-      message.reply('Error getting your deposit address.').then(message => message.delete(5000));
+      console.error(err);
+      message.reply('Error getting your deposit address.').then(message => message.delete({timeout: 5000}));
     } else {
       message.reply(`Your address is ${address}`);
     }
@@ -162,15 +162,15 @@ function doWithdraw(message, tipper, words, helpmsg) {
     amount = getValidatedAmount(words[3]);
 
   if (amount === null) {
-    message.reply("I don't know how to withdraw that many credits...").then(message => message.delete(5000));
+    message.reply('Invalid amount of credits specified... Cannot withdraw credits.').then(message => message.delete({timeout: 5000}));
     return;
   }
 
   lbry.sendFrom(tipper, address, amount, function(err, txId) {
     if (err) {
-      return message.reply(err.message).then(message => message.delete(5000));
+      return message.reply(err.message).then(message => message.delete({timeout: 5000}));
     }
-    message.reply(`You withdrew ${amount} LBC to ${address}.
+    message.reply(`${amount} LBC has been withdrawn to ${address}.
 ${txLink(txId)}`);
   });
 }
@@ -190,13 +190,13 @@ function doTip(bot, message, tipper, words, helpmsg, MultiorRole) {
   let amount = getValidatedAmount(words[amountOffset]);
 
   if (amount === null) {
-    return message.reply("I don't know how to tip that many credits...").then(message => message.delete(5000));
+    return message.reply('Invalid amount of credits specified...').then(message => message.delete({timeout: 5000}));
   }
 
   if (message.mentions.users.first() && message.mentions.users.first().id) {
     return sendLBC(bot, message, tipper, message.mentions.users.first().id.replace('!', ''), amount, prv, MultiorRole);
   }
-  message.reply('Sorry, I could not find a user in your tip...');
+  message.reply('Sorry, I could not find the user you are trying to tip...');
 }
 
 function doMultiTip(bot, message, tipper, words, helpmsg, MultiorRole) {
@@ -214,11 +214,11 @@ function doMultiTip(bot, message, tipper, words, helpmsg, MultiorRole) {
   }
   let [userIDs, amount] = findUserIDsAndAmount(message, words, prv);
   if (amount == null) {
-    message.reply("I don't know how to tip that many credits...").then(message => message.delete(5000));
+    message.reply('Invalid amount of credits specified...').then(message => message.delete({timeout: 5000}));
     return;
   }
-  if (!userIDs) {
+  if (!userIDs.length) {
-    message.reply('Sorry, I could not find a user in your tip...').then(message => message.delete(5000));
+    message.reply('Sorry, I could not find the user you are trying to tip...').then(message => message.delete({timeout: 5000}));
     return;
   }
   for (let i = 0; i < userIDs.length; i++) {
@@ -231,28 +231,28 @@ function doRoleTip(bot, message, tipper, words, helpmsg, MultiorRole) {
     doHelp(message, helpmsg);
     return;
   }
-  let prv = false;
+  let isPrivateTip = words.length >= 4 && words[1] === 'private';
-  let amountOffset = 2;
+  let amountOffset = isPrivateTip ? 3 : 2;
-  if (words.length >= 4 && words[1] === 'private') {
+
-    prv = true;
-    amountOffset = 3;
-  }
   let amount = getValidatedAmount(words[amountOffset]);
-  if (amount == null) {
+  if (amount === null) {
-    message.reply("I don't know how to tip that many LBC coins...").then(message => message.delete(10000));
+    message.reply("I don't know how to tip that amount of LBC...").then(message => message.delete({timeout: 10000}));
     return;
   }
-  if (message.mentions.roles.first().id) {
+
-    if (message.mentions.roles.first().members.first().id) {
+  let roleToTip = message.mentions.roles.first();
-      let userIDs = message.mentions.roles.first().members.map(member => member.user.id.replace('!', ''));
+  if (roleToTip !== null) {
-      for (let i = 0; i < userIDs.length; i++) {
+    let membersOfRole = roleToTip.members.keyArray();
-        sendLBC(bot, message, tipper, userIDs[i].toString(), amount, prv, MultiorRole);
+    if (membersOfRole.length > 0) {
-      }
+      let userIDs = membersOfRole.map(member => member.replace('!', ''));
+      userIDs.forEach(u => {
+        sendLBC(bot, message, tipper, u, amount, isPrivateTip, MultiorRole);
+      });
     } else {
-      return message.reply('Sorry, I could not find any users to tip in that role...').then(message => message.delete(10000));
+      return message.reply('Sorry, I could not find any users to tip in that role...').then(message => message.delete({timeout: 10000}));
     }
   } else {
-    return message.reply('Sorry, I could not find any roles in your tip...').then(message => message.delete(10000));
+    return message.reply('Sorry, I could not find any roles in your tip...').then(message => message.delete({timeout: 10000}));
   }
 }
 
@@ -278,27 +278,27 @@ function findUserIDsAndAmount(message, words, prv) {
 function sendLBC(bot, message, tipper, recipient, amount, privacyFlag, MultiorRole) {
   getAddress(recipient.toString(), function(err, address) {
     if (err) {
-      message.reply(err.message).then(message => message.delete(5000));
+      message.reply(err.message).then(message => message.delete({timeout: 5000}));
     } else {
       lbry.sendFrom(tipper, address, Number(amount), 1, null, null, function(err, txId) {
         if (err) {
-          message.reply(err.message).then(message => message.delete(5000));
+          message.reply(err.message).then(message => message.delete({timeout: 5000}));
         } else {
           let tx = txLink(txId);
           let msgtail = `
-DM me with \`${message.content.split(' ', 1)[0]}\` for command specific instructions or with \`!tips\` for all available commands`;
+DM me with \`!tips\` for all available commands or read our Tipbot FAQ <https://lbry.com/faq/tipbot-discord> for more details`;
           if (privacyFlag) {
             let usr = message.guild.members.find('id', recipient).user;
-            let authmsg = `You have just privately tipped @${usr.tag} ${amount} LBC.
+            let authmsg = `You have sent a private tip to @${usr.tag} with the amount of ${amount} LBC.
 ${tx}${msgtail}`;
             message.author.send(authmsg);
-            if (message.author.id !== message.mentions.users.first().id) {
+            if (message.author.id !== usr.id) {
               let recipientmsg = `You have just been privately tipped ${amount} LBC by @${message.author.tag}.
 ${tx}${msgtail}`;
               usr.send(recipientmsg);
             }
           } else {
-            let generalmsg = `Wubba lubba dub dub! <@${tipper}> tipped <@${recipient}> ${amount} LBC.
+            let generalmsg = `just tipped <@${recipient}> ${amount} LBC.
 ${tx}${msgtail}`;
             message.reply(generalmsg);
           }
@@ -307,7 +307,6 @@ ${tx}${msgtail}`;
     }
   });
 }
-
 function getAddress(userId, cb) {
   lbry.getAddressesByAccount(userId, function(err, addresses) {
     if (err) {
@@ -331,13 +330,10 @@ function inPrivateOrBotSandbox(msg) {
 }
 
 function getValidatedAmount(amount) {
-  amount = amount.trim();
+  amount = amount.toLowerCase().replace('lbc', '');
-  if (amount.toLowerCase().endsWith('lbc')) {
-    amount = amount.substring(0, amount.length - 3);
-  }
   return amount.match(/^[0-9]+(\.[0-9]+)?$/) ? amount : null;
 }
 
 function txLink(txId) {
-  return '<https://explorer.lbry.io/tx/' + txId + '>';
+  return '<https://explorer.lbry.com/tx/' + txId + '>';
 }

src/plugins.ts

@@ -1,7 +1,5 @@
-'use strict';
+import fs from 'fs';
-
+import path from 'path';
-const fs = require('fs'),
-  path = require('path');
 
 function getPlugins(srcpath) {
   return fs.readdirSync(srcpath);
@@ -9,7 +7,7 @@ function getPlugins(srcpath) {
 let plugin_directory = path.join(__dirname, 'modules');
 let plugins = getPlugins(plugin_directory);
 
-exports.init = function init() {
+export function init() {
   load_plugins();
 };
 

src/typings.ts

@@ -0,0 +1,18 @@
+export interface Config {
+  bot: BotConfig;
+  lbrycrd: LBRYCrdConfig;
+  sandboxchannel: string;
+}
+
+export interface BotConfig {
+  token: string;
+  prefix: string;
+  debug: boolean;
+  intents: string[];
+}
+
+export interface LBRYCrdConfig {
+  port: number;
+  user: string;
+  pass: string;
+}

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2020",
+    "inlineSourceMap": true,
+    "baseUrl": ".",
+    "outDir": "dist",
+    "removeComments": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "paths": {
+      "*": ["node_modules/*"]
+    }
+  },
+  "include": ["src/**/*"]
+}