Merge pull request #61 from lbryio/typescript-update

Dependency Update & Typescript Update

.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
+}

README.md

@@ -9,18 +9,26 @@ Features:
 
 ## Requirements
 
-- node > 8.0.0
-- npm > 0.12.x
-- LBRYCrd (https://github.com/lbryio/lbrycrd/)
+- node > 12.0.x
+- yarn
+- node-typescript
+- LBRYCrd 0.17.x (https://github.com/lbryio/lbrycrd/)
 
 ## Install the prerequisites
-```
-$ sudo apt-get install nodejs && apt-get update
-```
+### 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)
 
 ```
-$ wget https://github.com/lbryio/lbrycrd/releases/download/v0.12.4.0/lbrycrd-linux.zip
+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
 
@@ -53,10 +61,10 @@ Input your bot's token, the channel ID for your bot command channel, and the use
 $ mv default.json.example default.json
 ```
 
-Then run npm install from within lbry-tipbot directory
+Then run yarn install from within lbry-tipbot directory
 ```
-npm install
-node ~/lbry-tipbot/bot/bot.js
+yarn install
+yarn start
 ```
 
 ## 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,33 +1,32 @@
 {
   "dependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-preset-node8": "^1.2.0",
     "bitcoin": "^3.0.1",
-    "chrono-node": "^1.3.11",
-    "config": "^3.1.0",
-    "discord.js": "^11.4.2",
-    "embed-creator": "^1.2.4",
-    "jsonpath": "^1.0.1",
-    "moment": "^2.24.0",
-    "mongoose": "^5.7.5",
+    "chrono-node": "^2.1.9",
+    "config": "^3.3.2",
+    "discord.js": "^12.4.1",
+    "jsonpath": "^1.0.2",
+    "moment": "^2.29.1",
+    "needle": "^2.5.2",
     "node-config": "^0.0.2",
-    "numeral": "^2.0.6",
-    "request": "^2.88.0"
+    "numeral": "^2.0.6"
   },
   "scripts": {
     "prettier": "prettier --write '{bot,.}/**/*.{js,json}' --single-quote --print-width 240",
-    "build": "babel bot -d dist",
-    "prod": "babel bot -d dist & node dist/bot.js",
+    "build": "tsc",
+    "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.16.4"
+    "@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.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
-const Discord = require('discord.js');
-// Load config!
-let config = require('config');
-let botConfig = config.get('bot');
+let botConfig: BotConfig = config.get('bot');
 let commands = {};
 
 const bot = new Discord.Client();
 
-bot.on('ready', function() {
-  console.log(`Logged in! Serving in ${bot.guilds.array().length} servers`);
+bot.on('ready', () => {
+  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 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];
-        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?');
@@ -56,13 +54,11 @@ function checkMessageForCommand(msg) {
       return;
     }
 
-    if (msg.author !== bot.user && msg.isMentioned(bot.user)) {
+    if (msg.author !== bot.user && msg.mentions.has(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,10 +1,10 @@
-'use strict';
+import { LBRYCrdConfig } from '../typings';
+import config from 'config';
+const Bitcoin = require('bitcoin');
 
-const bitcoin = require('bitcoin');
-let config = require('config');
-let spamchannel = config.get('sandboxchannel');
-let lbrycrdConfig = config.get('lbrycrd');
-const lbry = new bitcoin.Client(lbrycrdConfig);
+let spamchannel: string = config.get('sandboxchannel');
+let lbrycrdConfig: LBRYCrdConfig = config.get('lbrycrd');
+const lbry = new Bitcoin.Client(lbrycrdConfig);
 const helpmsg = {
   embed: {
     description:
@@ -32,7 +32,7 @@ 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(' ')
@@ -131,11 +131,11 @@ 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) {
       console.error(err);
-      message.reply('Error getting balance.').then(message => message.delete(5000));
+      message.reply('Error getting balance.').then(message => message.delete({timeout: 5000}));
     } else {
       message.reply(`You have *${balance}* LBC. This may not reflect recent balance changes. Please wait a couple minutes and try again.`);
     }
@@ -146,7 +146,7 @@ function doDeposit(message, tipper) {
   getAddress(tipper, function(err, address) {
     if (err) {
       console.error(err);
-      message.reply('Error getting your deposit address.').then(message => message.delete(5000));
+      message.reply('Error getting your deposit address.').then(message => message.delete({timeout: 5000}));
     } else {
       message.reply(`Your address is ${address}`);
     }
@@ -162,13 +162,13 @@ function doWithdraw(message, tipper, words, helpmsg) {
     amount = getValidatedAmount(words[3]);
 
   if (amount === null) {
-    message.reply('Invalid amount of credits specified... Cannot withdraw 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(`${amount} LBC has been withdrawn to ${address}.
 ${txLink(txId)}`);
@@ -190,7 +190,7 @@ function doTip(bot, message, tipper, words, helpmsg, MultiorRole) {
   let amount = getValidatedAmount(words[amountOffset]);
 
   if (amount === null) {
-    return message.reply('Invalid amount of credits specified...').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) {
@@ -214,11 +214,11 @@ function doMultiTip(bot, message, tipper, words, helpmsg, MultiorRole) {
   }
   let [userIDs, amount] = findUserIDsAndAmount(message, words, prv);
   if (amount == null) {
-    message.reply('Invalid amount of credits specified...').then(message => message.delete(5000));
+    message.reply('Invalid amount of credits specified...').then(message => message.delete({timeout: 5000}));
     return;
   }
-  if (!userIDs) {
-    message.reply('Sorry, I could not find the user you are trying to tip...').then(message => message.delete(5000));
+  if (!userIDs.length) {
+    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++) {
@@ -236,7 +236,7 @@ function doRoleTip(bot, message, tipper, words, helpmsg, MultiorRole) {
 
   let amount = getValidatedAmount(words[amountOffset]);
   if (amount === null) {
-    message.reply("I don't know how to tip that amount of LBC...").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;
   }
 
@@ -249,10 +249,10 @@ function doRoleTip(bot, message, tipper, words, helpmsg, MultiorRole) {
         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,11 +278,11 @@ 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 = `

src/plugins.ts

@@ -1,7 +1,5 @@
-'use strict';
-
-const fs = require('fs'),
-  path = require('path');
+import fs from 'fs';
+import path from '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/**/*"]
+}