improve logging (#137)

Author: markonmars

package.json

@@ -37,6 +37,8 @@
 		"csv-writer": "^1.6.0",
 		"dotenv": "^16.0.2",
 		"lodash": "^4.17.21",
+		"mars-liquidation": "2.3.0",
+		"mars-rover-health-computer-node": "2.3.0-node",
 		"marsjs-types": "2.3.0",
 		"osmojs": "^16.5.1",
 		"prom-client": "^15.1.3",
@@ -45,15 +47,14 @@
 		"requests": "^0.3.0",
 		"ts-jest": "^29.2.5",
 		"ts-node": "^10.9.1",
-		"uuid": "^9.0.0",
-		"mars-rover-health-computer-node": "2.3.0-node",
-		"mars-liquidation": "2.3.0"
+		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
 		"@babel/core": "^7.21.0",
 		"@babel/preset-env": "^7.20.2",
 		"@babel/preset-typescript": "^7.21.0",
-		"@types/jest": "^29.2.6",
+		"@types/jest": "^30.0.0",
+		"@types/node": "^24.9.2",
 		"@typescript-eslint/eslint-plugin": "^5.48.2",
 		"@typescript-eslint/parser": "^5.48.2",
 		"babel-jest": "^29.4.3",

src/AmmRouter.ts

@@ -7,6 +7,7 @@ import { ConcentratedLiquidityPool, Pool, PoolType, XYKPool } from './types/Pool
 import { Coin, Dec, Int } from '@keplr-wallet/unit'
 import { ConcentratedLiquidityMath, BigDec } from '@osmosis-labs/math'
 import Long from 'long'
+import { logger } from './logger'
 // const { calcOutGivenIn, calcInGivenOut } = ConcentratedLiquidityMath
 
 export interface AMMRouterInterface {
@@ -45,7 +46,7 @@ export class AMMRouter implements AMMRouterInterface {
 		let amountAfterFees = new BigNumber(0)
 
 		if (tokenInAmount.isEqualTo(0)) {
-			console.log('ERROR - cannot use token in amount of 0')
+			logger.error('Cannot use token in amount of 0')
 			return amountAfterFees
 		}
 
@@ -163,7 +164,7 @@ export class AMMRouter implements AMMRouterInterface {
 		let amountAfterFees = new BigNumber(0)
 
 		if (tokenOutRequired.isEqualTo(0)) {
-			console.log('ERROR - cannot use token out amount of 0')
+			logger.error('Cannot use token out amount of 0')
 			return amountAfterFees
 		}
 		try {

src/BaseExecutor.ts

@@ -16,6 +16,7 @@ import { PriceResponse } from 'marsjs-types/mars-oracle-osmosis/MarsOracleOsmosi
 import { Market } from 'marsjs-types/mars-red-bank/MarsRedBank.types'
 import { Dictionary } from 'lodash'
 import { MetricsService } from './metrics'
+import { logger } from './logger'
 
 export interface BaseConfig {
 	lcdEndpoint: string
@@ -69,7 +70,7 @@ export class BaseExecutor {
 		public ammRouter: AMMRouter = new AMMRouter(),
 		public metrics: MetricsService = MetricsService.getInstance(),
 	) {
-		console.log({ config })
+		logger.debug('BaseExecutor config', config)
 	}
 
 	applyAvailableLiquidity = (market: Market): MarketInfo => {
@@ -142,14 +143,14 @@ export class BaseExecutor {
 				fetching = response.length === limit
 				retries = 0
 			} catch (e) {
-				console.warn(e)
+				logger.warn(e)
 				retries++
 				if (retries >= maxRetries) {
-					console.warn('Max retries exceeded, exiting', maxRetries)
+					logger.warn('Max retries exceeded, exiting', maxRetries)
 					fetching = false
 				} else {
 					await sleep(5000)
-					console.info('Retrying...')
+					logger.info('Retrying...')
 				}
 			}
 		}
@@ -177,14 +178,14 @@ export class BaseExecutor {
 				fetching = response.length === limit
 				retries = 0
 			} catch (e) {
-				console.warn(e)
+				logger.warn(e)
 				retries++
 				if (retries >= maxRetries) {
-					console.warn('Max retries exceeded, exiting', maxRetries)
+					logger.warn('Max retries exceeded, exiting', maxRetries)
 					fetching = false
 				} else {
 					await sleep(5000)
-					console.info('Retrying...')
+					logger.info('Retrying...')
 				}
 			}
 		}
@@ -230,14 +231,14 @@ export class BaseExecutor {
 				fetching = response.length === 5
 				retries = 0
 			} catch (ex) {
-				console.warn(ex)
+				logger.warn(ex)
 				retries++
 				if (retries > maxRetries) {
-					console.warn('Max retries exceeded, exiting', maxRetries)
+					logger.warn('Max retries exceeded, exiting', maxRetries)
 					fetching = false
 				} else {
 					await sleep(5000)
-					console.info('Retrying...')
+					logger.info('Retrying...')
 				}
 			}
 		}
@@ -262,7 +263,7 @@ export class BaseExecutor {
 				}
 			})
 		} catch (e) {
-			console.error(e)
+			logger.error(e)
 		}
 	}
 

