♻️ Disable Truffle Dashboard by Default (#104)

Signed-off-by: Pascal Marco Caversaccio <[email protected]>

README.md

@@ -55,7 +55,7 @@ This template implements the [`hardhat-ledger`](https://hardhat.org/hardhat-runn
 ## Using the Truffle Dashboard
 
 > [!IMPORTANT]
-> Truffle has been [sunsetted](https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat) by Consensys, but I still keep it in the template as I find it a very valuable tool.
+> Truffle has been [sunsetted](https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat) by Consensys, but I still keep it in the template as I find it a very valuable tool. Please note that due to the lengthy loading time of Truffle Dashboard's `npm` package [`@truffle/dashboard-hardhat-plugin`](https://www.npmjs.com/package/@truffle/dashboard-hardhat-plugin), the module is disabled by default in the [`hardhat.config.ts`](./hardhat.config.ts) file. If you want to use it, you must uncomment the module import and the `truffle` configuration accordingly.
 
 [Truffle](https://trufflesuite.com) developed the [Truffle Dashboard](https://trufflesuite.com/docs/truffle/how-to/use-the-truffle-dashboard/) to provide an easy way to use your existing MetaMask wallet for your deployments and for other transactions that you need to send from a command line context. Because the Truffle Dashboard connects directly to MetaMask it is also possible to use it in combination with hardware wallets like [Ledger](https://www.ledger.com) or [Trezor](https://trezor.io).
 

hardhat.config.ts

@@ -12,7 +12,9 @@ import "@matterlabs/hardhat-zksync-solc";
 import "@matterlabs/hardhat-zksync-deploy";
 import "@matterlabs/hardhat-zksync-verify";
 import "@matterlabs/hardhat-zksync-ethers";
-import "@truffle/dashboard-hardhat-plugin";
+// Uncomment if you want to use the Truffle Dashboard module
+// You must also uncomment the subsequent `truffle` configuration in this file accordingly
+// import "@truffle/dashboard-hardhat-plugin";
 import "hardhat-gas-reporter";
 import "hardhat-abi-exporter";
 import "solidity-coverage";
@@ -95,14 +97,15 @@ const config: HardhatUserConfig = {
       },
     },
   },
-  truffle: {
-    dashboardNetworkName: "truffleDashboard", // Truffle's default value is "truffleDashboard"
-    dashboardNetworkConfig: {
-      // Truffle's default value is 0 (i.e. no timeout), while Hardhat's default
-      // value is 40000 (40 seconds)
-      timeout: 0,
-    },
-  },
+  // Uncomment if you want to use the Truffle Dashboard module
+  // truffle: {
+  //   dashboardNetworkName: "truffleDashboard", // Truffle's default value is "truffleDashboard"
+  //   dashboardNetworkConfig: {
+  //     // Truffle's default value is 0 (i.e. no timeout), while Hardhat's default
+  //     // value is 40000 (40 seconds)
+  //     timeout: 0,
+  //   },
+  // },
   networks: {
     hardhat: {
       initialBaseFeePerGas: 0,