fix: export chainInfo into outputs artifacts (#248)

<!-- 
    🚨 ATTENTION! 🚨 
    
This PR template is REQUIRED. PRs not following this format will be
closed without review.
    
    Requirements:
- PR title must follow commit conventions:
https://www.conventionalcommits.org/en/v1.0.0/
- Label your PR with the correct type (e.g., 🐛 Bug, ✨ Enhancement, 🧪
Test, etc.)
    - Provide clear and specific details in each section
-->

**Motivation:**
<!--
Explain here the context, and why you're making that change. What is the
problem you're trying to solve.
-->
As a devkit developer, I want consolidated outputs containing all
information I would need to import into my app space, so that I do not
need to pull details from multiple sources.

**Modifications:**
<!--
Describe the modifications you've done from a high level. What are the
key technical decisions and why were they made?
-->
- Exports `chainInfo` into L1/L2 deployment outputs

**Result:**
<!--
*After your change, what will change.
-->
- Able to import contracts address, abi and chainId from a single output

**Testing:**
<!--
*List testing procedures taken and useful artifacts.
-->
- Tested against `hotdog-havoc`

Author: grezle

pkg/commands/deploy_actions.go

@@ -9,6 +9,7 @@ import (
 	"math/big"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"time"
 
@@ -34,9 +35,14 @@ type DeployContractTransport struct {
 }
 
 type DeployContractJson struct {
-	Name    string      `json:"name"`
-	Address string      `json:"address"`
-	ABI     interface{} `json:"abi"`
+	Name      string      `json:"name"`
+	Address   string      `json:"address"`
+	ABI       interface{} `json:"abi"`
+	ChainInfo ChainInfo   `json:"chainInfo"`
+}
+
+type ChainInfo struct {
+	ChainId int64 `json:"chainId"`
 }
 
 func StartDeployL1Action(cCtx *cli.Context) error {
@@ -409,7 +415,14 @@ func DeployL1ContractsAction(cCtx *cli.Context) error {
 	if err := contracts.Decode(&contractsList); err != nil {
 		return fmt.Errorf("decode deployed_l1_contracts: %w", err)
 	}
-	err = extractContractOutputs(cCtx, contextName, contractsList)
+	// Get the chainId
+	chainId := common.GetChildByKey(contextNode, "chains.l1.chain_id")
+	if chainId == nil {
+		return fmt.Errorf("chains.l1.chain_id node not found")
+	}
+	// Title line to split these logs from the main body for easy identification
+	logger.Title("Save L1 contract artifacts")
+	err = extractContractOutputs(cCtx, contextName, contractsList, chainId.Value)
 	if err != nil {
 		return fmt.Errorf("failed to write l1 contract artefacts: %w", err)
 	}
@@ -515,9 +528,14 @@ func DeployL2ContractsAction(cCtx *cli.Context) error {
 	if err := contracts.Decode(&contractsList); err != nil {
 		return fmt.Errorf("decode deployed_l2_contracts: %w", err)
 	}
-	// Empty log line to split these logs from the main body for easy identification
-	logger.Title("Save l2 contract artifacts")
-	err = extractContractOutputs(cCtx, contextName, contractsList)
+	// Get the chainId
+	chainId := common.GetChildByKey(contextNode, "chains.l2.chain_id")
+	if chainId == nil {
+		return fmt.Errorf("chains.l2.chain_id node not found")
+	}
+	// Title line to split these logs from the main body for easy identification
+	logger.Title("Save L2 contract artifacts")
+	err = extractContractOutputs(cCtx, contextName, contractsList, chainId.Value)
 	if err != nil {
 		return fmt.Errorf("failed to write l2 contract artefacts: %w", err)
 	}
@@ -839,7 +857,7 @@ func FetchZeusAddressesAction(cCtx *cli.Context) error {
 	return nil
 }
 
-func extractContractOutputs(cCtx *cli.Context, context string, contractsList []DeployContractTransport) error {
+func extractContractOutputs(cCtx *cli.Context, context string, contractsList []DeployContractTransport, chainId string) error {
 	logger := common.LoggerFromContext(cCtx.Context)
 
 	// Push contract artefacts to ./contracts/outputs
@@ -848,6 +866,12 @@ func extractContractOutputs(cCtx *cli.Context, context string, contractsList []D
 		return fmt.Errorf("create output dir: %w", err)
 	}
 
+	// Convert chainId to int
+	chainIdInt, err := strconv.ParseInt(chainId, 10, 64)
+	if err != nil {
+		return fmt.Errorf("failed to convert chainId: %w", err)
+	}
+
 	// For each contract extract details and produce json file in outputs/<context>/<contract.name>.json
 	for _, contract := range contractsList {
 		nameVal := contract.Name
@@ -885,6 +909,9 @@ func extractContractOutputs(cCtx *cli.Context, context string, contractsList []D
 			Name:    nameVal,
 			Address: addressVal,
 			ABI:     abi.ABI,
+			ChainInfo: ChainInfo{
+				ChainId: chainIdInt,
+			},
 		}
 
 		// Marshal with indentation

pkg/common/yaml.go

@@ -163,17 +163,50 @@ func CleanYAML(v interface{}) interface{} {
 }
 
 // GetChildByKey returns the value node associated with the given key from a MappingNode
-func GetChildByKey(node *yaml.Node, key string) *yaml.Node {
-	if node == nil || node.Kind != yaml.MappingNode {
+func GetChildByKey(node *yaml.Node, path string) *yaml.Node {
+	if node == nil {
 		return nil
 	}
-	for i := 0; i < len(node.Content); i += 2 {
-		k := node.Content[i]
-		if k.Value == key {
-			return node.Content[i+1]
+	currNode := node
+	for _, seg := range strings.Split(path, ".") {
+		// map lookup part before any index
+		key, segIdx := seg, -1
+		if idx := strings.Index(seg, "["); idx >= 0 {
+			key = seg[:idx]
+			closeIdxOffset := strings.Index(seg[idx:], "]")
+			if closeIdxOffset <= 1 {
+				return nil
+			}
+			idxVal, err := strconv.Atoi(seg[idx+1 : idx+closeIdxOffset])
+			if err != nil {
+				return nil
+			}
+			segIdx = idxVal
+		}
+		if key != "" {
+			if currNode.Kind != yaml.MappingNode {
+				return nil
+			}
+			found := false
+			for idx := 0; idx+1 < len(currNode.Content); idx += 2 {
+				if currNode.Content[idx].Value == key {
+					currNode = currNode.Content[idx+1]
+					found = true
+					break
+				}
+			}
+			if !found {
+				return nil
+			}
+		}
+		if segIdx >= 0 {
+			if currNode.Kind != yaml.SequenceNode || segIdx < 0 || segIdx >= len(currNode.Content) {
+				return nil
+			}
+			currNode = currNode.Content[segIdx]
 		}
 	}
-	return nil
+	return currNode
 }
 
 // CloneNode performs a deep copy of a *yaml.Node, including its content and comments