src/CsvWriter.ts

@@ -1,4 +1,5 @@
 import { createObjectCsvWriter } from 'csv-writer'
+import { logger } from './logger'
 
 export interface Header {
 	id: string
@@ -37,9 +38,9 @@ export class CSVWriter {
 			path: this.filePath,
 			header: this.headers,
 		})
-		console.log('writing results')
+		logger.info('writing results')
 		await writer.writeRecords(this.rows).then(() => {
-			console.log('...Done')
+			logger.info('...Done')
 		})
 	}
 }

src/helpers.ts

@@ -43,6 +43,7 @@ import { OsmoRoute } from './types/swapper'
 import { PerpPosition, Positions } from 'marsjs-types/mars-credit-manager/MarsCreditManager.types'
 import BigNumber from 'bignumber.js'
 import { PoolAsset } from './types/Pool'
+import { logger } from './logger'
 
 const { swapExactAmountIn } = osmosis.gamm.v1beta1.MessageComposer.withTypeUrl
 osmosis.gamm.v1beta1.MsgSwapExactAmountIn
@@ -66,8 +67,8 @@ export function readAddresses(deployConfigPath: string): ProtocolAddresses {
 
 		return camelCaseKeys(deployData.addresses) as ProtocolAddresses
 	} catch (e) {
-		console.error(`Failed to load artifacts path - could not find ${deployConfigPath}`)
-		process.exit(1)
+		logger.error(`Failed to load artifacts path - could not find ${deployConfigPath}`)
+		throw new Error(`Failed to load artifacts path - could not find ${deployConfigPath}`)
 	}
 }
 
@@ -178,8 +179,8 @@ export const queryAstroportLpUnderlyingCoins = async (
 		JSON.stringify({ simulate_withdraw: { lp_amount: lpCoin.amount } }),
 	).toString('base64')
 	const url = `${process.env.LCD_ENDPOINT}/cosmwasm/wasm/v1/contract/${pairAddress}/smart/${encodedMsg}`
-	console.log(`Querying Astroport LP underlying coins for ${lpCoin.denom}`)
-	console.log(`URL: ${url}`)
+	logger.info(`Querying Astroport LP underlying coins for ${lpCoin.denom}`)
+	logger.info(`URL: ${url}`)
 	// Fetch pair info
 	const response = await fetch(url)
 	return (await response.json())['data'] as AstroportSimulateWithdrawCoin[]
