feat(x/protorev): Use Transient store to store swap backruns (#7665)

* Replace to use transient store

* Bring back cache ctx

* Fix lint

* Add back delete swaps to backrun after each tx

* Add changelog

.vscode/settings.json

@@ -11,14 +11,14 @@
   "[go.mod]": {
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.organizeImports": "explicit"
     }
   },
   "[go]": {
     "editor.snippetSuggestions": "none",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.organizeImports": true
+      "source.organizeImports": "explicit"
     }
   },
   "gopls": {

CHANGELOG.md

@@ -58,7 +58,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * [#7619](https://github.com/osmosis-labs/osmosis/pull/7619) Slight speedup/gas improvement to CL GetTotalPoolLiquidity queries
 * [#7623](https://github.com/osmosis-labs/osmosis/pull/7623) Add query for querying all before send hooks
 * [#7622](https://github.com/osmosis-labs/osmosis/pull/7622) Remove duplicate CL accumulator update logic.
-* [#7503](https://github.com/osmosis-labs/osmosis/pull/7503) Add IBC wasm light clients module.
+* [#7665](https://github.com/osmosis-labs/osmosis/pull/7665) feat(x/protorev): Use Transient store to store swap backruns.
+* [#7503](https://github.com/osmosis-labs/osmosis/pull/7503) Add IBC wasm light clients module
 
 ### State Compatible
 

app/keepers/keepers.go

@@ -400,6 +400,7 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 
 	protorevKeeper := protorevkeeper.NewKeeper(
 		appCodec, appKeepers.keys[protorevtypes.StoreKey],
+		appKeepers.tkeys[protorevtypes.TransientStoreKey],
 		appKeepers.GetSubspace(protorevtypes.ModuleName),
 		appKeepers.AccountKeeper,
 		appKeepers.BankKeeper,

app/keepers/keys.go

@@ -7,6 +7,7 @@ import (
 
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 
+	protorevtypes "github.com/osmosis-labs/osmosis/v23/x/protorev/types"
 	twaptypes "github.com/osmosis-labs/osmosis/v23/x/twap/types"
 )
 
@@ -17,7 +18,7 @@ func (appKeepers *AppKeepers) GenerateKeys() {
 	appKeepers.keys = sdk.NewKVStoreKeys(KVStoreKeys()...)
 
 	// Define transient store keys
-	appKeepers.tkeys = sdk.NewTransientStoreKeys(paramstypes.TStoreKey, twaptypes.TransientStoreKey)
+	appKeepers.tkeys = sdk.NewTransientStoreKeys(paramstypes.TStoreKey, twaptypes.TransientStoreKey, protorevtypes.TransientStoreKey)
 
 	// MemKeys are for information that is stored only in RAM.
 	appKeepers.memKeys = sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)

x/protorev/keeper/keeper.go

@@ -15,9 +15,10 @@ import (
 
 type (
 	Keeper struct {
-		cdc        codec.BinaryCodec
-		storeKey   storetypes.StoreKey
-		paramstore paramtypes.Subspace
+		cdc          codec.BinaryCodec
+		storeKey     storetypes.StoreKey
+		transientKey *storetypes.TransientStoreKey
+		paramstore   paramtypes.Subspace
 
 		accountKeeper               types.AccountKeeper
 		bankKeeper                  types.BankKeeper
@@ -32,6 +33,7 @@ type (
 func NewKeeper(
 	cdc codec.BinaryCodec,
 	storeKey storetypes.StoreKey,
+	transientKey *storetypes.TransientStoreKey,
 	ps paramtypes.Subspace,
 	accountKeeper types.AccountKeeper,
 	bankKeeper types.BankKeeper,
@@ -49,6 +51,7 @@ func NewKeeper(
 	return Keeper{
 		cdc:                         cdc,
 		storeKey:                    storeKey,
+		transientKey:                transientKey,
 		paramstore:                  ps,
 		accountKeeper:               accountKeeper,
 		bankKeeper:                  bankKeeper,

x/protorev/keeper/protorev.go

@@ -199,8 +199,7 @@ func (k Keeper) DeleteAllPoolsForBaseDenom(ctx sdk.Context, baseDenom string) {
 
 // SetSwapsToBackrun sets the swaps to backrun, updated via hooks
 func (k Keeper) SetSwapsToBackrun(ctx sdk.Context, swapsToBackrun types.Route) error {
-	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.KeyPrefixSwapsToBackrun)
-
+	store := prefix.NewStore(ctx.TransientStore(k.transientKey), types.KeyPrefixSwapsToBackrun)
 	bz, err := swapsToBackrun.Marshal()
 	if err != nil {
 		return err
@@ -213,7 +212,7 @@ func (k Keeper) SetSwapsToBackrun(ctx sdk.Context, swapsToBackrun types.Route) e
 
 // GetSwapsToBackrun returns the swaps to backrun, updated via hooks
 func (k Keeper) GetSwapsToBackrun(ctx sdk.Context) (types.Route, error) {
-	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.KeyPrefixSwapsToBackrun)
+	store := prefix.NewStore(ctx.TransientStore(k.transientKey), types.KeyPrefixSwapsToBackrun)
 	bz := store.Get(types.KeyPrefixSwapsToBackrun)
 
 	swapsToBackrun := types.Route{}
@@ -227,7 +226,7 @@ func (k Keeper) GetSwapsToBackrun(ctx sdk.Context) (types.Route, error) {
 
 // DeleteSwapsToBackrun deletes the swaps to backrun
 func (k Keeper) DeleteSwapsToBackrun(ctx sdk.Context) {
-	store := prefix.NewStore(ctx.KVStore(k.storeKey), types.KeyPrefixSwapsToBackrun)
+	store := prefix.NewStore(ctx.TransientStore(k.transientKey), types.KeyPrefixSwapsToBackrun)
 	store.Delete(types.KeyPrefixSwapsToBackrun)
 }
 

x/protorev/types/keys.go

@@ -15,6 +15,8 @@ const (
 	// StoreKey defines the primary module store key
 	StoreKey = ModuleName
 
+	TransientStoreKey = "transient_" + ModuleName
+
 	// RouterKey defines the module's message routing key
 	RouterKey = ModuleName
 )