Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@matterlabs/hardhat-zksync

Package Overview
Dependencies
Maintainers
0
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@matterlabs/hardhat-zksync

zkSync bundle of Hardhat plugins

  • 0.3.0
  • legacy-ethers-v5
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.2K
decreased by-5.78%
Maintainers
0
Weekly downloads
 
Created
Source

hardhat-zksync 🚀

zkSync Era Hardhat plugin provides a convenient method for bundling and accessing a range of zkSync-related Hardhat plugins.

Era Logo

⚠️ 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

To install hardhat-zksync plugin, run:

npm i -D @matterlabs/hardhat-zksync

or

yarn add -D @matterlabs/hardhat-zksync

Usage

Here is an overview of the plugins currently available in this package when installed:

🔌 Plugin📄 Description
hardhat-zksync-solcSimplifies compiling Solidity contracts for the zkSync network, streamlining deployment preparation.
hardhat-zksync-deployFacilitates the deployment of contracts on zkSync, utilizing artifacts from hardhat-zksync-solc.
hardhat-zksync-verifyAutomates the process of verifying smart contracts on the zkSync network, enhancing transparency and trust.
hardhat-zksync-upgradeableEnables easier deployment and upgrading of smart contracts on the zkSync network, improving contract lifecycle management.
hardhat-zksync-nodeConvenient plugin to run the zkSync era-test-node locally.
hardhat-zksync-ethersA zksync-ethers SDK wrapper providing additional methods for accelerated development on zkSync.

This plugin enables access to all commands available for each specific plugin, making them readily accessible with just the usage of this plugin. To view the available commands and their descriptions, please refer to the documentation for each individual plugin.

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 and hardhat-zksync-upgradable.

📝 Documentation

In addition to the hardhat-zksync, zkSync's Era website offers a variety of resources including:

Guides to get started: Learn how to start building on zkSync Era.
Hardhat zkSync Era plugins: Overview and guides for all Hardhat zkSync Era plugins.
Hyperscaling: Deep dive into hyperscaling on zkSync Era.

🤝 Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request.

Go to CONTRIBUTING.md to learn about steps and best practices for contributing to zkSync hardhat tooling base repository.

🙌 Feedback, help and news

zkSync Era Discord server: for questions and feedback.
Follow zkSync Era on Twitter

Happy building! 👷‍♀️👷‍♂️

Keywords

FAQs

Package last updated on 25 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc