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

docs: ADR-008 – Improvements on rewards withdrawal experience. #462

Merged
merged 6 commits into from
Dec 1, 2023

Conversation

fdymylja
Copy link
Contributor

@fdymylja fdymylja commented Sep 27, 2023

This PR proposes changes to the rewards module to address UX problems on the rewards withdrawal mechanism.

Rendered: https://github.com/archway-network/archway/blob/2930de0a144170db8c76a1ac0d845a73ceceec25/docs/adr/ADR-008-withdrawal-ux-improvements.md

@fdymylja fdymylja requested a review from a team as a code owner September 27, 2023 08:57
@fdymylja fdymylja requested a review from spoo-bar September 27, 2023 08:57
Copy link
Contributor

@zanicar zanicar left a comment

Choose a reason for hiding this comment

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

LGTM

@aelesbao
Copy link
Member

I have only one doubt: should the default behavior be the direct distribution to the wallets, so the developer has the RewardRecord as an opt-in?

@zanicar
Copy link
Contributor

zanicar commented Sep 27, 2023

I have only one doubt: should the default behavior be the direct distribution to the wallets, so the developer has the RewardRecord as an opt-in?

This will invert the current behavior... thus, the suggested approach maintains the current status quo and adds the optional direct withdrawal without affecting any existing deployments; From the tooling, or CLI perspective, we can utilize direct withdrawal as default behavior by always setting the flag, effectively treating rewards records as an opt-in mechanism;

@spoo-bar spoo-bar merged commit f75897a into main Dec 1, 2023
8 checks passed
@spoo-bar spoo-bar deleted the fd/adr-008 branch December 1, 2023 11:39
spoo-bar added a commit that referenced this pull request Jan 22, 2024
* add withdrawal ux improvements adr

* Update ADR-008-withdrawal-ux-improvements.md

Signed-off-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>

* Update CHANGELOG.md

---------

Signed-off-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>
Co-authored-by: Spoorthi Satheesha <9302666+spoo-bar@users.noreply.github.com>
spoo-bar added a commit that referenced this pull request Jan 23, 2024
* refactor(x/rewards): move state to use collections (#475)

* state works in a backwards compatible manner

* migrate contract metadata to use collections

* move params in a backwards compatible way

* move params to use collections

* flat fees moved in backwards compatible way

* move flat fees fully to use collections

* flat fee keys cleanup

* move min cons fee in a non state breaking way

* move min cons fee to use collections fully

* cleanup keys.go

* move blockrewards to collections in a state compatible way

* move genesis to use collections

* move more code to use collections

* remove more code

* move DeleteBLockRewardsCascade from State to Keeper

* move tx rewards to collections in a safe way

* more of TxRewards state moved to collections

* fully migrate TxRewards to collections

* checkpoint

* remove GetRewardsByRewardAddr in state_rewards_record.go

* remove CreateRewardsRecord in state_rewards_record.go

* remove more from state_rewards_record.go

* tmp commit

* remove all unneeded things

* finalise fast removal

* fix prefix and cleanup

* lint fully + CHANGELOG.md

* address nits

* feat(rewards): enhance withdrawal of rewards developer experience (#502)

* add proto files and backwards compat test

* add changes + tests to distribution

* lint

* CHANGELOG.md

---------

Signed-off-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>

* docs: ADR-008 – Improvements on rewards withdrawal experience. (#462)

* add withdrawal ux improvements adr

* Update ADR-008-withdrawal-ux-improvements.md

Signed-off-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>

* Update CHANGELOG.md

---------

Signed-off-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>
Co-authored-by: Spoorthi Satheesha <9302666+spoo-bar@users.noreply.github.com>

* running swagger gen

---------

Signed-off-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>
Co-authored-by: Frojdi Dymylja <33157909+fdymylja@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants