fix(cli): make native token required in chain config (#3944)

### Description
- addresses P1 in
https://www.notion.so/hyperlanexyz/CLI-Bug-Bash-5fc0833e51034baeba3beba9319160ff?pvs=4
- NOTE: Mimicking this behaviour:
https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/typescript/cli/src/utils/balances.ts#L23

- fixes https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/4008

#### TODO:
- Once merged, this section of the quickstart guide should be removed:
https://www.notion.so/hyperlanexyz/Hyperlane-Quickstart-Beta-4d9ff48720ee43fa8456a7d1517098dd?pvs=4#15534475fd8d4b398e51e9e0d527fb48
  - cc @avious00

typescript/cli/src/config/chain.ts

@@ -88,28 +88,51 @@ export async function createChainConfig({
     rpcUrls: [{ http: rpcUrl }],
   };
 
-  const wantAdvancedConfig = await confirm({
+  await addBlockOrGasConfig(metadata);
+
+  await addNativeTokenConfig(metadata);
+
+  const parseResult = ChainMetadataSchema.safeParse(metadata);
+  if (parseResult.success) {
+    logGreen(`Chain config is valid, writing to registry`);
+    await context.registry.updateChain({ chainName: metadata.name, metadata });
+  } else {
+    errorRed(
+      `Chain config is invalid, please see https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/typescript/cli/examples/chain-config.yaml for an example`,
+    );
+    errorRed(JSON.stringify(parseResult.error.errors));
+    throw new Error('Invalid chain config');
+  }
+}
+
+async function addBlockOrGasConfig(metadata: ChainMetadata): Promise<void> {
+  const wantBlockOrGasConfig = await confirm({
     default: false,
-    message:
-      'Do you want to set block or gas properties for this chain config?',
+    message: 'Do you want to set block or gas properties for this chain config',
   });
-  if (wantAdvancedConfig) {
+  if (wantBlockOrGasConfig) {
+    await addBlockConfig(metadata);
+    await addGasConfig(metadata);
+  }
+}
+
+async function addBlockConfig(metadata: ChainMetadata): Promise<void> {
   const wantBlockConfig = await confirm({
-      message: 'Do you want to add block config for this chain?',
+    message: 'Do you want to add block config for this chain',
   });
   if (wantBlockConfig) {
     const blockConfirmation = await input({
       message:
-          'Enter no. of blocks to wait before considering a transaction confirmed(0-500)',
+        'Enter no. of blocks to wait before considering a transaction confirmed (0-500):',
       validate: (value) => parseInt(value) >= 0 && parseInt(value) <= 500,
     });
     const blockReorgPeriod = await input({
       message:
-          'Enter no. of blocks before a transaction has a near-zero chance of reverting(0-500)',
+        'Enter no. of blocks before a transaction has a near-zero chance of reverting (0-500):',
       validate: (value) => parseInt(value) >= 0 && parseInt(value) <= 500,
     });
     const blockTimeEstimate = await input({
-        message: 'Enter the rough estimate of time per block in seconds(0-20)',
+      message: 'Enter the rough estimate of time per block in seconds (0-20):',
       validate: (value) => parseInt(value) >= 0 && parseInt(value) <= 20,
     });
     metadata.blocks = {
@@ -118,19 +141,22 @@ export async function createChainConfig({
       estimateBlockTime: parseInt(blockTimeEstimate, 10),
     };
   }
+}
+
+async function addGasConfig(metadata: ChainMetadata): Promise<void> {
   const wantGasConfig = await confirm({
-      message: 'Do you want to add gas config for this chain?',
+    message: 'Do you want to add gas config for this chain',
   });
   if (wantGasConfig) {
     const isEIP1559 = await confirm({
-        message: 'Is your chain an EIP1559 enabled?',
+      message: 'Is your chain an EIP1559 enabled',
     });
     if (isEIP1559) {
       const maxFeePerGas = await input({
-          message: 'Enter the max fee per gas in gwei',
+        message: 'Enter the max fee per gas (gwei):',
       });
       const maxPriorityFeePerGas = await input({
-          message: 'Enter the max priority fee per gas in gwei',
+        message: 'Enter the max priority fee per gas (gwei):',
       });
       metadata.transactionOverrides = {
         maxFeePerGas: BigInt(maxFeePerGas) * BigInt(10 ** 9),
@@ -138,7 +164,7 @@ export async function createChainConfig({
       };
     } else {
       const gasPrice = await input({
-          message: 'Enter the gas price in gwei',
+        message: 'Enter the gas price (gwei):',
       });
       metadata.transactionOverrides = {
         gasPrice: BigInt(gasPrice) * BigInt(10 ** 9),
@@ -146,15 +172,29 @@ export async function createChainConfig({
     }
   }
 }
-  const parseResult = ChainMetadataSchema.safeParse(metadata);
-  if (parseResult.success) {
-    logGreen(`Chain config is valid, writing to registry`);
-    await context.registry.updateChain({ chainName: metadata.name, metadata });
-  } else {
-    errorRed(
-      `Chain config is invalid, please see https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/typescript/cli/examples/chain-config.yaml for an example`,
-    );
-    errorRed(JSON.stringify(parseResult.error.errors));
-    throw new Error('Invalid chain config');
+
+async function addNativeTokenConfig(metadata: ChainMetadata): Promise<void> {
+  const wantNativeConfig = await confirm({
+    default: false,
+    message:
+      'Do you want to set native token properties for this chain config (defaults to ETH)',
+  });
+  let symbol, name, decimals;
+  if (wantNativeConfig) {
+    symbol = await input({
+      message: "Enter the native token's symbol:",
+    });
+    name = await input({
+      message: `Enter the native token's name:`,
+    });
+    decimals = await input({
+      message: "Enter the native token's decimals:",
+    });
   }
+
+  metadata.nativeToken = {
+    symbol: symbol ?? 'ETH',
+    name: name ?? 'Ether',
+    decimals: decimals ? parseInt(decimals, 10) : 18,
+  };
 }

typescript/cli/src/deploy/utils.ts

@@ -132,7 +132,7 @@ export async function completeDeploy(
       `\t- Gas required for ${command} ${
         isDryRun ? 'dry-run' : 'deploy'
       } on ${chain}: ${ethers.utils.formatEther(balanceDelta)} ${
-        multiProvider.getChainMetadata(chain).nativeToken?.symbol
+        multiProvider.getChainMetadata(chain).nativeToken?.symbol ?? 'ETH'
       }`,
     );
   }