test: api integration tests for be

.github/workflows/integration-tests-api.yml

@@ -3,7 +3,6 @@ on: pull_request
 
 jobs:
   runTests:
-    name: Run API integration tests
     timeout-minutes: 30
     runs-on: ubuntu-latest
     permissions:
@@ -14,6 +13,7 @@ jobs:
       matrix:
         node-version: ['lts/*'] # 18.17.1 or lts/* 
         test-pattern:
+          - accounts.test.ts
           - addresses.test.ts
           - batches.test.ts
           - blocks.test.ts
@@ -22,6 +22,7 @@ jobs:
           - stats.test.ts
           - tokens.test.ts
           - transactions.test.ts
+    name: 'API test set: ${{ matrix.test-pattern}} / Node: ${{ matrix.node-version}}'
     steps:
       - name: Checkout with Submodule
         uses: actions/checkout@v3

.gitignore

@@ -18,6 +18,11 @@ cypress/videos/
 cypress/screenshots/
 tests/e2e/reports/
 **/tests/e2e/artifacts/
+**/playbook/artifacts-zk/
+**/playbook/artifacts/
+**/playbook/buffer/
+**/playbook/cache-zk/
+**/playbook/cache/
 
 # Logs
 logs

packages/app/tests/e2e/features/redirection/redirectionSet1.feature

@@ -13,7 +13,7 @@ Feature: Redirection
 
     Examples:
       | Extra button name | url                                     |
-      | Docs              | https://era.zksync.io/docs/dev/         |
+      | Docs              | https://docs.zksync.io/build/        |
       | Terms             | https://zksync.io/terms                 |
       | Contact           | https://zksync.io/contact      |
 
@@ -32,7 +32,7 @@ Feature: Redirection
   @id251
   Scenario: Verify redirection for Documentation link
     Given I click by text "Documentation"
-    Then New page have "https://era.zksync.io/docs/dev/" address
+    Then New page have "https://docs.zksync.io/build/" address
 
   @id252
   Scenario Outline: Verify redirection for "<Sub-Section>" in BE menu

packages/integration-tests/src/helper.ts

@@ -1,9 +1,14 @@
 import { execSync } from "child_process";
+import { ethers } from "ethers";
 import { promises as fs } from "fs";
 import * as path from "path";
+import { Provider } from "zksync-web3";
 
+import { localConfig } from "./config";
 import { Logger } from "./entities";
 
+import type { BaseProvider } from "@ethersproject/providers/src.ts/base-provider";
+
 export class Helper {
   async txHashLogger(txType: string, txValue: string, tokenName?: string) {
     const logMessage = `TxHash for ${txType} ${Logger.textSeparator} ${txValue}`;
@@ -35,4 +40,20 @@ export class Helper {
       console.log(`There is no the expected file: ${fileName}`);
     }
   }
+
+  async getBalanceETH(walletAddress: string, layer: string) {
+    let network: string;
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+    let provider: BaseProvider;
+    if (layer == "L1") {
+      network = localConfig.L1Network;
+      provider = ethers.getDefaultProvider(network);
+    } else if (layer == "L2") {
+      network = localConfig.L2Network;
+      provider = new Provider(network);
+    } else {
+      console.log(`Wrong layer: ${layer}`);
+    }
+    return ethers.utils.formatUnits(await provider.getBalance(walletAddress), "wei");
+  }
 }

packages/integration-tests/tests/api/accounts.test.ts

