Denom symbol migration

Author: masihyeganeh

app/app.go

@@ -1185,6 +1185,7 @@ func New(
 		appupgradev6.New(
 			app.ModuleManager,
 			app.configurator,
+			app.BankKeeper,
 		),
 	}
 

app/upgrade/v6/denom_symbol.go

@@ -0,0 +1,51 @@
+package v6
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/CoreumFoundation/coreum/v6/pkg/config/constant"
+	wbankkeeper "github.com/CoreumFoundation/coreum/v6/x/wbank/keeper"
+)
+
+func migrateDenomSymbol(ctx context.Context, bankKeeper wbankkeeper.BaseKeeperWrapper) error {
+	var denom string
+	var newSymbol string
+
+	sdkCtx := sdk.UnwrapSDKContext(ctx)
+	switch sdkCtx.ChainID() {
+	case string(constant.ChainIDMain):
+		denom = constant.DenomMain
+		newSymbol = "TX"
+	case string(constant.ChainIDTest):
+		denom = constant.DenomTest
+		newSymbol = "TESTTX"
+	case string(constant.ChainIDDev):
+		denom = constant.DenomDev
+		newSymbol = "DEVTX"
+	default:
+		return fmt.Errorf("unknown chain id: %s", sdkCtx.ChainID())
+	}
+
+	meta, found := bankKeeper.GetDenomMetaData(ctx, denom)
+	if !found {
+		return fmt.Errorf("denom metadata not found for %s", denom)
+	}
+
+	meta.Display = strings.ToLower(newSymbol)
+	meta.Symbol = newSymbol
+
+	// Optionally adjust DenomUnits to reflect the new display name
+	for i := range meta.DenomUnits {
+		if meta.DenomUnits[i].Denom == strings.ToLower(meta.Display) || meta.DenomUnits[i].Exponent == 6 {
+			meta.DenomUnits[i].Denom = strings.ToLower(newSymbol)
+		}
+	}
+
+	bankKeeper.SetDenomMetaData(ctx, meta)
+
+	return nil
+}

app/upgrade/v6/upgrade.go

@@ -8,13 +8,14 @@ import (
 	"github.com/cosmos/cosmos-sdk/types/module"
 
 	"github.com/CoreumFoundation/coreum/v6/app/upgrade"
+	wbankkeeper "github.com/CoreumFoundation/coreum/v6/x/wbank/keeper"
 )
 
 // Name defines the upgrade name.
 const Name = "v6"
 
 // New makes an upgrade handler for v6 upgrade.
-func New(mm *module.Manager, configurator module.Configurator) upgrade.Upgrade {
+func New(mm *module.Manager, configurator module.Configurator, bankKeeper wbankkeeper.BaseKeeperWrapper) upgrade.Upgrade {
 	return upgrade.Upgrade{
 		Name: Name,
 		StoreUpgrades: store.StoreUpgrades{
@@ -26,6 +27,10 @@ func New(mm *module.Manager, configurator module.Configurator) upgrade.Upgrade {
 				return nil, err
 			}
 
+			if err := migrateDenomSymbol(ctx, bankKeeper); err != nil {
+				return nil, err
+			}
+
 			return vmap, nil
 		},
 	}

integration-tests/upgrade/denom_symbol.go

@@ -0,0 +1,59 @@
+//go:build integrationtests
+
+package upgrade
+
+import (
+	"strings"
+	"testing"
+
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	"github.com/stretchr/testify/require"
+
+	integrationtests "github.com/CoreumFoundation/coreum/v6/integration-tests"
+	"github.com/CoreumFoundation/coreum/v6/pkg/config/constant"
+)
+
+type denomSymbol struct {
+}
+
+func (d *denomSymbol) Before(t *testing.T) {
+	ctx, chain := integrationtests.NewCoreumTestingContext(t)
+	requireT := require.New(t)
+
+	client := banktypes.NewQueryClient(chain.ClientContext)
+	denomMetadata, err := client.DenomMetadata(ctx, &banktypes.QueryDenomMetadataRequest{
+		Denom: chain.ChainSettings.Denom,
+	})
+	requireT.NoError(err)
+	switch chain.ChainSettings.ChainID {
+	case string(constant.ChainIDMain):
+		requireT.Equal(strings.ToUpper(constant.DenomMainDisplay), denomMetadata.Metadata.Symbol)
+	case string(constant.ChainIDTest):
+		requireT.Equal(strings.ToUpper(constant.DenomTestDisplay), denomMetadata.Metadata.Symbol)
+	case string(constant.ChainIDDev):
+		requireT.Equal(strings.ToUpper(constant.DenomDevDisplay), denomMetadata.Metadata.Symbol)
+	default:
+		requireT.FailNowf("unknown chain id: %s", chain.ChainSettings.ChainID)
+	}
+}
+
+func (d *denomSymbol) After(t *testing.T) {
+	ctx, chain := integrationtests.NewCoreumTestingContext(t)
+	requireT := require.New(t)
+
+	client := banktypes.NewQueryClient(chain.ClientContext)
+	denomMetadata, err := client.DenomMetadata(ctx, &banktypes.QueryDenomMetadataRequest{
+		Denom: chain.ChainSettings.Denom,
+	})
+	requireT.NoError(err)
+	switch chain.ChainSettings.ChainID {
+	case string(constant.ChainIDMain):
+		requireT.Equal("TX", denomMetadata.Metadata.Symbol)
+	case string(constant.ChainIDTest):
+		requireT.Equal("TESTTX", denomMetadata.Metadata.Symbol)
+	case string(constant.ChainIDDev):
+		requireT.Equal("DEVTX", denomMetadata.Metadata.Symbol)
+	default:
+		requireT.FailNowf("unknown chain id: %s", chain.ChainSettings.ChainID)
+	}
+}

integration-tests/upgrade/upgrade_test.go

@@ -51,7 +51,9 @@ func TestUpgrade(t *testing.T) {
 }
 
 func upgradeV5ToV6(t *testing.T) {
-	tests := []upgradeTest{}
+	tests := []upgradeTest{
+		&denomSymbol{},
+	}
 
 	for _, test := range tests {
 		test.Before(t)