Skip to content
This repository has been archived by the owner on Oct 3, 2024. It is now read-only.

Commit

Permalink
chore: replacing the toolbox plugin with hardhat-zksync (#1014)
Browse files Browse the repository at this point in the history
Co-authored-by: Marko Arambasic <[email protected]>
Co-authored-by: Dustin Brickwood <[email protected]>
  • Loading branch information
3 people authored Apr 10, 2024
1 parent b7a3553 commit 35f38e3
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ export const enSidebar = sidebar({
"/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/hardhat-zksync.md",
"/build/tooling/hardhat/hardhat-zksync-node.md",
"/build/tooling/hardhat/other-plugins.md",
]
Expand Down
1 change: 1 addition & 0 deletions docs/build/tooling/hardhat/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ zkSync Era has the following official plugins for Hardhat:
- [@matterlabs/hardhat-zksync-upgradable](./hardhat-zksync-upgradable.md) - used to deploy, update, and verify proxy smart contracts.
- [@matterlabs/hardhat-zksync-ethers](./hardhat-zksync-ethers.md) - wrapper around zksync-ethers with some extra Hardhat-specific functionality.
- [@matterlabs/hardhat-zksync-node](./hardhat-zksync-node.md) - used to run the zkSync era-test-node locally.
- [@matterlabs/hardhat-zksync](./hardhat-zksync.md) - used to access to all of the supported plugins and to use them as needed in your project.

::: tip Additional plugins
Learn more about [other plugins from the community](./other-plugins.md) that you can use with zkSync Era.
Expand Down
60 changes: 0 additions & 60 deletions docs/build/tooling/hardhat/hardhat-zksync-toolbox.md

This file was deleted.

74 changes: 74 additions & 0 deletions docs/build/tooling/hardhat/hardhat-zksync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
head:
- - meta
- name: "twitter:title"
content: zkSync Hardhat Plugins | zkSync Docs
---

# `hardhat-zksync`

The hardhat-zksync plugin provides a convenient method for bundling and accessing a range of zkSync-related Hardhat plugins. This approach simplifies the process of utilizing these plugins and promotes ease of use.

List of contained plugins:

- [hardhat-zksync-solc](./hardhat-zksync-solc.md)
- [hardhat-zksync-deploy](./hardhat-zksync-deploy.md)
- [hardhat-zksync-upgradable](./hardhat-zksync-upgradable.md)
- [hardhat-zksync-verify](./hardhat-zksync-verify.md)
- [hardhat-zksync-node](./hardhat-zksync-node.md)
- [hardhat-zksync-ethers](./hardhat-zksync-ethers.md)

::: tip Popular Hardhat plugins

You can find a list of all official plugins [here](./getting-started.md). Also, zkSync supports some other [popular plugins](./other-plugins.md) that can be used.

:::

### Installation

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

::: code-tabs

@tab:active yarn

```bash
yarn add -D @matterlabs/hardhat-zksync
```

@tab npm

```bash
npm i -D @matterlabs/hardhat-zksync
```

:::

### Usage

After installing it, add the plugin to your Hardhat config:

```javascript
import "@matterlabs/hardhat-zksync";
```

With the `hardhat-zksync` plugin installed and imported, you will have access to all of the supported plugins and will be able to use them as needed in your project.
This plugin enables access to all commands available for each specific plugin, making them readily accessible with just the usage of this plugin.

::: note
To learn more about using any of the plugins that are supported by the hardhat-zksync plugin, you can refer to their documentation above.
:::

For certain tasks present in the plugins encompassed by this plugin, it overrides them with new features and parameters. These tasks streamline common functionalities into a simplified workflow.

Here is a list of overriden tasks where this plugin adds new optional parameter `--verify`:

- `deploy-zksync:contract`
- `deploy-zksync:proxy`
- `upgrade-zksync:proxy`
- `deploy-zksync:beacon`
- `upgrade-zksync:beacon`

The `--verify` parameter allow the task to immediately verify all deployed and upgraded contracts when task is called.

To check other parameters present in these tasks, please check the documentation pages for [hardhat-zksync-deploy](./hardhat-zksync-deploy.md) and [hardhat-zksync-upgradable](./hardhat-zksync-upgradable.md).
8 changes: 4 additions & 4 deletions firebase.json
Original file line number Diff line number Diff line change
Expand Up @@ -1045,12 +1045,12 @@
},
{
"source": "/docs/tools/hardhat/plugins.html",
"destination": "/build/tooling/hardhat/hardhat-zksync-toolbox.html",
"destination": "/build/tooling/hardhat/hardhat-zksync.html",
"type": "302"
},
{
"source": "/docs/tools/hardhat/plugins.html",
"destination": "/build/tooling/hardhat/hardhat-zksync-toolbox.html",
"destination": "/build/tooling/hardhat/hardhat-zksync.html",
"type": "302"
},
{
Expand Down Expand Up @@ -2270,12 +2270,12 @@
},
{
"source": "/docs/tools/hardhat/plugins.html",
"destination": "/build/tooling/hardhat/hardhat-zksync-toolbox.html",
"destination": "/build/tooling/hardhat/hardhat-zksync.html",
"type": "302"
},
{
"source": "/docs/tools/hardhat/plugins.html",
"destination": "/build/tooling/hardhat/hardhat-zksync-toolbox.html",
"destination": "/build/tooling/hardhat/hardhat-zksync.html",
"type": "302"
},
{
Expand Down

0 comments on commit 35f38e3

Please sign in to comment.