chore: warning message related to plugin versions (#833)

Co-authored-by: Marko Arambasic <[email protected]> Co-authored-by: Nicolas Villanueva <[email protected]>
matter-labs · Jan 18, 2024 · 87c3db9 · 87c3db9
1 parent 15b8c79
commit 87c3db9
Show file tree

Hide file tree

Showing 8 changed files with 98 additions and 1 deletion.
diff --git a/docs/.vuepress/sidebar/en.ts b/docs/.vuepress/sidebar/en.ts
@@ -230,6 +230,7 @@ export const enSidebar = sidebar({
             "/build/tooling/hardhat/hardhat-zksync-chai-matchers.md",
             "/build/tooling/hardhat/hardhat-zksync-verify.md",
             "/build/tooling/hardhat/hardhat-zksync-verify-vyper.md",
+            "/build/tooling/hardhat/hardhat-zksync-ethers.md",
             "/build/tooling/hardhat/hardhat-zksync-toolbox.md",
             "/build/tooling/hardhat/other-plugins.md",
           ]

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-chai-matchers.md b/docs/build/tooling/hardhat/hardhat-zksync-chai-matchers.md
@@ -18,6 +18,19 @@ Currently, it is used in combination with [local testing environment](../../test
 - In addition, the `options` argument from `changeEtherBalance`/`changeEtherBalances` now includes the `overrides` field in order to support `zksync-ethers` transfer methods with overrides.
   :::
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+  - Compatible with ethers **v6** (⭐ Recommended)
+
+Examples are adopted for plugin version **>=1.0.0**
+:::
+
 ## Installation
 
 Add the latest version of this plugin to your project with the following command:

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-deploy.md b/docs/build/tooling/hardhat/hardhat-zksync-deploy.md
@@ -18,6 +18,19 @@ To use the `hardhat-zksync-deploy` in your project, we recommend that:
 - You have a wallet with sufficient Sepolia `ETH` on L1 to pay for bridging funds to zkSync as well as deploying smart contracts. Use the [network faucets](../../tooling/network-faucets.md) to get some test tokens in your account.
 - You know how to get your [private key from your MetaMask wallet](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key).
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+
+  - Compatible with ethers **v6** (⭐ Recommended)
+
+  :::
+
 ## Setup
 
 [@matterlabs/hardhat-zksync-deploy](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-deploy)

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-ethers.md b/docs/build/tooling/hardhat/hardhat-zksync-ethers.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: hardhat-zksync-ethers | zkSync Docs
+---
+
 # `hardhat-zksync-ethers`
 
 :::warning SDK Deprecation Notice
@@ -7,6 +14,19 @@ Moving forward, this package will be renamed to `hardhat-zksync-ethers` and will
 Please update your dependencies accordingly to ensure compatibility and continued support.
 :::
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+  - Compatible with ethers **v6** (⭐ Recommended)
+
+Examples are adopted for plugin version **>=1.0.0**
+:::
+
 ## Installation
 
 [@matterlabs/hardhat-zksync-ethers](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-ethers)

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-node.md b/docs/build/tooling/hardhat/hardhat-zksync-node.md
@@ -15,6 +15,17 @@ The zkSync Era In-memory node binaries are not supported on Windows at the momen
 
 :::
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+  - Compatible with ethers **v6** (⭐ Recommended)
+    :::
+
 ## Installation
 
 [@matterlabs/hardhat-zksync-node](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-node)

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-upgradable.md b/docs/build/tooling/hardhat/hardhat-zksync-upgradable.md
@@ -11,6 +11,19 @@ The `hardhat-zksync-upgradable` plugin is a Hardhat plugin that supports end-to-
 
 The plugin is based on [@openzeppelin/hardhat-upgrades](https://www.npmjs.com/package/@openzeppelin/hardhat-upgrades) and [@openzeppelin/upgrades-core](https://www.npmjs.com/package/@openzeppelin/upgrades-core) plugins for deploying and managing upgradeable smart contracts on the Ethereum network. The `hardhat-zkSync-upgradable` plugin provides an easy-to-use interface for interacting with the [OpenZeppelin Upgrades Plugins](https://docs.openzeppelin.com/upgrades-plugins) within a Hardhat environment on zkSync.
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+  - Compatible with ethers **v6** (⭐ Recommended)
+
+Examples are adopted for plugin version **>=1.0.0**
+:::
+
 ## Installation
 
 :::warning Version Incompatibility
@@ -124,7 +137,7 @@ To deploy a simple upgradable contract on zkSync Era local setup, first create a
 ```typescript
 // mnemonic for local node rich wallet
 const testMnemonic = "stuff slice staff easily soup parent arm payment cotton trade scatter struggle";
-const zkWallet = Wallet.fromMnemonic(testMnemonic, "m/44'/60'/0'/0/0");
+const zkWallet = Wallet.fromMnemonic(testMnemonic);
 
 const deployer = new Deployer(hre, zkWallet);
 ```

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-verify-vyper.md b/docs/build/tooling/hardhat/hardhat-zksync-verify-vyper.md
@@ -17,6 +17,19 @@ Because of verification context limitation, hardhat-zksync-verify-vyper plugin i
 
 :::
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+
+  - Compatible with ethers **v6** (⭐ Recommended)
+
+  :::
+
 ## Setup
 
 The [@matterlabs/hardhat-zksync-verify-vyper](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-verify-vyper) plugin is used to verify contracts on zkSync network.

diff --git a/docs/build/tooling/hardhat/hardhat-zksync-verify.md b/docs/build/tooling/hardhat/hardhat-zksync-verify.md
@@ -11,6 +11,19 @@ This plugin is used to verify contracts on the zkSync Era network.
 
 [Changelog](https://github.com/matter-labs/hardhat-zksync/blob/main/packages/hardhat-zksync-verify/CHANGELOG.md)
 
+::: warning Version Compatibility Warning
+Ensure you are using the correct version of the plugin with ethers:
+
+- For plugin version **<1.0.0**:
+
+  - Compatible with ethers **v5**.
+
+- For plugin version **≥1.0.0**:
+
+  - Compatible with ethers **v6** (⭐ Recommended)
+
+  :::
+
 ## Setup
 
 The [@matterlabs/hardhat-zksync-verify](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-verify) plugin is used in conjunction with [@nomicfoundation/hardhat-verify](https://www.npmjs.com/package/@nomicfoundation/hardhat-verify) and it supports backward compatibility.