Merge pull request #21 from NodeFactoryIo/mpetrun5/pass-logger-instance-to-tx-monitor

Pass logger instance to tx monitor

Author: mpetrunic

package.json

@@ -52,15 +52,18 @@
     "bsert": "0.0.10",
     "chai": "^4.2.0",
     "eslint": "^6.6.0",
+    "ethers": "^5.0.X",
     "mocha": "^6.2.3",
     "sinon": "^9.0.2",
     "ts-loader": "^6.2.1",
     "typescript": "^3.6.4"
   },
   "dependencies": {
     "axios": ">=0.19.2",
-    "debug": "^4.1.1",
-    "ethers": "^5.0.X",
+    "debug": "^4.2.0",
     "it-pushable": "^1.4.0"
+  },
+  "peerDependencies": {
+    "ethers": ">=5"
   }
 }

src/logger.ts

@@ -1,3 +1,27 @@
 import debug from "debug";
 
-export const logger = debug("web3-server-wallet");
+export interface ILogger<TReturn = void> {
+  info(msg: string, ...params: unknown[]): TReturn;
+  debug(msg: string, ...params: unknown[]): TReturn;
+  error(msg: string, ...params: unknown[]): TReturn;
+}
+
+export class DefaultLogger implements ILogger {
+  private infoLogger = debug("web3-server-wallet:INFO")
+  private debugLogger = debug("web3-server-wallet:DEBUG")
+  private errorLogger = debug("web3-server-wallet:ERROR")
+
+  public info(message: string): void {
+    this.infoLogger(message);
+  }
+
+  public debug(message: string): void {
+    this.debugLogger(message);
+  }
+
+  public error(message: string): void {
+    this.errorLogger(message);
+  }
+}
+
+export const defaultLogger = new DefaultLogger();

src/monitorService.ts

@@ -6,7 +6,7 @@ import {
   recalculateGasPrice,
   transactionNotInBlock
 } from "./utils";
-import {logger} from "./logger";
+import {defaultLogger, ILogger} from "./logger";
 
 interface ITxMonitorOptions {
   neededConfirmations: number;
@@ -17,6 +17,7 @@ interface ITxMonitorOptions {
 
 export class TxMonitorService {
   private wallet: ServerWeb3Wallet;
+  private logger: ILogger;
   private intervalId?: NodeJS.Timeout;
   private options: ITxMonitorOptions;
   private defaultOptions = {
@@ -25,8 +26,9 @@ export class TxMonitorService {
     transactionTimeout: 180000
   };
 
-  constructor(wallet: ServerWeb3Wallet, options?: Partial<ITxMonitorOptions>) {
+  constructor(wallet: ServerWeb3Wallet, logger=defaultLogger, options?: Partial<ITxMonitorOptions>) {
     this.wallet = wallet;
+    this.logger = logger;
     this.options = Object.assign({}, this.defaultOptions, options);
   };
 
@@ -74,6 +76,11 @@ export class TxMonitorService {
       this.options.gasPriceIncrease
     );
     try {
+      this.logger.debug(
+        `Resending transaction ${transaction.hash}.
+        Old gas: ${transaction.gasPrice}.
+        New gas price: ${transaction.gasPrice}`
+      );
       await this.wallet.sendTransaction({
         to: transaction.to,
         nonce: transaction.nonce,
@@ -84,8 +91,10 @@ export class TxMonitorService {
         gasPrice: newGasPrice
       });
     } catch(error) {
-      logger(`Resending transaction with hash ${transaction.hash} failed, ${error.message}`);
+      this.logger.error(`Resending transaction with hash ${transaction.hash} failed, ${error.message}`);
     }
+
+    this.logger.debug(`Deleting transaction ${transaction.hash} from storage`);
     await this.wallet.walletStorage.deleteTransaction(transaction.hash);
   }
 

src/utils.ts

@@ -1,7 +1,6 @@
 import axios from "axios";
 import {BigNumber, utils, providers} from "ethers";
 import {SavedTransactionResponse} from "./@types/wallet";
-import {logger} from "./logger";
 
 const GAS_PRICE_API = "https://ethgasstation.info/api/ethgasAPI.json"
 
@@ -27,7 +26,6 @@ export async function estimateGasPrice(
       return utils.parseUnits((gasPrice / 10).toString(), "gwei");
     }
   } catch(error) {
-    logger("Gas station api not available.");
     return;
   }
 }