chore: add comments to clarify deployment steps in migration scripts

Author: YukiTsuchida

scripts/migrate.sh

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
+# --- Config ---
 PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
 SCRIPTS_DIR="$PROJECT_ROOT/scripts/migrate"
 BROADCAST_DIR="$PROJECT_ROOT/broadcast"
@@ -15,12 +16,14 @@ CAST="npx -y -p @foundry-rs/forge cast"
 : "${MNEMONIC:=math razor capable expose worth grape metal sunset metal sudden usage scheme}"
 : "${PRIVATE_KEY:=$($CAST wallet private-key --mnemonic "$MNEMONIC" --mnemonic-index 0)}"
 
+# --- Helpers ---
 die() { echo "ERROR: $*" >&2; exit 1; }
 need() { command -v "$1" >/dev/null 2>&1 || die "missing command: $1"; }
 
 need jq
 need curl
 
+# --- Wait for node ---
 until curl -s "$RPC_URL" -H 'Content-Type: application/json' \
   -d '{"jsonrpc":"2.0","id":1,"method":"eth_blockNumber","params":[]}' >/dev/null; do
   sleep 0.3
@@ -29,6 +32,7 @@ done
 CHAIN_ID="$($CAST chain-id --rpc-url "$RPC_URL")"
 echo "RPC_URL=$RPC_URL CHAIN_ID=$CHAIN_ID"
 
+# --- Deploy libraries ---
 echo "==> Deploy libraries"
 LIB_COMMITMENT="$(
   $FORGE create "$LIB_COMMITMENT_SPEC" \
@@ -45,6 +49,7 @@ LIB_MSGS="$(
 echo "  IBCCommitment: $LIB_COMMITMENT"
 echo "  IBCMsgs      : $LIB_MSGS"
 
+# --- 001_DeployCore ---
 echo "==> 001_DeployCore"
 $FORGE script "$SCRIPTS_DIR/001_DeployCore.s.sol:DeployCore" \
   --rpc-url "$RPC_URL" --broadcast --private-key "$PRIVATE_KEY" \
@@ -58,6 +63,7 @@ IBC_HANDLER="$(jq -r '.transactions[] | select(.contractName=="OwnableIBCHandler
 [[ -n "$IBC_HANDLER" && "$IBC_HANDLER" != "null" ]] || die "failed to extract IBC_HANDLER"
 echo "  IBC_HANDLER: $IBC_HANDLER"
 
+# --- 002_DeployApp ---
 echo "==> 002_DeployApp"
 $FORGE script "$SCRIPTS_DIR/002_DeployApp.s.sol:DeployApp" \
   --rpc-url "$RPC_URL" --broadcast --private-key "$PRIVATE_KEY" \
@@ -76,6 +82,7 @@ echo "  MOCK_CLIENT        : $MOCK_CLIENT"
 PORT_CROSS="${PORT_CROSS:-cross}"
 MOCK_CLIENT_TYPE="${MOCK_CLIENT_TYPE:-mock-client}"
 
+# --- 003_Initialize ---
 echo "==> 003_Initialize"
 $FORGE script "$SCRIPTS_DIR/003_Initialize.s.sol:InitializeContracts" \
   --rpc-url "$RPC_URL" --broadcast --private-key "$PRIVATE_KEY" \

scripts/migrate/001_DeployCore.s.sol

@@ -13,6 +13,7 @@ contract DeployCore is Script {
     function run() external {
         vm.startBroadcast();
 
+        // --- Deploy dependent contracts ---
         IBCClient client = new IBCClient();
         console2.log("IBCClient:", address(client));