Protorev: Update timing for pool updating and dev fee payout #4827

NotJeremyLiu · 2023-04-03T22:41:43Z

What is the purpose of the change

This PR updates the timing cadence of certain protorev logic:

Changes dev account payment from once per week to after every trade (this is because the accumulation into the module account and taking from it has bad UX for those tracking protorev profits)
Changes highest liquidity pools updating from once per week to daily
Sets up protorev module for v16 upgrade migration

Brief Changelog

Uses daily epoch instead of weekly epoch for highest liquidity updating
Removes all developer fee logic from epoch triggering into ExecuteTrade triggering
Adds an upgrade migration in ProtoRev to payout what is left in the store when the v16 upgrade happens. This store will no longer be used with the new logic
Marks (via comments) no longer used functions in v16 as deprecated , and also denotes functions used only for the upgrade as removable in v17

Testing and Verifying

Removed tests for no longer used methods
Added a test for the new SendDeveloperFee method
All other tests pass after setting the developer account in the tests
Added checks in the TestUpgrade() function in v16 upgrade_test.go to ensure protorev upgrades properly (transfers all leftover dev fee funds in the store the the dev account)

Documentation and Release Note

Changelog added
Documentation has been updated to reflect new changes

- Not optimal because it still stores state, but want to show minimal working version - All tests pass after setting dev account for the tests, no new tests added

NotJeremyLiu · 2023-04-03T22:43:05Z

This commit is a minimal code change version of sending developer profit after every trade: 5bacd9e

It's not optimized for this change since it still stores state to track the dev fee (which is now unnecessary). Will be changed in a future commit to be an optimal version

bpiv400 · 2023-04-03T23:23:02Z

Should we interpret this as unfinished until the unnecessary state tracking is removed?

NotJeremyLiu · 2023-04-03T23:24:38Z

Should we interpret this as unfinished until the unnecessary state tracking is removed?

ye all these draft PRs are kinda not in review state lol, just putting them up as drafts for my own organization

- removes functions no longer necessary - Still needs upgrade migration work - Still needs a way to pay current dev fee payment to us during the upgrade - still needs to get tests to pass

github-actions · 2023-04-20T00:02:02Z

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

This reverts commit 1f2f3dc.

This reverts commit 49c7eaf.

- When testing via the upgrades_test.go file, the protorev migration would not run since it treated the from and to version to be 2 (pulling from the new consensus version set) - When adding this line and hardcoding the from version to 1, the upgrade processes as expected

This reverts commit da4efca.

This reverts commit 127dc5b.

app/upgrades/v16/upgrades.go

p0mvn · 2023-05-25T16:19:25Z

app/upgrades/v16/upgrades.go

+		if err := keepers.ProtoRevKeeper.SendDeveloperFeesToDeveloperAccount(ctx); err != nil {
+			ctx.Logger().Error("error sending developer fees to developer account during upgrade, expected in testing, not in prod", "error", err)
+		}


I would prefer it if this is handled properly. I know the process for updating e2e is cumbersome. However, handling this in the right way and e2e testing will save us time during the upgrade if any issues occur.

The process for setting this account in e2e is the following:

update e2e genesis for the protorev module in a separate PR:

osmosis/tests/e2e/initialization/config.go

Lines 234 to 237 in 1e56cc6

err = updateModuleGenesis(appGenState, staketypes.ModuleName, &staketypes.GenesisState{}, updateStakeGenesis)

if err != nil {

return err

}

backport that PR to v15.x

Grab the chain init docker image with v15 tag from here: https://hub.docker.com/r/osmolabs/osmosis-e2e-init-chain/tags

should be auto-uploaded

Copy this tag:

osmosis/tests/e2e/containers/config.go

Line 27 in 1e56cc6

previousVersionOsmoTag = "v15.x-833705e4-1679340262"

@p0mvn @stackman27 The PR for steps 1-2 is ready for review: #5312

If I understand correctly, once the above PR is merged, I will then be able to get the docker tag and then update the tag in this PR, to continue forward.

hi @NotJeremyLiu is this PR r4r now. I think just needs rebasing right?

@stackman27 I just updated the tag and removed the failing test, letting it run through workflow to see if all is good

Co-authored-by: Roman <[email protected]>

p0mvn · 2023-05-25T23:32:27Z

tests/e2e/containers/config.go