@@ -0,0 +1,109 @@
+import * as request from "supertest";
+import { setTimeout } from "timers/promises";
+
+import { environment } from "../../src/config";
+import { localConfig } from "../../src/config";
+import { Token, Wallets } from "../../src/entities";
+import { Helper } from "../../src/helper";
+
+describe("/api?module=account", () => {
+  jest.setTimeout(localConfig.standardTimeout);
+
+  const helper = new Helper();
+  //@id1704
+  it("Verify /api?module=account&action=balancemulti response", async () => {
+    const apiRoute = `/api?module=account&action=balancemulti&address=${Wallets.richWalletAddress},${Wallets.mainWalletAddress}`;
+    const richWalletBalance = await helper.getBalanceETH(Wallets.richWalletAddress, "L2");
+    const mainWalletBalance = await helper.getBalanceETH(Wallets.mainWalletAddress, "L2");
+    const richWalletLowerCase = Wallets.richWalletAddress.toLowerCase();
+    const mainWalletLowerCase = Wallets.mainWalletAddress.toLowerCase();
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body.result.length).toBeGreaterThan(1))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) =>
+        expect(res.body.result[0]).toStrictEqual(
+          expect.objectContaining({ account: richWalletLowerCase, balance: richWalletBalance })
+        )
+      )
+      .expect((res) =>
+        expect(res.body.result[1]).toStrictEqual(
+          expect.objectContaining({ account: mainWalletLowerCase, balance: mainWalletBalance })
+        )
+      );
+  });
+
+  //@id1703
+  it("Verify /api?module=account&action=balance response", async () => {
+    const apiRoute = `/api?module=account&action=balance&address=${Wallets.richWalletAddress}`;
+    const balance = await helper.getBalanceETH(Wallets.richWalletAddress, "L2");
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ result: balance })));
+  });
+
+  //@id1705
+  it("Verify /api?module=account&action=tokenbalance response", async () => {
+    const apiRoute = `/api?module=account&action=tokenbalance&contractaddress=${Token.ETHER_ERC20_Address}&address=${Wallets.richWalletAddress}`;
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) => expect(typeof res.body.result).toStrictEqual("string"));
+  });
+
+  //@id1702
+  it("Verify /api?module=account&action=txlist response", async () => {
+    const blocks = await request(environment.blockExplorerAPI).get("/blocks");
+
+    const blockNumber = blocks.body.items[0].number;
+    const apiRoute = `/api?module=account&action=txlist&page=1&offset=10&sort=desc&endblock${blockNumber}&startblock=0&address=${Wallets.richWalletAddress}`;
+
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body.result.length).toBeGreaterThan(1))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) => expect(typeof res.body.result[0].blockNumber).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].timeStamp).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].hash).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].nonce).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].blockHash).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].transactionIndex).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].from).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].to).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].value).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].gas).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].gasPrice).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].isError).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].txreceipt_status).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].input).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].contractAddress).toBeTruthy()) // can be null
+      .expect((res) => expect(typeof res.body.result[0].cumulativeGasUsed).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].gasUsed).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].confirmations).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].fee).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].commitTxHash).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].proveTxHash).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].executeTxHash).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].isL1Originated).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].l1BatchNumber).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].methodId).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result[0].functionName).toStrictEqual("string"));
+  });
+});

packages/integration-tests/tests/api/batches.test.ts

@@ -30,8 +30,8 @@ describe("/batches", () => {
   });
 
   //@id1514
-  xit("Verify the response via /batches/{batchNumber}", async () => {
-    await setTimeout(localConfig.standardPause); //works unstable without timeout
+  it("Verify the response via /batches/{batchNumber}", async () => {
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
 
     const batches = await request(environment.blockExplorerAPI).get("/batches");
 
@@ -56,6 +56,6 @@ describe("/batches", () => {
       .expect((res) => expect(typeof res.body.l1GasPrice).toStrictEqual("string"))
       .expect((res) => expect(typeof res.body.l2FairGasPrice).toStrictEqual("string"))
       .expect((res) => expect(typeof res.body.size).toStrictEqual("number"))
-      .expect((res) => expect(res.body.status).toStrictEqual("string"));
+      .expect((res) => expect(typeof res.body.status).toStrictEqual("string"));
   });
 });

packages/integration-tests/tests/api/blocks.test.ts

@@ -66,3 +66,58 @@ describe("/blocks", () => {
     );
   });
 });
+
+describe("/api?module=block", () => {
+  //@id1700
+  it("Verify /api?module=block&action=getblockcountdown&blockno={block_number} response", async () => {
+    const blocks = await request(environment.blockExplorerAPI).get("/blocks");
+
+    const blockNumber = blocks.body.items[0].number + 1;
+    const apiRoute = `/api?module=block&action=getblockcountdown&blockno=${blockNumber}`;
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) => expect(typeof res.body.result.CurrentBlock).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.CountdownBlock).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.RemainingBlock).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.EstimateTimeInSec).toStrictEqual("string"));
+  });
+
+  //@id1699
+  it("Verify /api?module=block&action=getblocknobytime&closest=before&timestamp={timestamp} response", async () => {
+    const apiRoute = `/api?module=block&action=getblocknobytime&closest=before&timestamp=1635934550`;
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) => expect(typeof res.body.result).toStrictEqual("string"));
+  });
+
+  //@id1701
+  it("Verify /api?module=block&action=getblockreward&blockno={blockNumber} response", async () => {
+    const blocks = await request(environment.blockExplorerAPI).get("/blocks");
+
+    const blockNumber = blocks.body.items[0].number;
+    const apiRoute = `/api?module=block&action=getblockreward&blockno=${blockNumber}`;
+    await setTimeout(localConfig.extendedPause); //works unstable without timeout
+
+    return request(environment.blockExplorerAPI)
+      .get(apiRoute)
+      .expect(200)
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ status: "1" })))
+      .expect((res) => expect(res.body).toStrictEqual(expect.objectContaining({ message: "OK" })))
+      .expect((res) => expect(typeof res.body.result.blockNumber).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.timeStamp).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.blockMiner).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.blockReward).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.uncleInclusionReward).toStrictEqual("string"))
+      .expect((res) => expect(typeof res.body.result.uncles).toStrictEqual("object"));
+  });
+});

