feat(ProtoRev): Support for CW Pools (#5901)

* init

* add new pool weights to upgrade handler

* change log

* add todo for genesis testing

* proto ci

* val basic testing

* e2e test

* main update

* nit

CHANGELOG.md

@@ -46,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * [#5532](https://github.com/osmosis-labs/osmosis/pull/5532) fix: Fix x/tokenfactory genesis import denoms reset x/bank existing denom metadata
 * [#5874](https://github.com/osmosis-labs/osmosis/pull/5874) Remove Partial Migration from superfluid migration to CL
+* [#5901](https://github.com/osmosis-labs/osmosis/pull/5901) Adding support for CW pools in ProtoRev
 
 ### BugFix
 

app/upgrades/v17/upgrades.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/osmosis-labs/osmosis/v17/app/keepers"
 	"github.com/osmosis-labs/osmosis/v17/app/upgrades"
+	"github.com/osmosis-labs/osmosis/v17/x/protorev/types"
 )
 
 func CreateUpgradeHandler(
@@ -23,6 +24,14 @@ func CreateUpgradeHandler(
 			return nil, err
 		}
 
+		// Reset the pool weights upon upgrade. This will add support for CW pools on ProtoRev.
+		keepers.ProtoRevKeeper.SetPoolWeights(ctx, types.PoolWeights{
+			BalancerWeight:     1,
+			StableWeight:       4,
+			ConcentratedWeight: 300,
+			CosmwasmWeight:     300,
+		})
+
 		return migrations, nil
 	}
 }

proto/osmosis/protorev/v1beta1/protorev.proto

@@ -87,6 +87,9 @@ message PoolWeights {
   // The weight of a concentrated pool
   uint64 concentrated_weight = 3
       [ (gogoproto.moretags) = "yaml:\"concentrated_weight\"" ];
+  // The weight of a cosmwasm pool
+  uint64 cosmwasm_weight = 4
+      [ (gogoproto.moretags) = "yaml:\"cosmwasm_weight\"" ];
 }
 
 // BaseDenom represents a single base denom that the module uses for its

x/protorev/keeper/keeper_test.go

@@ -140,6 +140,8 @@ func (s *KeeperTestSuite) SetupTest() {
 		sdk.NewCoin("hook", sdk.NewInt(9000000000000000000)),
 		sdk.NewCoin("eth", sdk.NewInt(9000000000000000000)),
 		sdk.NewCoin("gamm/pool/1", sdk.NewInt(9000000000000000000)),
+		sdk.NewCoin(apptesting.DefaultTransmuterDenomA, sdk.NewInt(9000000000000000000)),
+		sdk.NewCoin(apptesting.DefaultTransmuterDenomB, sdk.NewInt(9000000000000000000)),
 	)
 	s.fundAllAccountsWith()
 	s.Commit()
@@ -896,6 +898,10 @@ func (s *KeeperTestSuite) setUpPools() {
 	// Pool 49
 	s.PrepareConcentratedPoolWithCoinsAndFullRangePosition("epochTwo", "uosmo")
 
+	// Create a cosmwasm pool for testing
+	// Pool 50
+	s.PrepareCosmWasmPool()
+
 	// Set all of the pool info into the stores
 	err := s.App.ProtoRevKeeper.UpdatePools(s.Ctx)
 	s.Require().NoError(err)

x/protorev/keeper/msg_server_test.go

@@ -481,6 +481,7 @@ func (s *KeeperTestSuite) TestMsgSetPoolWeights() {
 				StableWeight:       1,
 				BalancerWeight:     2,
 				ConcentratedWeight: 3,
+				CosmwasmWeight:     4,
 			},
 			false,
 			false,
@@ -492,6 +493,7 @@ func (s *KeeperTestSuite) TestMsgSetPoolWeights() {
 				StableWeight:       0,
 				BalancerWeight:     2,
 				ConcentratedWeight: 1,
+				CosmwasmWeight:     4,
 			},
 			false,
 			false,
@@ -500,7 +502,8 @@ func (s *KeeperTestSuite) TestMsgSetPoolWeights() {
 			"Invalid message (unset pool weight)",
 			s.adminAccount.String(),
 			types.PoolWeights{
-				StableWeight: 1,
+				StableWeight:   1,
+				CosmwasmWeight: 4,
 			},
 			false,
 			false,
@@ -512,6 +515,7 @@ func (s *KeeperTestSuite) TestMsgSetPoolWeights() {
 				StableWeight:       1,
 				BalancerWeight:     2,
 				ConcentratedWeight: 3,
+				CosmwasmWeight:     4,
 			},
 			true,
 			false,
@@ -523,6 +527,7 @@ func (s *KeeperTestSuite) TestMsgSetPoolWeights() {
 				StableWeight:       1,
 				BalancerWeight:     2,
 				ConcentratedWeight: 3,
+				CosmwasmWeight:     4,
 			},
 			true,
 			true,

x/protorev/keeper/posthandler_test.go

@@ -340,7 +340,7 @@ func (s *KeeperTestSuite) TestAnteHandle() {
 			params: param{
 				trades: []types.Trade{
 					{
-						Pool:     50,
+						Pool:     51,
 						TokenOut: "ibc/0CD3A0285E1341859B5E86B6AB7682F023D03E97607CCC1DC95706411D866DF7",
 						TokenIn:  "uosmo",
 					},

x/protorev/keeper/routes.go

@@ -174,6 +174,8 @@ func (k Keeper) CalculateRoutePoolPoints(ctx sdk.Context, route poolmanagertypes
 			totalWeight += poolWeights.StableWeight
 		case poolmanagertypes.Concentrated:
 			totalWeight += poolWeights.ConcentratedWeight
+		case poolmanagertypes.CosmWasm:
+			totalWeight += poolWeights.CosmwasmWeight
 		default:
 			return 0, fmt.Errorf("invalid pool type")
 		}

x/protorev/keeper/routes_test.go

@@ -347,12 +347,29 @@ func (s *KeeperTestSuite) TestCalculateRoutePoolPoints() {
 			expectedRoutePoolPoints: 11,
 			expectedPass:            false,
 		},
+		{
+			description:             "Valid route with a cosmwasm pool",
+			route:                   []poolmanagertypes.SwapAmountInRoute{{PoolId: 1, TokenOutDenom: ""}, {PoolId: 50, TokenOutDenom: ""}, {PoolId: 2, TokenOutDenom: ""}},
+			expectedRoutePoolPoints: 8,
+			expectedPass:            true,
+		},
+		{
+			description:             "Valid route with cw pool, balancer, stable swap and cl pool",
+			route:                   []poolmanagertypes.SwapAmountInRoute{{PoolId: 1, TokenOutDenom: ""}, {PoolId: 50, TokenOutDenom: ""}, {PoolId: 40, TokenOutDenom: ""}, {PoolId: 49, TokenOutDenom: ""}},
+			expectedRoutePoolPoints: 10,
+			expectedPass:            true,
+		},
 	}
 
 	for _, tc := range cases {
 		s.Run(tc.description, func() {
 			s.SetupTest()
-			s.App.ProtoRevKeeper.SetPoolWeights(s.Ctx, types.PoolWeights{StableWeight: 3, BalancerWeight: 2, ConcentratedWeight: 1})
+			s.App.ProtoRevKeeper.SetPoolWeights(s.Ctx, types.PoolWeights{
+				StableWeight:       3,
+				BalancerWeight:     2,
+				ConcentratedWeight: 1,
+				CosmwasmWeight:     4,
+			})
 
 			routePoolPoints, err := s.App.ProtoRevKeeper.CalculateRoutePoolPoints(s.Ctx, tc.route)
 			if tc.expectedPass {

x/protorev/types/genesis.go

@@ -20,6 +20,10 @@ var (
 		StableWeight:       5, // it takes around 5 ms to simulate and execute a stable swap
 		BalancerWeight:     2, // it takes around 2 ms to simulate and execute a balancer swap
 		ConcentratedWeight: 2, // it takes around 2 ms to simulate and execute a concentrated swap
+
+		// TODO: This is a temporary weight until we can get a more accurate weight for cosmwasm swaps
+		// ref: https://github.com/osmosis-labs/osmosis/issues/5858
+		CosmwasmWeight: 5, // it takes around 5 ms to simulate and execute a cosmwasm swap
 	}
 	DefaultDaysSinceModuleGenesis    = uint64(0)
 	DefaultDeveloperFees             = []sdk.Coin{}

x/protorev/types/msg_test.go

@@ -520,6 +520,7 @@ func TestMsgSetPoolWeights(t *testing.T) {
 				BalancerWeight:     1,
 				StableWeight:       1,
 				ConcentratedWeight: 1,
+				CosmwasmWeight:     1,
 			},
 			false,
 		},
@@ -530,6 +531,7 @@ func TestMsgSetPoolWeights(t *testing.T) {
 				BalancerWeight:     0,
 				StableWeight:       1,
 				ConcentratedWeight: 1,
+				CosmwasmWeight:     1,
 			},
 			false,
 		},
@@ -540,6 +542,7 @@ func TestMsgSetPoolWeights(t *testing.T) {
 				BalancerWeight:     1,
 				StableWeight:       1,
 				ConcentratedWeight: 1,
+				CosmwasmWeight:     1,
 			},
 			true,
 		},

x/protorev/types/validate.go

@@ -49,7 +49,7 @@ func (pw *PoolWeights) Validate() error {
 		return fmt.Errorf("pool weights cannot be nil")
 	}
 
-	if pw.BalancerWeight == 0 || pw.StableWeight == 0 || pw.ConcentratedWeight == 0 {
+	if pw.BalancerWeight == 0 || pw.StableWeight == 0 || pw.ConcentratedWeight == 0 || pw.CosmwasmWeight == 0 {
 		return fmt.Errorf("pool weights cannot be 0")
 	}