docs: ✏️ add comments

src/app.module.ts

@@ -23,6 +23,9 @@ import { RootController } from './root/root.controller';
 import { RootService } from './root/root.service';
 import { ChainsyncService } from './chainsync/chainsync.service';
 
+/**
+ * Root module for the application.
+ */
 @Module({
   imports: [],
   controllers: [RootController],

src/chainsync/chainsync.service.ts

@@ -20,25 +20,38 @@
 
 import { Injectable, OnModuleInit } from '@nestjs/common';
 
+/**
+ * Service responsible for synchronizing with the blockchain.
+ */
 @Injectable()
 export class ChainsyncService implements OnModuleInit {
+  /**
+   * Lifecycle hook, called once the module has been initialized.
+   */
   async onModuleInit() {
     await this.startBackgroundTask();
   }
 
+  /**
+   * Start the background task for continuous synchronization.
+   */
   private async startBackgroundTask() {
     while (true) {
       try {
         console.log(
-          'Always craw the lastest tipset ,blockMessages and messages ',
+          'Always crawl the latest tipset, blockMessages, and messages.',
         );
         await this.delay(1000);
       } catch (error) {
-        console.error('Error in background task:', error);
+        console.error('Error in the background task:', error);
       }
     }
   }
 
+  /**
+   * Utility function to introduce a delay.
+   * @param ms - The delay time in milliseconds.
+   */
   private async delay(ms: number): Promise<void> {
     return new Promise((resolve) => setTimeout(resolve, ms));
   }

src/config/network.ts

@@ -27,6 +27,9 @@ import {
   AddressesFilterReplayStrategy,
 } from '@unipackage/filecoin';
 
+/**
+ * Configuration for a Filecoin network.
+ */
 export interface NetworkConfig {
   apiAddress: string;
   token: string;
@@ -37,6 +40,9 @@ export interface NetworkConfig {
   };
 }
 
+/**
+ * Represents a connection to a Filecoin network.
+ */
 export class ChainNetwork {
   rpc: ChainFilecoinRPC;
   messageDatastore: MessageMongoDatastore;
@@ -45,6 +51,10 @@ export class ChainNetwork {
   dataswapStartHeight: number;
   chainService: ChainService;
 
+  /**
+   * Creates an instance of ChainNetwork.
+   * @param config - The network configuration.
+   */
   constructor(config: NetworkConfig) {
     this.dataswapStartHeight = config.dataswapStartHeight;
     this.rpc = new ChainFilecoinRPC({
@@ -67,13 +77,19 @@ export class ChainNetwork {
   }
 }
 
+/**
+ * Calibration network configuration
+ */
 export const chainNetworkCalibration = new ChainNetwork({
   apiAddress: process.env.CALIBRATION_LOTUS_API_ENDPOINT as string,
   token: process.env.CALIBRATION_LOTUS_TOKEN as string,
   mongoUrl: process.env.CALIBRATION_MONGO_URL as string,
   dataswapStartHeight: 1,
 });
 
+/**
+ * Main network configuration
+ */
 export const chainNetwork = new ChainNetwork({
   apiAddress: process.env.MAIN_LOTUS_API_ENDPOINT as string,
   token: process.env.MAIN_LOTUS_TOKEN as string,

src/main.ts

@@ -21,8 +21,16 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
 
+/**
+ * Application bootstrap function.
+ */
 async function bootstrap() {
+  // Create a NestJS application instance
   const app = await NestFactory.create(AppModule);
+
+  // Start the application, listening on port 3000
   await app.listen(3000);
 }
+
+// Call the bootstrap function to start the application
 bootstrap();

src/root/root.controller.ts

@@ -21,10 +21,22 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { RootService } from './root.service';
 
+/**
+ * Controller responsible for handling root-level requests.
+ */
 @Controller()
 export class RootController {
+  /**
+   * Creates an instance of RootController.
+   * @param rootService - The RootService instance.
+   */
   constructor(private readonly rootService: RootService) {}
 
+  /**
+   * Handles GET requests for root-level resources with an identifier.
+   * @param param - Request parameters.
+   * @returns A string representing the response.
+   */
   @Get(':id')
   getHello(@Param() param): string {
     console.log(param.id);

src/root/root.service.ts

@@ -20,8 +20,15 @@
 
 import { Injectable } from '@nestjs/common';
 
+/**
+ * Service responsible for providing root-level functionality.
+ */
 @Injectable()
 export class RootService {
+  /**
+   * Gets a greeting message.
+   * @returns A string representing a greeting message.
+   */
   getHello(): string {
     return 'Hello World!';
   }