Parse ICS20 denomination using channel identifier format #1730

colin-axner · 2022-07-19T12:24:13Z

Description

closes: #1698

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

Change IBC token denomination parsing to use the channel identifier rather than the port Remove unfixable parsing validation test Fix migration tests Add check to migration of traces to panic upon denomination state corruption

modules/apps/transfer/keeper/migrations.go

colin-axner · 2022-07-19T12:25:45Z

modules/apps/transfer/keeper/migrations_test.go

@@ -108,3 +107,16 @@ func (suite *KeeperTestSuite) TestMigratorMigrateTraces() {
 		})
 	}
 }
+
+func (suite *KeeperTestSuite) TestMigratorMigrateTracesCorruptionDetection() {


Made as a separate test since it is the only test case which should panic

colin-axner · 2022-07-19T12:26:25Z

modules/apps/transfer/types/trace_test.go

-		{"trace info with multiple '/'s in base denom", "transfer/channelToA/gamm/pool/1", DenomTrace{BaseDenom: "gamm/pool/1", Path: "transfer/channelToA"}},
-		{"trace info with multiple double '/'s in base denom", "transfer/channelToA/gamm//pool//1", DenomTrace{BaseDenom: "gamm//pool//1", Path: "transfer/channelToA"}},
-		{"trace info with multiple port/channel pairs", "transfer/channelToA/transfer/channelToB/uatom", DenomTrace{BaseDenom: "uatom", Path: "transfer/channelToA/transfer/channelToB"}},
+		{"trace info", "transfer/channel-0/uatom", DenomTrace{BaseDenom: "uatom", Path: "transfer/channel-0"}},


changed channelToA -> channel-1, channelToB -> channel-2

modules/apps/transfer/types/trace_test.go

colin-axner · 2022-07-19T12:28:24Z

modules/apps/transfer/types/trace_test.go

 		{"empty denom", "", true},
 		{"single trace identifier", "transfer/", true},
-		{"invalid channel ID", "transfer/(channelToA)/uatom", true},


had to remove this test, the ValidatePrefixedDenom relies on the parsing function. As the documentation indicates, an invalid channel identifier will result in the channel identifier being treated as a base denomination, thus making the test case "invalid channel id" always pass (we don't do validation on the base denomination, since it isn't ours to validate)

….com:cosmos/ibc-go into colin/1698-parse-ics20-via-channelidentifier

damiannolan

Looks good to me 🚀

damiannolan · 2022-07-19T12:32:44Z

modules/apps/transfer/keeper/migrations_test.go

+	corruptedDenomTrace := transfertypes.DenomTrace{
+		BaseDenom: "customport/channel-0/uatom", Path: "",
+	}


mega nit but could we separate fields onto different lines for readability, e.g.

corruptedDenomTrace := transfertypes.DenomTrace{ BaseDenom: "customport/channel-0/uatom", Path: "", }

oh definitely! Didn't even notice it was two fields

modules/apps/transfer/types/trace.go

Co-authored-by: Damian Nolan <damiannolan@gmail.com>

AdityaSripal

Nice work!

AdityaSripal · 2022-07-19T12:41:11Z

modules/apps/transfer/keeper/migrations.go

+				// The new form of parsing will result in a token denomination change.
+				// A bank migration is required. A panic should occur to prevent the
+				// chain from using corrupted state.
+				panic(fmt.Sprintf("migration will result in corrupted state. Previous IBC token (%s) requires a bank migration. Expected denom trace (%s)", dt, newTrace))


We expect this to not occur correct?

correct. From my understanding, this should only be possible if any chains using the latest minor versions (1.5, 2.3, 3.1), use custom ports for transfer and allow receives of foreign assets. I'm believe there is no single case of this, but to be safe, the check is added to ensure that if this assumption is wrong we can fix the issue before it worsens

codecov-commenter · 2022-07-19T13:01:44Z

Codecov Report

Merging #1730 (2be1b63) into charly/denom_traces_migration_handler (7660328) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@                          Coverage Diff                           @@
##           charly/denom_traces_migration_handler    #1730   +/-   ##
======================================================================
  Coverage                                  80.01%   80.02%           
======================================================================
  Files                                        165      165           
  Lines                                      12336    12353   +17     
======================================================================
+ Hits                                        9871     9885   +14     
- Misses                                      2001     2003    +2     
- Partials                                     464      465    +1

Impacted Files	Coverage Δ
modules/apps/transfer/keeper/migrations.go	`88.23% <100.00%> (+2.02%)`	⬆️
modules/apps/transfer/types/trace.go	`91.17% <100.00%> (+0.85%)`	⬆️
modules/apps/transfer/keeper/grpc_query.go	`73.07% <0.00%> (-3.85%)`	⬇️

….com:cosmos/ibc-go into colin/1698-parse-ics20-via-channelidentifier

crodriguezvega

Superb work, @colin-axner!

colin-axner added 2 commits July 19, 2022 14:14

refactor: use channel identifier for parsing IBC tokens

900e20c

Change IBC token denomination parsing to use the channel identifier rather than the port Remove unfixable parsing validation test Fix migration tests Add check to migration of traces to panic upon denomination state corruption

add migration test

80117b7

colin-axner requested review from fedekunze and AdityaSripal as code owners July 19, 2022 12:24

colin-axner requested review from crodriguezvega, charleenfei, damiannolan and chatton July 19, 2022 12:24

colin-axner commented Jul 19, 2022

View reviewed changes

colin-axner added 4 commits July 19, 2022 14:29

Update modules/apps/transfer/keeper/migrations.go

f46506e

Update modules/apps/transfer/types/trace_test.go

8e43aa4

add changelog entry

e0a79fe

Merge branch 'colin/1698-parse-ics20-via-channelidentifier' of github…

88eb4d2

….com:cosmos/ibc-go into colin/1698-parse-ics20-via-channelidentifier

colin-axner requested a review from seantking as a code owner July 19, 2022 12:31

damiannolan approved these changes Jul 19, 2022

View reviewed changes

colin-axner and others added 2 commits July 19, 2022 14:37

Update modules/apps/transfer/types/trace.go

2be1b63

Co-authored-by: Damian Nolan <damiannolan@gmail.com>

apply review suggestions

8b57dc5

AdityaSripal approved these changes Jul 19, 2022

View reviewed changes

colin-axner and others added 2 commits July 19, 2022 15:10

Merge branch 'colin/1698-parse-ics20-via-channelidentifier' of github…

2e74b59

….com:cosmos/ibc-go into colin/1698-parse-ics20-via-channelidentifier

update go doc

1348d37

crodriguezvega approved these changes Jul 20, 2022

View reviewed changes

crodriguezvega merged commit b86cdd8 into charly/denom_traces_migration_handler Jul 20, 2022

crodriguezvega deleted the colin/1698-parse-ics20-via-channelidentifier branch July 20, 2022 18:05

crodriguezvega mentioned this pull request Jul 21, 2022

Change denom trace parsing to use channel identifier #1698

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Parse ICS20 denomination using channel identifier format #1730

Parse ICS20 denomination using channel identifier format #1730

colin-axner commented Jul 19, 2022 •

edited

Loading

colin-axner Jul 19, 2022

colin-axner Jul 19, 2022

colin-axner Jul 19, 2022

damiannolan left a comment

damiannolan Jul 19, 2022

colin-axner Jul 19, 2022

AdityaSripal left a comment

AdityaSripal Jul 19, 2022

colin-axner Jul 19, 2022

codecov-commenter commented Jul 19, 2022

crodriguezvega left a comment

Parse ICS20 denomination using channel identifier format #1730

Parse ICS20 denomination using channel identifier format #1730

Conversation

colin-axner commented Jul 19, 2022 • edited Loading

Description

colin-axner Jul 19, 2022

Choose a reason for hiding this comment

colin-axner Jul 19, 2022

Choose a reason for hiding this comment

colin-axner Jul 19, 2022

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

damiannolan Jul 19, 2022

Choose a reason for hiding this comment

colin-axner Jul 19, 2022

Choose a reason for hiding this comment

AdityaSripal left a comment

Choose a reason for hiding this comment

AdityaSripal Jul 19, 2022

Choose a reason for hiding this comment

colin-axner Jul 19, 2022

Choose a reason for hiding this comment

codecov-commenter commented Jul 19, 2022

Codecov Report

crodriguezvega left a comment

Choose a reason for hiding this comment

colin-axner commented Jul 19, 2022 •

edited

Loading