Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs regarding new hardhat-zksync-node properties #328

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kiriyaga-txfusion
Copy link
Contributor

Description

Update the documentation page for the hardhat-zksync-node plugin to include the new zksyncAnvil object in the Hardhat config file.

  zksyncAnvil: {
        version: '0.3.*', // optional.
        binaryPath: 'zksync/target/release/anvil-zksync', // optional
    },
  • version is the anvil-zksync version. The default version is 0.3.*,
    which resolves to the latest patch version for the specified minor and major version.
    Available options include latest, a specific version, or a version with * as the patch to get the latest patch for a given major and minor version.
  • binaryPath is binary path to anvil-zksync downloaded locally. If this property is set, it will take priority over the version property.

Linked Issues

Additional context

@kiriyaga-txfusion kiriyaga-txfusion requested a review from a team as a code owner February 24, 2025 16:07
@@ -60,6 +60,18 @@ Import the plugin in the `hardhat.config.ts` file:
import "@matterlabs/hardhat-zksync-node";
```

```typescript
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO a preface text is missing here, e.g.:

It's possible to configure the plugin to use a certain version of `anvil-zksync`.
To do that, add the following to the `hardhat.config.ts`:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants