feat(zk_toolbox): add fees integration test to toolbox

.github/workflows/ci-core-reusable.yml

@@ -185,6 +185,7 @@ jobs:
           SNAPSHOT_RECOVERY_LOGS_DIR=logs/snapshot_recovery/
           GENESIS_RECOVERY_LOGS_DIR=logs/genesis_recovery/
           EXTERNAL_NODE_LOGS_DIR=logs/external_node
+          FEES_LOGS_DIR=logs/fees
           REVERT_LOGS_DIR=logs/revert
 
           mkdir -p $SERVER_LOGS_DIR
@@ -193,6 +194,7 @@ jobs:
           mkdir -p $SNAPSHOT_RECOVERY_LOGS_DIR
           mkdir -p $GENESIS_RECOVERY_LOGS_DIR
           mkdir -p $EXTERNAL_NODE_LOGS_DIR
+          mkdir -p $FEES_LOGS_DIR
           mkdir -p $REVERT_LOGS_DIR
 
           echo "SERVER_LOGS_DIR=$SERVER_LOGS_DIR" >> $GITHUB_ENV
@@ -201,6 +203,7 @@ jobs:
           echo "SNAPSHOT_RECOVERY_LOGS_DIR=$SNAPSHOT_RECOVERY_LOGS_DIR" >> $GITHUB_ENV
           echo "GENESIS_RECOVERY_LOGS_DIR=$GENESIS_RECOVERY_LOGS_DIR" >> $GITHUB_ENV
           echo "EXTERNAL_NODE_LOGS_DIR=$EXTERNAL_NODE_LOGS_DIR" >> $GITHUB_ENV
+          echo "FEES_LOGS_DIR=$FEES_LOGS_DIR" >> $GITHUB_ENV
           echo "REVERT_LOGS_DIR=$REVERT_LOGS_DIR" >> $GITHUB_ENV
 
       - name: Initialize ecosystem
@@ -220,9 +223,9 @@ jobs:
 
       - name: Read Custom Token address and set as environment variable
         run: |
-          address=$(awk -F": " '/tokens:/ {found_tokens=1} found_tokens && /DAI:/ {found_dai=1} found_dai && /address:/ {print $2; exit}' ./configs/erc20.yaml)
-          echo "address=$address"
-          echo "address=$address" >> $GITHUB_ENV
+          CUSTOM_TOKEN_ADDRESS=$(awk -F": " '/tokens:/ {found_tokens=1} found_tokens && /DAI:/ {found_dai=1} found_dai && /address:/ {print $2; exit}' ./configs/erc20.yaml)
+          echo "CUSTOM_TOKEN_ADDRESS=$CUSTOM_TOKEN_ADDRESS"
+          echo "CUSTOM_TOKEN_ADDRESS=$CUSTOM_TOKEN_ADDRESS" >> $GITHUB_ENV
 
       - name: Create and initialize Validium chain
         run: |
@@ -256,7 +259,7 @@ jobs:
           --prover-mode no-proofs \
           --wallet-creation localhost \
           --l1-batch-commit-data-generator-mode rollup \
-          --base-token-address ${{ env.address }} \
+          --base-token-address ${{ env.CUSTOM_TOKEN_ADDRESS }} \
           --base-token-price-nominator 3 \
           --base-token-price-denominator 2 \
           --set-as-default false \
@@ -315,7 +318,7 @@ jobs:
           --prover-mode no-proofs \
           --wallet-creation localhost \
           --l1-batch-commit-data-generator-mode validium \
-          --base-token-address ${{ env.address }} \
+          --base-token-address ${{ env.CUSTOM_TOKEN_ADDRESS }} \
           --base-token-price-nominator 3 \
           --base-token-price-denominator 2 \
           --set-as-default false \
@@ -458,6 +461,27 @@ jobs:
           wait $PID3
           wait $PID4
 
