Skip to content

Commit

Permalink
Merge branch 'main' into fix-zksync-specifics-for-forge-init
Browse files Browse the repository at this point in the history
  • Loading branch information
Jrigada authored Dec 10, 2024
2 parents d99438f + 872643e commit cdf4fb1
Show file tree
Hide file tree
Showing 10 changed files with 1,091 additions and 513 deletions.
10 changes: 7 additions & 3 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
- [Gas Overview](./zksync-specifics/gas.md)
- [Paymaster Overview](./zksync-specifics/paymaster-overview.md)
- [Examples](./zksync-specifics/examples/README.md)
- [General Flow Paymaster](./zksync-specifics/examples/general-paymaster.md)
- [Paymaster Approval Based](./zksync-specifics/examples/paymaster-approval-based.md)
- [Ledger](./zksync-specifics/examples/ledger.md)
- [Multisig Smart Account](./zksync-specifics/examples/smart-account.md)
Expand Down Expand Up @@ -77,9 +78,12 @@

- [Overview of Cast](./cast/README.md)

# Anvil-ZKsync Overview

- [Anvil-ZKsync](./anvil-zksync/README.md)

# Not Supported

- [Anvil](./anvil/README.md)
- [Chisel](./chisel/README.md)

# Configuration
Expand Down Expand Up @@ -409,8 +413,8 @@
- [cast wallet verify](./reference/cast/cast-wallet-verify.md)
- [cast wallet import](./reference/cast/cast-wallet-import.md)
- [cast wallet list](./reference/cast/cast-wallet-list.md) -->
<!-- - [`anvil` Reference](./reference/anvil/README.md) -->
<!-- - [`chisel` Reference](./reference/chisel/README.md) -->
- [`anvil-zksync` Reference](./reference/anvil-zksync/README.md) -->
<!-- - [`chisel` Reference](./reference/chisel/README.md)
- [Config Reference](./reference/config/README.md)
- [Overview](./reference/config/overview.md)
- [Project](./reference/config/project.md)
Expand Down
27 changes: 27 additions & 0 deletions src/anvil-zksync/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Overview of Anvil-ZKsync

Anvil-ZKsync is a local testnet node shipped with Foundry-ZKsync. You can use it for testing your contracts from frontends or for interacting over RPC.

Anvil-ZKsync is part of the Foundry-ZKsync suite and is installed alongside `forge`, and `cast`. If you haven't installed Foundry-ZKsync yet, see [Foundry-ZKsync installation](../getting-started/installation.md).

> Note: If you have an older version of Foundry-ZKsync installed, you'll need to re-install `foundryup-zksync` in order for Anvil-ZKsync to be downloaded.
### How to use Anvil-ZKsync

To use Anvil-ZKsync, simply type `anvil-zksync`. You should see a list of accounts and private keys available for use, as well as the address and port that the node is listening on.

Anvil-ZKsync is highly configurable. You can run `anvil-zksync -h` to see all the configuration options.

Some basic options are:

```bash
# Number of dev accounts to generate and configure. [default: 10]
anvil-zksync -a, --accounts <ACCOUNTS>

# Port number to listen on. [default: 8545]
anvil-zksync -p, --port <PORT>
```

> 📚 **Reference**
>
> See the [`anvil-zksync` Reference](../reference/anvil-zksync/) for in depth information on Anvil-ZKsync and its capabilities.
Binary file added src/anvil-zksync/anvil_zksync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 0 additions & 7 deletions src/anvil/README.md

This file was deleted.

Binary file removed src/anvil/anvil.png
Binary file not shown.
4 changes: 3 additions & 1 deletion src/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ curl -L https://raw.githubusercontent.com/matter-labs/foundry-zksync/main/instal

This will install Foundryup-zksync. Simply follow the on-screen instructions, and the `foundryup-zksync` command will become available in your CLI.

Running `foundryup-zksync` will automatically install the latest (nightly) versions of the [precompiled binaries](#precompiled-binaries): `forge` and `cast`. For additional options, such as installing a specific version or commit, run `foundryup-zksync --help`.
Running `foundryup-zksync` automatically installs the latest nightly versions of the [precompiled binaries](#precompiled-binaries), including `forge` and `cast`. Additionally, it fetches the most recent version of the precompiled binary `anvil-zksync` from the [anvil-zksync releases](https://github.com/matter-labs/anvil-zksync/releases).

For additional options, such as installing a specific version or commit, run `foundryup-zksync --help`.

> ℹ️ **Note**
>
Expand Down
Loading

0 comments on commit cdf4fb1

Please sign in to comment.