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.

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

(feat) Add possibility to transfer entire balance. #6877

Merged
merged 10 commits into from
Jul 23, 2024

Conversation

bznein
Copy link
Contributor

@bznein bznein commented Jul 18, 2024

Description

closes: #6567


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 the 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 and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

Changes look good to me, @bznein. Maybe it would be worth adding a short e2e test and check that the balance of the account is zero after the transfer. Might be worth using 2 denoms in the e2e test.

@bznein
Copy link
Contributor Author

bznein commented Jul 19, 2024

Changes look good to me, @bznein. Maybe it would be worth adding a short e2e test and check that the balance of the account is zero after the transfer. Might be worth using 2 denoms in the e2e test.

Thanks Carlos! I've added the test, LMK if this is what you meant. FIY the test failed locally unless I manually built a new image and used that. I assume this would not happen in the CI.

Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

this lgtm. thanks! 🙏 We should probably document this in the transfer docs too.

modules/apps/transfer/keeper/relay.go Outdated Show resolved Hide resolved
Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Copy link
Contributor

@gjermundgaraba gjermundgaraba left a comment

Choose a reason for hiding this comment

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

Nice add-on! LGTM 🚀

@bznein bznein enabled auto-merge July 19, 2024 16:21
@crodriguezvega crodriguezvega added the priority PRs that need prompt reviews label Jul 22, 2024
Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

Thanks, @bznein. I left just one comment.

})

t.Run("send entire balance from B to A", func(t *testing.T) {
transferTxResp := s.Transfer(ctx, chainB, chainBWallet, channelA.Counterparty.PortID, channelA.Counterparty.ChannelID, sdk.NewCoins(sdk.NewCoin(chainBIBCToken.IBCDenom(), transfertypes.UnboundedSpendLimit())), chainBAddress, chainAAddress, s.GetTimeoutHeight(ctx, chainB), 0, "", nil)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we transfer the whole balance for both the native chain B denom and the IBC denom? Just to test that it all works fine with multidenom.

Copy link
Member

Choose a reason for hiding this comment

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

Why not!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea, done

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

Nice work, lgtm!

testing/chain.go Outdated Show resolved Hide resolved
modules/apps/transfer/types/token.go Show resolved Hide resolved
})

t.Run("send entire balance from B to A", func(t *testing.T) {
transferTxResp := s.Transfer(ctx, chainB, chainBWallet, channelA.Counterparty.PortID, channelA.Counterparty.ChannelID, sdk.NewCoins(sdk.NewCoin(chainBIBCToken.IBCDenom(), transfertypes.UnboundedSpendLimit())), chainBAddress, chainAAddress, s.GetTimeoutHeight(ctx, chainB), 0, "", nil)
Copy link
Member

Choose a reason for hiding this comment

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

Why not!

CHANGELOG.md Outdated Show resolved Hide resolved
@bznein bznein added this pull request to the merge queue Jul 23, 2024
@crodriguezvega crodriguezvega removed this pull request from the merge queue due to a manual request Jul 23, 2024
@crodriguezvega
Copy link
Contributor

@bznein Before merging the PR, should we address the latest comments?

@bznein
Copy link
Contributor Author

bznein commented Jul 23, 2024

@bznein Before merging the PR, should we address the latest comments?

Ah! Yeah sorry I added it at some point thiking it was ready to get merged (but it wasn't) and never removed it!

Copy link

sonarcloud bot commented Jul 23, 2024

@bznein bznein added this pull request to the merge queue Jul 23, 2024
Merged via the queue into main with commit 92e1f38 Jul 23, 2024
72 of 74 checks passed
@bznein bznein deleted the bznein/6567/TransferOfEntireBalance branch July 23, 2024 09:33
mergify bot pushed a commit that referenced this pull request Jul 23, 2024
* Add possibility to transfer entire balance.

* Added entry to the Changelog.

* Added e2e test

* Added forwarding

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Move UnboundedSpendLimit to token.go

* add documentation

* add test to compatibility matrices

* PR Feedback.

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 92e1f38)

# Conflicts:
#	.github/compatibility-test-matrices/release-v9.0.x/transfer-v2-multidenom-chain-a.json
mergify bot pushed a commit that referenced this pull request Jul 23, 2024
* Add possibility to transfer entire balance.

* Added entry to the Changelog.

* Added e2e test

* Added forwarding

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Move UnboundedSpendLimit to token.go

* add documentation

* add test to compatibility matrices

* PR Feedback.

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 92e1f38)

# Conflicts:
#	.github/compatibility-test-matrices/main/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/release-v9.0.x/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/unreleased/transfer-v2-multidenom.json
#	CHANGELOG.md
#	docs/docs/02-apps/01-transfer/04-messages.md
#	docs/docs/02-apps/01-transfer/10-ICS20-v1/04-messages.md
#	e2e/tests/transfer/base_test.go
#	modules/apps/transfer/keeper/relay.go
#	modules/apps/transfer/keeper/relay_test.go
#	modules/apps/transfer/types/token.go
#	modules/apps/transfer/types/transfer_authorization.go
#	testing/chain.go
mergify bot pushed a commit that referenced this pull request Jul 23, 2024
* Add possibility to transfer entire balance.

* Added entry to the Changelog.

* Added e2e test

* Added forwarding

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Move UnboundedSpendLimit to token.go

* add documentation

* add test to compatibility matrices

* PR Feedback.

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 92e1f38)

