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

Jump to bottom

feat!: add memo to IBC transfers of ICS rewards #2290

Merged
merged 12 commits into from
Sep 27, 2024
Merged

feat!: add memo to IBC transfers of ICS rewards #2290

merged 12 commits into from
Sep 27, 2024

Conversation

mpoke
Copy link
Contributor

@mpoke mpoke commented Sep 19, 2024 •
edited by sainoe
Loading

Description

Closes: #1634

TODO:

  • add e2e tests
  • add info about migration needed on the consumer (new param needs to be initialized)
  • add changelog entries
  • backport to v4.5.x so it can be used by consumers with SDK 0.47

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • Included the correct type prefix in the PR title
  • Added ! to the type prefix if the change is state-machine breaking
  • Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
  • Targeted the correct branch (see PR Targeting)
  • Provided a link to the relevant issue or specification
  • Followed the guidelines for building SDK modules
  • Included the necessary unit and integration tests
  • Added a changelog entry to CHANGELOG.md
  • Included comments for documenting Go code
  • Updated the relevant documentation or specification
  • Reviewed "Files changed" and left comments if necessary
  • Confirmed all CI checks have passed
  • If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! the type prefix if the change is state-machine breaking
  • confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage

@github-actions github-actions bot added C:Testing Assigned automatically by the PR labeler C:x/consumer Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler C:x/types Assigned automatically by the PR labeler labels Sep 19, 2024
@mpoke mpoke mentioned this pull request Sep 19, 2024
Closed
insumity
insumity approved these changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@insumity insumity left a comment

Choose a reason for hiding this comment

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

The draft looks good to me.
Did you talk with @MSalopek about his solution that doesn't involve consumer changes?

@mpoke mpoke assigned sainoe and insumity and unassigned insumity Sep 20, 2024
@mpoke mpoke mentioned this pull request Sep 20, 2024
Closed
@sainoe sainoe marked this pull request as ready for review September 25, 2024 14:23
@sainoe sainoe requested a review from a team as a code owner September 25, 2024 14:23
@sainoe sainoe mentioned this pull request Sep 25, 2024
Closed
21 tasks
insumity
insumity reviewed Sep 26, 2024
View reviewed changes
.changelog/unreleased/features/2290-add-memo-to-ICS-rewards.md.md Outdated
@@ -0,0 +1,4 @@
- `[x/consumer]` Populate the memo on the IBC transfer packets used to send ICS rewards.
Copy link
Contributor

@insumity insumity Sep 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

nit: file name contains twice .md, hence .md.md
Similarly for the file below.

insumity
insumity approved these changes Sep 26, 2024
View reviewed changes
Copy link
Contributor

@insumity insumity left a comment

Choose a reason for hiding this comment

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

Amazing work!

@sainoe sainoe self-requested a review September 27, 2024 16:00
MSalopek
MSalopek approved these changes Sep 27, 2024
View reviewed changes
Copy link
Contributor

@MSalopek MSalopek left a comment

Choose a reason for hiding this comment

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

Admin approval

