Skip to content

Commit

Permalink
chore: add hardhat migration guide prerequisites (#247)
Browse files Browse the repository at this point in the history
<!--

Thank you for contributing to the ZKsync Docs!

Before submitting the PR, please make sure you do the following:

- Update your PR title to follow [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- Read the [Contributing
Guide](https://github.com/matter-labs/zksync-docs/blob/main/CONTRIBUTING.md).
- Understand our [Code of
Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md)
- Please delete any unused parts of the template when submitting your PR

-->

# Description

To ensure a smooth migration and compatibility with your plugins, the
following prerequisites must be met:

Node.js Version
Minimum: v18.x or later

Hardhat Version
Minimum: 2.16.0

---------

Co-authored-by: Marko Arambasic <makiarambasic@gmail.com>
  • Loading branch information
kiriyaga-txfusion and kiriyaga authored Oct 24, 2024
1 parent e6836d5 commit 3302ede
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Migrating Hardhat project to ZKsync Era
description: Learn how to migrate an existing Hardhat project to ZKsync Era.
---

## Prerequisites

- [Node.js](https://nodejs.org) version 18 or newer is required.

- To ensure compatibility with our plugins, make sure that [Hardhat](https://hardhat.org) version 2.16.0 or newer is installed in your project.

## Project setup

The `@matterlabs/hardhat-zksync` plugin includes all the necessary tools to compile, test, deploy, and verify contracts on ZKsync.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ Ensure you are using the correct version of the plugin with ethers:
Examples are adopted for plugin version **>=1.0.0**
::

## Prerequisite

To use `hardhat-zksync-ethers` in your project, ensure the following:

- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Installation

[@matterlabs/hardhat-zksync-ethers](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-ethers)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ Ensure you are using the correct version of the plugin with ethers:

::

## Prerequisite

To use `hardhat-zksync-node` in your project, ensure the following:

- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Installation

[@matterlabs/hardhat-zksync-node](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-node)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ You can find a list of all [official plugins](/build/tooling/hardhat/guides/gett
Also, ZKsync supports some other [popular plugins](/build/tooling/hardhat/plugins/other-plugins) that can be used.
::

### Prerequisite

To use `hardhat-zksync` in your project, ensure the following:

- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

### Installation

Add the latest version of this plugin to your project with the following command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ Learn more about the latest updates in the [changelog](%%zk_git_repo_hardhat-zks

## Prerequisite

To use the `hardhat-zksync-solc` in your project, we recommend that:
To use `hardhat-zksync-solc` in your project, ensure the following:

- You have Node installed and `yarn` or `npm` package manager.
- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ Learn more about the latest updates in the [changelog](%%zk_git_repo_hardhat-zks

## Prerequisite

To use the `hardhat-zksync-vyper` in your project, we recommend that:
To use `hardhat-zksync-vyper` in your project, ensure the following:

- You have Node installed and `yarn` or `npm` package manager.
- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ or `@matterlabs/hardhat-zksync-vyper` plugins.

## Prerequisite

To use the `hardhat-zksync-deploy` in your project, we recommend that:
To use `hardhat-zksync-deploy` in your project, ensure the following:

- You have a Node installation and `yarn` or `npm` package manager.
- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.
- You are already familiar with deploying smart contracts on ZKsync Era.

If not, please refer to the first section of the [ZKsync 101 material](/build/start-coding/zksync-101/hello-zksync).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ Ensure that you're using the correct version of OpenZeppelin Contracts Upgradabl

::

## Prerequisite

To use `hardhat-zksync-upgradable` in your project, ensure the following:

- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Installation

::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ Ensure you are using the correct version of the plugin with ethers:
- Compatible with ethers **v6** (⭐ Recommended)
::

## Prerequisite

To use `hardhat-zksync-verify` in your project, ensure the following:

- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Setup

The [@matterlabs/hardhat-zksync-verify](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-verify) plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ Ensure you are using the correct version of the plugin with ethers:
- Compatible with ethers **v6** (⭐ Recommended)
::

## Prerequisite

To use `hardhat-zksync-verify-vyper` in your project, ensure the following:

- Node.js version 18 or higher is installed.
- Hardhat version 2.16.0 or higher is installed as a dependency.

## Setup

The [@matterlabs/hardhat-zksync-verify-vyper](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-verify-vyper) plugin
Expand Down

0 comments on commit 3302ede

Please sign in to comment.