chore(contract-manager) Script to fetch Entropy Dao Fees (#3007)

* chore(contract-manager) Entropy Dao Fees

* update

Author: aditya520

contract_manager/scripts/fetch_accrued_entropy_dao_fees.ts

@@ -0,0 +1,192 @@
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { DefaultStore } from "../src/node/utils/store";
+import { EvmChain } from "../src/core/chains";
+import { EvmEntropyContract } from "../src/core/contracts";
+import { findEntropyContract } from "./common";
+
+const parser = yargs(hideBin(process.argv))
+  .usage(
+    "Fetches the accrued Pyth DAO fees for entropy contracts across chains.\n" +
+      "Usage: $0 --chain <chain-id> | --all-chains <testnet|mainnet|all>",
+  )
+  .options({
+    chain: {
+      type: "string",
+      desc: "Fetch accrued fees for the entropy contract on this specific chain",
+      conflicts: "all-chains",
+    },
+    "all-chains": {
+      type: "string",
+      conflicts: "chain",
+      choices: ["testnet", "mainnet", "all"],
+      desc: "Fetch accrued fees for all entropy contracts deployed on specified network type",
+    },
+    "show-eth": {
+      type: "boolean",
+      default: false,
+      desc: "Show fees in ETH in addition to Wei",
+    },
+  })
+  .check((argv) => {
+    if (!argv.chain && !argv["all-chains"]) {
+      throw new Error("Must specify either --chain or --all-chains");
+    }
+    return true;
+  });
+
+interface FeeResult {
+  chainId: string;
+  contractAddress: string;
+  accruedFees: string;
+  accruedFeesEth?: string;
+  isMainnet: boolean;
+  error?: string;
+}
+
+async function fetchAccruedFees(
+  contract: EvmEntropyContract,
+  showEth: boolean,
+): Promise<FeeResult> {
+  const chainId = contract.getChain().getId();
+  const contractAddress = contract.address;
+  const isMainnet = contract.getChain().isMainnet();
+
+  try {
+    const accruedFeesWei = await contract.getAccruedPythFees();
+    let accruedFeesEth: string | undefined;
+
+    if (showEth) {
+      const web3 = contract.getChain().getWeb3();
+      accruedFeesEth = web3.utils.fromWei(accruedFeesWei, "ether");
+    }
+
+    return {
+      chainId,
+      contractAddress,
+      accruedFees: accruedFeesWei,
+      accruedFeesEth,
+      isMainnet,
+    };
+  } catch (error) {
+    return {
+      chainId,
+      contractAddress,
+      accruedFees: "0",
+      accruedFeesEth: showEth ? "0" : undefined,
+      isMainnet,
+      error: error instanceof Error ? error.message : "Unknown error",
+    };
+  }
+}
+
+function formatResults(results: FeeResult[], showEth: boolean): void {
+  console.log("\n=== Accrued Entropy DAO Fees Summary ===\n");
+
+  const successfulResults = results.filter((r) => !r.error);
+  const failedResults = results.filter((r) => r.error);
+
+  // Summary statistics
+  console.log("SUMMARY:");
+  console.log("─".repeat(40));
+  console.log(`Total Chains Checked: ${results.length}`);
+  console.log(`Successful Queries:   ${successfulResults.length}`);
+  console.log(`Failed Queries:       ${failedResults.length}`);
+  console.log("");
+
+  if (successfulResults.length > 0) {
+    console.log("Successful Queries:");
+    console.table(
+      successfulResults.map((r) => {
+        const baseData = {
+          Chain: r.chainId,
+          Network: r.isMainnet ? "Mainnet" : "Testnet",
+          "Fees (Wei)": r.accruedFees,
+        };
+
+        if (showEth && r.accruedFeesEth) {
+          return {
+            ...baseData,
+            "Fees (ETH)": r.accruedFeesEth,
+          };
+        }
+
+        return baseData;
+      }),
+    );
+  }
+
+  if (failedResults.length > 0) {
+    console.log("\nFailed Queries:");
+    console.table(
+      failedResults.map((r) => ({
+        Chain: r.chainId,
+        Network: r.isMainnet ? "Mainnet" : "Testnet",
+        Error: r.error,
+      })),
+    );
+  }
+}
+
+async function main() {
+  const argv = await parser.argv;
+  const results: FeeResult[] = [];
+
+  console.log("Fetching accrued entropy DAO fees from entropy contracts...\n");
+
+  if (argv.chain) {
+    // Fetch fees for a specific chain
+    try {
+      const chain = DefaultStore.getChainOrThrow(argv.chain, EvmChain);
+      const contract = findEntropyContract(chain);
+      console.log(`Fetching fees for ${argv.chain}...`);
+      const result = await fetchAccruedFees(contract, argv.showEth);
+      results.push(result);
+    } catch (error) {
+      console.error(
+        `Error fetching fees for ${argv.chain}:`,
+        error instanceof Error ? error.message : error,
+      );
+      process.exit(1);
+    }
+  } else if (argv["all-chains"]) {
+    // Fetch fees for all chains based on network type
+    const contracts = Object.values(DefaultStore.entropy_contracts);
+
+    if (contracts.length === 0) {
+      console.log("No entropy contracts found in the store.");
+      return;
+    }
+
+    console.log(`Found ${contracts.length} entropy contract(s) in the store.`);
+
+    for (const contract of contracts) {
+      const chainId = contract.getChain().getId();
+      const isMainnet = contract.getChain().isMainnet();
+
+      // Filter based on network type
+      if (argv["all-chains"] === "mainnet" && !isMainnet) continue;
+      if (argv["all-chains"] === "testnet" && isMainnet) continue;
+      // If "all", we include both mainnet and testnet
+
+      console.log(`Fetching fees for ${chainId}...`);
+      const result = await fetchAccruedFees(contract, argv.showEth);
+      results.push(result);
+    }
+  }
+
+  if (results.length === 0) {
+    console.log("No matching contracts found for the specified criteria.");
+    return;
+  }
+
+  formatResults(results, argv.showEth);
+}
+
+main().catch((error) => {
+  console.error(
+    "Script failed:",
+    error instanceof Error ? error.message : error,
+  );
+  process.exit(1);
+});

contract_manager/src/core/contracts/evm.ts

@@ -411,6 +411,11 @@ export class EvmEntropyContract extends Storable {
       from: address,
     });
   }
+
+  async getAccruedPythFees(): Promise<string> {
+    const contract = this.getContract();
+    return await contract.methods.getAccruedPythFees().call();
+  }
 }
 
 export class EvmExecutorContract extends Storable {