fix: batch of report improvements (#79)

bgd-labs · Dec 10, 2023 · 403280d · 403280d
1 parent ad24fa0
commit 403280d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/src/govv3/generatePayloadReport.ts b/src/govv3/generatePayloadReport.ts
@@ -1,6 +1,6 @@
 import { PublicClient } from 'viem';
 import { TenderlySimulationResponse } from '../utils/tenderlyClient';
-import { PayloadsController, getPayloadsController } from './payloadsController';
+import { HUMAN_READABLE_PAYLOAD_STATE, PayloadsController, getPayloadsController } from './payloadsController';
 import { renderCheckResult, renderUnixTime, toTxLink } from './utils/markdownUtils';
 import { checkTargetsNoSelfdestruct, checkTouchedContractsNoSelfdestruct } from './checks/selfDestruct';
 import { checkLogs } from './checks/logs';
@@ -19,9 +19,12 @@ export async function generateReport({ payloadId, payloadInfo, simulation, publi
   // generate file header
   let report = `## Payload ${payloadId} on ${publicClient.chain!.name}
 
+- Simulation: [https://dashboard.tenderly.co/me/simulator/${
+    simulation.simulation.id
+  }](https://dashboard.tenderly.co/me/simulator/${simulation.simulation.id})
 - creator: ${payload.creator}
 - maximumAccessLevelRequired: ${payload.maximumAccessLevelRequired}
-- state: ${payload.state}
+- state: ${payload.state}(${(HUMAN_READABLE_PAYLOAD_STATE as any)[payload.state]})
 - actions: ${JSON.stringify(payload.actions, (key, value) => (typeof value === 'bigint' ? value.toString() : value))}
 - createdAt: [${renderUnixTime(payload.createdAt)}](${toTxLink(createdLog.transactionHash, false, publicClient)})\n`;
   if (queuedLog) {
@@ -37,7 +40,9 @@ export async function generateReport({ payloadId, payloadInfo, simulation, publi
         publicClient
       )})\n`;
     } else {
-      report += `- earliest execution at: ${renderUnixTime(payload.queuedAt + 60 * 60 * 24)}\n`;
+      report += `- earliest execution at: [${renderUnixTime(
+        payload.queuedAt + payload.delay
+      )}](https://www.epochconverter.com/countdown?q=${payload.queuedAt + payload.delay})\n`;
     }
   }
 

diff --git a/src/govv3/generateProposalReport.ts b/src/govv3/generateProposalReport.ts
@@ -25,6 +25,9 @@ export async function generateProposalReport({
   // generate file header
   let report = `## Proposal ${proposalId}
 
+- Simulation: [https://dashboard.tenderly.co/me/simulator/${
+    simulation.simulation.id
+  }](https://dashboard.tenderly.co/me/simulator/${simulation.simulation.id})
 - state: ${HUMAN_READABLE_STATE[proposal.state as keyof typeof HUMAN_READABLE_STATE]}
 - creator: ${proposal.creator}
 - maximumAccessLevelRequired: ${proposal.accessLevel}

diff --git a/src/govv3/payloadsController.ts b/src/govv3/payloadsController.ts
@@ -32,6 +32,15 @@ export enum PayloadState {
   Expired,
 }
 
+export const HUMAN_READABLE_PAYLOAD_STATE = {
+  [PayloadState.None]: 'None',
+  [PayloadState.Created]: 'Created',
+  [PayloadState.Queued]: 'Queued',
+  [PayloadState.Executed]: 'Executed',
+  [PayloadState.Cancelled]: 'Cancelled',
+  [PayloadState.Expired]: 'Expired',
+};
+
 export interface PayloadsController {
   controllerContract: GetContractReturnType<typeof IPayloadsControllerCore_ABI, PublicClient>;
   // cache created / queued / Executed logs