feat: split zkstack cli command (#4418)

## What ❔

<!-- What are the changes this PR brings about? -->
<!-- Example: This PR adds a PR template to the repo. -->
<!-- (For bigger PRs adding more context is appreciated) -->

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- The `Why` has to be clear to non-Matter Labs entities running their
own ZK Chain -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Is this a breaking change?
- [ ] Yes
- [ ] No

## Operational changes
<!-- Any config changes? Any new flags? Any changes to any scripts? -->
<!-- Please add anything that non-Matter Labs entities running their own
ZK Chain may need to know -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [ ] 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 `zkstack dev fmt` and `zkstack dev
lint`.

---------

Signed-off-by: Danil <[email protected]>
Co-authored-by: Danil <[email protected]>

Author: Raid5594

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

@@ -247,6 +247,7 @@ jobs:
           --chain gateway \
           --validium-type no-da
           
+          ci_run zkstack chain gateway create-tx-filterer --chain gateway --ignore-prerequisites
           ci_run zkstack chain gateway convert-to-gateway --chain gateway --ignore-prerequisites
 
       - name: Run gateway

contracts

@@ -96,6 +96,47 @@ zkstack ecosystem init --dev
 If the process gets stuck, resume it with `--resume`. This flag keeps track of already sent transactions and sends new
 ones with provided params.
 
+To create only the ecosystem:
+
+```bash
+zkstack ecosystem init-core-contracts --l1-rpc-url <L1_RPC_ENDPOINT>
+```
+
+If the ecosystem has already been initialized, you can create a new ctm and rigester it in the existing bridgehub.
+
+This command create a new ctm and all related contracts:
+
+```bash
+zkstack ecosystem init-new-ctm --l1-rpc-url <L1_RPC_ENDPOINT> --bridgehub <BRIDGEHUB_CONTRACT_ADDRESS>
+```
+
+This should be called afterwards to register the created ctm in the bridgehub:
+
+```bash
+zkstack ecosystem register-ctm --l1-rpc-url <L1_RPC_ENDPOINT>
+```
+
+#### Gateway
+
+If the want to convert the newly created gateway chain to become the settlement layer for local testing:
+
+```bash
+zkstack chain gateway convert-to-gateway --chain <GATEWAY_CHAIN_NAME>
+```
+
+If we want to deploy a CTM on gateway for an existing settlement layer, please provide the bridgehub address and id of
+the chain, whose ctm you want to deploy:
+
+```bash
+zkstack chain gateway convert-to-gateway --chain <GATEWAY_CHAIN_NAME> --ignore-prerequisites --bridgehub-addr <BRIDGEHUB_CONTRACT_ADDRESS> --ctm-chain-id <CHAIN_ID_FOR_CTM>
+```
+
+To migrate the chain on top of gateway afterwards:
+
+```bash
+zkstack chain gateway migrate-to-gateway --chain <NAME_OF_CHAIN_TO_MIGRATE> --gateway-chain-name <GATEWAY_CHAIN_NAME>
+```
+
 #### Verifying Contracts
 
 To verify contracts, use the `--verify` flag.

zkstack_cli/README.md

@@ -30,6 +30,18 @@ pub const DEPLOY_ECOSYSTEM_SCRIPT_PARAMS: ForgeScriptParams = ForgeScriptParams
     script_path: "deploy-scripts/DeployL1.s.sol",
 };
 
+pub const DEPLOY_ECOSYSTEM_CORE_CONTRACTS_SCRIPT_PARAMS: ForgeScriptParams = ForgeScriptParams {
+    input: "script-config/config-deploy-l1.toml",
+    output: "script-out/output-deploy-l1.toml",
+    script_path: "deploy-scripts/DeployL1CoreContracts.s.sol",
+};
+
+pub const REGISTER_CTM_SCRIPT_PARAMS: ForgeScriptParams = ForgeScriptParams {
+    input: "script-config/config-deploy-l1.toml",
+    output: "script-out/output-deploy-l1.toml",
+    script_path: "deploy-scripts/RegisterCTM.s.sol",
+};
+
 pub const DEPLOY_L2_CONTRACTS_SCRIPT_PARAMS: ForgeScriptParams = ForgeScriptParams {
     input: "script-config/config-deploy-l2-contracts.toml",
     output: "script-out/output-deploy-l2-contracts.toml",

zkstack_cli/crates/config/src/forge_interface/script_params.rs

@@ -11,6 +11,7 @@ abigen!(
     function baseTokenAssetId(uint256)(bytes32)
     function chainTypeManager(uint256)(address)
     function chainAssetHandler() external view returns (address)
+    function owner()(address)
 ]"
 );
 

zkstack_cli/crates/zkstack/src/abi.rs

@@ -152,16 +152,25 @@ pub async fn make_permanent_rollup(
 pub async fn governance_execute_calls(
     shell: &Shell,
     ecosystem_config: &EcosystemConfig,
-    governor: &Wallet,
+    mode: AdminScriptMode,
     encoded_calls: Vec<u8>,
     forge_args: &ForgeScriptArgs,
     l1_rpc_url: String,
-) -> anyhow::Result<()> {
+    governance_address: Option<Address>,
+) -> anyhow::Result<AdminScriptOutput> {
     // resume doesn't properly work here.
     let mut forge_args = forge_args.clone();
     forge_args.resume = false;
 
-    let governance_address = ecosystem_config.get_contracts_config()?.l1.governance_addr;
+    let governance_address = match governance_address {
+        Some(addr) => addr,
+        None => {
+            let cfg = ecosystem_config
+                .get_contracts_config()
+                .context("Failed to fetch contracts config to resolve governance address")?;
+            cfg.l1.governance_addr
+        }
+    };
 
     let calldata = ADMIN_FUNCTIONS
         .encode(
@@ -177,9 +186,25 @@ pub async fn governance_execute_calls(
         )
         .with_ffi()
         .with_rpc_url(l1_rpc_url)
-        .with_broadcast()
         .with_calldata(&calldata);
-    accept_ownership(shell, governor, forge).await
+
+    let description = "executing governance calls";
+    let (forge, spinner_text) = match mode {
+        AdminScriptMode::OnlySave => (forge, format!("Preparing calldata for {description}")),
+        AdminScriptMode::Broadcast(wallet) => {
+            let forge = forge.with_broadcast();
+            let forge = fill_forge_private_key(forge, Some(&wallet), WalletOwner::Governor)?;
+            check_the_balance(&forge).await?;
+            (forge, format!("Executing {description}"))
+        }
+    };
+
+    let spinner = Spinner::new(&spinner_text);
+    forge.run(shell)?;
+    spinner.finish();
+
+    let output_path = ACCEPT_GOVERNANCE_SCRIPT_PARAMS.output(&foundry_contracts_path);
+    Ok(AdminScriptOutputInner::read(shell, output_path)?.into())
 }
 
 #[allow(clippy::too_many_arguments)]
@@ -369,6 +394,7 @@ async fn accept_ownership(
     Ok(())
 }
 
+#[derive(Clone)]
 pub enum AdminScriptMode {
     OnlySave,
     Broadcast(Wallet),