From 7cefdea6f7a10d37aedd02481fa1894fc00e7409 Mon Sep 17 00:00:00 2001
From: Danil <deniallugo@gmail.com>
Date: Tue, 27 Aug 2024 19:04:12 +0200
Subject: [PATCH] chore(zk_toolbox): Update readme

Signed-off-by: Danil <deniallugo@gmail.com>
---
 zk_toolbox/crates/zk_inception/README.md  | 89 +++++++++++++++------
 zk_toolbox/crates/zk_supervisor/README.md | 97 +++++++++++++++++++++--
 2 files changed, 154 insertions(+), 32 deletions(-)

diff --git a/zk_toolbox/crates/zk_inception/README.md b/zk_toolbox/crates/zk_inception/README.md
index 73bfb56cfd39..6f4d70b37b55 100644
--- a/zk_toolbox/crates/zk_inception/README.md
+++ b/zk_toolbox/crates/zk_inception/README.md
@@ -33,6 +33,7 @@ This document contains the help content for the `zk_inception` command-line prog
 - [`zk_inception contract-verifier`↴](#zk_inception-contract-verifier)
 - [`zk_inception contract-verifier run`↴](#zk_inception-contract-verifier-run)
 - [`zk_inception contract-verifier init`↴](#zk_inception-contract-verifier-init)
+- [`zk_inception portal`↴](#zk_inception-portal)
 - [`zk_inception update`↴](#zk_inception-update)
 
 ## `zk_inception`
@@ -50,6 +51,7 @@ ZK Toolbox is a set of tools for working with zk stack.
 - `external-node` — External Node related commands
 - `containers` — Run containers for local development
 - `contract-verifier` — Run contract verifier
+- `portal` — Run dapp-portal
 - `update` — Update zkSync
 
 ###### **Options:**
@@ -76,11 +78,7 @@ Ecosystem related commands
 
 Create a new ecosystem and chain, setting necessary configurations for later initialization
 
-**Usage:** `zk_inception ecosystem create [OPTIONS] [CHAIN_ID]`
-
-###### **Arguments:**
-
-- `<CHAIN_ID>`
+**Usage:** `zk_inception ecosystem create [OPTIONS]`
 
 ###### **Options:**
 
@@ -91,6 +89,7 @@ Create a new ecosystem and chain, setting necessary configurations for later ini
 
 - `--link-to-code <LINK_TO_CODE>` — Code link
 - `--chain-name <CHAIN_NAME>`
+- `--chain-id <CHAIN_ID>` — Chain ID
 - `--prover-mode <PROVER_MODE>` — Prover options
 
   Possible values: `no-proofs`, `gpu`
@@ -166,7 +165,9 @@ Initialize ecosystem and chain, deploying necessary contracts and performing on-
 - `-u`, `--use-default` — Use default database urls and names
 - `-d`, `--dont-drop`
 - `--dev` — Deploy ecosystem using all defaults. Suitable for local development
-- `-o`, `--observability` — Enable Grafana
+- `-o`, `--observability <OBSERVABILITY>` — Enable Grafana
+
+  Possible values: `true`, `false`
 
 ## `zk_inception ecosystem change-default-chain`
 
@@ -199,21 +200,18 @@ Chain related commands
 - `deploy-l2-contracts` — Deploy all l2 contracts
 - `upgrader` — Deploy Default Upgrader
 - `deploy-paymaster` — Deploy paymaster smart contract
-- `update-token-multiplier-setter` — Update Token Multiplier Setter address on l1
+- `update-token-multiplier-setter` — Update Token Multiplier Setter address on L1
 
 ## `zk_inception chain create`
 
 Create a new chain, setting the necessary configurations for later initialization
 
-**Usage:** `zk_inception chain create [OPTIONS] [CHAIN_ID]`
-
-###### **Arguments:**
-
-- `<CHAIN_ID>`
+**Usage:** `zk_inception chain create [OPTIONS]`
 
 ###### **Options:**
 
 - `--chain-name <CHAIN_NAME>`
+- `--chain-id <CHAIN_ID>` — Chain ID
 - `--prover-mode <PROVER_MODE>` — Prover options
 
   Possible values: `no-proofs`, `gpu`
@@ -393,11 +391,28 @@ Deploy paymaster smart contract
 
 ## `zk_inception chain update-token-multiplier-setter`
 
-Update Token Multiplier Setter address on l1. Token Multiplier Setter is used by chains with custom base token to
-propagate the changes to numerator / denominator to the l1. Address of the Token Multiplier Setter is taken from the
-wallets configuration.
+Update Token Multiplier Setter address on L1
+
+**Usage:** `zk_inception chain update-token-multiplier-setter [OPTIONS]`
+
+###### **Options:**
+
+- `--verify <VERIFY>` — Verify deployed contracts
 
-**Usage:** `zk_inception chain update-token-multiplier-setter`
+  Possible values: `true`, `false`
+
+- `--verifier <VERIFIER>` — Verifier to use
+
+  Default value: `etherscan`
+
+  Possible values: `etherscan`, `sourcify`, `blockscout`, `oklink`
+
+- `--verifier-url <VERIFIER_URL>` — Verifier URL, if using a custom provider
+- `--verifier-api-key <VERIFIER_API_KEY>` — Verifier API key
+- `--resume`
+- `-a`, `--additional-args <ADDITIONAL_ARGS>` — List of additional arguments that can be passed through the CLI.
+
+  e.g.: `zk_inception init -a --private-key=<PRIVATE_KEY>`
 
 ## `zk_inception prover`
 
@@ -428,7 +443,7 @@ Initialize prover
 - `--project-id <PROJECT_ID>`
 - `--shall-save-to-public-bucket <SHALL_SAVE_TO_PUBLIC_BUCKET>`
 
-Possible values: `true`, `false`
+  Possible values: `true`, `false`
 
 - `--public-store-dir <PUBLIC_STORE_DIR>`
 - `--public-bucket-base-url <PUBLIC_BUCKET_BASE_URL>`
@@ -438,15 +453,24 @@ Possible values: `true`, `false`
 - `--public-project-id <PUBLIC_PROJECT_ID>`
 - `--bellman-cuda-dir <BELLMAN_CUDA_DIR>`
 - `--download-key <DOWNLOAD_KEY>`
-- `--setup-database`
-- `--use-default` - use default database
-- `--dont-drop` - don't drop database
-- `--prover-db-url` - URL of database to use
-- `--prover-db-name` - Name of database to use
 
-Possible values: `true`, `false`
+  Possible values: `true`, `false`
 
 - `--setup-key-path <SETUP_KEY_PATH>`
+- `--setup-database <SETUP_DATABASE>`
+
+  Possible values: `true`, `false`
+
+- `--prover-db-url <PROVER_DB_URL>` — Prover database url without database name
+- `--prover-db-name <PROVER_DB_NAME>` — Prover database name
+- `-u`, `--use-default <USE_DEFAULT>` — Use default database urls and names
+
+  Possible values: `true`, `false`
+
+- `-d`, `--dont-drop <DONT_DROP>`
+
+  Possible values: `true`, `false`
+
 - `--cloud-type <CLOUD_TYPE>`
 
   Possible values: `gcp`, `local`
@@ -467,7 +491,8 @@ Run prover
 
 - `--component <COMPONENT>`
 
-  Possible values: `gateway`, `witness-generator`, `witness-vector-generator`, `prover`, `compressor`
+  Possible values: `gateway`, `witness-generator`, `witness-vector-generator`, `prover`, `compressor`,
+  `prover-job-monitor`
 
 - `--round <ROUND>`
 
@@ -549,7 +574,9 @@ Run containers for local development
 
 ###### **Options:**
 
-- `-o`, `--observability` — Enable Grafana
+- `-o`, `--observability <OBSERVABILITY>` — Enable Grafana
+
+  Possible values: `true`, `false`
 
 ## `zk_inception contract-verifier`
 
@@ -581,6 +608,18 @@ Download required binaries for contract verifier
 - `--solc-version <SOLC_VERSION>` — Version of solc to install
 - `--vyper-version <VYPER_VERSION>` — Version of vyper to install
 
+## `zk_inception portal`
+
+Run dapp-portal
+
+**Usage:** `zk_inception portal [OPTIONS]`
+
+###### **Options:**
+
+- `--port <PORT>` — The port number for the portal app
+
+  Default value: `3030`
+
 ## `zk_inception update`
 
 Update zkSync
diff --git a/zk_toolbox/crates/zk_supervisor/README.md b/zk_toolbox/crates/zk_supervisor/README.md
index 1f880cdcb30a..c3fac876ace6 100644
--- a/zk_toolbox/crates/zk_supervisor/README.md
+++ b/zk_toolbox/crates/zk_supervisor/README.md
@@ -5,7 +5,6 @@ This document contains the help content for the `zk_supervisor` command-line pro
 **Command Overview:**
 
 - [`zk_supervisor`↴](#zk_supervisor)
-- [`zk_supervisor prover-version`↴](#zk_supervisor-prover-version)
 - [`zk_supervisor database`↴](#zk_supervisor-database)
 - [`zk_supervisor database check-sqlx-data`↴](#zk_supervisor-database-check-sqlx-data)
 - [`zk_supervisor database drop`↴](#zk_supervisor-database-drop)
@@ -19,12 +18,21 @@ This document contains the help content for the `zk_supervisor` command-line pro
 - [`zk_supervisor test revert`↴](#zk_supervisor-test-revert)
 - [`zk_supervisor test recovery`↴](#zk_supervisor-test-recovery)
 - [`zk_supervisor test upgrade`↴](#zk_supervisor-test-upgrade)
+- [`zk_supervisor test rust`↴](#zk_supervisor-test-rust)
+- [`zk_supervisor test l1-contracts`↴](#zk_supervisor-test-l1-contracts)
+- [`zk_supervisor test prover`↴](#zk_supervisor-test-prover)
 - [`zk_supervisor clean`↴](#zk_supervisor-clean)
 - [`zk_supervisor clean all`↴](#zk_supervisor-clean-all)
 - [`zk_supervisor clean containers`↴](#zk_supervisor-clean-containers)
 - [`zk_supervisor clean contracts-cache`↴](#zk_supervisor-clean-contracts-cache)
 - [`zk_supervisor snapshot`↴](#zk_supervisor-snapshot)
 - [`zk_supervisor snapshot create`↴](#zk_supervisor-snapshot-create)
+- [`zk_supervisor lint`↴](#zk_supervisor-lint)
+- [`zk_supervisor fmt`↴](#zk_supervisor-fmt)
+- [`zk_supervisor fmt rustfmt`↴](#zk_supervisor-fmt-rustfmt)
+- [`zk_supervisor fmt contract`↴](#zk_supervisor-fmt-contract)
+- [`zk_supervisor fmt prettier`↴](#zk_supervisor-fmt-prettier)
+- [`zk_supervisor prover-version`↴](#zk_supervisor-prover-version)
 
 ## `zk_supervisor`
 
@@ -38,6 +46,9 @@ ZK Toolbox is a set of tools for working with zk stack.
 - `test` — Run tests
 - `clean` — Clean artifacts
 - `snapshot` — Snapshots creator
+- `lint` — Lint code
+- `fmt` — Format code
+- `prover-version` — Protocol version used by provers
 
 ###### **Options:**
 
@@ -45,12 +56,6 @@ ZK Toolbox is a set of tools for working with zk stack.
 - `--chain <CHAIN>` — Chain to use
 - `--ignore-prerequisites` — Ignores prerequisites checks
 
-## `zk_supervisor prover-version`
-
-Gets information about current protocol version of provers in `zksync-era` and snark wrapper hash.
-
-**Usage:** `zk_supervisor prover-version`
-
 ## `zk_supervisor database`
 
 Database related commands
@@ -189,6 +194,9 @@ Run tests
 - `revert` — Run revert tests
 - `recovery` — Run recovery tests
 - `upgrade` — Run upgrade tests
+- `rust` — Run unit-tests, accepts optional cargo test flags
+- `l1-contracts` — Run L1 contracts tests
+- `prover` — Run prover tests
 
 ## `zk_supervisor test integration`
 
@@ -227,6 +235,28 @@ Run upgrade tests
 
 **Usage:** `zk_supervisor test upgrade`
 
+## `zk_supervisor test rust`
+
+Run unit-tests, accepts optional cargo test flags
+
+**Usage:** `zk_supervisor test rust [OPTIONS]`
+
+###### **Options:**
+
+- `--options <OPTIONS>` — Cargo test flags
+
+## `zk_supervisor test l1-contracts`
+
+Run L1 contracts tests
+
+**Usage:** `zk_supervisor test l1-contracts`
+
+## `zk_supervisor test prover`
+
+Run prover tests
+
+**Usage:** `zk_supervisor test prover`
+
 ## `zk_supervisor clean`
 
 Clean artifacts
@@ -271,6 +301,59 @@ Snapshots creator
 
 **Usage:** `zk_supervisor snapshot create`
 
+## `zk_supervisor lint`
+
+Lint code
+
+**Usage:** `zk_supervisor lint [OPTIONS]`
+
+###### **Options:**
+
+- `-c`, `--check`
+- `-e`, `--extensions <EXTENSIONS>`
+
+  Possible values: `md`, `sol`, `js`, `ts`, `rs`
+
+## `zk_supervisor fmt`
+
+Format code
+
+**Usage:** `zk_supervisor fmt [OPTIONS] [COMMAND]`
+
+###### **Subcommands:**
+
+- `rustfmt` —
+- `contract` —
+- `prettier` —
+
+###### **Options:**
+
+- `-c`, `--check`
+
+## `zk_supervisor fmt rustfmt`
+
+**Usage:** `zk_supervisor fmt rustfmt`
+
+## `zk_supervisor fmt contract`
+
+**Usage:** `zk_supervisor fmt contract`
+
+## `zk_supervisor fmt prettier`
+
+**Usage:** `zk_supervisor fmt prettier [OPTIONS]`
+
+###### **Options:**
+
+- `-e`, `--extensions <EXTENSIONS>`
+
+  Possible values: `md`, `sol`, `js`, `ts`, `rs`
+
+## `zk_supervisor prover-version`
+
+Protocol version used by provers
+
+**Usage:** `zk_supervisor prover-version`
+
 <hr/>
 
 <small><i> This document was generated automatically by