chore: fix extra reporting by CSM

Author: tamtamchik

globals.d.ts

@@ -17,6 +17,9 @@ declare namespace NodeJS {
     /* if "on" the integration tests will deploy the contracts to the empty Hardhat Network node using scratch deploy */
     INTEGRATION_ON_SCRATCH?: "on" | "off"; // default: "off"
 
+    /* if "on" the integration tests will assume CSM module is present in the StakingRouter, and adjust accordingly */
+    INTEGRATION_WITH_CSM?: "on" | "off"; // default: "off"
+
     /**
      * Network configuration for the protocol discovery.
      */

lib/protocol/context.ts

@@ -26,6 +26,7 @@ export const getProtocolContext = async (): Promise<ProtocolContext> => {
   // By default, all flags are "on"
   const flags = {
     onScratch: process.env.INTEGRATION_ON_SCRATCH === "on",
+    withCSM: process.env.INTEGRATION_WITH_CSM !== "off",
   } as ProtocolContextFlags;
 
   log.debug("Protocol context flags", {

lib/protocol/types.ts

@@ -135,6 +135,7 @@ export type Signer = keyof ProtocolSigners;
 
 export type ProtocolContextFlags = {
   onScratch: boolean;
+  withCSM: boolean;
 };
 
 export type ProtocolContext = {

lib/scratch.ts

@@ -9,7 +9,6 @@ import { resetStateFile } from "./state-file";
 const deployedSteps: string[] = [];
 
 async function applySteps(steps: string[]) {
-
   if (steps.every((step) => deployedSteps.includes(step))) {
     return; // All steps have been deployed
   }
@@ -30,10 +29,15 @@ export async function deployUpgrade(networkName: string): Promise<void> {
     networkName = "mainnet-fork";
   }
 
-  const stepsFile = `upgrade/steps-${networkName}.json`;
-  const steps = loadSteps(stepsFile);
+  try {
+    const stepsFile = `upgrade/steps-${networkName}.json`;
+    const steps = loadSteps(stepsFile);
 
-  await applySteps(steps);
+    await applySteps(steps);
+  } catch (error) {
+    log.error("Upgrade failed:", (error as Error).message);
+    log.warning("Upgrade steps not found, assuming the protocol is already deployed");
+  }
 }
 
 export async function deployScratchProtocol(networkName: string): Promise<void> {

package.json

@@ -25,9 +25,9 @@
     "test:integration": "hardhat test test/integration/**/*.ts",
     "test:integration:trace": "hardhat test test/integration/**/*.ts --trace --disabletracer",
     "test:integration:fulltrace": "hardhat test test/integration/**/*.ts --fulltrace --disabletracer",
-    "test:integration:scratch": "INTEGRATION_WITH_SCRATCH_DEPLOY=on hardhat test test/integration/**/*.ts",
-    "test:integration:scratch:trace": "INTEGRATION_WITH_SCRATCH_DEPLOY=on hardhat test test/integration/**/*.ts --trace --disabletracer",
-    "test:integration:scratch:fulltrace": "INTEGRATION_WITH_SCRATCH_DEPLOY=on hardhat test test/integration/**/*.ts --fulltrace --disabletracer",
+    "test:integration:scratch": "INTEGRATION_WITH_CSM=off INTEGRATION_WITH_SCRATCH_DEPLOY=on hardhat test test/integration/**/*.ts",
+    "test:integration:scratch:trace": "INTEGRATION_WITH_CSM=off INTEGRATION_WITH_SCRATCH_DEPLOY=on hardhat test test/integration/**/*.ts --trace --disabletracer",
+    "test:integration:scratch:fulltrace": "INTEGRATION_WITH_CSM=off INTEGRATION_WITH_SCRATCH_DEPLOY=on hardhat test test/integration/**/*.ts --fulltrace --disabletracer",
     "test:integration:fork:local": "hardhat test test/integration/**/*.ts --network local",
     "test:integration:fork:mainnet": "hardhat test test/integration/**/*.ts --network mainnet-fork",
     "typecheck": "tsc --noEmit",

scripts/archive/sr-v2-deploy-holesky.ts

@@ -1,6 +1,6 @@
 import { ethers, run } from "hardhat";
 
-import { DepositSecurityModule, DepositSecurityModule__factory } from "typechain-types";
+import { DepositSecurityModule } from "typechain-types";
 
 import {
   deployImplementation,
@@ -114,10 +114,7 @@ async function main() {
 
   log(`New DSM address: ${depositSecurityModuleAddress}`);
 
-  const dsmContract = await loadContract<DepositSecurityModule>(
-    DepositSecurityModule__factory,
-    depositSecurityModuleAddress,
-  );
+  const dsmContract = await loadContract<DepositSecurityModule>("DepositSecurityModule", depositSecurityModuleAddress);
   await dsmContract.addGuardians(guardians, quorum);
 
   await dsmContract.setOwner(APP_AGENT_ADDRESS);

scripts/upgrade/steps-local.json

@@ -1,3 +1,3 @@
 {
-  "steps": ["upgrade/steps/0000-deploy-locator"]
+  "steps": []
 }

scripts/upgrade/steps-mainnet-fork.json

@@ -5,7 +5,7 @@ import { ethers } from "hardhat";
 import { HardhatEthersSigner } from "@nomicfoundation/hardhat-ethers/signers";
 import { setBalance } from "@nomicfoundation/hardhat-network-helpers";
 
-import { ether, impersonate, ONE_GWEI, trace, updateBalance } from "lib";
+import { ether, impersonate, log, ONE_GWEI, trace, updateBalance } from "lib";
 import { getProtocolContext, ProtocolContext } from "lib/protocol";
 import {
   finalizeWithdrawalQueue,
@@ -15,7 +15,7 @@ import {
   sdvtEnsureOperators,
 } from "lib/protocol/helpers";
 
-import { bailOnFailure, Snapshot } from "test/suite";
+import { Snapshot } from "test/suite";
 
 const LIMITER_PRECISION_BASE = BigInt(10 ** 9);
 
@@ -64,8 +64,6 @@ describe("Accounting", () => {
     });
   });
 
-  beforeEach(bailOnFailure);
-
   beforeEach(async () => (originalState = await Snapshot.take()));
 
   afterEach(async () => await Snapshot.restore(originalState));
@@ -282,6 +280,7 @@ describe("Accounting", () => {
 
     // Report
     const params = { clDiff: rebaseAmount, excludeVaultsBalances: true };
+
     const { reportTx } = (await report(ctx, params)) as {
       reportTx: TransactionResponse;
       extraDataTx: TransactionResponse;
@@ -306,6 +305,8 @@ describe("Accounting", () => {
     const stakingModulesCount = await stakingRouter.getStakingModulesCount();
     const transferSharesEvents = ctx.getEvents(reportTxReceipt, "TransferShares");
 
+    log.debug("Staking modules count", { stakingModulesCount });
+
     const mintedSharesSum = transferSharesEvents
       .slice(hasWithdrawals ? 1 : 0) // skip burner if withdrawals processed
       .reduce((acc, { args }) => acc + args.sharesValue, 0n);
@@ -317,9 +318,11 @@ describe("Accounting", () => {
 
     // if withdrawals processed goes after burner and NOR, if no withdrawals processed goes after NOR
     const sdvtSharesAsFees = transferSharesEvents[hasWithdrawals ? 2 : 1];
+    const feeDistributionTransfer = ctx.flags.withCSM ? 1n : 0n;
 
+    // Magic numbers here: 2 – burner and treasury, 1 – only treasury
     expect(transferSharesEvents.length).to.equal(
-      hasWithdrawals ? 2n : 1n + stakingModulesCount,
+      (hasWithdrawals ? 2n : 1n) + stakingModulesCount + feeDistributionTransfer,
       "Expected transfer of shares to DAO and staking modules",
     );
 
@@ -654,9 +657,10 @@ describe("Accounting", () => {
 
     // if withdrawals processed goes after burner and NOR, if no withdrawals processed goes after NOR
     const sdvtSharesAsFees = transferSharesEvents[hasWithdrawals ? 2 : 1];
+    const feeDistributionTransfer = ctx.flags.withCSM ? 1n : 0n;
 
     expect(transferSharesEvents.length).to.equal(
-      hasWithdrawals ? 2n : 1n + stakingModulesCount,
+      hasWithdrawals ? 2n : 1n + stakingModulesCount + feeDistributionTransfer,
       "Expected transfer of shares to DAO and staking modules",
     );
 
@@ -754,9 +758,10 @@ describe("Accounting", () => {
 
     // if withdrawals processed goes after burner and NOR, if no withdrawals processed goes after NOR
     const sdvtSharesAsFees = transferSharesEvents[hasWithdrawals ? 2 : 1];
+    const feeDistributionTransfer = ctx.flags.withCSM ? 1n : 0n;
 
     expect(transferSharesEvents.length).to.equal(
-      hasWithdrawals ? 2n : 1n + stakingModulesCount,
+      hasWithdrawals ? 2n : 1n + stakingModulesCount + feeDistributionTransfer,
       "Expected transfer of shares to DAO and staking modules",
     );