fix(x/staking): make metadata nullable (#22556)

julienrbrt · web-flow · commit 48f2b3685424 · 2024-11-26T23:46:22.000Z
diff --git a/api/cosmos/staking/v1beta1/staking.pulsar.go b/api/cosmos/staking/v1beta1/staking.pulsar.go
diff --git a/simapp/simd/cmd/testnet.go b/simapp/simd/cmd/testnet.go
@@ -353,7 +353,7 @@ func initTestnetFiles(
 			valStr,
 			valPubKeys[i],
 			sdk.NewCoin(args.bondTokenDenom, valTokens),
-			stakingtypes.NewDescription(nodeDirName, "", "", "", "", stakingtypes.Metadata{}),
+			stakingtypes.NewDescription(nodeDirName, "", "", "", "", &stakingtypes.Metadata{}),
 			stakingtypes.NewCommissionRates(math.LegacyOneDec(), math.LegacyOneDec(), math.LegacyOneDec()),
 			math.OneInt(),
 		)
diff --git a/simapp/v2/simdv2/cmd/testnet.go b/simapp/v2/simdv2/cmd/testnet.go
@@ -295,7 +295,7 @@ func initTestnetFiles[T transaction.Tx](
 			valStr,
 			valPubKeys[i],
 			sdk.NewCoin(args.bondTokenDenom, valTokens),
-			stakingtypes.NewDescription(nodeDirName, "", "", "", "", stakingtypes.Metadata{}),
+			stakingtypes.NewDescription(nodeDirName, "", "", "", "", &stakingtypes.Metadata{}),
 			stakingtypes.NewCommissionRates(math.LegacyOneDec(), math.LegacyOneDec(), math.LegacyOneDec()),
 			math.OneInt(),
 		)
diff --git a/tests/integration/gov/common_test.go b/tests/integration/gov/common_test.go
@@ -34,7 +34,7 @@ import (
 var (
 	valTokens           = sdk.TokensFromConsensusPower(42, sdk.DefaultPowerReduction)
 	TestProposal        = v1beta1.NewTextProposal("Test", "description")
-	TestDescription     = stakingtypes.NewDescription("T", "E", "S", "T", "Z", stakingtypes.Metadata{})
+	TestDescription     = stakingtypes.NewDescription("T", "E", "S", "T", "Z", &stakingtypes.Metadata{})
 	TestCommissionRates = stakingtypes.NewCommissionRates(math.LegacyZeroDec(), math.LegacyZeroDec(), math.LegacyZeroDec())
 )
 
diff --git a/tests/integration/slashing/slashing_test.go b/tests/integration/slashing/slashing_test.go
@@ -83,7 +83,7 @@ func TestSlashingMsgs(t *testing.T) {
 
 	require.NoError(t, err)
 
-	description := stakingtypes.NewDescription("foo_moniker", "", "", "", "", stakingtypes.Metadata{})
+	description := stakingtypes.NewDescription("foo_moniker", "", "", "", "", &stakingtypes.Metadata{})
 	commission := stakingtypes.NewCommissionRates(math.LegacyZeroDec(), math.LegacyZeroDec(), math.LegacyZeroDec())
 
 	addrStrVal, err := valaddrCodec.BytesToString(addr1)
diff --git a/tests/integration/staking/keeper/deterministic_test.go b/tests/integration/staking/keeper/deterministic_test.go
@@ -210,9 +210,9 @@ func bondTypeGenerator() *rapid.Generator[stakingtypes.BondStatus] {
 	})
 }
 
-func metadataGenerator() *rapid.Generator[stakingtypes.Metadata] {
-	return rapid.Custom(func(t *rapid.T) stakingtypes.Metadata {
-		return stakingtypes.Metadata{
+func metadataGenerator() *rapid.Generator[*stakingtypes.Metadata] {
+	return rapid.Custom(func(t *rapid.T) *stakingtypes.Metadata {
+		return &stakingtypes.Metadata{
 			ProfilePicUri:    generateUri(t),
 			SocialHandleUris: []string{generateUri(t), generateUri(t)},
 		}
@@ -325,7 +325,7 @@ func getStaticValidator(t *testing.T, f *deterministicFixture) stakingtypes.Vali
 			"website",
 			"securityContact",
 			"details",
-			stakingtypes.Metadata{},
+			&stakingtypes.Metadata{},
 		),
 		UnbondingHeight: 10,
 		UnbondingTime:   time.Date(2022, 10, 1, 0, 0, 0, 0, time.UTC),
@@ -361,7 +361,7 @@ func getStaticValidator2(t *testing.T, f *deterministicFixture) stakingtypes.Val
 			"website",
 			"securityContact",
 			"details",
-			stakingtypes.Metadata{},
+			&stakingtypes.Metadata{},
 		),
 		UnbondingHeight: 100132,
 		UnbondingTime:   time.Date(2025, 10, 1, 0, 0, 0, 0, time.UTC),
diff --git a/tests/integration/staking/keeper/genesis_test.go b/tests/integration/staking/keeper/genesis_test.go
@@ -41,7 +41,7 @@ func TestInitGenesis(t *testing.T) {
 		Status:          types.Bonded,
 		Tokens:          valTokens,
 		DelegatorShares: math.LegacyNewDecFromInt(valTokens),
-		Description:     types.NewDescription("hoop", "", "", "", "", types.Metadata{}),
+		Description:     types.NewDescription("hoop", "", "", "", "", &types.Metadata{}),
 	}
 	assert.NilError(t, f.stakingKeeper.SetValidator(f.sdkCtx, bondedVal))
 
@@ -67,15 +67,15 @@ func TestInitGenesis(t *testing.T) {
 		Status:          types.Bonded,
 		Tokens:          valTokens,
 		DelegatorShares: math.LegacyNewDecFromInt(valTokens),
-		Description:     types.NewDescription("hoop", "", "", "", "", types.Metadata{}),
+		Description:     types.NewDescription("hoop", "", "", "", "", &types.Metadata{}),
 	}
 	bondedVal2 := types.Validator{
 		OperatorAddress: sdk.ValAddress(addrs[2]).String(),
 		ConsensusPubkey: pk2,
 		Status:          types.Bonded,
 		Tokens:          valTokens,
 		DelegatorShares: math.LegacyNewDecFromInt(valTokens),
-		Description:     types.NewDescription("bloop", "", "", "", "", types.Metadata{}),
+		Description:     types.NewDescription("bloop", "", "", "", "", &types.Metadata{}),
 	}
 
 	// append new bonded validators to the list
@@ -148,7 +148,7 @@ func TestInitGenesis_PoolsBalanceMismatch(t *testing.T) {
 		Jailed:          false,
 		Tokens:          math.NewInt(10),
 		DelegatorShares: math.LegacyNewDecFromInt(math.NewInt(10)),
-		Description:     types.NewDescription("bloop", "", "", "", "", types.Metadata{}),
+		Description:     types.NewDescription("bloop", "", "", "", "", &types.Metadata{}),
 	}
 
 	params := types.Params{
@@ -195,7 +195,7 @@ func TestInitGenesisLargeValidatorSet(t *testing.T) {
 		validators[i], err = types.NewValidator(
 			sdk.ValAddress(addrs[i]).String(),
 			PKs[i],
-			types.NewDescription(fmt.Sprintf("#%d", i), "", "", "", "", types.Metadata{}),
+			types.NewDescription(fmt.Sprintf("#%d", i), "", "", "", "", &types.Metadata{}),
 		)
 		assert.NilError(t, err)
 		validators[i].Status = types.Bonded
diff --git a/tests/integration/staking/keeper/msg_server_test.go b/tests/integration/staking/keeper/msg_server_test.go
@@ -44,7 +44,7 @@ func TestCancelUnbondingDelegation(t *testing.T) {
 	delegatorAddr := addrs[1]
 
 	// setup a new validator with bonded status
-	validator, err := types.NewValidator(valAddr.String(), PKs[0], types.NewDescription("Validator", "", "", "", "", types.Metadata{}))
+	validator, err := types.NewValidator(valAddr.String(), PKs[0], types.NewDescription("Validator", "", "", "", "", &types.Metadata{}))
 	validator.Status = types.Bonded
 	assert.NilError(t, err)
 	assert.NilError(t, f.stakingKeeper.SetValidator(ctx, validator))
diff --git a/testutil/network/network.go b/testutil/network/network.go
@@ -493,7 +493,7 @@ func New(l Logger, baseDir string, cfg Config) (NetworkI, error) {
 			sdk.ValAddress(addr).String(),
 			valPubKeys[i],
 			sdk.NewCoin(cfg.BondDenom, cfg.BondedTokens),
-			stakingtypes.NewDescription(nodeDirName, "", "", "", "", stakingtypes.Metadata{}),
+			stakingtypes.NewDescription(nodeDirName, "", "", "", "", &stakingtypes.Metadata{}),
 			stakingtypes.NewCommissionRates(commission, sdkmath.LegacyOneDec(), sdkmath.LegacyOneDec()),
 			sdkmath.OneInt(),
 		)
diff --git a/x/genutil/gentx_test.go b/x/genutil/gentx_test.go
@@ -36,7 +36,7 @@ var (
 	pk2   = priv2.PubKey()
 	addr1 = sdk.AccAddress(pk1.Address())
 	addr2 = sdk.AccAddress(pk2.Address())
-	desc  = stakingtypes.NewDescription("testname", "", "", "", "", stakingtypes.Metadata{})
+	desc  = stakingtypes.NewDescription("testname", "", "", "", "", &stakingtypes.Metadata{})
 	comm  = stakingtypes.CommissionRates{}
 )
 
diff --git a/x/genutil/types/genesis_state_test.go b/x/genutil/types/genesis_state_test.go
@@ -39,7 +39,7 @@ func TestNetGenesisState(t *testing.T) {
 }
 
 func TestValidateGenesisMultipleMessages(t *testing.T) {
-	desc := stakingtypes.NewDescription("testname", "", "", "", "", stakingtypes.Metadata{})
+	desc := stakingtypes.NewDescription("testname", "", "", "", "", &stakingtypes.Metadata{})
 	comm := stakingtypes.CommissionRates{}
 	valAc := codectestutil.CodecOptions{}.GetValidatorCodec()
 
@@ -66,7 +66,7 @@ func TestValidateGenesisMultipleMessages(t *testing.T) {
 }
 
 func TestValidateGenesisBadMessage(t *testing.T) {
-	desc := stakingtypes.NewDescription("testname", "", "", "", "", stakingtypes.Metadata{})
+	desc := stakingtypes.NewDescription("testname", "", "", "", "", &stakingtypes.Metadata{})
 	pk1Addr, err := codectestutil.CodecOptions{}.GetValidatorCodec().BytesToString(pk1.Address())
 	require.NoError(t, err)
 	msg1 := stakingtypes.NewMsgEditValidator(pk1Addr, desc, nil, nil)
diff --git a/x/staking/CHANGELOG.md b/x/staking/CHANGELOG.md
@@ -34,7 +34,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 * [#19537](https://github.com/cosmos/cosmos-sdk/pull/19537) Changing `MinCommissionRate` in `MsgUpdateParams` now updates the minimum commission rate for all validators.
 * [#20434](https://github.com/cosmos/cosmos-sdk/pull/20434) Add consensus address to validator query response
-* [#21315](https://github.com/cosmos/cosmos-sdk/pull/21315) Create metadata type and add metadata field in validator details proto
+* [#21315](https://github.com/cosmos/cosmos-sdk/pull/21315), [#22556](https://github.com/cosmos/cosmos-sdk/pull/22556) Create metadata type and add metadata field in validator details proto
     * Add parsing of `metadata-profile-pic-uri` in `create-validator` JSON.
     * Add cli flag: `metadata-profile-pic-uri` to `edit-validator` cmd.
 
diff --git a/x/staking/client/cli/tx.go b/x/staking/client/cli/tx.go
@@ -133,7 +133,7 @@ func NewEditValidatorCmd() *cobra.Command {
 			profilePicUri, _ := cmd.Flags().GetString(FlagMetadataProfilePicUri)
 			socialHandlesUris, _ := cmd.Flags().GetStringArray(FlagMetadataSocialHandleUris)
 
-			metadata := types.Metadata{
+			metadata := &types.Metadata{
 				ProfilePicUri:    profilePicUri,
 				SocialHandleUris: socialHandlesUris,
 			}
@@ -401,7 +401,7 @@ func BuildCreateValidatorMsg(clientCtx client.Context, config TxCreateValidatorC
 		config.Website,
 		config.SecurityContact,
 		config.Details,
-		config.Metadata,
+		&config.Metadata,
 	)
 
 	// get the initial validator commission parameters
diff --git a/x/staking/client/cli/utils.go b/x/staking/client/cli/utils.go
@@ -24,7 +24,7 @@ type validator struct {
 	Website           string
 	Security          string
 	Details           string
-	Metadata          types.Metadata
+	Metadata          *types.Metadata
 	CommissionRates   types.CommissionRates
 	MinSelfDelegation math.Int
 }
@@ -134,11 +134,15 @@ func buildCommissionRates(rateStr, maxRateStr, maxChangeRateStr string) (commiss
 	return commission, nil
 }
 
-func buildMetadata(profilePicUri string, socialHandlesUris []string) (metadata types.Metadata, err error) {
-	metadata.ProfilePicUri = profilePicUri
-	metadata.SocialHandleUris = socialHandlesUris
+func buildMetadata(profilePicUri string, socialHandlesUris []string) (*types.Metadata, error) {
+	metadata := types.Metadata{
+		ProfilePicUri:    profilePicUri,
+		SocialHandleUris: socialHandlesUris,
+	}
+
 	if err := metadata.Validate(); err != nil {
-		return metadata, err
+		return nil, err
 	}
-	return metadata, nil
+
+	return &metadata, nil
 }
diff --git a/x/staking/keeper/keeper_test.go b/x/staking/keeper/keeper_test.go
@@ -481,7 +481,7 @@ func (s *KeeperTestSuite) TestValidatorsMigrationToColls() {
 			// legacy Set method
 			s.ctx.KVStore(s.key).Set(getValidatorKey(valAddrs[i]), valBz)
 		},
-		"55565aebbb67e1de08d0f17634ad168c68eae74f5cc9074e3a1ec4d1fbff16e5",
+		"d8acdcf8b7c8e17f3e83f0a4c293f89ad619a5dcb14d232911ccc5da15653177",
 	)
 	s.Require().NoError(err)
 
@@ -507,7 +507,7 @@ func (s *KeeperTestSuite) TestValidatorsMigrationToColls() {
 			err := s.stakingKeeper.SetValidator(s.ctx, val)
 			s.Require().NoError(err)
 		},
-		"55565aebbb67e1de08d0f17634ad168c68eae74f5cc9074e3a1ec4d1fbff16e5",
+		"d8acdcf8b7c8e17f3e83f0a4c293f89ad619a5dcb14d232911ccc5da15653177",
 	)
 	s.Require().NoError(err)
 }
diff --git a/x/staking/proto/cosmos/staking/v1beta1/staking.proto b/x/staking/proto/cosmos/staking/v1beta1/staking.proto
@@ -79,7 +79,7 @@ message Description {
   // details define other optional details.
   string details = 5;
   // metadata defines extra information about the validator.
-  Metadata metadata = 6 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+  Metadata metadata = 6 [(gogoproto.nullable) = true, (amino.dont_omitempty) = false];
 }
 
 // Metadata defines extra information about the validator.
diff --git a/x/staking/simulation/msg_factory.go b/x/staking/simulation/msg_factory.go
@@ -46,7 +46,7 @@ func MsgCreateValidatorFactory(k *keeper.Keeper) simsx.SimMsgFactoryFn[*types.Ms
 			r.StringN(10),
 			r.StringN(10),
 			r.StringN(10),
-			types.Metadata{
+			&types.Metadata{
 				ProfilePicUri:    RandURIOfHostLength(r.Rand, 10),
 				SocialHandleUris: RandSocialHandleURIs(r.Rand, 2, 10),
 			},
@@ -143,7 +143,7 @@ func MsgEditValidatorFactory(k *keeper.Keeper) simsx.SimMsgFactoryFn[*types.MsgE
 		}
 		valOpAddrBz := must(k.ValidatorAddressCodec().StringToBytes(val.GetOperator()))
 		valOper := testData.GetAccountbyAccAddr(reporter, valOpAddrBz)
-		d := types.NewDescription(r.StringN(10), r.StringN(10), r.StringN(10), r.StringN(10), r.StringN(10), types.Metadata{
+		d := types.NewDescription(r.StringN(10), r.StringN(10), r.StringN(10), r.StringN(10), r.StringN(10), &types.Metadata{
 			ProfilePicUri:    RandURIOfHostLength(r.Rand, 10),
 			SocialHandleUris: RandSocialHandleURIs(r.Rand, 2, 10),
 		})
diff --git a/x/staking/types/staking.pb.go b/x/staking/types/staking.pb.go
diff --git a/x/staking/types/validator.go b/x/staking/types/validator.go

Original file line number	Diff line number	Diff line change
`@@ -353,7 +353,7 @@ func initTestnetFiles(`
`353`	`353`	`valStr,`
`354`	`354`	`valPubKeys[i],`
`355`	`355`	`sdk.NewCoin(args.bondTokenDenom, valTokens),`
`356`		`- stakingtypes.NewDescription(nodeDirName, "", "", "", "", stakingtypes.Metadata{}),`
	`356`	`+ stakingtypes.NewDescription(nodeDirName, "", "", "", "", &stakingtypes.Metadata{}),`
`357`	`357`	`stakingtypes.NewCommissionRates(math.LegacyOneDec(), math.LegacyOneDec(), math.LegacyOneDec()),`
`358`	`358`	`math.OneInt(),`
`359`	`359`	`)`
Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,7 @@ func initTestnetFiles[T transaction.Tx](`
`295`	`295`	`valStr,`
`296`	`296`	`valPubKeys[i],`
`297`	`297`	`sdk.NewCoin(args.bondTokenDenom, valTokens),`
`298`		`- stakingtypes.NewDescription(nodeDirName, "", "", "", "", stakingtypes.Metadata{}),`
	`298`	`+ stakingtypes.NewDescription(nodeDirName, "", "", "", "", &stakingtypes.Metadata{}),`
`299`	`299`	`stakingtypes.NewCommissionRates(math.LegacyOneDec(), math.LegacyOneDec(), math.LegacyOneDec()),`
`300`	`300`	`math.OneInt(),`
`301`	`301`	`)`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ import (`
`34`	`34`	`var (`
`35`	`35`	`valTokens = sdk.TokensFromConsensusPower(42, sdk.DefaultPowerReduction)`
`36`	`36`	`TestProposal = v1beta1.NewTextProposal("Test", "description")`
`37`		`- TestDescription = stakingtypes.NewDescription("T", "E", "S", "T", "Z", stakingtypes.Metadata{})`
	`37`	`+ TestDescription = stakingtypes.NewDescription("T", "E", "S", "T", "Z", &stakingtypes.Metadata{})`
`38`	`38`	`TestCommissionRates = stakingtypes.NewCommissionRates(math.LegacyZeroDec(), math.LegacyZeroDec(), math.LegacyZeroDec())`
`39`	`39`	`)`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -493,7 +493,7 @@ func New(l Logger, baseDir string, cfg Config) (NetworkI, error) {`
`493`	`493`	`sdk.ValAddress(addr).String(),`
`494`	`494`	`valPubKeys[i],`
`495`	`495`	`sdk.NewCoin(cfg.BondDenom, cfg.BondedTokens),`
`496`		`- stakingtypes.NewDescription(nodeDirName, "", "", "", "", stakingtypes.Metadata{}),`
	`496`	`+ stakingtypes.NewDescription(nodeDirName, "", "", "", "", &stakingtypes.Metadata{}),`
`497`	`497`	`stakingtypes.NewCommissionRates(commission, sdkmath.LegacyOneDec(), sdkmath.LegacyOneDec()),`
`498`	`498`	`sdkmath.OneInt(),`
`499`	`499`	`)`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ var (`
`36`	`36`	`pk2 = priv2.PubKey()`
`37`	`37`	`addr1 = sdk.AccAddress(pk1.Address())`
`38`	`38`	`addr2 = sdk.AccAddress(pk2.Address())`
`39`		`- desc = stakingtypes.NewDescription("testname", "", "", "", "", stakingtypes.Metadata{})`
	`39`	`+ desc = stakingtypes.NewDescription("testname", "", "", "", "", &stakingtypes.Metadata{})`
`40`	`40`	`comm = stakingtypes.CommissionRates{}`
`41`	`41`	`)`
`42`	`42`