feat: added Decimals field in the Metadata struct

* Required to enable human readable formats in exchange module
InjectiveLabs · Jan 21, 2025 · d8651f9 · d8651f9
1 parent 3bd66ce
commit d8651f9
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 62 deletions.
diff --git a/tests/integration/bank/keeper/deterministic_test.go b/tests/integration/bank/keeper/deterministic_test.go
@@ -54,8 +54,9 @@ var (
 				Aliases:  []string{"ATOM"},
 			},
 		},
-		Base:    "uatom",
-		Display: "atom",
+		Base:     "uatom",
+		Display:  "atom",
+		Decimals: 6,
 	}
 )
 

diff --git a/x/bank/keeper/grpc_query_test.go b/x/bank/keeper/grpc_query_test.go
@@ -408,8 +408,9 @@ func (suite *KeeperTestSuite) TestQueryDenomsMetadata() {
 							Aliases:  []string{"ATOM"},
 						},
 					},
-					Base:    "uatom",
-					Display: "atom",
+					Base:     "uatom",
+					Display:  "atom",
+					Decimals: 6,
 				}
 
 				metadataEth := types.Metadata{
@@ -425,8 +426,9 @@ func (suite *KeeperTestSuite) TestQueryDenomsMetadata() {
 							Aliases:  []string{"ETH", "ether"},
 						},
 					},
-					Base:    "wei",
-					Display: "eth",
+					Base:     "wei",
+					Display:  "eth",
+					Decimals: 18,
 				}
 
 				suite.bankKeeper.SetDenomMetaData(suite.ctx, metadataAtom)
@@ -507,8 +509,9 @@ func (suite *KeeperTestSuite) TestQueryDenomMetadata() {
 							Aliases:  []string{"ATOM"},
 						},
 					},
-					Base:    "uatom",
-					Display: "atom",
+					Base:     "uatom",
+					Display:  "atom",
+					Decimals: 6,
 				}
 
 				suite.bankKeeper.SetDenomMetaData(suite.ctx, expMetadata)
@@ -584,8 +587,9 @@ func (suite *KeeperTestSuite) TestQueryDenomMetadataByQueryStringRequest() {
 							Aliases:  []string{"ATOM"},
 						},
 					},
-					Base:    "uatom",
-					Display: "atom",
+					Base:     "uatom",
+					Display:  "atom",
+					Decimals: 6,
 				}
 
 				suite.bankKeeper.SetDenomMetaData(suite.ctx, expMetadata)

diff --git a/x/bank/proto/cosmos/bank/v1beta1/bank.proto b/x/bank/proto/cosmos/bank/v1beta1/bank.proto
@@ -115,4 +115,7 @@ message Metadata {
   // URIHash is a sha256 hash of a document pointed by URI. It's used to verify that
   // the document didn't change. Optional.
   string uri_hash = 8 [(gogoproto.customname) = "URIHash", (cosmos_proto.field_added_in) = "cosmos-sdk 0.46"];
+
+  // Decimals represent the number of decimals use to represent token amount on chain
+  uint32 decimals = 9 [(gogoproto.customname) = "Decimals", (cosmos_proto.field_added_in) = "cosmos-sdk 0.50-inj"];
 }
diff --git a/x/bank/types/bank.pb.go b/x/bank/types/bank.pb.go
diff --git a/x/bank/types/metadata_test.go b/x/bank/types/metadata_test.go
@@ -27,8 +27,9 @@ func TestMetadataValidate(t *testing.T) {
 					{"matom", uint32(3), []string{"milliatom"}},
 					{"atom", uint32(6), nil},
 				},
-				Base:    "uatom",
-				Display: "atom",
+				Base:     "uatom",
+				Display:  "atom",
+				Decimals: 6,
 			},
 			false,
 		},
@@ -148,8 +149,9 @@ func TestMetadataValidate(t *testing.T) {
 					{"matom", uint32(3), []string{"milliatom"}},
 					{"atom", uint32(6), nil},
 				},
-				Base:    "uatom",
-				Display: "atom",
+				Base:     "uatom",
+				Display:  "atom",
+				Decimals: 6,
 			},
 			true,
 		},
@@ -164,8 +166,9 @@ func TestMetadataValidate(t *testing.T) {
 					{"matom", uint32(3), []string{"milliatom"}},
 					{"atom", uint32(6), nil},
 				},
-				Base:    "uatom",
-				Display: "atom",
+				Base:     "uatom",
+				Display:  "atom",
+				Decimals: 6,
 			},
 			true,
 		},