bank: name and symbol metadata fields (#8677)

* bank: name and symbol metadata fields * cli test * changelog
cosmos · Feb 24, 2021 · 149bed4 · 149bed4
1 parent 77668a3
commit 149bed4
Show file tree

Hide file tree

Showing 11 changed files with 243 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -61,6 +61,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (x/bank) [\#8614](https://github.com/cosmos/cosmos-sdk/issues/8614) Add `Name` and `Symbol` fields to denom metadata
 * (x/auth) [\#8522](https://github.com/cosmos/cosmos-sdk/pull/8522) Allow to query all stored accounts
 * (crypto/types) [\#8600](https://github.com/cosmos/cosmos-sdk/pull/8600) `CompactBitArray`: optimize the `NumTrueBitsBefore` method and add an `Equal` method.
 

diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -1711,6 +1711,8 @@ a basic token.
 | `denom_units` | [DenomUnit](#cosmos.bank.v1beta1.DenomUnit) | repeated | denom_units represents the list of DenomUnit's for a given coin |
 | `base` | [string](#string) |  | base represents the base denom (should be the DenomUnit with exponent = 0). |
 | `display` | [string](#string) |  | display indicates the suggested denom that should be displayed in clients. |
+| `name` | [string](#string) |  | name defines the name of the token (eg: Cosmos Atom) |
+| `symbol` | [string](#string) |  | symbol is the token symbol usually shown on exchanges (eg: ATOM). This can be the same as the display. |
 
 
 

diff --git a/proto/cosmos/bank/v1beta1/bank.proto b/proto/cosmos/bank/v1beta1/bank.proto
@@ -82,4 +82,9 @@ message Metadata {
   // display indicates the suggested denom that should be
   // displayed in clients.
   string display = 4;
+  // name defines the name of the token (eg: Cosmos Atom)
+  string name = 5;
+  // symbol is the token symbol usually shown on exchanges (eg: ATOM). This can
+  // be the same as the display.
+  string symbol = 6; 
 }
diff --git a/x/bank/client/cli/cli_test.go b/x/bank/client/cli/cli_test.go
@@ -40,6 +40,8 @@ func (s *IntegrationTestSuite) SetupSuite() {
 
 	bankGenesis.DenomMetadata = []types.Metadata{
 		{
+			Name:        "Cosmos Hub Atom",
+			Symbol:      "ATOM",
 			Description: "The native staking token of the Cosmos Hub.",
 			DenomUnits: []*types.DenomUnit{
 				{
@@ -57,6 +59,8 @@ func (s *IntegrationTestSuite) SetupSuite() {
 			Display: "atom",
 		},
 		{
+			Name:        "Ethereum",
+			Symbol:      "ETH",
 			Description: "Ethereum mainnet token",
 			DenomUnits: []*types.DenomUnit{
 				{
@@ -246,6 +250,8 @@ func (s *IntegrationTestSuite) TestGetCmdQueryDenomsMetadata() {
 			expected: &types.QueryDenomsMetadataResponse{
 				Metadatas: []types.Metadata{
 					{
+						Name:        "Cosmos Hub Atom",
+						Symbol:      "ATOM",
 						Description: "The native staking token of the Cosmos Hub.",
 						DenomUnits: []*types.DenomUnit{
 							{
@@ -263,6 +269,8 @@ func (s *IntegrationTestSuite) TestGetCmdQueryDenomsMetadata() {
 						Display: "atom",
 					},
 					{
+						Name:        "Ethereum",
+						Symbol:      "ETH",
 						Description: "Ethereum mainnet token",
 						DenomUnits: []*types.DenomUnit{
 							{
@@ -293,6 +301,8 @@ func (s *IntegrationTestSuite) TestGetCmdQueryDenomsMetadata() {
 			respType: &types.QueryDenomMetadataResponse{},
 			expected: &types.QueryDenomMetadataResponse{
 				Metadata: types.Metadata{
+					Name:        "Cosmos Hub Atom",
+					Symbol:      "ATOM",
 					Description: "The native staking token of the Cosmos Hub.",
 					DenomUnits: []*types.DenomUnit{
 						{

diff --git a/x/bank/client/rest/grpc_query_test.go b/x/bank/client/rest/grpc_query_test.go
@@ -121,6 +121,8 @@ func (s *IntegrationTestSuite) TestDenomMetadataGRPCHandler() {
 			&types.QueryDenomsMetadataResponse{
 				Metadatas: []types.Metadata{
 					{
+						Name:        "Cosmos Hub Atom",
+						Symbol:      "ATOM",
 						Description: "The native staking token of the Cosmos Hub.",
 						DenomUnits: []*types.DenomUnit{
 							{
@@ -151,6 +153,8 @@ func (s *IntegrationTestSuite) TestDenomMetadataGRPCHandler() {
 			&types.QueryDenomMetadataResponse{},
 			&types.QueryDenomMetadataResponse{
 				Metadata: types.Metadata{
+					Name:        "Cosmos Hub Atom",
+					Symbol:      "ATOM",
 					Description: "The native staking token of the Cosmos Hub.",
 					DenomUnits: []*types.DenomUnit{
 						{

diff --git a/x/bank/client/rest/query_test.go b/x/bank/client/rest/query_test.go
@@ -33,6 +33,8 @@ func (s *IntegrationTestSuite) SetupSuite() {
 
 	bankGenesis.DenomMetadata = []types.Metadata{
 		{
+			Name:        "Cosmos Hub Atom",
+			Symbol:      "ATOM",
 			Description: "The native staking token of the Cosmos Hub.",
 			DenomUnits: []*types.DenomUnit{
 				{

diff --git a/x/bank/keeper/keeper_test.go b/x/bank/keeper/keeper_test.go
@@ -1004,6 +1004,8 @@ func (suite *IntegrationTestSuite) TestIterateAllDenomMetaData() {
 
 func (suite *IntegrationTestSuite) getTestMetadata() []types.Metadata {
 	return []types.Metadata{{
+		Name:        "Cosmos Hub Atom",
+		Symbol:      "ATOM",
 		Description: "The native staking token of the Cosmos Hub.",
 		DenomUnits: []*types.DenomUnit{
 			{"uatom", uint32(0), []string{"microatom"}},
@@ -1014,6 +1016,8 @@ func (suite *IntegrationTestSuite) getTestMetadata() []types.Metadata {
 		Display: "atom",
 	},
 		{
+			Name:        "Token",
+			Symbol:      "TOKEN",
 			Description: "The native staking token of the Token Hub.",
 			DenomUnits: []*types.DenomUnit{
 				{"1token", uint32(5), []string{"decitoken"}},

diff --git a/x/bank/types/bank.pb.go b/x/bank/types/bank.pb.go
diff --git a/x/bank/types/genesis_test.go b/x/bank/types/genesis_test.go
@@ -28,6 +28,8 @@ func TestGenesisStateValidate(t *testing.T) {
 				Supply: sdk.Coins{sdk.NewInt64Coin("uatom", 1)},
 				DenomMetadata: []Metadata{
 					{
+						Name:        "Cosmos Hub Atom",
+						Symbol:      "ATOM",
 						Description: "The native staking token of the Cosmos Hub.",
 						DenomUnits: []*DenomUnit{
 							{"uatom", uint32(0), []string{"microatom"}},
@@ -85,6 +87,8 @@ func TestGenesisStateValidate(t *testing.T) {
 			GenesisState{
 				DenomMetadata: []Metadata{
 					{
+						Name:        "Cosmos Hub Atom",
+						Symbol:      "ATOM",
 						Description: "The native staking token of the Cosmos Hub.",
 						DenomUnits: []*DenomUnit{
 							{"uatom", uint32(0), []string{"microatom"}},
@@ -95,6 +99,8 @@ func TestGenesisStateValidate(t *testing.T) {
 						Display: "atom",
 					},
 					{
+						Name:        "Cosmos Hub Atom",
+						Symbol:      "ATOM",
 						Description: "The native staking token of the Cosmos Hub.",
 						DenomUnits: []*DenomUnit{
 							{"uatom", uint32(0), []string{"microatom"}},
@@ -113,6 +119,8 @@ func TestGenesisStateValidate(t *testing.T) {
 			GenesisState{
 				DenomMetadata: []Metadata{
 					{
+						Name:        "Cosmos Hub Atom",
+						Symbol:      "ATOM",
 						Description: "The native staking token of the Cosmos Hub.",
 						DenomUnits: []*DenomUnit{
 							{"uatom", uint32(0), []string{"microatom"}},

diff --git a/x/bank/types/metadata.go b/x/bank/types/metadata.go
@@ -9,12 +9,21 @@ import (
 )
 
 // Validate performs a basic validation of the coin metadata fields. It checks:
+//  - Name and Symbol are not blank
 //  - Base and Display denominations are valid coin denominations
 //  - Base and Display denominations are present in the DenomUnit slice
 //  - Base denomination has exponent 0
 //  - Denomination units are sorted in ascending order
 //  - Denomination units not duplicated
 func (m Metadata) Validate() error {
+	if strings.TrimSpace(m.Name) == "" {
+		return errors.New("name field cannot be blank")
+	}
+
+	if strings.TrimSpace(m.Symbol) == "" {
+		return errors.New("symbol field cannot be blank")
+	}
+
 	if err := sdk.ValidateDenom(m.Base); err != nil {
 		return fmt.Errorf("invalid metadata base denom: %w", err)
 	}