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

feat(zkstack): Move containers, explorer and portal commands into ecosystem command #3286

Open
wants to merge 5 commits into
base: matias/refactor-chain-commands
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/guides/advanced/01_initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ re-running any `zkstack` command.

#### Containers

The first step to initialize a ZK Stack ecosystem is to run the command `zkstack containers`. This command gets the
docker images for `postgres` and `reth`. If the `--observability` option is passed to the command, or the corresponding
option is selected in the interactive prompt, then Prometheus, Grafana and other observability-related images are
downloaded and run.
The first step to initialize a ZK Stack ecosystem is to run the command `zkstack ecosystem containers`. This command
gets the docker images for `postgres` and `reth`. If the `--observability` option is passed to the command, or the
corresponding option is selected in the interactive prompt, then Prometheus, Grafana and other observability-related
images are downloaded and run.

Reth (one of the Ethereum clients) will be used to setup our own copy of L1 chain (that our local ZKsync would use).

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The project root directory includes configuration files for an ecosystem with a
ecosystem, first start the required containers:
```bash
zkstack containers
zkstack ecosystem containers
```
Next, run:
Expand Down Expand Up @@ -79,7 +79,7 @@ zkstack dev clean all
You can then reinitialize the ecosystem as described in the [Configure Ecosystem](#configure-ecosystem) section.

```bash
zkstack containers
zkstack ecosystem containers
zkstack ecosystem init
```

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Prepare dev environment prerequisites: see
Run the required containers with:

```bash
zkstack containers
zkstack ecosystem containers
```

Setup:
Expand All @@ -33,7 +33,7 @@ To completely reset the dev environment:
- Repeat the setup procedure above

```bash
zkstack containers
zkstack ecosystem containers
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd prefer to keep it separate.

zkstack ecosystem init
```

Expand All @@ -43,7 +43,7 @@ If you want to run [Dockprom](https://github.com/stefanprodan/dockprom/) stack (
containers - add `--observability` parameter during initialisation.

```bash
zkstack containers --observability
zkstack ecosystem containers --observability
```

or select `yes` when prompted during the interactive execution of the command.
Expand Down Expand Up @@ -198,5 +198,5 @@ It appears that no containers are currently running, which is likely the reason
Ensure that the necessary containers have been started and are functioning correctly to resolve the issue.
```bash
zkstack containers
zkstack ecosystem containers
```
12 changes: 6 additions & 6 deletions zkstack_cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ zkstack ecosystem create
If you choose not to start database & L1 containers after creating the ecosystem, you can later run:

```bash
zkstack containers
zkstack ecosystem containers
```

Execute subsequent commands from within the created ecosystem folder:
Expand Down Expand Up @@ -133,7 +133,7 @@ zkstack ecosystem init --observability
To start observability containers:

```bash
zkstack containers --observability
zkstack ecosystem containers --observability
```

### ZK Chain
Expand Down Expand Up @@ -259,7 +259,7 @@ Once you have at least one chain initialized, you can run the [portal](https://g
web-app to bridge tokens between L1 and L2 and more:

```bash
zkstack portal
zkstack ecosystem portal
```

This command will start the dockerized portal app using configuration from `apps/portal.config.json` file inside your
Expand All @@ -275,7 +275,7 @@ contracts and more.
First, each chain should be initialized:

```bash
zkstack explorer init
zkstack ecosystem explorer init
```

This command creates a database to store explorer data and generatesdocker compose file with explorer services
Expand All @@ -284,7 +284,7 @@ This command creates a database to store explorer data and generatesdocker compo
Next, for each chain you want to have an explorer, you need to start its backend services:

```bash
zkstack explorer backend --chain <chain_name>
zkstack ecosystem explorer backend --chain <chain_name>
```

This command uses previously created docker compose file to start the services (api, data fetcher, worker) required for
Expand All @@ -293,7 +293,7 @@ the explorer.
Finally, you can run the explorer app:

```bash
zkstack explorer run
zkstack ecosystem explorer run
```

This command will start the dockerized explorer app using configuration from `apps/explorer.config.json` file inside
Expand Down
Loading