# Conflicts:
#	.github/compatibility-test-matrices/main/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/release-v9.0.x/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/unreleased/transfer-v2-multidenom.json
#	CHANGELOG.md
#	docs/docs/02-apps/01-transfer/04-messages.md
#	docs/docs/02-apps/01-transfer/10-ICS20-v1/04-messages.md
#	e2e/tests/transfer/base_test.go
#	modules/apps/transfer/keeper/relay.go
#	modules/apps/transfer/keeper/relay_test.go
#	modules/apps/transfer/types/token.go
#	modules/apps/transfer/types/transfer_authorization.go
crodriguezvega added a commit that referenced this pull request Jul 25, 2024
…6929)

* (feat) Add possibility to transfer entire balance. (#6877)

* Add possibility to transfer entire balance.

* Added entry to the Changelog.

* Added e2e test

* Added forwarding

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Move UnboundedSpendLimit to token.go

* add documentation

* add test to compatibility matrices

* PR Feedback.

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 92e1f38)

# Conflicts:
#	.github/compatibility-test-matrices/main/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/release-v9.0.x/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/unreleased/transfer-v2-multidenom.json
#	CHANGELOG.md
#	docs/docs/02-apps/01-transfer/04-messages.md
#	docs/docs/02-apps/01-transfer/10-ICS20-v1/04-messages.md
#	e2e/tests/transfer/base_test.go
#	modules/apps/transfer/keeper/relay.go
#	modules/apps/transfer/keeper/relay_test.go
#	modules/apps/transfer/types/token.go
#	modules/apps/transfer/types/transfer_authorization.go
#	testing/chain.go

* fix conflicts

* lint

* delete docs

---------

Co-authored-by: Nikolas De Giorgis <nikolas.degiorgis@interchain.io>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
crodriguezvega added a commit that referenced this pull request Jul 25, 2024
…6930)

* (feat) Add possibility to transfer entire balance. (#6877)

* Add possibility to transfer entire balance.

* Added entry to the Changelog.

* Added e2e test

* Added forwarding

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Move UnboundedSpendLimit to token.go

* add documentation

* add test to compatibility matrices

* PR Feedback.

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 92e1f38)

# Conflicts:
#	.github/compatibility-test-matrices/main/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/release-v9.0.x/transfer-v2-multidenom-chain-a.json
#	.github/compatibility-test-matrices/unreleased/transfer-v2-multidenom.json
#	CHANGELOG.md
#	docs/docs/02-apps/01-transfer/04-messages.md
#	docs/docs/02-apps/01-transfer/10-ICS20-v1/04-messages.md
#	e2e/tests/transfer/base_test.go
#	modules/apps/transfer/keeper/relay.go
#	modules/apps/transfer/keeper/relay_test.go
#	modules/apps/transfer/types/token.go
#	modules/apps/transfer/types/transfer_authorization.go

* fix conflicts

* remove unused code

---------

Co-authored-by: Nikolas De Giorgis <nikolas.degiorgis@interchain.io>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
crodriguezvega added a commit that referenced this pull request Jul 26, 2024
…6920)

* (feat) Add possibility to transfer entire balance. (#6877)

* Add possibility to transfer entire balance.

* Added entry to the Changelog.

* Added e2e test

* Added forwarding

* Update modules/apps/transfer/keeper/relay.go

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>

* Move UnboundedSpendLimit to token.go

* add documentation

* add test to compatibility matrices

* PR Feedback.

---------

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
(cherry picked from commit 92e1f38)

# Conflicts:
#	.github/compatibility-test-matrices/release-v9.0.x/transfer-v2-multidenom-chain-a.json

* delete e2e

* Revert "delete e2e"

This reverts commit 71db49e.

---------

Co-authored-by: Nikolas De Giorgis <nikolas.degiorgis@interchain.io>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: IBC transfers of the entire balance of a particular denomination.
5 participants