fix(ProtoRev): Parameterizing Pool Type Information #5948

davidterpay · 2023-08-01T22:59:40Z

What is the purpose of the change

In this PR, I refactor the way we track information about different pool types in ProtoRev. In particular, currently each pool type has an associated pool weight (estimated amount of time in ms it takes to make a swap on that pool). However, with the addition of Cosmwasm and CL pools, we will likely need to make more assumptions based on pool type. The most basic one is MaxTicksCrossed which denotes the number of ticks we are willing to cross in our binary search.

This update will allow us to have more control over how ProtoRev responds to different pool types.

Testing and Verifying

Refactored all of the previous unit tests to use the new pool info type
Added tests for basic validation on the different pool types

Documentation and Release Note

Changelog entry added to Unreleased section of CHANGELOG.md?

This is related to the over-arching issue tracking protorev V17 updates. #5858

x/protorev/types/constants.go

x/protorev/types/genesis.go

app/upgrades/v17/upgrades.go

davidterpay · 2023-08-02T21:56:47Z

proto/osmosis/protorev/v1beta1/protorev.proto

+// CosmwasmPoolInfo contains meta data pertaining to a cosmwasm pool type.
+message CosmwasmPoolInfo {
+  // The weight of a cosmwasm pool (by contract address)
+  map<string, uint64> weight_map = 1 [


I'm not sure if using a map is problematic for app hashing. We do no iterations on the map itself in the module. The primary use case is determining the number of pool weight of a given cosmwasm pool (which may vary across applications which is why its mapped to contract addresses).

@ValarDragon can you verify the safety of this?

We had instances where we tried to use maps quite a while ago, I think the decision back then was to try avoid using maps for extra safety, would it be possible to change it so tht we use repeated structs instead here?

got it. ty for confirming

NotJeremyLiu · 2023-08-03T16:01:49Z

x/protorev/client/cli/tx.go

+			},
+			"cosmwasm" : {
+				"weight_map" : {
+					"ibc/123..." : 1,


Suggested change

"ibc/123..." : 1,

"osmo123..." : 1,

nit: cosmwasm weight map represents address to weight, so use an address placeholder instead of an asset placeholder

NotJeremyLiu

lgtm, left comments on the benchmark decisions

davidterpay · 2023-08-04T18:16:35Z

Execution time of a swap on a three pool route with a CW pool. Total execution time was ~8ms and balancer pools normally take around ~2ms to execute.

davidterpay · 2023-08-04T19:33:08Z

goos: darwin
goarch: arm64
pkg: github.com/osmosis-labs/osmosis/v17/x/protorev/keeper
BenchmarkFourHopHotRouteArb-10    	       175	               1402491 ns/op	       1132910 B/op	       20913 allocs/op

Base weight on CL pools should be around 7 (takes 7ms to execute a route with a CL pool).

czarcas7ic

Everything except for the map in the proto and the changed proto field looks good to me. Will need a second ack before merge. Thank you!

czarcas7ic · 2023-08-05T00:35:06Z

proto/osmosis/protorev/v1beta1/genesis.proto

+  // Information that is used to estimate execution time / gas
+  // consumption of a swap on a given pool type.
+  InfoByPoolType info_by_pool_type = 4 [
    (gogoproto.nullable) = false,
-    (gogoproto.moretags) = "yaml:\"pool_weights\""
+    (gogoproto.moretags) = "yaml:\"info_by_pool_type\""


If we are renaming the proto field, we should depreciate this field and add a new one

(Or reserve!)

Just to clarify, add a note that this is deprecated and adding a new field?

Added back the previous field with a note that it is being deprecated.

czarcas7ic · 2023-08-05T00:38:15Z

proto/osmosis/protorev/v1beta1/protorev.proto

+// CosmwasmPoolInfo contains meta data pertaining to a cosmwasm pool type.
+message CosmwasmPoolInfo {
+  // The weight of a cosmwasm pool (by contract address)
+  map<string, uint64> weight_map = 1 [


@ValarDragon can you verify the safety of this?

czarcas7ic · 2023-08-05T00:40:03Z

x/protorev/client/cli/query.go

+		Use:   "info-by-pool-type",
+		Short: "Query the pool info used to determine how computationally expensive a route is",


I assume there is an input right? I think this should be "info-by-pool-type [pool-type]"

yea the input is the json file with all of the correct pool info. This isnt used to update by a single pool type (although once the dependencies on a given pool type grow it might be worth migrating to separate message handlers).

I'll update the PR with the json example I used in testing.

mattverse

LGTM, except for using repeated structs as an alternative for maps

davidterpay · 2023-08-07T14:39:16Z

@czarcas7ic @mattverse PR is updated with the removal of the map struct! Please lmk if there are any other blocks on your end (since I know the code freeze should be happening soon).

ValarDragon

LGTM!

mattverse

Did not review details of calculation going on for CL pools, otherwise LGTM

* init * testing update * changelog * comments * nit * refactor * clean up * nit * comment * cr * cl are not symetric * init * smh more symetric changes * simpler safe swap * map update * more stuff * testing fixes * more testing * nits * benchmark + CLI clean up * test fix * no map no problems * update with merge * better docs

davidterpay added 16 commits July 28, 2023 18:15

init

063602c

testing update

e2b628e

changelog

c9b13cd

comments

a706848

nit

efa68d2

refactor

d25d53e

clean up

bde5c73

nit

2f314fa

comment

1ede81d

cr

b0c92f3

cl are not symetric

1c78485

init

e50b0aa

smh more symetric changes

64a6891

simpler safe swap

b8e3f1f

map update

41b6e69

more stuff

da72dd0

github-actions bot added C:CLI C:app-wiring Changes to the app folder labels Aug 1, 2023

davidterpay added 3 commits August 2, 2023 13:26

testing fixes

8cedc6e

more testing

7ef7106

Merge branch 'terpay/search-range-update' into terpay/pool-point-update

85c64ca

davidterpay mentioned this pull request Aug 2, 2023

ProtoRev v17 Improvements Tracking #5858

Closed

10 tasks

davidterpay commented Aug 2, 2023

View reviewed changes

x/protorev/types/constants.go Show resolved Hide resolved

davidterpay commented Aug 2, 2023

View reviewed changes

x/protorev/types/genesis.go Outdated Show resolved Hide resolved

davidterpay commented Aug 2, 2023

View reviewed changes

app/upgrades/v17/upgrades.go Outdated Show resolved Hide resolved

davidterpay commented Aug 2, 2023

View reviewed changes

nits

d9ba32a

davidterpay requested a review from NotJeremyLiu August 2, 2023 21:59

davidterpay added protorev All things related to x/protorev V:state/breaking State machine breaking PR labels Aug 2, 2023

NotJeremyLiu reviewed Aug 3, 2023

View reviewed changes

NotJeremyLiu approved these changes Aug 3, 2023

View reviewed changes

benchmark + CLI clean up

954269b

davidterpay marked this pull request as ready for review August 4, 2023 20:57

davidterpay requested a review from p0mvn as a code owner August 4, 2023 20:57

test fix

6f984fb

Base automatically changed from terpay/search-range-update to main August 4, 2023 23:11

czarcas7ic approved these changes Aug 5, 2023

View reviewed changes

mattverse reviewed Aug 7, 2023

View reviewed changes

davidterpay added 5 commits August 7, 2023 10:13

no map no problems

a45d681

Merge branch 'main' into terpay/pool-point-update

a252cc1

update with merge

6aa732e

Merge branch 'main' into terpay/pool-point-update

33424a3

better docs

8e4c0e8

ValarDragon approved these changes Aug 7, 2023

View reviewed changes

ValarDragon merged commit 6240cab into main Aug 7, 2023

ValarDragon deleted the terpay/pool-point-update branch August 7, 2023 18:16

mattverse reviewed Aug 9, 2023

View reviewed changes

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

Broken Links Detected notional-labs/osmosis#75

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

fix(ProtoRev): Parameterizing Pool Type Information #5948

fix(ProtoRev): Parameterizing Pool Type Information #5948

davidterpay commented Aug 1, 2023 •

edited

Loading

davidterpay Aug 2, 2023 •

edited

Loading

czarcas7ic Aug 5, 2023

mattverse Aug 7, 2023

davidterpay Aug 7, 2023

NotJeremyLiu Aug 3, 2023

NotJeremyLiu Aug 3, 2023

NotJeremyLiu left a comment

davidterpay commented Aug 4, 2023

davidterpay commented Aug 4, 2023 •

edited

Loading

czarcas7ic left a comment

czarcas7ic Aug 5, 2023

mattverse Aug 7, 2023

davidterpay Aug 7, 2023

davidterpay Aug 7, 2023

czarcas7ic Aug 5, 2023

czarcas7ic Aug 5, 2023

davidterpay Aug 7, 2023 •

edited

Loading

mattverse left a comment

davidterpay commented Aug 7, 2023

ValarDragon left a comment

mattverse left a comment

		Use: "info-by-pool-type",
		Short: "Query the pool info used to determine how computationally expensive a route is",

fix(ProtoRev): Parameterizing Pool Type Information #5948

fix(ProtoRev): Parameterizing Pool Type Information #5948

Conversation

davidterpay commented Aug 1, 2023 • edited Loading

What is the purpose of the change

Testing and Verifying

Documentation and Release Note

davidterpay Aug 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NotJeremyLiu left a comment

Choose a reason for hiding this comment

davidterpay commented Aug 4, 2023

davidterpay commented Aug 4, 2023 • edited Loading

czarcas7ic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidterpay Aug 7, 2023 • edited Loading

Choose a reason for hiding this comment

mattverse left a comment

Choose a reason for hiding this comment

davidterpay commented Aug 7, 2023

ValarDragon left a comment

Choose a reason for hiding this comment

mattverse left a comment

Choose a reason for hiding this comment

davidterpay commented Aug 1, 2023 •

edited

Loading

davidterpay Aug 2, 2023 •

edited

Loading

davidterpay commented Aug 4, 2023 •

edited

Loading

davidterpay Aug 7, 2023 •

edited

Loading