fix: clean comments

Author: uniyalabhishek

cmd/common/helpers.go

@@ -121,29 +121,26 @@ type AddressFormatContext struct {
 	// Names maps native address string to account name.
 	Names types.AccountNames
 	// Eth maps native address string to Ethereum hex address string, if known.
-	// This is optional metadata coming from wallet/addressbook/test accounts (and never derived from chain state).
 	Eth map[string]string
 }
 
 // GenAccountEthMap generates a map of native address string -> eth hex address (if known).
+// Priority order matches GenAccountNames: test accounts < addressbook < wallet.
 func GenAccountEthMap() map[string]string {
 	eth := make(map[string]string)
 
-	// From test accounts.
 	for _, acc := range testing.TestAccounts {
 		if acc.EthAddress != nil {
 			eth[acc.Address.String()] = acc.EthAddress.Hex()
 		}
 	}
 
-	// From address book entries (higher priority than test accounts).
 	for _, acc := range config.Global().AddressBook.All {
 		if ethAddr := acc.GetEthAddress(); ethAddr != nil {
 			eth[acc.GetAddress().String()] = ethAddr.Hex()
 		}
 	}
 
-	// From wallet entries (highest priority), when an Ethereum address is available in config.
 	for _, acc := range config.Global().Wallet.All {
 		if ethAddr := acc.GetEthAddress(); ethAddr != nil {
 			eth[acc.GetAddress().String()] = ethAddr.Hex()
@@ -161,29 +158,22 @@ func GenAddressFormatContext() AddressFormatContext {
 	}
 }
 
-// PrettyAddressWith formats an address using a precomputed context.
-// If the address is known (in wallet, addressbook, or test accounts), it returns "name (address)".
-// For secp256k1 accounts with a known Ethereum address, the Ethereum hex format is preferred in parentheses.
-// If the address is unknown, it returns the original address string unchanged.
+// PrettyAddressWith formats a string address for display using a precomputed context.
+// Known addresses return "name (preferred_addr)", unknown addresses return the input unchanged.
 func PrettyAddressWith(ctx AddressFormatContext, addr string) string {
-	// Try to parse the address to get canonical native form.
 	nativeAddr, ethFromInput, err := helpers.ResolveEthOrOasisAddress(addr)
 	if err != nil || nativeAddr == nil {
-		// Cannot parse, return unchanged.
 		return addr
 	}
 
 	nativeStr := nativeAddr.String()
 
-	// Look up the name.
 	name := ctx.Names[nativeStr]
 	if name == "" {
-		// Unknown address, return the original input.
 		return addr
 	}
 
-	// Determine which address to show in parentheses.
-	// Prefer Ethereum address if available (from input or from known eth addresses).
+	// Prefer eth address in parentheses when available.
 	var parenAddr string
 	if ethFromInput != nil {
 		parenAddr = ethFromInput.Hex()
@@ -193,18 +183,14 @@ func PrettyAddressWith(ctx AddressFormatContext, addr string) string {
 		parenAddr = nativeStr
 	}
 
-	// Guard against redundant "name (name)" output.
 	if name == parenAddr {
 		return parenAddr
 	}
 
 	return fmt.Sprintf("%s (%s)", name, parenAddr)
 }
 
-// PrettyAddress formats an address for display without network context.
-// If the address is known (in wallet, addressbook, or test accounts), it returns "name (address)".
-// For secp256k1 accounts with a known Ethereum address, the Ethereum hex format is preferred in parentheses.
-// If the address is unknown, it returns the original address string unchanged.
+// PrettyAddress is like PrettyAddressWith but builds a fresh context on each call.
 func PrettyAddress(addr string) string {
 	return PrettyAddressWith(GenAddressFormatContext(), addr)
 }

cmd/common/json.go

@@ -155,8 +155,7 @@ func PrettyPrint(npa *NPASelection, prefix string, blob interface{}) string {
 	return PrettyPrintWithTxDetails(npa, prefix, blob, nil)
 }
 
-// PrettyPrintWithTxDetails is like PrettyPrint but also includes transaction-specific details in the
-// signature context (if the blob is a transaction pretty-printer).
+// PrettyPrintWithTxDetails is like PrettyPrint but passes txDetails to the signature context.
 func PrettyPrintWithTxDetails(npa *NPASelection, prefix string, blob interface{}, txDetails *signature.TxDetails) string {
 	ret := ""
 	switch rtx := blob.(type) {

cmd/common/transaction.go

@@ -366,8 +366,7 @@ func PrintTransactionRaw(npa *NPASelection, tx interface{}) {
 	PrintTransactionRawWithTxDetails(npa, tx, nil)
 }
 
-// PrintTransactionRawWithTxDetails prints the transaction which can be either signed or unsigned,
-// and also provides transaction-specific details to the pretty-printer when applicable.
+// PrintTransactionRawWithTxDetails is like PrintTransactionRaw but passes txDetails to the pretty-printer.
 func PrintTransactionRawWithTxDetails(npa *NPASelection, tx interface{}, txDetails *signature.TxDetails) {
 	switch tx.(type) {
 	case consensusPretty.PrettyPrinter:
@@ -383,8 +382,7 @@ func PrintTransaction(npa *NPASelection, tx interface{}) {
 	PrintTransactionWithTxDetails(npa, tx, nil)
 }
 
-// PrintTransactionWithTxDetails is like PrintTransaction but also provides transaction-specific
-// details to the pretty-printer when applicable.
+// PrintTransactionWithTxDetails is like PrintTransaction but passes txDetails to the pretty-printer.
 func PrintTransactionWithTxDetails(npa *NPASelection, tx interface{}, txDetails *signature.TxDetails) {
 	PrintTransactionRawWithTxDetails(npa, tx, txDetails)
 

cmd/common/wallet.go

@@ -130,8 +130,7 @@ func LoadAccount(cfg *config.Config, name string) wallet.Account {
 	acc, err := cfg.Wallet.Load(name, passphrase)
 	cobra.CheckErr(err)
 
-	// Persist Ethereum address metadata (if available) so other commands can prefer it without
-	// needing to unlock/load the account again. This is best-effort and should never fail the command.
+	// Persist eth address on unlock so future commands can show it without unlocking again.
 	if accCfg, ok := cfg.Wallet.All[name]; ok && accCfg.EthAddress == "" {
 		if ethAddr := acc.EthAddress(); ethAddr != nil {
 			accCfg.EthAddress = ethAddr.Hex()

cmd/rofl/list.go

@@ -88,7 +88,6 @@ func outputAppsText(network *config.Network, apps []*rofl.AppConfig) {
 		// Extract version from metadata.
 		version := app.Metadata["net.oasis.rofl.version"]
 
-		// Format admin address with pretty formatting.
 		var admin string
 		if app.Admin != nil {
 			admin = common.PrettyAddress(app.Admin.String())

cmd/rofl/provider/show.go

@@ -92,7 +92,6 @@ func outputProviderText(npa *common.NPASelection, provider *roflmarket.Provider,
 	fmt.Println("=== Basic Information ===")
 	fmt.Printf("Scheduler App:    %s\n", provider.SchedulerApp)
 
-	// Payment address with pretty formatting.
 	var paymentAddr string
 	switch {
 	case provider.PaymentAddress.Native != nil:

config/wallet.go

@@ -83,7 +83,7 @@ func (w *Wallet) Create(name string, passphrase string, nw *Account) error {
 	}
 	nw.Address = string(address)
 
-	// Store Ethereum address (if any) so we don't need to unlock/load the account later just to show it.
+	// Store eth address so wallet list can show it without unlocking.
 	if ethAddr := acc.EthAddress(); ethAddr != nil {
 		nw.EthAddress = ethAddr.Hex()
 	}
@@ -227,7 +227,7 @@ func (w *Wallet) Import(name string, passphrase string, nw *Account, src *wallet
 	}
 	nw.Address = string(address)
 
-	// Store Ethereum address (if any) so we don't need to unlock/load the account later just to show it.
+	// Store eth address (same as Create).
 	if ethAddr := acc.EthAddress(); ethAddr != nil {
 		nw.EthAddress = ethAddr.Hex()
 	}