feat: LoggingStaticJsonRpcProvider

packages/client/src/Ethereum.ts

@@ -2,12 +2,12 @@
  * Config and utilities for interating with identity & Ethereum chain.
  */
 import { Wallet } from '@ethersproject/wallet'
-import { StaticJsonRpcProvider } from '@ethersproject/providers'
 import type { Provider } from '@ethersproject/providers'
 import type { ConnectionInfo } from '@ethersproject/web'
 import type { Overrides } from '@ethersproject/contracts'
 import type { BigNumber } from '@ethersproject/bignumber'
 import { ChainConnectionInfo, StrictStreamrClientConfig } from './Config'
+import { LoggingStaticJsonRpcProvider } from './utils/LoggingStaticJsonRpcProvider'
 
 export const generateEthereumAccount = (): { address: string, privateKey: string } => {
     const wallet = Wallet.createRandom()
@@ -23,7 +23,7 @@ export const getStreamRegistryChainProviders = (config: Pick<StrictStreamrClient
 
 const getRpcProviders = (connectionInfo: ChainConnectionInfo, pollInterval?: number): Provider[] => {
     return connectionInfo.rpcs.map((c: ConnectionInfo) => {
-        const provider = new StaticJsonRpcProvider(c)
+        const provider = new LoggingStaticJsonRpcProvider(c)
         if (pollInterval !== undefined) {
             provider.pollingInterval = pollInterval
         }

packages/client/src/utils/LoggingStaticJsonRpcProvider.ts

@@ -0,0 +1,34 @@
+import { StaticJsonRpcProvider } from '@ethersproject/providers'
+import { Logger, randomString } from '@streamr/utils'
+
+export class LoggingStaticJsonRpcProvider extends StaticJsonRpcProvider {
+    private readonly logger = new Logger(module)
+
+    override async send(method: string, params: any[]): Promise<any> {
+        const traceId = randomString(5)
+        const startTime = Date.now()
+        const logContext = {
+            traceId,
+            method,
+            params,
+            connection: this.connection
+        }
+        this.logger.debug('Send request', logContext)
+        let result
+        try {
+            result = await super.send(method, params)
+        } catch (err) {
+            this.logger.debug('Encountered error while requesting', {
+                ...logContext,
+                err,
+                elapsedTime: Date.now() - startTime
+            })
+            throw err
+        }
+        this.logger.debug('Received response', {
+            ...logContext,
+            elapsedTime: Date.now() - startTime
+        })
+        return result
+    }
+}