Skip to content

Commit

Permalink
fix: warnings ethers and oz (#238)
Browse files Browse the repository at this point in the history
# Description

Updates warnings in upgradable plugin

## Linked Issues

N/A

## Additional context
  • Loading branch information
uF4No authored Oct 25, 2024
1 parent f675eb4 commit c5af262
Showing 1 changed file with 6 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,19 @@ The `hardhat-zksync-upgradable` plugin provides an easy-to-use interface for int
[OpenZeppelin Upgrades Plugins](https://docs.openzeppelin.com/upgrades-plugins) within a Hardhat environment on ZKsync.

::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
Ensure you are using the correct version of the plugin with ethers:
Ensure you are using the corresponding version of the plugin for ethers `v5` and `v6`:

- For plugin version **<1.0.0**:

- Compatible with ethers **v5**.

- For plugin version **≥1.0.0**:
- Compatible with ethers **v6** (⭐ Recommended)
- Plugin version **<1.0.0** is compatible with ethers **v5**.
- Plugin version **≥1.0.0** is compatible with ethers **v6** (⭐ Recommended)

Examples are adopted for plugin version **>=1.0.0**
::

::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
Ensure that you're using the correct version of OpenZeppelin Contracts Upgradable for compatibility with your plugin:

- For plugin version **<1.6.0**:

- Compatible with `@openzeppelin/contracts-upgradeable` **v4**.
Ensure that you're using the correct version of the plugin for compatibility with OpenZeppelin Contracts Upgradable `v4` and `v5`:

- For plugin version **≥1.7.0**:
- Compatible with `@openzeppelin/contracts-upgradeable` **v5** (⭐ Recommended)
- Plugin version **<1.6.0** is compatible with `@openzeppelin/contracts-upgradeable` **v4**.
- Plugin version **≥1.7.0** is compatible with `@openzeppelin/contracts-upgradeable` **v5** (⭐ Recommended)

::

Expand All @@ -46,10 +38,6 @@ To use `hardhat-zksync-upgradable` in your project, ensure the following:

## Installation

::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
Current version of the upgradable plugin does not support the latest version of the `@openzeppelin/upgrades-core` package.
::

[@matterlabs/hardhat-zksync-upgradable](https://www.npmjs.com/package/@matterlabs/hardhat-zksync-upgradable)

Add the latest version of this plugin to your project with the following command:
Expand Down

0 comments on commit c5af262

Please sign in to comment.