[ZK Stack] - How to properly deploy a hyperchain with the docker containers?

[ETeissonniere]

Module Affected

• System contracts (era-system-contracts)
• Smart contracts (era-contracts)
• zkEVM (era-zk_evm)
• Server (zksync-era)
• Prover (era-boojum)
• Fee withdrawer (era-fee-withdrawer)
• Block Explorer (clock-explorer)
• Portal - Wallet + Bridge (dapp-portal)
• Other (please specify below)

Rust Version

stable-x86_64-unknown-linux-gnu

Operating System

• Ubuntu
• MacOS
• Windows
• Other (Please specify below)

Issue Description

zk stack docker-setup does generate a working docker compose file but it seems unusable out of the box. The env file expects connections to a geth instance, postgres instance, etc... which are all not part of the docker compose file. Significant and undocumented modifications seem to be necessary to actually make use of the docker files.

Expected Behavior

The docker compose file should be good enough to start a hyperchain via docker, or documentation should be provided.

Current Behavior

Docker compose does not work out of the box, and necessary modifications are unclear. We have tried to start a local geth node, modify the docker compose file etc... but it appears that more details need to go into the setup as we were not able to complete the setup and had to revert to not using the docker images.

Repository Link (if applicable)

No response

Additional Details

No response

Prior Research

• Yes, I searched for similar issues and did not find any matching ones.

[SuccinctPaul]

Hi,guys, I've met the same problem and found it https://github.com/matter-labs/local-setup .

This repo provides a docker-compose.yaml and readme.

Hope it can help u.

[ETeissonniere]

Mainly reverse engineering the zk scripts and figuring out the right values to add to the config file. Of the top of my mind we met the following issues:

1. the docker-setup command did not create a docker compose file that works out of the box
2. containers were not tagged with the names the zk docker-setup script told us were used
3. even when we figured out what values to use our team had to disable the housekeeper service which led to no blocks being finalized on the testnet/Sepolia - we had to do some more reverse engineering to figure out how to enable it

The end result should be contained here, though we since moved away from trying to host our own rollup sequencer for the time being so I can't guarantee this will quite work out of the box. I have also made an attempt to redact any sensitive values (look for # REDACTED) so you'd need to set those again.

[SuccinctPaul]

@bxpana Would you provide a more details(from 0 to1) docs about how to deploy hyperchain in docker?

Besides, I have several questions:

1. what's the difference between server-v2 and local-node and zk-envoriment DockerFile??
2. How to deploy node and it's replica-one ?
3. How to deal when node shutdown on production environment.

[bxpana]

@SuccinctPaul in our docs you can run locally that uses docker https://docs.zksync.io/zk-stack/running-a-hyperchain/locally.html

Will check on your other questions.

[githubdoramon]

@ETeissonniere and @SuccinctPaul, the zk stack cli commands (actually, the whole zk set of commands) are being totally refactored now. Would it be ok for you to hold on a few weeks so we can get it out, or are you dealing with some time-sensitive tasks now?

[ETeissonniere]

yup - no worries

[SuccinctPaul]

Yeah, no problem for that.

[SuccinctPaul]

hi,@githubdoramon , any updates?

[githubdoramon]

We didn't finish the revamp yet, but now you can spin up local setup with ZK chains :)

https://x.com/zkSyncDevs/status/1791172661554315639