@@ -24,7 +24,7 @@ const (
 	// It should be uploaded to Docker Hub. OSMOSIS_E2E_SKIP_UPGRADE should be unset
 	// for this functionality to be used.
 	previousVersionOsmoRepository = "osmolabs/osmosis-dev"
-	previousVersionOsmoTag        = "v15.x-833705e4-1679340262"
+	previousVersionOsmoTag        = "v15.x-63e3f053-1685053483"


please also bump previousVersionInitTag below to v15.x-63e3f053-1685053483

NotJeremyLiu · 2023-05-26T00:25:43Z

All checks pass, finally r4r @stackman27

stackman27

LGTM

p0mvn

LGTM

p0mvn · 2023-05-26T02:00:55Z

x/protorev/keeper/developer_fees.go

+// Deprecated: Can be removed in v16
 // UpdateDeveloperFees updates the fees that developers can withdraw from the module account
 func (k Keeper) UpdateDeveloperFees(ctx sdk.Context, denom string, profit sdk.Int) error {


Let's remove now?

This is unused now. Please submit separate PR if agreed. Not going to block merge on this

* Update highest liquidity pools in daily epoch instead of weekly * Minimal code change to send dev profit after every trade - Not optimal because it still stores state, but want to show minimal working version - All tests pass after setting dev account for the tests, no new tests added * Handles dev fee payment without storing in kvstore - removes functions no longer necessary - Still needs upgrade migration work - Still needs a way to pay current dev fee payment to us during the upgrade - still needs to get tests to pass * Increase consensus version * Revert "Handles dev fee payment without storing in kvstore" This reverts commit 1f2f3dc. * add upgrade logic, new functions, and deprecated comments * add another todo * Revert "add another todo" This reverts commit 49c7eaf. * add another todo * Panic on migration error * Hardcode protorev from version to 1 - When testing via the upgrades_test.go file, the protorev migration would not run since it treated the from and to version to be 2 (pulling from the new consensus version set) - When adding this line and hardcoding the from version to 1, the upgrade processes as expected * Add tests to ensure protorev upgrade is successful * Remove deprecated comment to pass linter * lint * add changelog entry * Change documentation to reflect new timing cadence * Change developer_fees test for new SendDeveloperFee method - Removes tests for no longer used functions - Adds a test for the new SendDeveloperFee method * Update app/upgrades/v16/upgrades.go fix typo Co-authored-by: David Terpay <[email protected]> * move test to top of file, helper at bottom * fix merge conflict typo * added migration function to upgrades.go * bump consensus version to 2 * comment out everything upgrade related to isolate problem * Revert "comment out everything upgrade related to isolate problem" This reverts commit da4efca. * Revert "bump consensus version to 2" This reverts commit 127dc5b. * log instead of pass back up errors * Remove commented out code * clean up comments * add clarifying comment * fix typpo Co-authored-by: Roman <[email protected]> * update v15 prev version tag in e2e container * remove e2e test that checks protorev dev account not initialized * return err if protorev dev account payment errors during upgrade * Add dev fee payment check when testing trade execution --------- Co-authored-by: David Terpay <[email protected]> Co-authored-by: stackman27 <[email protected]> Co-authored-by: Roman <[email protected]>

NotJeremyLiu added 2 commits April 3, 2023 14:49

Update highest liquidity pools in daily epoch instead of weekly

df18e54

Minimal code change to send dev profit after every trade

5bacd9e

- Not optimal because it still stores state, but want to show minimal working version - All tests pass after setting dev account for the tests, no new tests added

NotJeremyLiu added the V:state/breaking State machine breaking PR label Apr 3, 2023

NotJeremyLiu changed the title ~~Jl/protorev update timing~~ Protorev: Update timing for pool updating and dev fee payout Apr 4, 2023

NotJeremyLiu added the protorev All things related to x/protorev label Apr 4, 2023

Handles dev fee payment without storing in kvstore

1f2f3dc

- removes functions no longer necessary - Still needs upgrade migration work - Still needs a way to pay current dev fee payment to us during the upgrade - still needs to get tests to pass

p0mvn mentioned this pull request Apr 10, 2023

[v16]: Scoping issue #4700

Closed

github-actions bot added the Stale label Apr 20, 2023

NotJeremyLiu mentioned this pull request Apr 24, 2023

ProtoRev v16 Tracking Issue #4997

Closed

3 tasks

NotJeremyLiu added 2 commits April 24, 2023 15:47

Merge branch 'main' into jl/protorev-update-timing

955b2aa

Increase consensus version

9189461

github-actions bot added the C:app-wiring Changes to the app folder label Apr 24, 2023

NotJeremyLiu added 6 commits April 24, 2023 16:32

Revert "Handles dev fee payment without storing in kvstore"

efbd26e

This reverts commit 1f2f3dc.

add upgrade logic, new functions, and deprecated comments

744d22e

add another todo

49c7eaf

Revert "add another todo"

104720a

This reverts commit 49c7eaf.

add another todo

c8f8ff3

Panic on migration error

865161c

github-actions bot removed the Stale label Apr 25, 2023

NotJeremyLiu added 7 commits April 25, 2023 17:41

Add tests to ensure protorev upgrade is successful

e7b0047

Remove deprecated comment to pass linter

2653b70

lint

f457bed

add changelog entry

2474ad6

Merge branch 'main' into jl/protorev-update-timing

17a85bf

Change documentation to reflect new timing cadence

5ebb8b6

NotJeremyLiu added 8 commits May 24, 2023 10:52

bump consensus version to 2

127dc5b

comment out everything upgrade related to isolate problem

da4efca

Revert "comment out everything upgrade related to isolate problem"

314d1c4

This reverts commit da4efca.

Revert "bump consensus version to 2"

43b0abb

This reverts commit 127dc5b.

log instead of pass back up errors

e68be34

Remove commented out code

f0a88c9

clean up comments

b069fa1

add clarifying comment

6723370

NotJeremyLiu requested a review from stackman27 May 25, 2023 15:50

Merge branch 'main' into jl/protorev-update-timing

af008b7

p0mvn reviewed May 25, 2023

View reviewed changes

NotJeremyLiu and others added 5 commits May 25, 2023 12:20

fix typpo

61b7c83

Co-authored-by: Roman <[email protected]>

Merge branch 'main' into jl/protorev-update-timing

3be7cbc

update v15 prev version tag in e2e container

7f8f1e9

remove e2e test that checks protorev dev account not initialized

0d63186

return err if protorev dev account payment errors during upgrade

4957aff

p0mvn reviewed May 25, 2023

View reviewed changes

Merge branch 'main' into jl/protorev-update-timing

783e448

stackman27 approved these changes May 26, 2023

View reviewed changes

Add dev fee payment check when testing trade execution

fced67d

p0mvn approved these changes May 26, 2023

View reviewed changes

p0mvn merged commit 13fd14a into main May 26, 2023

p0mvn deleted the jl/protorev-update-timing branch May 26, 2023 02:10

stackman27 mentioned this pull request May 26, 2023

Jl/fix e2e #5285

Closed

6 tasks

github-actions bot mentioned this pull request Feb 15, 2024

Broken Links Detected #7491

Closed

github-actions bot mentioned this pull request Mar 15, 2024

Broken Links Detected #7752

Closed

github-actions bot mentioned this pull request May 15, 2024

Broken Links Detected #8269

Closed

github-actions bot mentioned this pull request Nov 1, 2024

Broken Links Detected notional-labs/osmosis#76

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Protorev: Update timing for pool updating and dev fee payout #4827

Protorev: Update timing for pool updating and dev fee payout #4827

NotJeremyLiu commented Apr 3, 2023 •

edited

Loading

NotJeremyLiu commented Apr 3, 2023

bpiv400 commented Apr 3, 2023

NotJeremyLiu commented Apr 3, 2023

github-actions bot commented Apr 20, 2023

p0mvn May 25, 2023 •

edited

Loading

NotJeremyLiu May 25, 2023

stackman27 May 25, 2023

NotJeremyLiu May 25, 2023

p0mvn May 25, 2023 •

edited

Loading

NotJeremyLiu commented May 26, 2023

stackman27 left a comment

p0mvn left a comment

p0mvn May 26, 2023

p0mvn May 26, 2023

	err = updateModuleGenesis(appGenState, staketypes.ModuleName, &staketypes.GenesisState{}, updateStakeGenesis)
	if err != nil {
	return err
	}

Protorev: Update timing for pool updating and dev fee payout #4827

Protorev: Update timing for pool updating and dev fee payout #4827

Conversation

NotJeremyLiu commented Apr 3, 2023 • edited Loading

What is the purpose of the change

Brief Changelog

Testing and Verifying

Documentation and Release Note

NotJeremyLiu commented Apr 3, 2023

bpiv400 commented Apr 3, 2023

NotJeremyLiu commented Apr 3, 2023

github-actions bot commented Apr 20, 2023

p0mvn May 25, 2023 • edited Loading

Choose a reason for hiding this comment

NotJeremyLiu May 25, 2023

Choose a reason for hiding this comment

stackman27 May 25, 2023

Choose a reason for hiding this comment

NotJeremyLiu May 25, 2023

Choose a reason for hiding this comment

p0mvn May 25, 2023 • edited Loading

Choose a reason for hiding this comment

NotJeremyLiu commented May 26, 2023

stackman27 left a comment

Choose a reason for hiding this comment

p0mvn left a comment

Choose a reason for hiding this comment

p0mvn May 26, 2023

Choose a reason for hiding this comment

p0mvn May 26, 2023

Choose a reason for hiding this comment

NotJeremyLiu commented Apr 3, 2023 •

edited

Loading

p0mvn May 25, 2023 •

edited

Loading

p0mvn May 25, 2023 •

edited

Loading