refactor: add Denom type and embed into Token (#6409)

cosmos · May 28, 2024 · a4511a7 · a4511a7
1 parent 534f8a4
commit a4511a7
Show file tree

Hide file tree

Showing 14 changed files with 1,159 additions and 455 deletions.
diff --git a/modules/apps/callbacks/ibc_middleware_test.go b/modules/apps/callbacks/ibc_middleware_test.go
@@ -167,9 +167,11 @@ func (s *CallbacksTestSuite) TestSendPacket() {
  packetData = transfertypes.NewFungibleTokenPacketDataV2(
  []transfertypes.Token{
  {
- Denom: ibctesting.TestCoin.GetDenom(),
+ Denom: transfertypes.Denom{
+ Base: ibctesting.TestCoin.GetDenom(),
+ Trace: []string{},
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: []string{},
  },
  },
  ibctesting.TestAccAddress,
@@ -309,9 +311,11 @@ func (s *CallbacksTestSuite) TestOnAcknowledgementPacket() {
  packetData = transfertypes.NewFungibleTokenPacketDataV2(
  []transfertypes.Token{
  {
- Denom: ibctesting.TestCoin.GetDenom(),
+ Denom: transfertypes.Denom{
+ Base: ibctesting.TestCoin.GetDenom(),
+ Trace: []string{},
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: []string{},
  },
  },
  ibctesting.TestAccAddress,
@@ -642,9 +646,11 @@ func (s *CallbacksTestSuite) TestOnRecvPacket() {
  packetData = transfertypes.NewFungibleTokenPacketDataV2(
  []transfertypes.Token{
  {
- Denom: ibctesting.TestCoin.GetDenom(),
+ Denom: transfertypes.Denom{
+ Base: ibctesting.TestCoin.GetDenom(),
+ Trace: []string{},
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: []string{},
  },
  },
  ibctesting.TestAccAddress,
@@ -774,9 +780,11 @@ func (s *CallbacksTestSuite) TestWriteAcknowledgement() {
  packetData = transfertypes.NewFungibleTokenPacketDataV2(
  []transfertypes.Token{
  {
- Denom: ibctesting.TestCoin.GetDenom(),
+ Denom: transfertypes.Denom{
+ Base: ibctesting.TestCoin.GetDenom(),
+ Trace: []string{},
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: []string{},
  },
  },
  ibctesting.TestAccAddress,
@@ -998,9 +1006,11 @@ func (s *CallbacksTestSuite) TestUnmarshalPacketDataV1() {
  expPacketDataICS20V2 := transfertypes.FungibleTokenPacketDataV2{
  Tokens: []transfertypes.Token{
  {
- Denom: ibctesting.TestCoin.Denom,
+ Denom: transfertypes.Denom{
+ Base: ibctesting.TestCoin.Denom,
+ Trace: nil,
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: nil,
  },
  },
  Sender: ibctesting.TestAccAddress,
@@ -1032,9 +1042,11 @@ func (s *CallbacksTestSuite) TestUnmarshalPacketDataV2() {
  expPacketDataICS20V2 := transfertypes.FungibleTokenPacketDataV2{
  Tokens: []transfertypes.Token{
  {
- Denom: ibctesting.TestCoin.Denom,
+ Denom: transfertypes.Denom{
+ Base: ibctesting.TestCoin.Denom,
+ Trace: nil,
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: nil,
  },
  },
  Sender: ibctesting.TestAccAddress,

diff --git a/modules/apps/transfer/ibc_module_test.go b/modules/apps/transfer/ibc_module_test.go
@@ -555,9 +555,11 @@ func (suite *TransferTestSuite) TestPacketDataUnmarshalerInterface() {
  initialPacketData = types.FungibleTokenPacketDataV2{
  Tokens: []types.Token{
  {
- Denom: "atom",
+ Denom: types.Denom{
+ Base: "atom",
+ Trace: []string{"transfer/channel-0"},
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: []string{"transfer/channel-0"},
  },
  },
  Sender: sender,
@@ -576,9 +578,11 @@ func (suite *TransferTestSuite) TestPacketDataUnmarshalerInterface() {
  initialPacketData = types.FungibleTokenPacketDataV2{
  Tokens: []types.Token{
  {
- Denom: ibctesting.TestCoin.Denom,
+ Denom: types.Denom{
+ Base: ibctesting.TestCoin.Denom,
+ Trace: nil,
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: nil,
  },
  },
  Sender: sender,
@@ -597,9 +601,11 @@ func (suite *TransferTestSuite) TestPacketDataUnmarshalerInterface() {
  initialPacketData = types.FungibleTokenPacketDataV2{
  Tokens: []types.Token{
  {
- Denom: ibctesting.TestCoin.Denom,
+ Denom: types.Denom{
+ Base: ibctesting.TestCoin.Denom,
+ Trace: []string{""},
+ },
  Amount: ibctesting.TestCoin.Amount.String(),
- Trace: []string{""},
  },
  },
  Sender: sender,

diff --git a/modules/apps/transfer/internal/convert/convert.go b/modules/apps/transfer/internal/convert/convert.go
@@ -16,9 +16,11 @@ func PacketDataV1ToV2(packetData types.FungibleTokenPacketData) types.FungibleTo
  return types.FungibleTokenPacketDataV2{
  Tokens: []types.Token{
  {
- Denom: v2Denom,
+ Denom: types.Denom{
+ Base: v2Denom,
+ Trace: trace,
+ },
  Amount: packetData.Amount,
- Trace: trace,
  },
  },
  Sender: packetData.Sender,

diff --git a/modules/apps/transfer/internal/convert/convert_test.go b/modules/apps/transfer/internal/convert/convert_test.go
@@ -28,9 +28,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom",
+ Denom: types.Denom{
+ Base: "atom",
+ Trace: []string{"transfer/channel-0"},
+ },
  Amount: "1000",
- Trace: []string{"transfer/channel-0"},
  },
  }, sender, receiver, ""),
  nil,
@@ -41,9 +43,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom",
+ Denom: types.Denom{
+ Base: "atom",
+ Trace: nil,
+ },
  Amount: "1000",
- Trace: nil,
  },
  }, sender, receiver, ""),
  nil,
@@ -54,9 +58,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom/withslash",
+ Denom: types.Denom{
+ Base: "atom/withslash",
+ Trace: []string{"transfer/channel-0"},
+ },
  Amount: "1000",
- Trace: []string{"transfer/channel-0"},
  },
  }, sender, receiver, ""),
  nil,
@@ -67,9 +73,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom/",
+ Denom: types.Denom{
+ Base: "atom/",
+ Trace: []string{"transfer/channel-0"},
+ },
  Amount: "1000",
- Trace: []string{"transfer/channel-0"},
  },
  }, sender, receiver, ""),
  nil,
@@ -80,9 +88,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom/pool",
+ Denom: types.Denom{
+ Base: "atom/pool",
+ Trace: []string{"transfer/channel-0", "transfer/channel-1"},
+ },
  Amount: "1000",
- Trace: []string{"transfer/channel-0", "transfer/channel-1"},
  },
  }, sender, receiver, ""),
  nil,
@@ -93,9 +103,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom",
+ Denom: types.Denom{
+ Base: "atom",
+ Trace: []string{"transfer/channel-0", "transfer/channel-1", "transfer-custom/channel-2"},
+ },
  Amount: "1000",
- Trace: []string{"transfer/channel-0", "transfer/channel-1", "transfer-custom/channel-2"},
  },
  }, sender, receiver, ""),
  nil,
@@ -106,9 +118,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
  types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: "atom/pool",
+ Denom: types.Denom{
+ Base: "atom/pool",
+ Trace: []string{"transfer/channel-0", "transfer/channel-1", "transfer-custom/channel-2"},
+ },
  Amount: "1000",
- Trace: []string{"transfer/channel-0", "transfer/channel-1", "transfer-custom/channel-2"},
  },
  }, sender, receiver, ""),
  nil,

diff --git a/modules/apps/transfer/keeper/mbt_relay_test.go b/modules/apps/transfer/keeper/mbt_relay_test.go
@@ -153,9 +153,11 @@ func FungibleTokenPacketFromTla(packet TlaFungibleTokenPacket) FungibleTokenPack
  Data: types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: packet.Data.Amount,
- Trace: trace,
  },
  },
  AddressFromString(packet.Data.Sender),

diff --git a/modules/apps/transfer/keeper/relay.go b/modules/apps/transfer/keeper/relay.go
@@ -136,9 +136,11 @@ func (k Keeper) sendTransfer(
 
  denom, trace := convertinternal.ExtractDenomAndTraceFromV1Denom(fullDenomPath)
  token := types.Token{
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: coin.Amount.String(),
- Trace: trace,
  }
  tokens = append(tokens, token)
  }

diff --git a/modules/apps/transfer/keeper/relay_test.go b/modules/apps/transfer/keeper/relay_test.go
@@ -357,9 +357,11 @@ func (suite *KeeperTestSuite) TestOnRecvPacket_ReceiverIsNotSource() {
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: sdk.DefaultBondDenom,
+ Denom: types.Denom{
+ Base: sdk.DefaultBondDenom,
+ Trace: []string{},
+ },
  Amount: amount.String(),
- Trace: []string{},
  },
  }, suite.chainA.SenderAccount.GetAddress().String(), receiver, memo)
  packet := channeltypes.NewPacket(data.GetBytes(), seq, path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, clienttypes.NewHeight(1, 100), 0)
@@ -510,9 +512,11 @@ func (suite *KeeperTestSuite) TestOnRecvPacket_ReceiverIsSource() {
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: amount.String(),
- Trace: trace,
  },
  }, suite.chainA.SenderAccount.GetAddress().String(), receiver, memo)
  packet = channeltypes.NewPacket(data.GetBytes(), seq, path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, clienttypes.NewHeight(1, 100), 0)
@@ -589,9 +593,11 @@ func (suite *KeeperTestSuite) TestOnRecvPacketSetsTotalEscrowAmountForSourceIBCT
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: amount.String(),
- Trace: trace,
  },
  }, suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), "")
  packet := channeltypes.NewPacket(
@@ -721,9 +727,11 @@ func (suite *KeeperTestSuite) TestOnAcknowledgementPacket() {
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: amount.String(),
- Trace: trace,
  },
  }, suite.chainA.SenderAccount.GetAddress().String(), suite.chainB.SenderAccount.GetAddress().String(), "")
  packet := channeltypes.NewPacket(data.GetBytes(), 1, path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, clienttypes.NewHeight(1, 100), 0)
@@ -816,9 +824,11 @@ func (suite *KeeperTestSuite) TestOnAcknowledgementPacketSetsTotalEscrowAmountFo
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: amount.String(),
- Trace: trace,
  },
  },
  suite.chainB.SenderAccount.GetAddress().String(),
@@ -945,9 +955,11 @@ func (suite *KeeperTestSuite) TestOnTimeoutPacket() {
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: amount.String(),
- Trace: trace,
  },
  }, sender, suite.chainB.SenderAccount.GetAddress().String(), "")
  packet := channeltypes.NewPacket(data.GetBytes(), 1, path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, clienttypes.NewHeight(1, 100), 0)
@@ -1033,9 +1045,11 @@ func (suite *KeeperTestSuite) TestOnTimeoutPacketSetsTotalEscrowAmountForSourceI
  data := types.NewFungibleTokenPacketDataV2(
  []types.Token{
  {
- Denom: denom,
+ Denom: types.Denom{
+ Base: denom,
+ Trace: trace,
+ },
  Amount: amount.String(),
- Trace: trace,
  },
  }, suite.chainB.SenderAccount.GetAddress().String(), suite.chainA.SenderAccount.GetAddress().String(), "")
  packet := channeltypes.NewPacket(