feat: update type to ContractAddress for all contract address types

Author: murongg

packages/orap/src/flow/orap.ts

@@ -1,5 +1,6 @@
 import type { Providers } from '@ora-io/reku'
-import type { Fn } from '@ora-io/utils'
+import type { ContractAddress, Fn } from '@ora-io/utils'
+import { isAddressable } from 'ethers'
 import type { Interface, InterfaceAbi } from 'ethers'
 import { OrapVerse } from '../verse/orap'
 import type { EventSignalRegisterParams } from '../signal'
@@ -27,12 +28,11 @@ export class OrapFlow implements Flow {
   }
 
   event(params: EventSignalRegisterParams, handler?: HandleFn): EventFlow
-  event(params: string, abi: Interface | InterfaceAbi | HandleFn, eventName: string, handler?: HandleFn): EventFlow
-  event(params: EventSignalRegisterParams | string, abi?: Interface | InterfaceAbi | HandleFn, eventName?: string, handler?: HandleFn): EventFlow {
-    if (typeof params === 'string')
+  event(address: ContractAddress, abi: Interface | InterfaceAbi | HandleFn, eventName: string, handler?: HandleFn): EventFlow
+  event(params: EventSignalRegisterParams | ContractAddress, abi?: Interface | InterfaceAbi | HandleFn, eventName?: string, handler?: HandleFn): EventFlow {
+    if (typeof params === 'string' || isAddressable(params))
       params = { address: params, abi: abi as Interface | InterfaceAbi, eventName: eventName as string }
-    else
-      handler = abi as HandleFn
+    else handler = abi as HandleFn
 
     const eventFlow = new EventFlow(this, params, handler)
     this.subflows.event.push(eventFlow)

packages/orap/src/signal/event.ts

@@ -2,10 +2,11 @@ import type { EventFragment, Interface, InterfaceAbi, Log } from 'ethers'
 import { ContractEventPayload, ContractUnknownEventPayload, ethers } from 'ethers'
 import { AutoCrossChecker, ONE_MINUTE_MS, RekuProviderManager } from '@ora-io/reku'
 import type { AutoCrossCheckParam, Providers } from '@ora-io/reku'
+import type { ContractAddress } from '@ora-io/utils'
 import type { Signal } from './interface'
 
 export interface EventSignalRegisterParams {
-  address: string
+  address: ContractAddress
   abi: Interface | InterfaceAbi
   eventName: string
   // esig?: string,

packages/reku/src/event/crosschecker/interface.ts

@@ -1,12 +1,12 @@
-import type { Awaitable, Milliseconds, Store } from '@ora-io/utils'
+import type { Awaitable, ContractAddress, Milliseconds, Store } from '@ora-io/utils'
 import type { ethers } from 'ethers'
 
 export type FnOnMissingLog = (log: ethers.Log) => Awaitable<void>
 
 export interface SimpleLog { transactionHash: string; index?: number }
 
 export interface LogFilterParam {
-  address: string
+  address: ContractAddress
   topics: string[]
   fromBlock?: number
   toBlock?: number

packages/reku/src/provider/contract.ts

@@ -1,12 +1,12 @@
-import type { Fn } from '@ora-io/utils'
+import type { ContractAddress, Fn } from '@ora-io/utils'
 import type { Interface, InterfaceAbi } from 'ethers'
 import { ethers } from 'ethers'
 
 export class ContractManager {
   private _contract?: ethers.Contract
   private _listeners: Map<ethers.ContractEventName, Fn> = new Map()
 
-  constructor(public address: string, public abi: Interface | InterfaceAbi, public provider: ethers.JsonRpcProvider | ethers.WebSocketProvider) {
+  constructor(public address: ContractAddress, public abi: Interface | InterfaceAbi, public provider: ethers.JsonRpcProvider | ethers.WebSocketProvider) {
     this._contract = new ethers.Contract(address, abi, provider)
   }
 

packages/reku/src/provider/provider.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from 'node:events'
 import type { InterfaceAbi } from 'ethers'
 import { Interface, WebSocketProvider, ethers } from 'ethers'
 import type { ErrorEvent, WebSocket } from 'ws'
+import type { ContractAddress } from '@ora-io/utils'
 import { debug } from '../debug'
 import { ContractManager } from './contract'
 
@@ -20,7 +21,7 @@ export type RekuProviderManagerEvent = 'error' | 'close'
 
 export class RekuProviderManager {
   private _provider?: ethers.JsonRpcProvider | ethers.WebSocketProvider
-  private _contracts: Map<string, ContractManager> = new Map()
+  private _contracts: Map<ContractAddress, ContractManager> = new Map()
 
   private _heartbeatInterval = 10 * 1000
 
@@ -53,9 +54,9 @@ export class RekuProviderManager {
     return this._contracts
   }
 
-  addContract(address: string, contract: ethers.Contract): ContractManager | undefined
-  addContract(address: string, abi: Interface | InterfaceAbi): ContractManager | undefined
-  addContract(address: string, abi: Interface | InterfaceAbi | ethers.Contract): ContractManager | undefined {
+  addContract(address: ContractAddress, contract: ethers.Contract): ContractManager | undefined
+  addContract(address: ContractAddress, abi: Interface | InterfaceAbi): ContractManager | undefined
+  addContract(address: ContractAddress, abi: Interface | InterfaceAbi | ethers.Contract): ContractManager | undefined {
     if (this._provider) {
       if (abi instanceof Interface || Array.isArray(abi)) {
         if (!abi)
@@ -77,11 +78,11 @@ export class RekuProviderManager {
     return undefined
   }
 
-  addListener(contractAddress: string, event: ethers.ContractEventName, listener: ethers.Listener) {
+  addListener(contractAddress: ContractAddress, event: ethers.ContractEventName, listener: ethers.Listener) {
     this._contracts.get(contractAddress)?.addListener(event, listener)
   }
 
-  removeListener(contractAddress: string, event: ethers.ContractEventName, listener: ethers.Listener) {
+  removeListener(contractAddress: ContractAddress, event: ethers.ContractEventName, listener: ethers.Listener) {
     this._contracts.get(contractAddress)?.removeListener(event, listener)
   }
 
@@ -154,7 +155,7 @@ export class RekuProviderManager {
       // reconnect provider
       this.connect()
       // reset contracts
-      const contracts: Map<string, ContractManager> = new Map()
+      const contracts: Map<ContractAddress, ContractManager> = new Map()
       this._contracts.forEach((contract) => {
         if (this._provider) {
           const newContract = new ContractManager(contract.address, contract.abi, this._provider)

packages/utils/src/index.ts

@@ -1,4 +1,5 @@
 export * from './common'
 export * from './store'
 export * from './w3'
+export type * from './types'
 export * from '@murongg/utils'

packages/utils/src/types/index.ts

@@ -0,0 +1 @@
+export * from './w3'

packages/utils/src/types/w3.ts

@@ -0,0 +1,3 @@
+import type { Addressable } from 'ethers'
+
+export type ContractAddress = Addressable | string