@sainoe sainoe added this pull request to the merge queue Sep 27, 2024
@sainoe sainoe removed this pull request from the merge queue due to a manual request Sep 27, 2024
@sainoe sainoe added this pull request to the merge queue Sep 27, 2024
Merged via the queue into main with commit 0d78295 Sep 27, 2024
22 of 23 checks passed
@sainoe sainoe deleted the marius/rewards-memo branch September 27, 2024 16:21
mergify bot pushed a commit that referenced this pull request Sep 27, 2024
@mpoke @mergify
feat!: add memo to IBC transfers of ICS rewards (#2290)
9a1b02f 
* add consumer ID to consumer genesis

* add RewardMemo to token transfer

* handle memo on provider side

* fix democ tests

* wip

* add e2e-test

* refactor consumer reward tests

* add consumer migration info

* add changelog

* fix changelog filename

---------

Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com>
(cherry picked from commit 0d78295)

# Conflicts:
#	UPGRADING.md
#	tests/e2e/actions.go
#	tests/e2e/state.go
#	tests/e2e/steps_democracy.go
#	tests/e2e/steps_inactive_vals.go
#	tests/e2e/test_driver.go
#	tests/e2e/testlib/types.go
#	tests/e2e/v4/state.go
#	x/ccv/consumer/migrations/v3/legacy_params.go
#	x/ccv/provider/ibc_middleware.go
#	x/ccv/provider/keeper/consumer_lifecycle.go
#	x/ccv/provider/keeper/consumer_lifecycle_test.go
#	x/ccv/provider/keeper/grpc_query.go
#	x/ccv/provider/types/errors.go
#	x/ccv/provider/types/msg.go
#	x/ccv/provider/types/msg_test.go
#	x/ccv/types/errors.go
#	x/ccv/types/shared_consumer.pb.go
#	x/ccv/types/shared_params.go
@mergify mergify bot mentioned this pull request Sep 27, 2024
Merged
25 tasks
sainoe added a commit that referenced this pull request Sep 27, 2024
@sainoe
Revert "feat!: add memo to IBC transfers of ICS rewards (#2290)"
f875cf4 
This reverts commit 9a1b02f.
sainoe added a commit that referenced this pull request Sep 27, 2024
@mergify @mpoke @sainoe
feat!: add memo to IBC transfers of ICS rewards (backport #2290) (#2312)
084d792 
* add consumer ID to consumer genesis

* add RewardMemo to token transfer

* handle memo on provider side

* add consumer migration info

* add changelog

* fix changelog

* feat!: add memo to IBC transfers of ICS rewards (#2290)

* add consumer ID to consumer genesis

* add RewardMemo to token transfer

* handle memo on provider side

* fix democ tests

* wip

* add e2e-test

* refactor consumer reward tests

* add consumer migration info

* add changelog

* fix changelog filename

---------

Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com>
(cherry picked from commit 0d78295)

# Conflicts:
#	UPGRADING.md
#	tests/e2e/actions.go
#	tests/e2e/state.go
#	tests/e2e/steps_democracy.go
#	tests/e2e/steps_inactive_vals.go
#	tests/e2e/test_driver.go
#	tests/e2e/testlib/types.go
#	tests/e2e/v4/state.go
#	x/ccv/consumer/migrations/v3/legacy_params.go
#	x/ccv/provider/ibc_middleware.go
#	x/ccv/provider/keeper/consumer_lifecycle.go
#	x/ccv/provider/keeper/consumer_lifecycle_test.go
#	x/ccv/provider/keeper/grpc_query.go
#	x/ccv/provider/types/errors.go
#	x/ccv/provider/types/msg.go
#	x/ccv/provider/types/msg_test.go
#	x/ccv/types/errors.go
#	x/ccv/types/shared_consumer.pb.go
#	x/ccv/types/shared_params.go

* Revert "feat!: add memo to IBC transfers of ICS rewards (#2290)"

This reverts commit 9a1b02f.

* fix genesis test

---------

Co-authored-by: mpoke <marius.poke@posteo.de>
Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com>
@coderabbitai coderabbitai bot mentioned this pull request Sep 30, 2024
Merged
12 tasks
@sainoe sainoe mentioned this pull request Sep 30, 2024
Merged
@sainoe sainoe mentioned this pull request Oct 15, 2024
Closed
mergify bot pushed a commit that referenced this pull request Nov 6, 2024
@mpoke @mergify
feat!: add memo to IBC transfers of ICS rewards (#2290)
eb4336f 
* add consumer ID to consumer genesis

* add RewardMemo to token transfer

* handle memo on provider side

* fix democ tests

* wip

* add e2e-test

* refactor consumer reward tests

* add consumer migration info

* add changelog

* fix changelog filename

---------

Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com>
(cherry picked from commit 0d78295)

# Conflicts:
#	tests/e2e/actions.go
#	tests/e2e/steps_democracy.go
#	tests/e2e/steps_inactive_vals.go
#	tests/e2e/test_driver.go
#	tests/e2e/v4/state.go
#	x/ccv/provider/ibc_middleware.go
#	x/ccv/provider/keeper/consumer_lifecycle.go
#	x/ccv/provider/keeper/consumer_lifecycle_test.go
#	x/ccv/provider/keeper/grpc_query.go
#	x/ccv/provider/types/errors.go
#	x/ccv/provider/types/msg.go
#	x/ccv/provider/types/msg_test.go
#	x/ccv/types/errors.go
#	x/ccv/types/shared_consumer.pb.go
#	x/ccv/types/shared_params.go
@mergify mergify bot mentioned this pull request Nov 6, 2024
Closed
25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MSalopek MSalopek MSalopek approved these changes

@insumity insumity insumity approved these changes

@sainoe sainoe Awaiting requested review from sainoe

Assignees

@sainoe sainoe

Labels
A:backport/v4.5.x A:backport/v5.2.x C:Testing Assigned automatically by the PR labeler C:x/consumer Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler C:x/types Assigned automatically by the PR labeler
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enable consumer chains to send ICS rewards in non-native denoms
4 participants
@mpoke @insumity @MSalopek @sainoe