Some chore (#296)

* add log-level

* chore: adjust clean not found logs

* chore: update some logs and docs

* chore: add log-level readme

Author: RetricSu

README.md

@@ -33,6 +33,7 @@ There are BREAKING CHANGES between v0.3.x and v0.4.x, make sure to read the [mig
   - [List All Settings](#list-all-settings)
   - [Set CKB version](#set-ckb-version)
   - [Set Network Proxy](#set-network-proxy)
+- [Log-Level](#log-level)
 - [Built-in scripts](#built-in-scripts)
 - [Accounts](#accounts)
 - [About CCC](#about-ccc)
@@ -203,6 +204,8 @@ offckb deploy --type-id --network <devnet/testnet>
 
 Your deployed scripts info will be be listed in the `output-folder-path` which you defined in the command.
 
+Note that upgrades are keyed by the contract‘s artifact name. If you plan to upgrade with `--type-id`, do not rename your contract artifact (e.g. keep `hello-world.bc`). Renaming it makes the offckb unable to find the previous Type ID info from the `output-folder-path` and will create a new Type ID.
+
 ### Debug a transaction
 
 If you are interacting the CKB devnet via the proxy RPC server(`localhost:28114`), all the failed transactions will be dumped and recorded so you can debug them later.
@@ -291,6 +294,16 @@ offckb config get proxy
 > No Proxy.
 ```
 
+## Log-Level
+
+You can tweak env `LOG_LEVEL` to control the `offckb` log level.
+
+For example, set `LOG_LEVEL=debug` gives you more outputs of offckb proxy RPC.
+
+```sh
+LOG_LEVEL offckb node
+```
+
 ## Built-in scripts
 
 - [x] xUDT https://github.com/nervosnetwork/rfcs/pull/428

src/cmd/clean.ts

@@ -16,6 +16,6 @@ export function clean() {
       logger.error((error as Error).message);
     }
   } else {
-    logger.info(`${allDevnetDataPath} not found, unable to clean it.`);
+    logger.info(`Nothing to clean. Devnet data directory ${allDevnetDataPath} not found.`);
   }
 }

src/cmd/deploy.ts

@@ -52,7 +52,7 @@ export async function deploy(
     `   📁 Deployment artifacts will be saved to: ${outputFolder}`,
     `   🌐 Network: ${network}`,
     `   🔑 Using ${opt.privkey ? 'custom' : 'default'} private key`,
-    `   🔄 Type ID: ${enableTypeId ? 'enabled (upgradable)' : 'disabled'}`,
+    `   🔄 Type ID: ${enableTypeId ? 'enabled (upgradable)' : 'disabled (immutable)'}`,
   ]);
 
   const res = await confirm({

src/sdk/ckb.ts

@@ -218,6 +218,10 @@ export class CKB {
     const typeId = deploymentReceipt.cellRecipes[0].typeId;
     if (typeId == null) throw new Error("type id in migration file is null, can't be updated.");
 
+    logger.info(`Existing Type-ID found:
+- Type ID: ${typeId}
+(Upgrade keeps the same type-id by consuming the old code Cell and creating a new one.)
+`);
     const cell = await this.client.getCell(outpoint);
     if (cell == null) {
       throw new Error('type id cell not found!');

src/tools/rpc-proxy.ts

@@ -28,6 +28,7 @@ export function createRPCProxy(network: Network, targetRpcUrl: string, port: num
         const method = jsonRpcContent.method;
         const params = jsonRpcContent.params;
         logger.info('RPC Req: ', method);
+        logger.debug('RPC Params: ', params);
 
         if (method === 'send_transaction') {
           const tx = params[0];
@@ -61,10 +62,7 @@ export function createRPCProxy(network: Network, targetRpcUrl: string, port: num
 
       try {
         const jsonRpcResponse = JSON.parse(res);
-        const error = jsonRpcResponse.error;
-        if (error) {
-          logger.debug('RPC Response: ', jsonRpcResponse);
-        }
+        logger.debug('RPC Response: ', jsonRpcResponse);
       } catch (err) {
         logger.error('Error parsing JSON-RPC res content:', (err as Error).message);
       }

src/util/logger.ts

@@ -1,5 +1,6 @@
 import winston from 'winston';
 import chalk from 'chalk';
+import process from 'node:process';
 
 // Define log levels with corresponding chalk colors
 const levelColors = {
@@ -29,7 +30,7 @@ class UnifiedLogger {
 
     // Create Winston logger with custom format and levels
     this.logger = winston.createLogger({
-      level: options.level || 'info',
+      level: options.level || process.env.LOG_LEVEL || 'info',
       levels: {
         error: 0,
         warn: 1,