feat(orap&reku): add setLogger

Author: nom4dv3

packages/orap/orap.ts

@@ -1,5 +1,7 @@
 import type { Providers } from '@ora-io/reku'
 import { RekuProviderManager } from '@ora-io/reku'
+import type { Logger } from '@ora-io/utils'
+import { logger } from '@ora-io/utils'
 import { EventSignal } from './signal/event'
 
 export interface ListenOptions {
@@ -12,14 +14,16 @@ export class Orap {
     event: EventSignal[]
   }
 
+  logger: Logger = logger
+
   constructor() {
     this.routes = {
       event: [],
     }
   }
 
   event(options: any, fn: any) {
-    const es = new EventSignal(options, fn)
+    const es = new EventSignal(options, fn, this.logger)
     this.routes.event.push(es)
     return es
   }
@@ -37,4 +41,8 @@ export class Orap {
     onListen()
     return this
   }
+
+  setLogger(logger: Logger) {
+    this.logger = logger
+  }
 }

packages/orap/signal/event.ts

@@ -2,6 +2,7 @@ import type { EventFragment, Log } from 'ethers'
 import { ethers } from 'ethers'
 import { AutoCrossChecker, ONE_MINUTE_MS, RekuProviderManager } from '@ora-io/reku'
 import type { AutoCrossCheckParam, Providers } from '@ora-io/reku'
+import type { Logger } from '@ora-io/utils'
 import type { Signal } from './type'
 
 export interface EventSignalRegisterParams {
@@ -28,6 +29,7 @@ export class EventSignal implements Signal {
   constructor(
     public params: EventSignalRegisterParams,
     public callback: EventSignalCallback,
+    public logger: Logger,
   ) {
     this.contract = new ethers.Contract(
       params.address,
@@ -88,6 +90,7 @@ export class EventSignal implements Signal {
     if (!this.crosscheckerOptions)
       throw new Error('no crosscheck set, can\'t start crosschecker')
     this.crosschecker = new AutoCrossChecker(provider, this.crosscheckerOptions)
+    this.crosschecker.setLogger(this.logger)
     await this.crosschecker.start(this.crosscheckerOptions)
   }
 

packages/reku/event/crosschecker/autochecker.ts

@@ -1,5 +1,5 @@
 import type { ethers } from 'ethers'
-import { logger, polling, retryOnNull, sleep } from '@ora-io/utils'
+import { polling, retryOnNull, sleep } from '@ora-io/utils'
 import { ETH_BLOCK_INTERVAL_MS } from '../../constants'
 import type { Providers } from '../../types/w3'
 import { CrossCheckerCacheManager } from './cache/manager'
@@ -8,7 +8,7 @@ import { BaseCrossChecker } from './basechecker'
 
 export class AutoCrossChecker extends BaseCrossChecker {
   // TODO: make cache self-clean with a MAX cap
-  cache: CrossCheckerCacheManager = new CrossCheckerCacheManager()
+  cache: CrossCheckerCacheManager
   checkpointBlockNumber = 0
 
   constructor(
@@ -92,10 +92,10 @@ export class AutoCrossChecker extends BaseCrossChecker {
     const waitNextCrosscheck = async (): Promise<boolean> => {
       // TODO: use blockNumber for performance
       const latestblocknum = (await retryOnNull(async () => await this.provider.provider?.getBlock('latest'))).number
-      logger.info(`[*] ccrOptions: fromBlock ${ccrOptions.fromBlock}, toBlock ${ccrOptions.toBlock}, latestblocknum ${latestblocknum}`)
+      this.logger.info('[*] ccrOptions: fromBlock', ccrOptions.fromBlock, ', toBlock', ccrOptions.toBlock, ', latestblocknum', latestblocknum)
       if (ccrOptions.toBlock + delayBlockFromLatest > latestblocknum) {
         // sleep until the toBlock
-        logger.info(`sleep until the latestblocknum >= toBlock + delayBlockFromLatest, i.e. ${(ccrOptions.toBlock + delayBlockFromLatest - latestblocknum) * blockIntervalMs} ms`)
+        this.logger.debug('sleep until the latestblocknum >= toBlock + delayBlockFromLatest, i.e.', (ccrOptions.toBlock + delayBlockFromLatest - latestblocknum) * blockIntervalMs, 'ms')
         await sleep((ccrOptions.toBlock + delayBlockFromLatest - latestblocknum) * blockIntervalMs)
         return false
       }

packages/reku/event/crosschecker/basechecker.ts

@@ -1,11 +1,13 @@
 import type { ethers } from 'ethers'
+import type { Logger } from '@ora-io/utils'
 import { logger, retryOnNull } from '@ora-io/utils'
 import { ETH_BLOCK_COUNT_ONE_HOUR } from '../../constants'
 import type { Providers } from '../../types/w3'
 import type { CrossCheckFromParam, CrossCheckRangeParam, CrossCheckRetroParam, SimpleLog } from './interface'
 
 export class BaseCrossChecker {
   provider: Providers
+  logger: Logger = logger
   constructor(provider: Providers) {
     this.provider = provider
   }
@@ -30,7 +32,7 @@ export class BaseCrossChecker {
     const { retroBlockCount } = ccrOptions
     // TODO: change to chain rpc based block interval
     if (retroBlockCount < ETH_BLOCK_COUNT_ONE_HOUR)
-      logger.warn('crosscheck retroBlockCount too low, recommend block range >= 1 hour')
+      this.logger.warn('crosscheck retroBlockCount too low, recommend block range >= 1 hour')
 
     // define from, to
     // TODO: use blockNumber for performance
@@ -57,7 +59,7 @@ export class BaseCrossChecker {
 
     // suggest use large retroBlockCount
     if (block.number - ccfOptions.fromBlock < ETH_BLOCK_COUNT_ONE_HOUR)
-      logger.warn('crosscheck retroBlockCount too low, recommend crosscheck interval >= 1 hour')
+      this.logger.warn('crosscheck retroBlockCount too low, recommend crosscheck interval >= 1 hour')
 
     // define from, to
     const options: CrossCheckRangeParam = {
@@ -85,7 +87,7 @@ export class BaseCrossChecker {
     const missing = (logToFind: ethers.Log) => {
       const logIndex = ignoreLogs.findIndex(
         log => log.transactionHash === logToFind.transactionHash
-        && (!log.index || log.index === logToFind.index),
+          && (!log.index || log.index === logToFind.index),
       )
 
       return logIndex === -1
@@ -117,5 +119,9 @@ export class BaseCrossChecker {
         await options.onMissingLog(log)
     }
   }
+
+  setLogger(logger: Logger) {
+    this.logger = logger
+  }
 }