feat(zk_toolbox): Redesign zk_toolbox commands

.githooks/pre-push

@@ -7,13 +7,13 @@ RED='\033[0;31m'
 NC='\033[0m' # No Color
 
 # Check that prettier formatting rules are not violated.
-if which zk_supervisor >/dev/null; then
-  if ! zk_supervisor fmt --check; then
+if which zkstack >/dev/null; then
+  if ! zkstack dev fmt --check; then
       echo -e "${RED}Push error!${NC}"
-      echo "Please format the code via 'zks fmt', cannot push unformatted code"
+      echo "Please format the code via 'zki dev fmt', cannot push unformatted code"
       exit 1
   fi
 else
-  echo "Please install zk_toolbox using zkup from https://github.com/matter-labs/zksync-era/tree/main/zk_toolbox/zkup, and then run ./bin/zkt from the zksync-era repository."
+  echo "Please install ZK Stack CLI using zkstackup from https://github.com/matter-labs/zksync-era/tree/main/zkstack_cli/zkstackup, and then run ./bin/zkt from the zksync-era repository."
   exit 1
 fi

.github/pull_request_template.md

@@ -17,4 +17,4 @@
 - [ ] PR title corresponds to the body of PR (we generate changelog entries from PRs).
 - [ ] Tests for the changes have been added / updated.
 - [ ] Documentation comments have been added / updated.
-- [ ] Code has been formatted via `zk_supervisor fmt` and `zk_supervisor lint`.
+- [ ] Code has been formatted via `zkstack dev fmt` and `zkstack dev lint`.

.github/release-please/config.json

@@ -20,12 +20,12 @@
       "release-type": "simple",
       "component": "prover"
     },
-    "zk_toolbox": {
+    "zkstack_cli": {
       "release-type": "simple",
-      "component": "zk_toolbox",
+      "component": "zkstack_cli",
       "plugins": [
         "cargo-workspace"
       ]
     }
   }
-}
+}

.github/release-please/manifest.json

@@ -1,5 +1,5 @@
 {
   "core": "24.28.0",
   "prover": "16.5.0",
-  "zk_toolbox": "0.1.2"
-}
+  "zkstack_cli": "0.1.2"
+}

.github/workflows/build-contract-verifier-template.yml

@@ -121,7 +121,7 @@ jobs:
         if: env.BUILD_CONTRACTS == 'true'
         run: |
           ci_run cp etc/tokens/{test,localhost}.json
-          ci_run zk_supervisor contracts
+          ci_run zkstack dev contracts
 
       - name: Login to Docker registries
         if: ${{ inputs.action == 'push' }}

.github/workflows/build-core-template.yml

@@ -134,7 +134,7 @@ jobs:
         if: env.BUILD_CONTRACTS == 'true'
         run: |
           ci_run cp etc/tokens/{test,localhost}.json
-          ci_run zk_supervisor contracts
+          ci_run zkstack dev contracts
 
       - name: Login to Docker registries
         if: ${{ inputs.action == 'push' }}

.github/workflows/build-local-node-docker.yml

@@ -63,7 +63,7 @@ jobs:
           ci_run zk
           ci_run zkt
           ci_run cp etc/tokens/{test,localhost}.json
-          ci_run zk_supervisor contracts 
+          ci_run zkstack dev contracts 
 
       - name: update-image
         run: |

.github/workflows/ci-common-reusable.yml

@@ -37,5 +37,5 @@ jobs:
       # This does both linting and "building". We're using `zk lint prover` as it's common practice within our repo
       # `zk lint prover` = cargo clippy, which does cargo check behind the scenes, which is a lightweight version of cargo build
       - name: Lints
-        run: ci_run zk_supervisor lint -t rs --check
+        run: ci_run zkstack dev lint -t rs --check
 

.github/workflows/ci-core-lint-reusable.yml

@@ -32,18 +32,18 @@ jobs:
           ci_run ./bin/zkt
           ci_run yarn install
           ci_run git config --global --add safe.directory /usr/src/zksync
-          ci_run zk_supervisor db setup --prover-url=${{ env.prover_url }} --core-url=${{ env.core_url }}
+          ci_run zkstack dev db setup --prover-url=${{ env.prover_url }} --core-url=${{ env.core_url }}
 
 
       - name: Lints
         run: |