@@ -238,12 +239,12 @@ export const seedAddresses = async (
 	const seededAddresses: string[] = []
 	const sendTokenMsgs: EncodeObject[] = []
 
-	console.log(`seeding children for ${sender}`)
+	logger.info(`seeding children for ${sender}`)
 	accounts.forEach((account) => {
 		if (account.address === sender) return
 
 		const addressToSeed = account.address
-		console.log(`seeding ${addressToSeed}`)
+		logger.info(`seeding ${addressToSeed}`)
 
 		// todo - optimise this into one msg
 		const gasMsg = {

src/logger.ts

@@ -0,0 +1,94 @@
+type LogLevel = 'debug' | 'info' | 'warn' | 'error'
+
+const levelWeights: Record<LogLevel, number> = {
+	debug: 10,
+	info: 20,
+	warn: 30,
+	error: 40,
+}
+
+const normalizeLevel = (level: string | undefined): LogLevel => {
+	switch (level?.toLowerCase()) {
+		case 'debug':
+			return 'debug'
+		case 'warn':
+			return 'warn'
+		case 'error':
+			return 'error'
+		case 'info':
+		default:
+			return 'info'
+	}
+}
+
+class Logger {
+	private minLevel: LogLevel
+
+	constructor(level?: string) {
+		this.minLevel = normalizeLevel(level)
+	}
+
+	setLevel(level: LogLevel): void {
+		this.minLevel = level
+	}
+
+	debug(message?: unknown, ...optionalParams: unknown[]): void {
+		this.write('debug', message, ...optionalParams)
+	}
+
+	info(message?: unknown, ...optionalParams: unknown[]): void {
+		this.write('info', message, ...optionalParams)
+	}
+
+	warn(message?: unknown, ...optionalParams: unknown[]): void {
+		this.write('warn', message, ...optionalParams)
+	}
+
+	error(message?: unknown, ...optionalParams: unknown[]): void {
+		this.write('error', message, ...optionalParams)
+	}
+
+	private write(level: LogLevel, message?: unknown, ...optionalParams: unknown[]): void {
+		if (levelWeights[level] < levelWeights[this.minLevel]) return
+
+		const timestamp = new Date().toISOString()
+		const upperLevel = level.toUpperCase().padEnd(5, ' ')
+
+		const formatted = this.formatMessage(message, optionalParams)
+		const line = `[${timestamp}] [${upperLevel}] ${formatted}\n`
+
+		if (level === 'error') {
+			process.stderr.write(line)
+		} else {
+			process.stdout.write(line)
+		}
+	}
+
+	private formatMessage(message: unknown, additional: unknown[]): string {
+		const segments = [message, ...additional].filter((segment) => segment !== undefined)
+		if (segments.length === 0) {
+			return ''
+		}
+
+		return segments
+			.map((segment) => {
+				if (segment instanceof Error) {
+					return segment.stack ?? `${segment.name}: ${segment.message}`
+				}
+				if (typeof segment === 'string') {
+					return segment
+				}
+				if (typeof segment === 'number' || typeof segment === 'boolean' || segment === null) {
+					return String(segment)
+				}
+				try {
+					return JSON.stringify(segment, null, 2)
+				} catch {
+					return String(segment)
+				}
+			})
+			.join(' ')
+	}
+}
+
+export const logger = new Logger(process.env.LOG_LEVEL)

src/main.ts

@@ -16,6 +16,7 @@ import { SkipRouteRequester } from './query/routing/skip/SkipRouteRequester.js'
 import { RouteRequester } from './query/routing/RouteRequesterInterface.js'
 import { ChainQuery } from './query/chainQuery.js'
 import { MetricsService } from './metrics.js'
+import { logger } from './logger'
 
 const REDBANK = 'Redbank'
 const ROVER = 'Rover'
@@ -74,7 +75,7 @@ export const main = async () => {
 	const metricsPort = process.env.METRICS_PORT ? parseInt(process.env.METRICS_PORT) : 9090
 	const metrics = MetricsService.getInstance()
 	metrics.startMetricsServer(metricsPort)
-	console.log(`Metrics server started on port ${metricsPort}`)
+	logger.info(`Metrics server started on port ${metricsPort}`)
 
 	switch (executorType) {
 		case REDBANK:
@@ -129,6 +130,6 @@ const launchRedbank = async (
 }
 
 main().catch((e) => {
-	console.log(e)
+	logger.error(e)
 	process.exit(1)
 })

src/metrics.ts

@@ -1,5 +1,6 @@
 import promClient from 'prom-client'
 import http from 'http'
+import { logger } from './logger'
 
 export class MetricsService {
 	private static instance: MetricsService
@@ -134,7 +135,7 @@ export class MetricsService {
 	}
 
 	public startMetricsServer(port: number = 9090): void {
-		const server = http.createServer(async (req, res) => {
+		const server = http.createServer(async (req: http.IncomingMessage, res: http.ServerResponse) => {
 			if (req.url === '/metrics') {
 				res.setHeader('Content-Type', this.register.contentType)
 				res.end(await this.register.metrics())
@@ -148,7 +149,7 @@ export class MetricsService {
 		})
 
 		server.listen(port, () => {
-			console.log(`Metrics server listening on port ${port}`)
+			logger.info(`Metrics server listening on port ${port}`)
 		})
 	}
 

src/query/routing/skip/SkipRouteRequester.ts

@@ -50,8 +50,6 @@ export class SkipRouteRequester extends RouteRequester {
 				pool: swapOp.pool,
 			})),
 		}))
-		console.log('operations')
-		console.log(JSON.stringify(operations))
 		return {
 			amountIn: skipRoute.amount_in,
 			estimatedAmountOut: skipRoute.amount_out,

src/query/routing/skip/getSwapRoute.ts

@@ -1,3 +1,4 @@
+import { logger } from '../../../logger'
 /**
  * Skip API v2 Fungible Route Client
  * Fetches swap routes from https://api.skip.build/v2/fungible/route
@@ -117,8 +118,8 @@ export async function getSwapRoute(
 
 		return data
 	} catch (error) {
-		console.error('Error fetching route:', error)
-		console.error(
+		logger.error('Error fetching route:', error)
+		logger.error(
 			'params:',
 			JSON.stringify({
 				denomIn,