+      - name: Fee projection tests
+        run: |
+          ci_run killall -INT zksync_server || true
+
+          ci_run zk_supervisor test fees --no-deps --no-kill --chain era &> ${{ env.FEES_LOGS_DIR }}/era.log &
+          PID1=$!
+
+          ci_run zk_supervisor test fees --no-deps --no-kill --chain validium &> ${{ env.FEES_LOGS_DIR }}/validium.log &
+          PID2=$!
+
+          ci_run zk_supervisor test fees --no-deps --no-kill --chain custom_token &> ${{ env.FEES_LOGS_DIR }}/custom_token.log &
+          PID3=$!
+
+          ci_run zk_supervisor test fees --no-deps --no-kill --chain consensus &> ${{ env.FEES_LOGS_DIR }}/consensus.log &
+          PID4=$!
+
+          wait $PID1
+          wait $PID2
+          wait $PID3
+          wait $PID4
+
       - name: Run revert tests
         run: |
           ci_run killall -INT zksync_server || true

core/tests/ts-integration/src/context-owner.ts

@@ -7,6 +7,7 @@ import { lookupPrerequisites } from './prerequisites';
 import { Reporter } from './reporter';
 import { scaledGasPrice } from './helpers';
 import { RetryProvider } from './retry-provider';
+import { killPidWithAllChilds } from 'utils/build/kill';
 
 // These amounts of ETH would be provided to each test suite through its "main" account.
 // It is assumed to be enough to run a set of "normal" transactions.
@@ -624,6 +625,11 @@ export class TestContextOwner {
             // Then propagate the exception.
             throw error;
         }
+        if (this.env.l2NodePid !== undefined) {
+            this.reporter.startAction(`Terminating L2 node process`);
+            await killPidWithAllChilds(this.env.l2NodePid, 9);
+            this.reporter.finishAction();
+        }
     }
 
     /**
@@ -648,6 +654,10 @@ export class TestContextOwner {
         // into account. If the same wallet would be reused (e.g. on stage), it'll just have to
         // deposit less next time.
     }
+
+    setL2NodePid(newPid: number) {
+        this.env.l2NodePid = newPid;
+    }
 }
 
 /**

core/tests/ts-integration/src/env.ts

@@ -6,7 +6,17 @@ import { DataAvailabityMode, NodeMode, TestEnvironment } from './types';
 import { Reporter } from './reporter';
 import * as yaml from 'yaml';
 import { L2_BASE_TOKEN_ADDRESS } from 'zksync-ethers/build/utils';
-import { loadConfig, loadEcosystem, shouldLoadConfigFromFile } from 'utils/build/file-configs';
+import { FileConfig, loadConfig, loadEcosystem, shouldLoadConfigFromFile } from 'utils/build/file-configs';
+import { NodeSpawner } from './utils';
+import { logsTestPath } from 'utils/build/logs';
+import * as nodefs from 'node:fs/promises';
+import { exec } from 'utils';
+
+const enableConsensus = process.env.ENABLE_CONSENSUS === 'true';
+
+async function logsPath(chain: string, name: string): Promise<string> {
+    return await logsTestPath(chain, 'logs/server/', name);
+}
 
 /**
  * Attempts to connect to server.
@@ -60,8 +70,10 @@ function getMainWalletPk(pathToHome: string): string {
 /*
     Loads the environment for file based configs.
  */
