refactor: remove SendTransfer, require IBC transfers to be initiated with MsgTransfer by colin-axner · Pull Request #2446 · cosmos/ibc-go

colin-axner · 2022-09-29T16:49:26Z

Description

closes: #1918

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

Remove SendTransfer function. MsgTransfer should be used which will call sendTransfer Tests refactored to utilize MsgTransfer. Simplified test logic.

colin-axner · 2022-09-29T16:52:54Z

modules/apps/transfer/keeper/msg_server_test.go


 	for _, tc := range testCases {
-		suite.SetupTest()
+		suite.Run(tc.name, func() {


I like using suite.Run because it adds the test case name to the output if it fails

modules/apps/transfer/keeper/relay_test.go

codecov-commenter · 2022-09-29T17:17:48Z

Codecov Report

Merging #2446 (cca0b61) into main (4bd05c6) will increase coverage by 0.04%.
The diff coverage is 66.66%.

❗ Current head cca0b61 differs from pull request most recent head 9e03e65. Consider uploading reports for the commit 9e03e65 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2446      +/-   ##
==========================================
+ Coverage   78.70%   78.74%   +0.04%     
==========================================
  Files         178      178              
  Lines       12311    12298      -13     
==========================================
- Hits         9689     9684       -5     
+ Misses       2195     2190       -5     
+ Partials      427      424       -3

Impacted Files	Coverage Δ
modules/apps/29-fee/types/msgs.go	`90.43% <ø> (-0.33%)`	⬇️
modules/core/02-client/types/msgs.go	`75.73% <ø> (ø)`
.../27-interchain-accounts/controller/types/params.go	`47.82% <33.33%> (ø)`
...s/apps/27-interchain-accounts/host/types/params.go	`42.10% <33.33%> (ø)`
modules/apps/transfer/types/params.go	`48.00% <40.00%> (ø)`
modules/apps/transfer/ibc_module.go	`64.96% <66.66%> (+0.03%)`	⬆️
modules/apps/transfer/keeper/msg_server.go	`100.00% <100.00%> (ø)`
modules/apps/transfer/keeper/relay.go	`90.63% <100.00%> (+2.56%)`	⬆️
modules/apps/transfer/types/msgs.go	`95.12% <100.00%> (-0.12%)`	⬇️
modules/apps/transfer/types/packet.go	`92.00% <100.00%> (+0.33%)`	⬆️
... and 1 more

crodriguezvega

Nice work on the tests! 👏

CHANGELOG.md

crodriguezvega · 2022-09-30T07:39:22Z

modules/apps/transfer/keeper/relay.go

 	timeoutHeight clienttypes.Height,
 	timeoutTimestamp uint64,
 ) error {
-	if !k.GetSendEnabled(ctx) {


What's the reason to move these checks to the message server?

I believe the message server was added after send enabled, which is why it ended up within "SendTransfer"

The reasoning for why I moved it is because I view it as auxiliary to the transfer logic. It isn't in the IBC specification for ICS20

I visualize the code like this:

// entry point MsgTransfer // basic checks/auxiliary logic IsSendEnabeld? IsSenderBlocked? // perform ics20 logic sendTransfer

I think this should be true for most of our handlers:

// single entry point, Msg... // basic checks in msg_server.go isEnabled? object.ValidateBasic() // perform logic (typically relay.go)

In general I think we should avoid overloading functions. Basic enablement checks make sense to go directly in the entrypoint (msg_server.go), while functions nested deeper in the handler can focus on ICS logic entirely

Agree++

Definitely a good way to reason about things!

modules/apps/transfer/keeper/msg_server_test.go

crodriguezvega · 2022-09-30T08:02:28Z

modules/apps/transfer/keeper/relay_test.go

+
 			if tc.expPass {
 				suite.Require().NoError(err)
+				suite.Require().NotNil(res)


Do you think we should also add here checks for changes that we expect to have happened in case of success (e.g. the expected amount is escrowed in the escrow account)? We check for this already in the e2e tests but maybe it's good to add here for redundancy?

Same comment maybe for the failure cases.

I think we should. But maybe we should do in a followup issue so as not to increase the scope of this one too much?

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

damiannolan

Super clean refactor. Nice work!

damiannolan · 2022-10-04T10:16:11Z

modules/apps/transfer/keeper/relay.go

 	timeoutHeight clienttypes.Height,
 	timeoutTimestamp uint64,
 ) error {
-	if !k.GetSendEnabled(ctx) {


Agree++

Definitely a good way to reason about things!

…e-SendTransfer-pubclicfunc

…om:cosmos/ibc-go into colin/1918-remove-SendTransfer-pubclicfunc

…e-SendTransfer-pubclicfunc

…om:cosmos/ibc-go into colin/1918-remove-SendTransfer-pubclicfunc

…with MsgTransfer (#2446) ## Description closes: #1918 --- 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. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [x] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [x] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing) - [x] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [x] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [x] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [x] Re-reviewed `Files changed` in the Github PR explorer - [x] Review `Codecov Report` in the comment section below once CI passes (cherry picked from commit 24b17bd) # Conflicts: # modules/apps/transfer/keeper/mbt_relay_test.go # modules/apps/transfer/keeper/msg_server_test.go # modules/apps/transfer/keeper/relay.go # modules/apps/transfer/keeper/relay_test.go

…with MsgTransfer (backport #2446) (#2527) * refactor: remove SendTransfer, require IBC transfers to be initiated with MsgTransfer (#2446) ## Description closes: #1918 --- 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. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [x] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [x] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing) - [x] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [x] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [x] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [x] Re-reviewed `Files changed` in the Github PR explorer - [x] Review `Codecov Report` in the comment section below once CI passes (cherry picked from commit 24b17bd) # Conflicts: # modules/apps/transfer/keeper/mbt_relay_test.go # modules/apps/transfer/keeper/msg_server_test.go # modules/apps/transfer/keeper/relay.go # modules/apps/transfer/keeper/relay_test.go * fix test Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Carlos Rodriguez <crodveg@gmail.com>

colin-axner added 2 commits September 29, 2022 18:48

refactor: remove SendTransfer public function in favor of MsgTransfer

4db8313

Remove SendTransfer function. MsgTransfer should be used which will call sendTransfer Tests refactored to utilize MsgTransfer. Simplified test logic.

add changelog entry

d2da1c9

colin-axner changed the title ~~refactor: remove SendTransfer public function in favor of MsgTransfer~~ refactor: remove SendTransfer, require IBC transfers to be initiated with MsgTransfer Sep 29, 2022

self review: increase code coverage, fix minor bugs

e87087b

colin-axner commented Sep 29, 2022

View reviewed changes

Merge branch 'main' into colin/1918-remove-SendTransfer-pubclicfunc

7549663

colin-axner marked this pull request as ready for review September 29, 2022 17:08

colin-axner requested review from AdityaSripal, charleenfei, chatton, crodriguezvega, damiannolan and seantking as code owners September 29, 2022 17:08

crodriguezvega reviewed Sep 30, 2022

View reviewed changes

crodriguezvega added the backport-to-v6.0.x label Oct 3, 2022

colin-axner and others added 3 commits October 3, 2022 15:53

Update CHANGELOG.md

05098fb

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

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

c7bb641

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

Merge branch 'main' into colin/1918-remove-SendTransfer-pubclicfunc

1f03958

damiannolan approved these changes Oct 4, 2022

View reviewed changes

colin-axner added 5 commits October 6, 2022 13:22

Merge branch 'main' of github.com:cosmos/ibc-go into colin/1918-remov…

a11a447

…e-SendTransfer-pubclicfunc

Merge branch 'colin/1918-remove-SendTransfer-pubclicfunc' of github.c…

a3d80c7

…om:cosmos/ibc-go into colin/1918-remove-SendTransfer-pubclicfunc

Merge branch 'main' of github.com:cosmos/ibc-go into colin/1918-remov…

1b41b9b

…e-SendTransfer-pubclicfunc

self review fix

9351467

Merge branch 'main' into colin/1918-remove-SendTransfer-pubclicfunc

dabfc5c

colin-axner requested a review from crodriguezvega October 6, 2022 14:54

crodriguezvega approved these changes Oct 11, 2022

View reviewed changes

colin-axner added 3 commits October 11, 2022 12:21

Merge branch 'main' of github.com:cosmos/ibc-go into colin/1918-remov…

9c4d411

…e-SendTransfer-pubclicfunc

Merge branch 'colin/1918-remove-SendTransfer-pubclicfunc' of github.c…

a878376

…om:cosmos/ibc-go into colin/1918-remove-SendTransfer-pubclicfunc

chore: remove outdated testing comments

cca0b61

colin-axner added the automerge label Oct 11, 2022

Merge branch 'main' into colin/1918-remove-SendTransfer-pubclicfunc

9e03e65

mergify bot merged commit 24b17bd into main Oct 11, 2022

mergify bot deleted the colin/1918-remove-SendTransfer-pubclicfunc branch October 11, 2022 10:43

mergify bot mentioned this pull request Oct 11, 2022

refactor: remove SendTransfer, require IBC transfers to be initiated with MsgTransfer (backport #2446) #2527

Merged

damiannolan mentioned this pull request Oct 14, 2022

docs: adding migration doc for ibc-go v6 #2417

Merged

9 tasks

chatton mentioned this pull request Nov 7, 2022

Add git cliff toml to support generation of changelog #2697

Merged

9 tasks

llama-del-rey mentioned this pull request Jan 5, 2023

Update ibc-go to v6.1 provenance-io/provenance#1278

Merged

8 tasks

Conversation

colin-axner commented Sep 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

colin-axner Sep 29, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Sep 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

crodriguezvega left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

crodriguezvega Sep 30, 2022

Choose a reason for hiding this comment

Uh oh!

colin-axner Oct 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

colin-axner Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

damiannolan Oct 4, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

crodriguezvega Sep 30, 2022

Choose a reason for hiding this comment

Uh oh!

colin-axner Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

damiannolan left a comment

Choose a reason for hiding this comment

Uh oh!

damiannolan Oct 4, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

colin-axner commented Sep 29, 2022 •

edited

Loading

codecov-commenter commented Sep 29, 2022 •

edited

Loading

colin-axner Oct 3, 2022 •

edited

Loading