Modernizes the CRE CLI's user interface by integrating the Charm ecosystem

cmd/account/link_key/link_key.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"io"
 	"math/big"
-	"os"
 	"strconv"
 	"strings"
 	"sync"
@@ -26,10 +25,10 @@ import (
 	"github.com/smartcontractkit/cre-cli/internal/constants"
 	"github.com/smartcontractkit/cre-cli/internal/credentials"
 	"github.com/smartcontractkit/cre-cli/internal/environments"
-	"github.com/smartcontractkit/cre-cli/internal/prompt"
 	"github.com/smartcontractkit/cre-cli/internal/runtime"
 	"github.com/smartcontractkit/cre-cli/internal/settings"
 	"github.com/smartcontractkit/cre-cli/internal/types"
+	"github.com/smartcontractkit/cre-cli/internal/ui"
 	"github.com/smartcontractkit/cre-cli/internal/validation"
 )
 
@@ -59,7 +58,7 @@ type initiateLinkingResponse struct {
 }
 
 func Exec(ctx *runtime.Context, in Inputs) error {
-	h := newHandler(ctx, os.Stdin)
+	h := newHandler(ctx, nil)
 
 	if err := h.ValidateInputs(in); err != nil {
 		return err
@@ -161,12 +160,11 @@ func (h *handler) Execute(in Inputs) error {
 	h.displayDetails()
 
 	if in.WorkflowOwnerLabel == "" {
-		if err := prompt.SimplePrompt(h.stdin, "Provide a label for your owner address", func(inputLabel string) error {
-			in.WorkflowOwnerLabel = inputLabel
-			return nil
-		}); err != nil {
+		label, err := ui.Input("Provide a label for your owner address")
+		if err != nil {
 			return err
 		}
+		in.WorkflowOwnerLabel = label
 	}
 
 	h.wg.Wait()
@@ -182,7 +180,7 @@ func (h *handler) Execute(in Inputs) error {
 		return nil
 	}
 
-	fmt.Printf("Starting linking: owner=%s, label=%s\n", in.WorkflowOwner, in.WorkflowOwnerLabel)
+	ui.Dim(fmt.Sprintf("Starting linking: owner=%s, label=%s", in.WorkflowOwner, in.WorkflowOwnerLabel))
 
 	resp, err := h.callInitiateLinking(context.Background(), in)
 	if err != nil {
@@ -198,7 +196,7 @@ func (h *handler) Execute(in Inputs) error {
 	h.log.Debug().Msg("\nRaw linking response payload:\n\n" + string(prettyResp))
 
 	if in.WorkflowRegistryContractAddress == resp.ContractAddress {
-		fmt.Println("Contract address validation passed")
+		ui.Success("Contract address validation passed")
 	} else {
 		h.log.Warn().Msg("The workflowRegistryContractAddress in your settings does not match the one returned by the server")
 		return fmt.Errorf("contract address validation failed")
@@ -299,11 +297,14 @@ func (h *handler) linkOwner(resp initiateLinkingResponse) error {
 
 	switch txOut.Type {
 	case client.Regular:
-		fmt.Println("Transaction confirmed")
-		fmt.Printf("View on explorer: \033]8;;%s/tx/%s\033\\%s/tx/%s\033]8;;\033\\\n", h.environmentSet.WorkflowRegistryChainExplorerURL, txOut.Hash, h.environmentSet.WorkflowRegistryChainExplorerURL, txOut.Hash)
-		fmt.Println("\n[OK] web3 address linked to your CRE organization successfully")
-		fmt.Println("\nNote: Linking verification may take up to 60 seconds.")
-		fmt.Println("\n→ You can now deploy workflows using this address")
+		ui.Success("Transaction confirmed")
+		ui.URL(fmt.Sprintf("%s/tx/%s", h.environmentSet.WorkflowRegistryChainExplorerURL, txOut.Hash))
+		ui.Line()
+		ui.Success("web3 address linked to your CRE organization successfully")
+		ui.Line()
+		ui.Dim("Note: Linking verification may take up to 60 seconds.")
+		ui.Line()
+		ui.Bold("You can now deploy workflows using this address")
 
 	case client.Raw:
 		selector, err := strconv.ParseUint(resp.ChainSelector, 10, 64)
@@ -317,19 +318,19 @@ func (h *handler) linkOwner(resp initiateLinkingResponse) error {
 			return err
 		}
 
-		fmt.Println("")
-		fmt.Println("Ownership linking initialized successfully!")
-		fmt.Println("")
-		fmt.Println("Next steps:")
-		fmt.Println("")
-		fmt.Println("   1. Submit the following transaction on the target chain:")
-		fmt.Printf("      Chain:            %s\n", ChainName)
-		fmt.Printf("      Contract Address: %s\n", txOut.RawTx.To)
-		fmt.Println("")
-		fmt.Println("   2. Use the following transaction data:")
-		fmt.Println("")
-		fmt.Printf("      %x\n", txOut.RawTx.Data)
-		fmt.Println("")
+		ui.Line()
+		ui.Success("Ownership linking initialized successfully!")
+		ui.Line()
+		ui.Bold("Next steps:")
+		ui.Line()
+		ui.Print("   1. Submit the following transaction on the target chain:")
+		ui.Dim(fmt.Sprintf("      Chain:            %s", ChainName))
+		ui.Dim(fmt.Sprintf("      Contract Address: %s", txOut.RawTx.To))
+		ui.Line()
+		ui.Print("   2. Use the following transaction data:")
+		ui.Line()
+		ui.Code(fmt.Sprintf("      %x", txOut.RawTx.Data))
+		ui.Line()
 
 	case client.Changeset:
 		chainSelector, err := settings.GetChainSelectorByChainName(h.environmentSet.WorkflowRegistryChainName)
@@ -338,7 +339,7 @@ func (h *handler) linkOwner(resp initiateLinkingResponse) error {
 		}
 		mcmsConfig, err := settings.GetMCMSConfig(h.settings, chainSelector)
 		if err != nil {
-			fmt.Println("\nMCMS config not found or is incorrect, skipping MCMS config in changeset")
+			ui.Warning("MCMS config not found or is incorrect, skipping MCMS config in changeset")
 		}
 		cldSettings := h.settings.CLDSettings
 		changesets := []types.Changeset{
@@ -370,30 +371,32 @@ func (h *handler) linkOwner(resp initiateLinkingResponse) error {
 		h.log.Warn().Msgf("Unsupported transaction type: %s", txOut.Type)
 	}
 
-	fmt.Println("Linked successfully")
+	ui.Success("Linked successfully")
 	return nil
 }
 
 func (h *handler) checkIfAlreadyLinked() (bool, error) {
 	ownerAddr := common.HexToAddress(h.settings.Workflow.UserWorkflowSettings.WorkflowOwnerAddress)
-	fmt.Println("\nChecking existing registrations...")
+	ui.Dim("Checking existing registrations...")
 
 	linked, err := h.wrc.IsOwnerLinked(ownerAddr)
 	if err != nil {
 		return false, fmt.Errorf("failed to check owner link status: %w", err)
 	}
 
 	if linked {
-		fmt.Println("web3 address already linked")
+		ui.Success("web3 address already linked")
 		return true, nil
 	}
 
-	fmt.Println("✓ No existing link found for this address")
+	ui.Success("No existing link found for this address")
 	return false, nil
 }
 
 func (h *handler) displayDetails() {
-	fmt.Println("Linking web3 key to your CRE organization")
-	fmt.Printf("Target : \t\t %s\n", h.settings.User.TargetName)
-	fmt.Printf("✔ Using Address : \t %s\n\n", h.settings.Workflow.UserWorkflowSettings.WorkflowOwnerAddress)
+	ui.Line()
+	ui.Title("Linking web3 key to your CRE organization")
+	ui.Dim(fmt.Sprintf("Target:        %s", h.settings.User.TargetName))
+	ui.Dim(fmt.Sprintf("Owner Address: %s", h.settings.Workflow.UserWorkflowSettings.WorkflowOwnerAddress))
+	ui.Line()
 }

cmd/account/list_key/list_key.go

@@ -13,6 +13,7 @@ import (
 	"github.com/smartcontractkit/cre-cli/internal/credentials"
 	"github.com/smartcontractkit/cre-cli/internal/environments"
 	"github.com/smartcontractkit/cre-cli/internal/runtime"
+	"github.com/smartcontractkit/cre-cli/internal/ui"
 )
 
 const queryListWorkflowOwners = `
@@ -88,6 +89,9 @@ type WorkflowOwner struct {
 }
 
 func (h *Handler) Execute(ctx context.Context) error {
+	spinner := ui.NewSpinner()
+	spinner.Start("Fetching workflow owners...")
+
 	req := graphql.NewRequest(queryListWorkflowOwners)
 
 	var respEnvelope struct {
@@ -97,32 +101,34 @@ func (h *Handler) Execute(ctx context.Context) error {
 	}
 
 	if err := h.client.Execute(ctx, req, &respEnvelope); err != nil {
+		spinner.Stop()
 		return fmt.Errorf("fetch workflow owners failed: %w", err)
 	}
 
-	fmt.Println("\nWorkflow owners retrieved successfully:")
+	spinner.Stop()
+	ui.Success("Workflow owners retrieved successfully")
 	h.logOwners("Linked Owners", respEnvelope.ListWorkflowOwners.LinkedOwners)
 
 	return nil
 }
 
 func (h *Handler) logOwners(label string, owners []WorkflowOwner) {
-	fmt.Println("")
+	ui.Line()
 	if len(owners) == 0 {
-		fmt.Printf("  No %s found\n", strings.ToLower(label))
+		ui.Warning(fmt.Sprintf("No %s found", strings.ToLower(label)))
 		return
 	}
 
-	fmt.Printf("%s:\n", label)
-	fmt.Println("")
+	ui.Title(label)
+	ui.Line()
 
 	for i, o := range owners {
-		fmt.Printf("  %d. %s\n", i+1, o.WorkflowOwnerLabel)
-		fmt.Printf("     Owner Address:    \t%s\n", o.WorkflowOwnerAddress)
-		fmt.Printf("     Status:          \t%s\n", o.VerificationStatus)
-		fmt.Printf("     Verified At:     \t%s\n", o.VerifiedAt)
-		fmt.Printf("     Chain Selector:  \t%s\n", o.ChainSelector)
-		fmt.Printf("     Contract Address:\t%s\n", o.ContractAddress)
-		fmt.Println("")
+		ui.Bold(fmt.Sprintf("%d. %s", i+1, o.WorkflowOwnerLabel))
+		ui.Dim(fmt.Sprintf("   Owner Address:     %s", o.WorkflowOwnerAddress))
+		ui.Dim(fmt.Sprintf("   Status:            %s", o.VerificationStatus))
+		ui.Dim(fmt.Sprintf("   Verified At:       %s", o.VerifiedAt))
+		ui.Dim(fmt.Sprintf("   Chain Selector:    %s", o.ChainSelector))
+		ui.Dim(fmt.Sprintf("   Contract Address:  %s", o.ContractAddress))
+		ui.Line()
 	}
 }

cmd/account/unlink_key/unlink_key.go

@@ -24,10 +24,10 @@ import (
 	"github.com/smartcontractkit/cre-cli/internal/client/graphqlclient"
 	"github.com/smartcontractkit/cre-cli/internal/credentials"
 	"github.com/smartcontractkit/cre-cli/internal/environments"
-	"github.com/smartcontractkit/cre-cli/internal/prompt"
 	"github.com/smartcontractkit/cre-cli/internal/runtime"
 	"github.com/smartcontractkit/cre-cli/internal/settings"
 	"github.com/smartcontractkit/cre-cli/internal/types"
+	"github.com/smartcontractkit/cre-cli/internal/ui"
 	"github.com/smartcontractkit/cre-cli/internal/validation"
 )
 
@@ -142,7 +142,7 @@ func (h *handler) Execute(in Inputs) error {
 
 	h.displayDetails()
 
-	fmt.Printf("Starting unlinking: owner=%s\n", in.WorkflowOwner)
+	ui.Dim(fmt.Sprintf("Starting unlinking: owner=%s", in.WorkflowOwner))
 
 	h.wg.Wait()
 	if h.wrcErr != nil {
@@ -154,20 +154,19 @@ func (h *handler) Execute(in Inputs) error {
 		return err
 	}
 	if !linked {
-		fmt.Println("Your web3 address is not linked, nothing to do")
+		ui.Warning("Your web3 address is not linked, nothing to do")
 		return nil
 	}
 
 	// Check if confirmation should be skipped
 	if !in.SkipConfirmation {
-		deleteWorkflows, err := prompt.YesNoPrompt(
-			h.stdin,
-			"! Warning: Unlink is a destructive action that will wipe out all workflows registered under your owner address. Do you wish to proceed?",
-		)
+		ui.Warning("Unlink is a destructive action that will wipe out all workflows registered under your owner address.")
+		ui.Line()
+		confirm, err := ui.Confirm("Do you wish to proceed?")
 		if err != nil {
 			return err
 		}
-		if !deleteWorkflows {
+		if !confirm {
 			return fmt.Errorf("unlinking aborted by user")
 		}
 	}
@@ -186,7 +185,7 @@ func (h *handler) Execute(in Inputs) error {
 	h.log.Debug().Msg("\nRaw linking response payload:\n\n" + string(prettyResp))
 
 	if in.WorkflowRegistryContractAddress == resp.ContractAddress {
-		fmt.Println("Contract address validation passed")
+		ui.Success("Contract address validation passed")
 	} else {
 		return fmt.Errorf("contract address validation failed")
 	}
@@ -256,12 +255,15 @@ func (h *handler) unlinkOwner(owner string, resp initiateUnlinkingResponse) erro
 
 	switch txOut.Type {
 	case client.Regular:
-		fmt.Println("Transaction confirmed")
-		fmt.Printf("View on explorer: \033]8;;%s/tx/%s\033\\%s/tx/%s\033]8;;\033\\\n", h.environmentSet.WorkflowRegistryChainExplorerURL, txOut.Hash, h.environmentSet.WorkflowRegistryChainExplorerURL, txOut.Hash)
-		fmt.Println("\n[OK] web3 address unlinked from your CRE organization successfully")
-		fmt.Println("\nNote: Unlinking verification may take up to 60 seconds.")
-		fmt.Println("      You must wait for verification to complete before linking this address again.")
-		fmt.Println("\n→ This address can no longer deploy workflows on behalf of your organization")
+		ui.Success("Transaction confirmed")
+		ui.URL(fmt.Sprintf("%s/tx/%s", h.environmentSet.WorkflowRegistryChainExplorerURL, txOut.Hash))
+		ui.Line()
+		ui.Success("web3 address unlinked from your CRE organization successfully")
+		ui.Line()
+		ui.Dim("Note: Unlinking verification may take up to 60 seconds.")
+		ui.Dim("      You must wait for verification to complete before linking this address again.")
+		ui.Line()
+		ui.Bold("This address can no longer deploy workflows on behalf of your organization")
 
 	case client.Raw:
 		selector, err := strconv.ParseUint(resp.ChainSelector, 10, 64)
@@ -275,20 +277,19 @@ func (h *handler) unlinkOwner(owner string, resp initiateUnlinkingResponse) erro
 			return err
 		}
 
-		fmt.Println("")
-		fmt.Println("Ownership unlinking initialized successfully!")
-		fmt.Println("")
-		fmt.Println("Next steps:")
-		fmt.Println("")
-		fmt.Println("   1. Submit the following transaction on the target chain:")
-		fmt.Println("")
-		fmt.Printf("      Chain:            %s\n", ChainName)
-		fmt.Printf("      Contract Address: %s\n", resp.ContractAddress)
-		fmt.Println("")
-		fmt.Println("   2. Use the following transaction data:")
-		fmt.Println("")
-		fmt.Printf("      %s\n", resp.TransactionData)
-		fmt.Println("")
+		ui.Line()
+		ui.Success("Ownership unlinking initialized successfully!")
+		ui.Line()
+		ui.Bold("Next steps:")
+		ui.Line()
+		ui.Print("   1. Submit the following transaction on the target chain:")
+		ui.Dim(fmt.Sprintf("      Chain:            %s", ChainName))
+		ui.Dim(fmt.Sprintf("      Contract Address: %s", resp.ContractAddress))
+		ui.Line()
+		ui.Print("   2. Use the following transaction data:")
+		ui.Line()
+		ui.Code(fmt.Sprintf("      %s", resp.TransactionData))
+		ui.Line()
 
 	case client.Changeset:
 		chainSelector, err := settings.GetChainSelectorByChainName(h.environmentSet.WorkflowRegistryChainName)
@@ -297,7 +298,7 @@ func (h *handler) unlinkOwner(owner string, resp initiateUnlinkingResponse) erro
 		}
 		mcmsConfig, err := settings.GetMCMSConfig(h.settings, chainSelector)
 		if err != nil {
-			fmt.Println("\nMCMS config not found or is incorrect, skipping MCMS config in changeset")
+			ui.Warning("MCMS config not found or is incorrect, skipping MCMS config in changeset")
 		}
 		cldSettings := h.settings.CLDSettings
 		changesets := []types.Changeset{
@@ -328,7 +329,7 @@ func (h *handler) unlinkOwner(owner string, resp initiateUnlinkingResponse) erro
 		h.log.Warn().Msgf("Unsupported transaction type: %s", txOut.Type)
 	}
 
-	fmt.Println("Unlinked successfully")
+	ui.Success("Unlinked successfully")
 	return nil
 }
 
@@ -344,7 +345,9 @@ func (h *handler) checkIfAlreadyLinked() (bool, error) {
 }
 
 func (h *handler) displayDetails() {
-	fmt.Println("Unlinking web3 key from your CRE organization")
-	fmt.Printf("Target : \t\t %s\n", h.settings.User.TargetName)
-	fmt.Printf("✔ Using Address : \t %s\n\n", h.settings.Workflow.UserWorkflowSettings.WorkflowOwnerAddress)
+	ui.Line()
+	ui.Title("Unlinking web3 key from your CRE organization")
+	ui.Dim(fmt.Sprintf("Target:        %s", h.settings.User.TargetName))
+	ui.Dim(fmt.Sprintf("Owner Address: %s", h.settings.Workflow.UserWorkflowSettings.WorkflowOwnerAddress))
+	ui.Line()
 }