-async function loadTestEnvironmentFromFile(chain: string): Promise<TestEnvironment> {
+async function loadTestEnvironmentFromFile(fileConfig: FileConfig): Promise<TestEnvironment> {
+    let chain = fileConfig.chain!;
     const pathToHome = path.join(__dirname, '../../../..');
+    let spawnNode = process.env.SPAWN_NODE;
     let nodeMode;
     if (process.env.EXTERNAL_NODE == 'true') {
         nodeMode = NodeMode.External;
@@ -75,18 +87,42 @@ async function loadTestEnvironmentFromFile(chain: string): Promise<TestEnvironme
     let configsFolderSuffix = nodeMode == NodeMode.External ? 'external_node' : undefined;
     let generalConfig = loadConfig({ pathToHome, chain, config: 'general.yaml', configsFolderSuffix });
     let secretsConfig = loadConfig({ pathToHome, chain, config: 'secrets.yaml', configsFolderSuffix });
+    let contracts = loadConfig({ pathToHome, chain, config: 'contracts.yaml', configsFolderSuffix });
 
     const network = ecosystem.l1_network.toLowerCase();
     let mainWalletPK = getMainWalletPk(pathToHome);
 
     const l2NodeUrl = generalConfig.api.web3_json_rpc.http_url;
 
-    await waitForServer(l2NodeUrl);
+    const l1NodeUrl = secretsConfig.l1.l1_rpc_url;
+
+    const pathToMainLogs = await logsPath(fileConfig.chain!, 'server.log');
+    let mainLogs = await nodefs.open(pathToMainLogs, 'a');
+    let l2Node;
+    if (spawnNode) {
+        // Before starting any actual logic, we need to ensure that the server is running (it may not
+        // be the case, for example, right after deployment on stage).
+        const autoKill: boolean = process.env.NO_KILL !== 'true';
+        if (autoKill) {
+            try {
+                await exec(`killall -KILL zksync_server`);
+            } catch (err) {
+                console.log(`ignored error: ${err}`);
+            }
+        }
+        let mainNodeSpawner = new NodeSpawner(pathToHome, mainLogs, fileConfig, {
+            enableConsensus,
+            ethClientWeb3Url: l1NodeUrl,
+            apiWeb3JsonRpcHttpUrl: l2NodeUrl,
+            baseTokenAddress: contracts.l1.base_token_addr
+        });
+
+        l2Node = await mainNodeSpawner.spawnMainNode();
+    }
 
     const l2Provider = new zksync.Provider(l2NodeUrl);
     const baseTokenAddress = await l2Provider.getBaseTokenContractAddress();
 
-    const l1NodeUrl = secretsConfig.l1.l1_rpc_url;
     const wsL2NodeUrl = generalConfig.api.web3_json_rpc.ws_url;
 
     const contractVerificationUrl = generalConfig.contract_verifier.url;
@@ -141,6 +177,7 @@ async function loadTestEnvironmentFromFile(chain: string): Promise<TestEnvironme
         network,
         mainWalletPK,
         l2NodeUrl,
+        l2NodePid: l2Node ? l2Node.proc.pid : undefined,
         l1NodeUrl,
         wsL2NodeUrl,
         contractVerificationUrl,
@@ -163,10 +200,10 @@ async function loadTestEnvironmentFromFile(chain: string): Promise<TestEnvironme
 }
 
 export async function loadTestEnvironment(): Promise<TestEnvironment> {
-    const { loadFromFile, chain } = shouldLoadConfigFromFile();
+    const fileConfig = shouldLoadConfigFromFile();
 
-    if (loadFromFile) {
-        return await loadTestEnvironmentFromFile(chain);
+    if (fileConfig.loadFromFile) {
+        return await loadTestEnvironmentFromFile(fileConfig);
     }
     return await loadTestEnvironmentFromEnv();
 }
@@ -257,6 +294,7 @@ export async function loadTestEnvironmentFromEnv(): Promise<TestEnvironment> {
         network,
         mainWalletPK,
         l2NodeUrl,
+        l2NodePid: undefined,
         l1NodeUrl,
         wsL2NodeUrl,
         healthcheckPort,

core/tests/ts-integration/src/jest-setup/global-setup.ts

@@ -18,10 +18,7 @@ async function performSetup(_globalConfig: any, _projectConfig: any) {
     console.log('');
     globalThis.rawWriteToConsole = console.log;
 
-    // Before starting any actual logic, we need to ensure that the server is running (it may not
-    // be the case, for example, right after deployment on stage).
-
-    const testEnvironment = await loadTestEnvironment();
+    let testEnvironment = await loadTestEnvironment();
     const testContextOwner = new TestContextOwner(testEnvironment);
     const testContext = await testContextOwner.setupContext();
 

core/tests/ts-integration/src/types.ts

@@ -55,6 +55,10 @@ export interface TestEnvironment {
      * Mode of the l2 node
      */
     nodeMode: NodeMode;
+    /*
+     * L2 node PID
+     */
+    l2NodePid: number | undefined;
     /**
      * Plaintext name of the L1 network name (i.e. `localhost` or `goerli`).
      */