-          ci_run zk_supervisor fmt --check
-          ci_run zk_supervisor lint -t md --check
-          ci_run zk_supervisor lint -t sol --check
-          ci_run zk_supervisor lint -t js --check
-          ci_run zk_supervisor lint -t ts --check
-          ci_run zk_supervisor lint -t rs --check
+          ci_run zkstack dev fmt --check
+          ci_run zkstack dev lint -t md --check
+          ci_run zkstack dev lint -t sol --check
+          ci_run zkstack dev lint -t js --check
+          ci_run zkstack dev lint -t ts --check
+          ci_run zkstack dev lint -t rs --check
 
       - name: Check Database
         run: |
-          ci_run zk_supervisor database check-sqlx-data --prover-url=${{ env.prover_url }} --core-url=${{ env.core_url }}
+          ci_run zkstack dev database check-sqlx-data --prover-url=${{ env.prover_url }} --core-url=${{ env.core_url }}

.github/workflows/ci-docs-reusable.yml

@@ -35,4 +35,4 @@ jobs:
 
       - name: Lints
         run: |
-          ci_run zk_supervisor lint -t md --check
+          ci_run zkstack dev lint -t md --check

.github/workflows/ci-prover-reusable.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Init
         run: |
           ci_run zkt
-          ci_run zk_supervisor db setup --prover-url=${{ env.prover_url }} --core-url=${{ env.core_url }}
+          ci_run zkstack dev db setup --prover-url=${{ env.prover_url }} --core-url=${{ env.core_url }}
 
       - name: Formatting
         run: ci_run bash -c "cd prover && cargo fmt --check"
@@ -73,4 +73,4 @@ jobs:
       - name: Prover unit tests
         run: |
           # Not all tests are enabled, since prover and setup_key_generator_and_server requires bellman-cuda to be present
-          ci_run zk_supervisor test prover
+          ci_run zkstack dev test prover

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     outputs:
       core: ${{ steps.changed-files.outputs.core_any_changed }}
       prover: ${{ steps.changed-files.outputs.prover_any_changed }}
-      zk_toolbox: ${{ steps.changed-files.outputs.zk_toolbox_any_changed }}
+      zkstack_cli: ${{ steps.changed-files.outputs.zkstack_cli_any_changed }}
       docs: ${{ steps.changed-files.outputs.docs_any_changed }}
       all: ${{ steps.changed-files.outputs.all_any_changed }}
     steps:
@@ -58,7 +58,7 @@ jobs:
               - '.github/workflows/ci-core-lint-reusable.yml'
               - 'Cargo.toml'
               - 'Cargo.lock'
-              - 'zk_toolbox/**'
+              - 'zkstack_cli/**'
               - '!**/*.md'
               - '!**/*.MD'
               - 'docker-compose.yml'

.github/workflows/new-build-contract-verifier-template.yml

@@ -134,7 +134,7 @@ jobs:
         shell: bash
         run: |
           cp etc/tokens/{test,localhost}.json
-          zk_supervisor contracts
+          zkstack dev contracts
 
       - name: Upload contracts
         uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0

.github/workflows/new-build-core-template.yml

@@ -139,7 +139,7 @@ jobs:
         shell: bash
         run: |
           cp etc/tokens/{test,localhost}.json
-          zk_supervisor contracts
+          zkstack dev contracts
 
       - name: Upload contracts
         uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0

.github/workflows/vm-perf-comparison.yml

@@ -49,7 +49,7 @@ jobs:
         shell: bash
         run: |
           ci_run zkt
-          ci_run zk_supervisor contracts --system-contracts
+          ci_run zk_supervisor contracts --system-contracts || ci_run zkstack dev contracts --system-contracts
           ci_run cargo bench --package vm-benchmark --bench iai | tee base-iai
           ci_run cargo run --package vm-benchmark --release --bin instruction_counts | tee base-opcodes || touch base-opcodes
 
@@ -61,7 +61,7 @@ jobs:
         shell: bash
         run: |
           ci_run zkt
-          ci_run zk_supervisor contracts --system-contracts
+          ci_run zkstack dev contracts --system-contracts
           ci_run cargo bench --package vm-benchmark --bench iai | tee pr-iai
           ci_run cargo run --package vm-benchmark --release --bin instruction_counts | tee pr-opcodes || touch pr-opcodes
 

.github/workflows/vm-perf-to-prometheus.yml