packages/integration-tests/tests/api/contracts.test.ts

@@ -1,12 +1,13 @@
 import * as request from "supertest";
+import { setTimeout } from "timers/promises";
 
 import { environment } from "../../src/config";
 import { localConfig } from "../../src/config";
 import { Buffer, Wallets } from "../../src/entities";
 import { Helper } from "../../src/helper";
 import { Playbook } from "../../src/playbook/playbook";
 
-describe("Contracts API", () => {
+describe("/api?module=contract", () => {
   jest.setTimeout(localConfig.standardTimeout);
 
   const helper = new Helper();
@@ -24,7 +25,8 @@ describe("Contracts API", () => {
     });
 
     //@id1696
-    xit("Verify the response via /api?module=contract&action=getcontractcreation&contractaddresses={address1},{address2}", async () => {
+    it("Verify /api?module=contract&action=getcontractcreation&contractaddresses={address1},{address2} response", async () => {
+      await setTimeout(localConfig.standardPause);
       paymasterContract = await helper.getStringFromFile(bufferFile + Buffer.paymaster);
       paymasterTx = await helper.getStringFromFile(bufferFile + Buffer.paymasterDeployTx);
       multicallCallerContract = await helper.getStringFromFile(bufferFile + Buffer.addressMultiCallCaller);

packages/integration-tests/tests/api/logs.test.ts

@@ -1,12 +1,13 @@
 import * as request from "supertest";
+import { setTimeout } from "timers/promises";
 
 import { environment } from "../../src/config";
 import { localConfig } from "../../src/config";
 import { Buffer } from "../../src/entities";
 import { Helper } from "../../src/helper";
 import { Playbook } from "../../src/playbook/playbook";
 
-xdescribe("Logs API", () => {
+describe("/api?module=logs", () => {
   jest.setTimeout(localConfig.standardTimeout); //works unstable without timeout
   const helper = new Helper();
   const bufferFile = "src/playbook/";
@@ -21,7 +22,8 @@ xdescribe("Logs API", () => {
     });
 
     //@id1808
-    it("Verify the response via /api?module=logs&action=getLogs&page={page}&offset={offset}0&toBlock={toBlock}&fromBlock={fromBlock}&address={address}", async () => {
+    it("Verify /api?module=logs&action=getLogs&page={page}&offset={offset}0&toBlock={toBlock}&fromBlock={fromBlock}&address={address} response", async () => {
+      await setTimeout(localConfig.standardPause);
       contractAddress = await helper.getStringFromFile(bufferFile + Buffer.greeterL2);
       txHash = await helper.getStringFromFile(bufferFile + Buffer.executeGreeterTx);
 
@@ -42,7 +44,7 @@ xdescribe("Logs API", () => {
         .expect((res) => expect(res.body.result[0].data.length).toBe(194))
         .expect((res) => expect(typeof res.body.result[0].blockNumber).toStrictEqual("string"))
         .expect((res) => expect(res.body.result[0].blockNumber.startsWith("0x")).toBe(true))
-        .expect((res) => expect(res.body.result[0].blockNumber.length).toBe(5))
+        .expect((res) => expect(typeof res.body.result[0].blockNumber.length).toStrictEqual("number"))
         .expect((res) => expect(typeof res.body.result[0].timeStamp).toStrictEqual("string"))
         .expect((res) => expect(res.body.result[0].timeStamp.startsWith("0x")).toBe(true))
         .expect((res) => expect(res.body.result[0].timeStamp.length).toBe(10))