ln,bot: convert ln to TS (#646)

* ln,bot: convert ln to TS

Convert ln module to TypeScript.

* package.json: install type packages

Add type packages needed for Typescript code to package.json.

* use eslint on TS files

Setup eslint so that it checks .ts files instead of .js.

* fix eslint import ordering errors

Fix "Import in body of module; reorder to top  import/first"
eslint errors.

* bot: change signature of notAuthorized function

From Promise<void> to Promise<undefined>, to get rid of the
following error:
```
tests/bot/validation.spec.ts(376,19): error TS2339: Property 'tg_id' does not exist on type 'void | (UserDocument & { _id: ObjectId; })'.
  Property 'tg_id' does not exist on type 'void'.
```

* fix more eslint errors

* eslint: silenced remaining errors

Silenced remaining eslint errors as what they refer to is
intended behavior.

Author: webwarrior-ws

.eslintrc.json

@@ -5,6 +5,7 @@
     "node": true,
     "jest": true
   },
+  "parser": "@typescript-eslint/parser",
   "extends": ["standard", "eslint-config-prettier"],
   "parserOptions": {
     "ecmaVersion": "latest"

.github/workflows/integrate.yaml

@@ -55,8 +55,8 @@ jobs:
           sleep 10
           
           mongosh --eval 'db.getSiblingDB("lnp2pbot").createCollection("mycollection")'
-
-      - run: npm install @types/node @types/i18n @types/mocha
+      
+      - run: npm install @types/node
       - run: npx tsc
       - run: npm ci
       - name: Run tests

app.ts

@@ -2,7 +2,7 @@ import "dotenv/config";
 import { SocksProxyAgent } from "socks-proxy-agent";
 import { start } from "./bot/start";
 import { connect as mongoConnect } from './db_connect'
-const { resubscribeInvoices } = require('./ln');
+import { resubscribeInvoices } from './ln';
 import { logger } from "./logger";
 import { Telegraf } from "telegraf";
 import { delay } from './util';

bot/messages.ts

@@ -1,5 +1,4 @@
-import { TelegramError } from 'telegraf'
-import QR from 'qrcode';
+import { TelegramError, Telegraf } from 'telegraf'
 import {
   getCurrency,
   numberFormat,
@@ -12,19 +11,18 @@ import {
   decimalRound,
   getUserAge,
   getStars,
+  generateQRWithImage,
 } from '../util';
 import * as OrderEvents from './modules/events/orders';
 import { logger } from "../logger";
 import { HasTelegram, MainContext } from './start';
 import { UserDocument } from '../models/user'
 import { IOrder } from '../models/order'
-import { Telegraf } from 'telegraf';
 import { I18nContext } from '@grammyjs/i18n';
 import { IConfig } from '../models/config';
 import { IPendingPayment } from '../models/pending_payment';
 import { PayViaPaymentRequestResult } from 'lightning';
 import { IFiat } from '../util/fiatModel';
-import { generateQRWithImage } from '../util';
 import { CommunityContext } from './modules/community/communityContext';
 
 const startMessage = async (ctx: MainContext) => {
@@ -132,7 +130,7 @@ const showQRCodeMessage = async (
   }
 };
 
-const pendingSellMessage = async (ctx: MainContext, user: UserDocument, order: IOrder, channel: string, i18n: I18nContext) => {
+const pendingSellMessage = async (ctx: HasTelegram, user: UserDocument, order: IOrder, channel: string, i18n: I18nContext) => {
   try {
     const orderExpirationWindow =
       Number(process.env.ORDER_PUBLISHED_EXPIRATION_WINDOW) / 60 / 60;
@@ -168,7 +166,7 @@ const pendingSellMessage = async (ctx: MainContext, user: UserDocument, order: I
   }
 };
 
-const pendingBuyMessage = async (bot: MainContext, user: UserDocument, order: IOrder, channel: string, i18n: I18nContext) => {
+const pendingBuyMessage = async (bot: HasTelegram, user: UserDocument, order: IOrder, channel: string, i18n: I18nContext) => {
   try {
     const orderExpirationWindow =
       Number(process.env.ORDER_PUBLISHED_EXPIRATION_WINDOW) / 60 / 60;
@@ -239,7 +237,7 @@ const expiredInvoiceMessage = async (ctx: MainContext) => {
   }
 };
 
-const expiredInvoiceOnPendingMessage = async (bot: Telegraf<CommunityContext>, user: UserDocument, order: IOrder, i18n: I18nContext) => {
+const expiredInvoiceOnPendingMessage = async (bot: HasTelegram, user: UserDocument, order: IOrder, i18n: I18nContext) => {
   try {
     await bot.telegram.sendMessage(user.tg_id, i18n.t('invoice_expired_long'));
     await bot.telegram.sendMessage(
@@ -363,7 +361,7 @@ const beginTakeBuyMessage = async (ctx: MainContext, bot: HasTelegram, seller: U
     const expirationTime =
       Number(process.env.HOLD_INVOICE_EXPIRATION_WINDOW) / 60;
 
-    let caption = ctx.i18n.t('begin_take_buy', { expirationTime });
+    const caption = ctx.i18n.t('begin_take_buy', { expirationTime });
 
     await bot.telegram.sendMediaGroup(seller.tg_id, [{
       type: 'photo',
@@ -442,7 +440,7 @@ const showHoldInvoiceMessage = async (
 };
 
 const onGoingTakeBuyMessage = async (
-  bot: MainContext,
+  bot: HasTelegram,
   seller: UserDocument,
   buyer: UserDocument,
   order: IOrder,
@@ -519,7 +517,7 @@ const beginTakeSellMessage = async (ctx: MainContext, bot: HasTelegram, buyer: U
 };
 
 const onGoingTakeSellMessage = async (
-  bot: MainContext,
+  bot: HasTelegram,
   sellerUser: UserDocument,
   buyerUser: UserDocument,
   order: IOrder,
@@ -574,7 +572,7 @@ const takeSellWaitingSellerToPayMessage = async (
 };
 
 const releasedSatsMessage = async (
-  bot: MainContext,
+  bot: HasTelegram,
   sellerUser: UserDocument,
   buyerUser: UserDocument,
   i18nBuyer: I18nContext,
@@ -594,7 +592,7 @@ const releasedSatsMessage = async (
   }
 };
 
-const rateUserMessage = async (bot: Telegraf<CommunityContext>, caller: UserDocument, order: IOrder, i18n: I18nContext) => {
+const rateUserMessage = async (bot: HasTelegram, caller: UserDocument, order: IOrder, i18n: I18nContext) => {
   try {
     const starButtons = [];
     for (let num = 5; num > 0; num--) {
@@ -640,7 +638,7 @@ const notOrderMessage = async (ctx: MainContext) => {
 };
 
 const publishBuyOrderMessage = async (
-  bot: MainContext,
+  bot: HasTelegram,
   user: UserDocument,
   order: IOrder,
   i18n: I18nContext,
@@ -678,7 +676,7 @@ const publishBuyOrderMessage = async (
 };
 
 const publishSellOrderMessage = async (
-  ctx: MainContext,
+  ctx: HasTelegram,
   user: UserDocument,
   order: IOrder,
   i18n: I18nContext,
@@ -990,7 +988,7 @@ const notOrdersMessage = async (ctx: MainContext) => {
   }
 };
 
-const notRateForCurrency = async (bot: MainContext, user: UserDocument, i18n: I18nContext) => {
+const notRateForCurrency = async (bot: HasTelegram, user: UserDocument, i18n: I18nContext) => {
   try {
     await bot.telegram.sendMessage(
       user.tg_id,
@@ -1182,7 +1180,7 @@ const counterPartyWantsCooperativeCancelMessage = async (
   }
 };
 
-const invoicePaymentFailedMessage = async (bot: MainContext, user: UserDocument, i18n: I18nContext) => {
+const invoicePaymentFailedMessage = async (bot: HasTelegram, user: UserDocument, i18n: I18nContext) => {
   try {
     await bot.telegram.sendMessage(
       user.tg_id,
@@ -1247,7 +1245,7 @@ const showInfoMessage = async (ctx: MainContext, user: UserDocument, config: ICo
   }
 };
 
-const buyerReceivedSatsMessage = async (bot: MainContext, buyerUser: UserDocument, sellerUser: UserDocument, i18n: I18nContext) => {
+const buyerReceivedSatsMessage = async (bot: HasTelegram, buyerUser: UserDocument, sellerUser: UserDocument, i18n: I18nContext) => {
   try {
     await bot.telegram.sendMessage(
       buyerUser.tg_id,
@@ -1651,7 +1649,7 @@ const currencyNotSupportedMessage = async (ctx: MainContext, currencies: Array<s
   }
 };
 
-const notAuthorized = async (ctx: MainContext, tgId?: string) => {
+const notAuthorized = async (ctx: MainContext, tgId?: string) : Promise<undefined> => {
   try {
     if (tgId) {
       await ctx.telegram.sendMessage(tgId, ctx.i18n.t('not_authorized'));

bot/modules/community/communityContext.ts

@@ -1,16 +1,18 @@
 import { MainContext } from '../../start';
 import { SceneContextScene, WizardContextWizard, WizardSessionData } from 'telegraf/typings/scenes';
 import { Update, Message } from 'telegraf/typings/core/types/typegram';
-import { Scenes, Telegraf } from 'telegraf';
+import { Telegraf } from 'telegraf';
 import { ICommunity, IOrderChannel, IUsernameId } from '../../../models/community';
 import { IOrder } from '../../../models/order';
 import { UserDocument } from '../../../models/user';
 
+/* eslint-disable no-use-before-define */
 export interface CommunityContext extends MainContext {
   scene: SceneContextScene<CommunityContext, WizardSessionData>;
   wizard: CommunityWizard;
   message: (Update.New & Update.NonChannel & Message.TextMessage) | undefined;
 }
+/* eslint-enable no-use-before-define */
 
 // This type is catch-all for any wizard state and probably should be split into several
 // more specialized types.

bot/modules/community/scenes.ts

@@ -105,6 +105,7 @@ export const communityWizard = new Scenes.WizardScene<CommunityContext>(
       }
       ctx.wizard.selectStep(0);
       // use ['steps'] syntax as steps is private property and TypeScript would complain
+      // eslint-disable-next-line dot-notation
       return ctx.wizard['steps'][ctx.wizard.cursor](ctx);
     } catch (err) {
       logger.error(err);
@@ -230,7 +231,7 @@ const createCommunitySteps = {
       }
       const { bot, user } = ctx.wizard.state;
       const chan = itemsFromMessage(text);
-      //ctx.wizard.state.channels = chan; // ???
+      // ctx.wizard.state.channels = chan; // ???
       if (chan.length > 2) {
         await ctx.telegram.deleteMessage(
           ctx.message!.chat.id,

bot/modules/dispute/commands.ts

@@ -5,7 +5,6 @@ import { validateParams, validateObjectId, validateDisputeOrder } from '../../va
 import * as messages from './messages';
 import * as globalMessages from '../../messages';
 import { logger } from '../../../logger';
-import * as OrderEvents from '../../modules/events/orders';
 import { removeAtSymbol } from '../../../util';
 
 const dispute = async (ctx: MainContext) => {

bot/modules/nostr/config.ts

@@ -1,5 +1,4 @@
-import { generateSecretKey, getPublicKey as nostrGetPublicKey } from 'nostr-tools';
-import { SimplePool } from 'nostr-tools';
+import { generateSecretKey, getPublicKey as nostrGetPublicKey, SimplePool } from 'nostr-tools';
 
 const nostrSkEnvVar = process.env.NOSTR_SK;
 const sk = nostrSkEnvVar ? Buffer.from(nostrSkEnvVar, 'hex') : generateSecretKey();

bot/modules/nostr/index.ts

@@ -1,4 +1,3 @@
-require('websocket-polyfill');
 import { logger } from '../../../logger';
 import * as Config from './config';
 import { createOrderEvent } from './events';
@@ -8,6 +7,8 @@ import { IOrder } from '../../../models/order';
 import * as CommunityEvents from '../events/community';
 import { CommunityContext } from '../community/communityContext';
 
+require('websocket-polyfill'); // is it needed?
+
 export const configure = (bot: Telegraf<CommunityContext>) => {
   bot.command('/nostr', Commands.info);
 

bot/modules/orders/index.ts

@@ -9,7 +9,6 @@ import { takeOrderActionValidation, takeOrderValidation, takesell, takebuyValida
 import { extractId } from '../../../util';
 import { Telegraf } from 'telegraf';
 import { CommunityContext } from '../community/communityContext';
-import { MainContext } from '../../start';
 export * as Scenes from './scenes';
 
 export const configure = (bot: Telegraf<CommunityContext>) => {