@@ -34,7 +34,7 @@ jobs:
           run_retried docker compose pull zk
           docker compose up -d zk
           ci_run zkt
-          ci_run zk_supervisor contracts
+          ci_run zkstack dev contracts
 
       - name: run benchmarks
         run: |

.gitignore

@@ -30,7 +30,7 @@ Cargo.lock
 !/Cargo.lock
 !/infrastructure/zksync-crypto/Cargo.lock
 !/prover/Cargo.lock
-!/zk_toolbox/Cargo.lock
+!/zkstack_cli/Cargo.lock
 
 /etc/env/target/*
 /etc/env/.current
@@ -112,7 +112,7 @@ hyperchain-*.yml
 prover/crates/bin/vk_setup_data_generator_server_fri/data/setup_*
 prover/data/keys/setup_*
 
-# Zk Toolbox
+# ZK Stack CLI
 chains/era/configs/*
 configs/*
 era-observability/

bin/zkt

@@ -2,16 +2,13 @@
 
 cd $(dirname $0)
 
-if which zkup >/dev/null; then
-    cargo uninstall zk_inception
-    cargo uninstall zk_supervisor
+if which zkstackup >/dev/null; then
+    cargo uninstall zkstack
     git config --local core.hooksPath ||
     git config --local core.hooksPath ./.githooks
-    zkup -p .. --alias
+    zkstackup -p .. --alias
 else
-    echo zkup is not installed, please install it https://github.com/matter-labs/zksync-era/tree/main/zk_toolbox/zkup
-    cd ../zk_toolbox
-    cargo install --path ./crates/zk_inception --force
-    cargo install --path ./crates/zk_supervisor --force
+    echo zkstackup is not installed, please install it https://github.com/matter-labs/zksync-era/tree/main/zkstack_cli/zkstackup
+    cd ../zkstack_cli
+    cargo install --path ./crates/zkstack --force
 fi
-

core/lib/utils/src/env.rs

@@ -19,8 +19,8 @@ pub enum Workspace<'a> {
     Core(&'a Path),
     /// `prover` folder.
     Prover(&'a Path),
-    /// `toolbox` folder.
-    Toolbox(&'a Path),
+    /// ZK Stack CLI folder.
+    ZkStackCli(&'a Path),
 }
 
 impl Workspace<'static> {
@@ -48,15 +48,15 @@ impl Workspace<'static> {
 
 impl<'a> Workspace<'a> {
     const PROVER_DIRECTORY_NAME: &'static str = "prover";
-    const TOOLBOX_DIRECTORY_NAME: &'static str = "zk_toolbox";
+    const ZKSTACK_CLI_DIRECTORY_NAME: &'static str = "zkstack_cli";
 
     /// Returns the path of the core workspace.
     /// For `Workspace::None`, considers the current directory to represent core workspace.
     pub fn core(self) -> PathBuf {
         match self {
             Self::None => PathBuf::from("."),
             Self::Core(path) => path.into(),
-            Self::Prover(path) | Self::Toolbox(path) => path.parent().unwrap().into(),
+            Self::Prover(path) | Self::ZkStackCli(path) => path.parent().unwrap().into(),
         }
     }
 
@@ -68,11 +68,11 @@ impl<'a> Workspace<'a> {
         }
     }
 
-    /// Returns the path of the `zk_toolbox`` workspace.
-    pub fn toolbox(self) -> PathBuf {
+    /// Returns the path of the ZK Stack CLI workspace.
+    pub fn zkstack_cli(self) -> PathBuf {
         match self {
-            Self::Toolbox(path) => path.into(),
-            _ => self.core().join(Self::TOOLBOX_DIRECTORY_NAME),
+            Self::ZkStackCli(path) => path.into(),
+            _ => self.core().join(Self::ZKSTACK_CLI_DIRECTORY_NAME),
         }
     }
 }
@@ -81,8 +81,8 @@ impl<'a> From<&'a Path> for Workspace<'a> {
     fn from(path: &'a Path) -> Self {
         if path.ends_with(Self::PROVER_DIRECTORY_NAME) {
             Self::Prover(path)
-        } else if path.ends_with(Self::TOOLBOX_DIRECTORY_NAME) {
-            Self::Toolbox(path)
+        } else if path.ends_with(Self::ZKSTACK_CLI_DIRECTORY_NAME) {
+            Self::ZkStackCli(path)
         } else {
             Self::Core(path)
         }
@@ -154,16 +154,16 @@ mod tests {
         let workspace = Workspace::locate();
         assert_matches!(workspace, Workspace::Core(_));
         let core_path = workspace.core();
-        // Check if prover and toolbox directories exist.
+        // Check if prover and ZK Stack CLI directories exist.
         assert!(workspace.prover().exists());
         assert_matches!(
             Workspace::from(workspace.prover().as_path()),
             Workspace::Prover(_)
         );
-        assert!(workspace.toolbox().exists());
+        assert!(workspace.zkstack_cli().exists());
         assert_matches!(
-            Workspace::from(workspace.toolbox().as_path()),
-            Workspace::Toolbox(_)
+            Workspace::from(workspace.zkstack_cli().as_path()),
+            Workspace::ZkStackCli(_)
         );
 
         // Prover.
@@ -181,17 +181,17 @@ mod tests {
             Workspace::from(workspace.core().as_path()),
             Workspace::Core(_)
         );
-        assert!(workspace.toolbox().exists());
+        assert!(workspace.zkstack_cli().exists());
         assert_matches!(
-            Workspace::from(workspace.toolbox().as_path()),
-            Workspace::Toolbox(_)
+            Workspace::from(workspace.zkstack_cli().as_path()),
+            Workspace::ZkStackCli(_)
         );
 
-        // Toolbox.
-        std::env::set_current_dir(workspace.toolbox()).unwrap();
+        // ZK Stack CLI
+        std::env::set_current_dir(workspace.zkstack_cli()).unwrap();
         let workspace_path = locate_workspace_inner().unwrap();
         let workspace = Workspace::from(workspace_path.as_path());
-        assert_matches!(workspace, Workspace::Toolbox(_));
+        assert_matches!(workspace, Workspace::ZkStackCli(_));
         assert_eq!(workspace.core(), core_path);
         assert_matches!(
             Workspace::from(workspace.core().as_path()),

core/tests/recovery-test/src/index.ts

@@ -86,7 +86,7 @@ export async function getExternalNodeHealth(url: string) {
 
 export async function dropNodeData(env: { [key: string]: string }, useZkSupervisor?: boolean, chain?: string) {
     if (useZkSupervisor) {
-        let cmd = 'zk_inception external-node init';
+        let cmd = 'zkstack external-node init';
         cmd += chain ? ` --chain ${chain}` : '';
         await executeNodeCommand(env, cmd);
     } else {
@@ -176,7 +176,7 @@ export class NodeProcess {
         logsFile: FileHandle | string,
         pathToHome: string,
         components: NodeComponents = NodeComponents.STANDARD,
-        useZkInception?: boolean,
+        useZkStack?: boolean,
         chain?: string
     ) {
         const logs = typeof logsFile === 'string' ? await fs.open(logsFile, 'a') : logsFile;
@@ -186,7 +186,7 @@ export class NodeProcess {
             stdio: ['ignore', logs.fd, logs.fd],
             cwd: pathToHome,
             env,
-            useZkInception,
+            useZkStack,
             chain
         });
 

core/tests/recovery-test/src/utils.ts

@@ -48,19 +48,19 @@ export function runExternalNodeInBackground({
     stdio,
     cwd,
     env,
-    useZkInception,
+    useZkStack,
     chain
 }: {
     components?: string[];
     stdio: any;
     cwd?: Parameters<typeof background>[0]['cwd'];
     env?: Parameters<typeof background>[0]['env'];
-    useZkInception?: boolean;
+    useZkStack?: boolean;
     chain?: string;
 }): ChildProcessWithoutNullStreams {
     let command = '';
-    if (useZkInception) {
-        command = 'zk_inception external-node run';
+    if (useZkStack) {
+        command = 'zkstack external-node run';
         command += chain ? ` --chain ${chain}` : '';
     } else {
         command = 'zk external-node --';

core/tests/recovery-test/tests/snapshot-recovery.test.ts

@@ -461,7 +461,7 @@ async function decompressGzip(filePath: string): Promise<Buffer> {
 async function createSnapshot(zkSupervisor: boolean) {
     let command = '';
     if (zkSupervisor) {
-        command = `zk_supervisor snapshot create`;
+        command = `zkstack dev snapshot create`;
         command += ` --chain ${fileConfig.chain}`;
     } else {
         command = `zk run snapshots-creator`;