Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: use typed Trace #6432

Merged
merged 12 commits into from
May 30, 2024
Merged

refactor: use typed Trace #6432

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ad7412d
refactor: initial introduction of typed trace
colin-axner May 30, 2024
4bf75ce
Merge branch 'main' of github.com:cosmos/ibc-go into colin/6362-typed…
colin-axner May 30, 2024
5390c36
fix: build
colin-axner May 30, 2024
5883616
fix: types test
colin-axner May 30, 2024
ac1d484
fix: callbacks test
colin-axner May 30, 2024
a269d93
Update modules/apps/transfer/ibc_module_test.go
colin-axner May 30, 2024
67abac3
review: apply suggestion
colin-axner May 30, 2024
369e9f3
lint
colin-axner May 30, 2024
0f872d9
Merge branch 'main' of github.com:cosmos/ibc-go into colin/6362-typed…
colin-axner May 30, 2024
4f37530
tiny nit
May 30, 2024
19fdd2c
fix: tests from merging main
colin-axner May 30, 2024
361b352
Merge branch 'colin/6362-typed-trace' of github.com:cosmos/ibc-go int…
colin-axner May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions modules/apps/callbacks/ibc_middleware_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ func (s *CallbacksTestSuite) TestSendPacket() {
{
Denom: transfertypes.Denom{
Base: ibctesting.TestCoin.GetDenom(),
Trace: []string{},
Trace: []transfertypes.Trace{},
},
Amount: ibctesting.TestCoin.Amount.String(),
},
Expand Down Expand Up @@ -313,7 +313,7 @@ func (s *CallbacksTestSuite) TestOnAcknowledgementPacket() {
{
Denom: transfertypes.Denom{
Base: ibctesting.TestCoin.GetDenom(),
Trace: []string{},
Trace: []transfertypes.Trace{},
},
Amount: ibctesting.TestCoin.Amount.String(),
},
Expand Down Expand Up @@ -648,7 +648,7 @@ func (s *CallbacksTestSuite) TestOnRecvPacket() {
{
Denom: transfertypes.Denom{
Base: ibctesting.TestCoin.GetDenom(),
Trace: []string{},
Trace: []transfertypes.Trace{},
},
Amount: ibctesting.TestCoin.Amount.String(),
},
Expand Down Expand Up @@ -782,7 +782,7 @@ func (s *CallbacksTestSuite) TestWriteAcknowledgement() {
{
Denom: transfertypes.Denom{
Base: ibctesting.TestCoin.GetDenom(),
Trace: []string{},
Trace: []transfertypes.Trace{},
},
Amount: ibctesting.TestCoin.Amount.String(),
},
Expand Down
10 changes: 6 additions & 4 deletions modules/apps/transfer/ibc_module_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,8 +556,10 @@ func (suite *TransferTestSuite) TestPacketDataUnmarshalerInterface() {
Tokens: []types.Token{
{
Denom: types.Denom{
Base: "atom",
Trace: []string{"transfer/channel-0"},
Base: "atom",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
},
},
Amount: ibctesting.TestCoin.Amount.String(),
},
Expand Down Expand Up @@ -603,7 +605,7 @@ func (suite *TransferTestSuite) TestPacketDataUnmarshalerInterface() {
{
Denom: types.Denom{
Base: ibctesting.TestCoin.Denom,
Trace: []string{""},
Trace: []types.Trace{{}},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find this to be an odd linting standard

},
Amount: ibctesting.TestCoin.Amount.String(),
},
Expand All @@ -615,7 +617,7 @@ func (suite *TransferTestSuite) TestPacketDataUnmarshalerInterface() {

data = initialPacketData.(types.FungibleTokenPacketDataV2).GetBytes()
},
errors.New("trace info must come in pairs of port and channel identifiers"),
errors.New("invalid token denom: invalid trace: invalid portID: identifier cannot be blank: invalid identifier"),
},
{
"failure: invalid packet data",
Expand Down
41 changes: 29 additions & 12 deletions modules/apps/transfer/internal/convert/convert_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,10 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
[]types.Token{
{
Denom: types.Denom{
Base: "atom",
Trace: []string{"transfer/channel-0"},
Base: "atom",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
},
},
Amount: "1000",
},
Expand Down Expand Up @@ -59,8 +61,10 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
[]types.Token{
{
Denom: types.Denom{
Base: "atom/withslash",
Trace: []string{"transfer/channel-0"},
Base: "atom/withslash",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
},
},
Amount: "1000",
},
Expand All @@ -74,8 +78,10 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
[]types.Token{
{
Denom: types.Denom{
Base: "atom/",
Trace: []string{"transfer/channel-0"},
Base: "atom/",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
},
},
Amount: "1000",
},
Expand All @@ -89,8 +95,11 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
[]types.Token{
{
Denom: types.Denom{
Base: "atom/pool",
Trace: []string{"transfer/channel-0", "transfer/channel-1"},
Base: "atom/pool",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
types.NewTrace("transfer", "channel-1"),
},
},
Amount: "1000",
},
Expand All @@ -104,8 +113,12 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
[]types.Token{
{
Denom: types.Denom{
Base: "atom",
Trace: []string{"transfer/channel-0", "transfer/channel-1", "transfer-custom/channel-2"},
Base: "atom",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
types.NewTrace("transfer", "channel-1"),
types.NewTrace("transfer-custom", "channel-2"),
},
},
Amount: "1000",
},
Expand All @@ -119,8 +132,12 @@ func TestConvertPacketV1ToPacketV2(t *testing.T) {
[]types.Token{
{
Denom: types.Denom{
Base: "atom/pool",
Trace: []string{"transfer/channel-0", "transfer/channel-1", "transfer-custom/channel-2"},
Base: "atom/pool",
Trace: []types.Trace{
types.NewTrace("transfer", "channel-0"),
types.NewTrace("transfer", "channel-1"),
types.NewTrace("transfer-custom", "channel-2"),
},
},
Amount: "1000",
},
Expand Down
16 changes: 8 additions & 8 deletions modules/apps/transfer/keeper/genesis_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ import (
)

func (suite *KeeperTestSuite) TestGenesis() {
getTrace := func(index uint) string {
return fmt.Sprintf("transfer/channelToChain%d", index)
getTrace := func(index uint) types.Trace {
return types.NewTrace("transfer", fmt.Sprintf("channelToChain%d", index))
}

var (
denoms types.Denoms
escrows sdk.Coins
traceAndEscrowAmounts = []struct {
trace []string
trace []types.Trace
escrow string
}{
{[]string{getTrace(0)}, "10"},
{[]string{getTrace(1), getTrace(0)}, "100000"},
{[]string{getTrace(2), getTrace(1), getTrace(0)}, "10000000000"},
{[]string{getTrace(3), getTrace(2), getTrace(1), getTrace(0)}, "1000000000000000"},
{[]string{getTrace(4), getTrace(3), getTrace(2), getTrace(1), getTrace(0)}, "100000000000000000000"},
{[]types.Trace{getTrace(0)}, "10"},
{[]types.Trace{getTrace(1), getTrace(0)}, "100000"},
{[]types.Trace{getTrace(2), getTrace(1), getTrace(0)}, "10000000000"},
{[]types.Trace{getTrace(3), getTrace(2), getTrace(1), getTrace(0)}, "1000000000000000"},
{[]types.Trace{getTrace(4), getTrace(3), getTrace(2), getTrace(1), getTrace(0)}, "100000000000000000000"},
}
)

Expand Down
37 changes: 24 additions & 13 deletions modules/apps/transfer/keeper/grpc_query_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@ func (suite *KeeperTestSuite) TestQueryDenom() {
"success: correct ibc denom",
func() {
expDenom = types.Denom{
Base: "uatom", //nolint:goconst
Trace: []string{"transfer/channelToA", "transfer/channelToB"}, //nolint:goconst
Base: "uatom", //nolint:goconst
Trace: []types.Trace{
types.NewTrace("transfer", "channelToA"), //nolint:goconst
types.NewTrace("transfer", "channelToB"), //nolint:goconst
},
}
suite.chainA.GetSimApp().TransferKeeper.SetDenom(suite.chainA.GetContext(), expDenom)

Expand All @@ -42,10 +45,12 @@ func (suite *KeeperTestSuite) TestQueryDenom() {
"success: correct hex hash",
func() {
expDenom = types.Denom{
Base: "uatom", //nolint:goconst
Trace: []string{"transfer/channelToA", "transfer/channelToB"}, //nolint:goconst
Base: "uatom", //nolint:goconst
Trace: []types.Trace{
types.NewTrace("transfer", "channelToA"), //nolint:goconst
types.NewTrace("transfer", "channelToB"), //nolint:goconst
},
}

suite.chainA.GetSimApp().TransferKeeper.SetDenom(suite.chainA.GetContext(), expDenom)

req = &types.QueryDenomRequest{
Expand All @@ -67,8 +72,11 @@ func (suite *KeeperTestSuite) TestQueryDenom() {
"failure: not found denom trace",
func() {
expDenom = types.Denom{
Base: "uatom", //nolint:goconst
Trace: []string{"transfer/channelToA", "transfer/channelToB"}, //nolint:goconst
Base: "uatom", //nolint:goconst
Trace: []types.Trace{
types.NewTrace("transfer", "channelToA"), //nolint:goconst
types.NewTrace("transfer", "channelToB"), //nolint:goconst
},
}

req = &types.QueryDenomRequest{
Expand Down Expand Up @@ -122,8 +130,8 @@ func (suite *KeeperTestSuite) TestQueryDenoms() {
"success",
func() {
expDenoms = append(expDenoms, types.Denom{Base: "uatom"})
expDenoms = append(expDenoms, types.Denom{Base: "uatom", Trace: []string{"transfer/channelToB"}})
expDenoms = append(expDenoms, types.Denom{Base: "uatom", Trace: []string{"transfer/channelToA", "transfer/channelToB"}})
expDenoms = append(expDenoms, types.Denom{Base: "uatom", Trace: []types.Trace{types.NewTrace("transfer", "channelToB")}})
expDenoms = append(expDenoms, types.Denom{Base: "uatom", Trace: []types.Trace{types.NewTrace("transfer", "channelToA"), types.NewTrace("transfer", "channelToB")}})

for _, trace := range expDenoms {
suite.chainA.GetSimApp().TransferKeeper.SetDenom(suite.chainA.GetContext(), trace)
Expand Down Expand Up @@ -170,8 +178,11 @@ func (suite *KeeperTestSuite) TestQueryParams() {

func (suite *KeeperTestSuite) TestQueryDenomHash() {
reqDenom := types.Denom{
Base: "uatom",
Trace: []string{"transfer/channelToA", "transfer/channelToB"},
Base: "uatom",
Trace: []types.Trace{
types.NewTrace("transfer", "channelToA"),
types.NewTrace("transfer", "channelToB"),
},
}

var (
Expand Down Expand Up @@ -336,7 +347,7 @@ func (suite *KeeperTestSuite) TestTotalEscrowForDenom() {
func() {
denomTrace := types.Denom{
Base: sdk.DefaultBondDenom,
Trace: []string{"transfer/channel-0"},
Trace: []types.Trace{types.NewTrace("transfer", "channel-0")},
}

suite.chainA.GetSimApp().TransferKeeper.SetDenom(suite.chainA.GetContext(), denomTrace)
Expand All @@ -355,7 +366,7 @@ func (suite *KeeperTestSuite) TestTotalEscrowForDenom() {
func() {
denomTrace := types.Denom{
Base: sdk.DefaultBondDenom,
Trace: []string{"transfer/channel-0"},
Trace: []types.Trace{types.NewTrace("transfer", "channel-0")},
}

req = &types.QueryTotalEscrowForDenomRequest{
Expand Down
3 changes: 1 addition & 2 deletions modules/apps/transfer/keeper/mbt_relay_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,8 +341,7 @@ func (suite *KeeperTestSuite) TestModelBasedRelay() {
panic(errors.New("MBT failed to convert sender address"))
}
registerDenomFn()
denomTrace := types.ParseDenomTrace(tc.packet.Data.Tokens[0].GetFullDenomPath())
denom := denomTrace.IBCDenom()
denom := tc.packet.Data.Tokens[0].Denom.IBCDenom()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refactor to use the new Trace type in the Denom field.

The change at line 344 where denom := tc.packet.Data.Tokens[0].Denom.IBCDenom() is used, correctly reflects the transition from using strings to using the Trace type for denomination tracing. This is in line with the PR's objective to minimize string parsing by using a typed Trace. Ensure that all related functions and methods that interact with this line are updated to handle the Trace type effectively.

err = sdk.ValidateDenom(denom)
if err == nil {
amount, ok := sdkmath.NewIntFromString(tc.packet.Data.Tokens[0].Amount)
Expand Down
4 changes: 2 additions & 2 deletions modules/apps/transfer/keeper/relay.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ func (k Keeper) sendTransfer(
telemetry.SetGaugeWithLabels(
[]string{"tx", "msg", "ibc", "transfer"},
float32(amount.Int64()),
[]metrics.Label{telemetry.NewLabel(coretypes.LabelDenom, token.GetFullDenomPath())},
[]metrics.Label{telemetry.NewLabel(coretypes.LabelDenom, token.Denom.FullPath())},
)
}
}
Expand Down Expand Up @@ -239,7 +239,7 @@ func (k Keeper) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, data t
// sender chain is the source, mint vouchers

// since SendPacket did not prefix the denomination, we must add the destination port and channel to the trace
trace := []string{fmt.Sprintf("%s/%s", packet.DestinationPort, packet.DestinationChannel)}
trace := []types.Trace{types.NewTrace(packet.DestinationPort, packet.DestinationChannel)}
token.Denom.Trace = append(trace, token.Denom.Trace...)

if !k.HasDenom(ctx, token.Denom.Hash()) {
Expand Down
26 changes: 17 additions & 9 deletions modules/apps/transfer/keeper/relay_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
func() {
// send IBC token back to chainB
denom := types.Denom{
Base: coin.Denom,
Trace: []string{path.EndpointA.ChannelConfig.PortID + "/" + path.EndpointA.ChannelID},
Base: coin.Denom,
Trace: []types.Trace{
types.NewTrace(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID),
},
}
coin = sdk.NewCoin(denom.IBCDenom(), coin.Amount)
},
Expand All @@ -68,8 +70,10 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
func() {
// send IBC token back to chainB
denom := types.Denom{
Base: coin.Denom,
Trace: []string{path.EndpointA.ChannelConfig.PortID + "/" + path.EndpointA.ChannelID},
Base: coin.Denom,
Trace: []types.Trace{
types.NewTrace(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID),
},
}
coin = sdk.NewCoin(denom.IBCDenom(), coin.Amount)
memo = "memo"
Expand Down Expand Up @@ -102,8 +106,10 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
"failure: denom trace not found",
func() {
denom := types.Denom{
Base: "randomdenom",
Trace: []string{path.EndpointA.ChannelConfig.PortID + "/" + path.EndpointA.ChannelID},
Base: "randomdenom",
Trace: []types.Trace{
types.NewTrace(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID),
},
}
coin = sdk.NewCoin(denom.IBCDenom(), coin.Amount)
},
Expand All @@ -113,8 +119,10 @@ func (suite *KeeperTestSuite) TestSendTransfer() {
"failure: bank send from module account failed, insufficient balance",
func() {
denom := types.Denom{
Base: coin.Denom,
Trace: []string{path.EndpointA.ChannelConfig.PortID + "/" + path.EndpointA.ChannelID},
Base: coin.Denom,
Trace: []types.Trace{
types.NewTrace(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID),
},
}
coin = sdk.NewCoin(denom.IBCDenom(), coin.Amount.Add(sdkmath.NewInt(1)))
},
Expand Down Expand Up @@ -374,7 +382,7 @@ func (suite *KeeperTestSuite) TestOnRecvPacket_ReceiverIsNotSource() {
{
Denom: types.Denom{
Base: sdk.DefaultBondDenom,
Trace: []string{},
Trace: []types.Trace{},
},
Amount: amount.String(),
},
Expand Down
9 changes: 5 additions & 4 deletions modules/apps/transfer/transfer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package transfer_test

import (
"fmt"
"testing"

testifysuite "github.com/stretchr/testify/suite"
Expand Down Expand Up @@ -71,8 +70,10 @@ func (suite *TransferTestSuite) TestHandleMsgTransfer() {

// check that voucher exists on chain B
denom := types.Denom{
Base: sdk.DefaultBondDenom,
Trace: []string{fmt.Sprintf("%s/%s", packet.DestinationPort, packet.DestinationChannel)},
Base: sdk.DefaultBondDenom,
Trace: []types.Trace{
types.NewTrace(packet.DestinationPort, packet.DestinationChannel),
},
}
balance = suite.chainB.GetSimApp().BankKeeper.GetBalance(suite.chainB.GetContext(), suite.chainB.SenderAccount.GetAddress(), denom.IBCDenom())
coinSentFromAToB := sdk.NewCoin(denom.IBCDenom(), amount)
Expand All @@ -97,7 +98,7 @@ func (suite *TransferTestSuite) TestHandleMsgTransfer() {
suite.Require().NoError(err) // relay committed

// NOTE: fungible token is prefixed with the full trace in order to verify the packet commitment
trace := []string{fmt.Sprintf("%s/%s", pathBtoC.EndpointB.ChannelConfig.PortID, pathBtoC.EndpointB.ChannelID)}
trace := []types.Trace{types.NewTrace(pathBtoC.EndpointB.ChannelConfig.PortID, pathBtoC.EndpointB.ChannelID)}
denom.Trace = append(trace, denom.Trace...)

// check that the balance is updated on chainC
Expand Down
Loading