@bgd-labs/toolbox 0.0.28 → 0.0.30

package/dist/index.d.mts

@@ -14015,7 +14015,7 @@ declare function genericIndexer<T extends {} = {}>(args: GenericIndexerArgs<T>):
 type LogType = {
     topics: [Hex];
     data: Hex;
-    emitter: Address;
+    address: Address;
     eventName?: string;
     args?: any;
 };
@@ -14030,7 +14030,7 @@ declare function parseLogs({ logs, eventDb }: ParseLogsArgs): LogType[];
  * @param logs
  * @returns
  */
-declare function enhanceLogs(client: Client, logs: LogType[]): Promise<(LogType | undefined)[]>;
+declare function enhanceLogs(client: Client, logs: LogType[]): Promise<LogType[]>;
 
 declare enum SelfdestructCheckState {
     TRUSTED = 0,
@@ -14069,8 +14069,9 @@ type RenderTenderlyReportParams = {
     config: {
         etherscanApiKey: string;
     };
+    getContractName: (address: Address) => string;
 };
-declare function renderTenderlyReport({ client, sim, payloadId, payload, onchainLogs: { createdLog, queuedLog, executedLog }, eventCache, config, }: RenderTenderlyReportParams): Promise<{
+declare function renderTenderlyReport({ client, sim, payloadId, payload, onchainLogs: { createdLog, queuedLog, executedLog }, eventCache, config, getContractName, }: RenderTenderlyReportParams): Promise<{
     report: string;
     eventCache: AbiEvent[];
 }>;
@@ -14117,6 +14118,7 @@ type StreamChangedType = {
     tokenAddress?: Address;
     ratePerSecond?: string;
     remainingBalance?: string;
+    deposit?: string;
 };
 type InterestDataChangedType = {
     optimalUsageRatio: number | string;
@@ -14129,8 +14131,12 @@ type ChangeMap = {
     _streams: StreamChangedType;
     _interestRateData: InterestDataChangedType;
     assetsSources: string;
-    _balances: string;
-    _allowances: string;
+    totalSupply: string;
+    _balances: Record<string, string>;
+    _allowances: Record<string, string>;
+    balanceOf: Record<string, string>;
+    allowed: Record<string, string>;
+    balances: Record<string, string>;
 };
 type Change<TName extends string = string> = {
     type: string;

package/dist/index.d.ts

@@ -14015,7 +14015,7 @@ declare function genericIndexer<T extends {} = {}>(args: GenericIndexerArgs<T>):
 type LogType = {
     topics: [Hex];
     data: Hex;
-    emitter: Address;
+    address: Address;
     eventName?: string;
     args?: any;
 };
@@ -14030,7 +14030,7 @@ declare function parseLogs({ logs, eventDb }: ParseLogsArgs): LogType[];
  * @param logs
  * @returns
  */
-declare function enhanceLogs(client: Client, logs: LogType[]): Promise<(LogType | undefined)[]>;
+declare function enhanceLogs(client: Client, logs: LogType[]): Promise<LogType[]>;
 
 declare enum SelfdestructCheckState {
     TRUSTED = 0,
@@ -14069,8 +14069,9 @@ type RenderTenderlyReportParams = {
     config: {
         etherscanApiKey: string;
     };
+    getContractName: (address: Address) => string;
 };
-declare function renderTenderlyReport({ client, sim, payloadId, payload, onchainLogs: { createdLog, queuedLog, executedLog }, eventCache, config, }: RenderTenderlyReportParams): Promise<{
+declare function renderTenderlyReport({ client, sim, payloadId, payload, onchainLogs: { createdLog, queuedLog, executedLog }, eventCache, config, getContractName, }: RenderTenderlyReportParams): Promise<{
     report: string;
     eventCache: AbiEvent[];
 }>;
@@ -14117,6 +14118,7 @@ type StreamChangedType = {
     tokenAddress?: Address;
     ratePerSecond?: string;
     remainingBalance?: string;
+    deposit?: string;
 };
 type InterestDataChangedType = {
     optimalUsageRatio: number | string;
@@ -14129,8 +14131,12 @@ type ChangeMap = {
     _streams: StreamChangedType;
     _interestRateData: InterestDataChangedType;
     assetsSources: string;
-    _balances: string;
-    _allowances: string;
+    totalSupply: string;
+    _balances: Record<string, string>;
+    _allowances: Record<string, string>;
+    balanceOf: Record<string, string>;
+    allowed: Record<string, string>;
+    balances: Record<string, string>;
 };
 type Change<TName extends string = string> = {
     type: string;

package/dist/index.js

@@ -33109,6 +33109,19 @@ async function addAssetPrice(client, address) {
   }
   return `${address} (latestAnswer: ${decimals ? prettifyNumber({ value: latestAnswer, decimals, showDecimals: true }) : latestAnswer}, description: ${description})`;
 }
+function getMdContractName(contracts, address) {
+  const contract = contracts.find(
+    (c) => c.address.toLowerCase() === address.toLowerCase()
+  );
+  if (!contract) return `unknown contract name at \`${(0, import_viem9.getAddress)(address)}\``;
+  let contractName = contract?.contract_name;
+  if (contract?.token_data?.name)
+    contractName += ` (${contract?.token_data?.name})`;
+  if (contract.standards?.includes("eip1967") && contract.child_contracts?.[0].address) {
+    return `${contractName} at \`${(0, import_viem9.getAddress)(address)}\` with implementation ${getMdContractName(contracts, contract.child_contracts?.[0].address)}`;
+  }
+  return `${contractName} at \`${(0, import_viem9.getAddress)(address)}\``;
+}
 
 // src/seatbelt/logs.ts
 function parseLogs({ logs, eventDb }) {
@@ -33135,8 +33148,7 @@ function enhanceLogs(client, logs) {
         if (["Transfer", "Approval", "Burn", "Mint", "BalanceTransfer"].includes(
           log.eventName
         )) {
-          const asset = await findAsset(client, log.emitter);
-          log.emitter = addAssetSymbol(asset, log.emitter);
+          const asset = await findAsset(client, log.address);
           for (const key of argKeys) {
             if (["value", "amount", "wad"].includes(key)) {
               log.args[key] = prettifyNumber({
@@ -33181,6 +33193,7 @@ function enhanceLogs(client, logs) {
         }
         return log;
       }
+      return log;
     })
   );
 }
@@ -33273,6 +33286,9 @@ function checkCode(bytecode) {
   return { halted, delegatecall, selfDestruct: false };
 }
 
+// src/seatbelt/tenderly-report.ts
+var import_viem12 = require("viem");
+
 // src/seatbelt/verified.ts
 var import_actions7 = require("viem/actions");
 var VerificationStatus = /* @__PURE__ */ ((VerificationStatus2) => {
@@ -33432,12 +33448,15 @@ function getObjectDiff(obj1, obj2) {
 function renderMarkdownStateDiffReport(changes, getContractName = (address) => `${address}`) {
   let report = "";
   for (const contract of Object.keys(changes)) {
-    report += `## ${getContractName(contract)}
+    report += `#### ${getContractName(contract)}
 
+\`\`\`diff
 `;
     for (const change of changes[contract]) {
       report += deepDiff(change);
     }
+    report += `\`\`\`
+`;
   }
   return report;
 }
@@ -33584,18 +33603,26 @@ async function enhanceStateDiff(client, diff) {
       }
       if (isChangeOfType(change, "_streams")) {
         await formatBeforeAndAfter(change, async (data) => {
-          if (data.tokenAddress && data.ratePerSecond && data.remainingBalance) {
+          if (data.tokenAddress) {
             const assetInfo = await findAsset(client, data.tokenAddress);
-            change.after.ratePerSecond = prettifyNumber({
-              decimals: assetInfo.decimals,
-              value: data.ratePerSecond,
-              showDecimals: true
-            });
-            change.after.remainingBalance = prettifyNumber({
-              showDecimals: true,
-              decimals: assetInfo.decimals,
-              value: data.remainingBalance
-            });
+            if (data.ratePerSecond)
+              data.ratePerSecond = prettifyNumber({
+                decimals: assetInfo.decimals,
+                value: data.ratePerSecond,
+                showDecimals: true
+              });
+            if (data.remainingBalance)
+              data.remainingBalance = prettifyNumber({
+                showDecimals: true,
+                decimals: assetInfo.decimals,
+                value: data.remainingBalance
+              });
+            if (data.deposit)
+              data.deposit = prettifyNumber({
+                showDecimals: true,
+                decimals: assetInfo.decimals,
+                value: data.deposit
+              });
           }
           return data;
         });
@@ -33605,15 +33632,31 @@ async function enhanceStateDiff(client, diff) {
           return addAssetPrice(client, data);
         });
       }
-      if (isChangeOfType(change, "_allowances") || isChangeOfType(change, "_balances")) {
+      if (change.type === "mapping (address => uint256)" || isChangeOfType(change, "totalSupply")) {
         await formatBeforeAndAfter(change, async (data) => {
           const asset = await findAsset(client, key);
-          if (asset)
+          if (asset) {
             return prettifyNumber({
               decimals: asset.decimals,
               value: data,
               showDecimals: true
             });
+          }
+          return data;
+        });
+      }
+      if (isChangeOfType(change, "_allowances") || isChangeOfType(change, "allowed")) {
+        await formatBeforeAndAfter(change, async (data) => {
+          const asset = await findAsset(client, key);
+          if (asset && typeof data === "object") {
+            Object.keys(data).forEach((key2) => {
+              data[key2] = prettifyNumber({
+                decimals: asset.decimals,
+                value: data[key2],
+                showDecimals: true
+              });
+            });
+          }
           return data;
         });
       }
@@ -33632,7 +33675,8 @@ async function renderTenderlyReport({
   payload,
   onchainLogs: { createdLog, queuedLog, executedLog },
   eventCache = [],
-  config
+  config,
+  getContractName = (address) => getMdContractName(sim.contracts, address)
 }) {
   const events = sim.transaction.transaction_info?.logs ? tenderly_logsToAbiLogs(sim.transaction.transaction_info?.logs) : [];
   events.map((e) => {
@@ -33724,13 +33768,13 @@ ${payload.actions.map(
 
 `;
   }
-  report += renderMarkdownStateDiffReport(stateDiff);
+  report += renderMarkdownStateDiffReport(stateDiff, getContractName);
   if (verified.length) {
     report += "### Verification status for contracts touched in the proposal\n\n";
     report += "| Contract | Status |\n";
     report += "|---------|------------|\n";
     verified.map((contract) => {
-      report += `| ${contract.address}(${contract.name}) | ${verificationStatusToString(contract.status)} |
+      report += `| ${getContractName(contract.address)}(${contract.name}) | ${verificationStatusToString(contract.status)} |
 `;
     });
     report += "\n";
@@ -33742,7 +33786,7 @@ ${payload.actions.map(
     report += "| Address | Result |\n";
     report += "|---------|------------|\n";
     selfDestruct.map((selfDestruct2) => {
-      report += `| ${selfDestruct2.address} | ${selfDestructStatusToString(
+      report += `| ${getContractName(selfDestruct2.address)} | ${selfDestructStatusToString(
         selfDestruct2.state
       )} |
 `;
@@ -33751,13 +33795,17 @@ ${payload.actions.map(
   }
   if (logs.length) {
     report += "### Events emitted from the proposal\n\n";
-    report += "| Address | Event Name | Arguments |\n";
-    report += "|---------|------------|-----------|\n";
-    logs.map((log) => {
-      report += `| ${log.address} | ${log.eventName || log.topics} | ${log.args ? JSON.stringify(
+    let ctr = import_viem12.zeroAddress;
+    logs.sort((a, b) => a.address.localeCompare(b.address)).map((log) => {
+      if (log.address !== ctr) {
+        report += `- ${getContractName(log.address)}
+`;
+        ctr = log.address;
+      }
+      report += `  - \`${log.eventName || log.topics}(${log.args ? JSON.stringify(
         log.args,
         (_, v) => typeof v === "bigint" ? v.toString() : v
-      ) : log.data} |
+      ) : log.data})\`
 `;
     });
   }