Merge pull request #2279 from finnfisher-de/add-logger

 feat(core): preserve logs fetched during genMaciState execution

Author: 0xmad

packages/cli/ts/index.ts

@@ -1040,6 +1040,7 @@ program
     "Backup files for ipfs messages (name format: ipfsHash1.json, ipfsHash2.json, ..., ipfsHashN.json)",
     (value: string | undefined) => value?.split(/\s*,\s*/),
   )
+  .option("-l, --logs-output <logsOutputPath>", "the path where to save the logs for debugging and auditing purposes")
   .action(async (cmdObj) => {
     try {
       const signer = await getSigner();
@@ -1066,6 +1067,7 @@ program
         ipfsMessageBackupFiles: cmdObj.ipfsMessageBackupFiles,
         sleep: cmdObj.sleep,
         signer,
+        logsOutputPath: cmdObj.logsOutput,
       });
     } catch (error) {
       program.error((error as Error).message, { exitCode: 1 });

packages/contracts/ts/genMaciState.ts

@@ -23,6 +23,8 @@ import { sleep, sortActions } from "./utils";
  * @param blocksPerRequest - the number of blocks to fetch in each request
  * @param endBlock - the block number at which to stop fetching events
  * @param sleepAmount - the amount of time to sleep between each request
+ * @param ipfsMessageBackupFiles - backup files for ipfs messages
+ * @param logsOutputPath - the file path where to save the logs for debugging and auditing purposes
  * @returns an instance of MaciState
  */
 export const genMaciStateFromContract = async ({
@@ -35,6 +37,7 @@ export const genMaciStateFromContract = async ({
   endBlock,
   sleepAmount,
   ipfsMessageBackupFiles = [],
+  logsOutputPath,
 }: IGenMaciStateFromContractArgs): Promise<MaciState> => {
   // ensure the pollId is valid
   assert(pollId >= 0);
@@ -303,6 +306,26 @@ export const genMaciStateFromContract = async ({
 
   maciState.polls.set(pollId, poll);
 
+  // Save logs if output path is provided
+  if (logsOutputPath) {
+    const logsOutputDirectory = path.resolve(logsOutputPath);
+
+    if (!fs.existsSync(logsOutputDirectory)) {
+      await fs.promises.mkdir(logsOutputDirectory, { recursive: true });
+    }
+
+    const logs = {
+      maciAddress: address,
+      pollId: pollId.toString(),
+      fromBlock,
+      toBlock: lastBlock,
+      timestamp: new Date().toISOString(),
+      actions,
+    };
+
+    await fs.promises.writeFile(logsOutputPath, JSON.stringify(logs, null, 2));
+  }
+
   return maciState;
 };
 

packages/contracts/ts/types.ts

@@ -305,6 +305,11 @@ export interface IGenMaciStateFromContractArgs {
    * Backup files for ipfs messages (name format: ipfsHash.json)
    */
   ipfsMessageBackupFiles?: string[];
+
+  /**
+   * The file path where to save the logs for debugging and auditing purposes
+   */
+  logsOutputPath?: string;
 }
 
 /**

packages/sdk/ts/maci/state.ts

@@ -26,6 +26,7 @@ export const generateMaciState = async ({
   sleep,
   signer,
   ipfsMessageBackupFiles,
+  logsOutputPath,
 }: IGenerateMaciStateArgs): Promise<MaciState> => {
   if (!maciAddress) {
     throw new Error("MACI contract address is empty");
@@ -96,6 +97,7 @@ export const generateMaciState = async ({
     endBlock: endBlockNumber,
     sleepAmount: sleep,
     ipfsMessageBackupFiles,
+    logsOutputPath,
   });
 
   // write the state to a file

packages/sdk/ts/maci/types.ts

@@ -198,4 +198,9 @@ export interface IGenerateMaciStateArgs {
    * Backup files for ipfs messages (name format: ipfsHash.json)
    */
   ipfsMessageBackupFiles?: string[];
+
+  /**
+   * The file path where to save the logs for debugging and auditing purposes
+   */
+  logsOutputPath?: string;
 }