Support debugging mode

packages/cli/cli_internal.ts

@@ -16,7 +16,7 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
-import { Project, web3, NetworkId, networkIds, validateNFTBaseUri } from '@alephium/web3'
+import { Project, web3, NetworkId, networkIds, validateNFTBaseUri, enableDebugMode } from '@alephium/web3'
 import { program } from 'commander'
 import { run as runJestTests } from 'jest'
 import path from 'path'
@@ -29,7 +29,9 @@ import { codegen, getConfigFile, isNetworkLive, loadConfig } from './src'
 function getConfig(options: any): Configuration {
   const configFile = options.config ? (options.config as string) : getConfigFile()
   console.log(`Loading alephium config file: ${configFile}`)
-  return loadConfig(configFile)
+  const config = loadConfig(configFile)
+  if (config.enableDebugMode) enableDebugMode()
+  return config
 }
 
 function checkAndGetNetworkId(networkId?: string): NetworkId {

packages/cli/src/types.ts

@@ -57,6 +57,8 @@ export interface Configuration<Settings = unknown> {
   compilerOptions?: CompilerOptions
 
   networks: Record<NetworkId, Network<Settings>>
+
+  enableDebugMode?: boolean
 }
 
 export const DEFAULT_CONFIGURATION_VALUES = {

packages/web3/src/api/node-provider.ts

@@ -24,7 +24,8 @@ import {
   FungibleTokenMetaData,
   NFTMetaData,
   NFTCollectionMetaData,
-  StdInterfaceIds
+  StdInterfaceIds,
+  requestWithLog
 } from './types'
 import { Api as NodeApi, CallContractFailed, CallContractSucceeded } from './api-alephium'
 import { HexString, tryGetCallResult } from '../contract'
@@ -100,6 +101,7 @@ export class NodeProvider implements NodeProviderApis {
     this.utils = { ...nodeApi.utils }
     this.miners = { ...nodeApi.miners }
     this.events = { ...nodeApi.events }
+    requestWithLog(this)
   }
 
   request = (args: ApiRequestArguments): Promise<any> => {

packages/web3/src/api/types.ts

@@ -17,6 +17,7 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { ZERO_ADDRESS } from '../constants'
+import { isDebugModeEnabled } from '../debug'
 import { assertType, bs58, Eq, isBase58, isHexString } from '../utils'
 import * as node from './api-alephium'
 
@@ -267,12 +268,42 @@ export interface ApiRequestArguments {
 }
 export type ApiRequestHandler = (args: ApiRequestArguments) => Promise<any>
 
+async function call(args: ApiRequestArguments, handler: ApiRequestHandler): Promise<any> {
+  const debugModeEnabled = isDebugModeEnabled()
+  const { path, method, params } = args
+  if (debugModeEnabled) {
+    console.log(`[REQUEST] ${path} ${method} ${JSON.stringify(params)}`)
+  }
+  try {
+    const response = await handler(args)
+    if (debugModeEnabled) {
+      console.log(`[RESPONSE] ${path} ${method} ${JSON.stringify(response)}`)
+    }
+    return response
+  } catch (error) {
+    if (debugModeEnabled) {
+      console.error(`[ERROR] ${path} ${method} `, error)
+    }
+    throw error
+  }
+}
+
 export function forwardRequests(api: Record<string, any>, handler: ApiRequestHandler): void {
   // Update class properties to forward requests
   for (const [path, pathObject] of Object.entries(api)) {
     for (const method of Object.keys(pathObject)) {
       pathObject[`${method}`] = async (...params: any): Promise<any> => {
-        return handler({ path, method, params })
+        return call({ path, method, params }, handler)
+      }
+    }
+  }
+}
+
+export function requestWithLog(api: Record<string, any>) {
+  for (const [path, pathObject] of Object.entries(api)) {
+    for (const [method, handler] of Object.entries(pathObject)) {
+      pathObject[`${method}`] = async (...params: any): Promise<any> => {
+        return call({ path, method, params }, () => (handler as (...any) => Promise<any>)(...params))
       }
     }
   }

packages/web3/src/debug.ts

@@ -0,0 +1,31 @@
+/*
+Copyright 2018 - 2022 The Alephium Authors
+This file is part of the alephium project.
+
+The library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+The library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+let debugModeEnabled = false
+
+export function isDebugModeEnabled() {
+  return debugModeEnabled
+}
+
+export function enableDebugMode() {
+  debugModeEnabled = true
+}
+
+export function disableDebugMode() {
+  debugModeEnabled = false
+}

packages/web3/src/index.ts

@@ -31,3 +31,4 @@ export * from './constants'
 export * as web3 from './global'
 
 export * as utils from './utils'
+export * from './debug'