Node Syncing Issues: Taker fee swaps (#1316)

* add interval and enable boolean for taker fees

* swap message

* message removal

* update params

* minor review change

Author: amityadav0

api/elys/parameter/params.pulsar.go

@@ -51,4 +51,6 @@ message Params {
     (gogoproto.nullable) = false
   ];
   string taker_fee_collection_address = 7;
+  bool enable_taker_fee_swap = 8;
+  uint64 taker_fee_collection_interval = 9;
 }

api/elys/parameter/tx.pulsar.go

@@ -90,6 +90,8 @@ message MsgUpdateTakerFees {
     (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
     (gogoproto.nullable) = false
   ];
+  bool enable_taker_fee_swap = 3;
+  uint64 taker_fee_collection_interval = 4;
 }
 
 message MsgUpdateTakerFeesResponse {}

proto/elys/parameter/params.proto

@@ -20,8 +20,11 @@ import (
 
 // BeginBlocker of amm module
 func (k Keeper) BeginBlocker(ctx sdk.Context) error {
+	params := k.parameterKeeper.GetParams(ctx)
 	// convert balances in taker address to elys and burn them
-	k.ProcessTakerFee(ctx)
+	if ctx.BlockHeight()%int64(params.TakerFeeCollectionInterval) == 0 && params.EnableTakerFeeSwap {
+		k.ProcessTakerFee(ctx)
+	}
 	return nil
 }
 

proto/elys/parameter/tx.proto

@@ -82,6 +82,8 @@ func (k msgServer) UpdateTakerFees(goCtx context.Context, msg *types.MsgUpdateTa
 
 	params := k.GetParams(ctx)
 	params.TakerFees = msg.TakerFees
+	params.EnableTakerFeeSwap = msg.EnableTakerFeeSwap
+	params.TakerFeeCollectionInterval = msg.TakerFeeCollectionInterval
 	k.SetParams(ctx, params)
 	return &types.MsgUpdateTakerFeesResponse{}, nil
 }

x/masterchef/keeper/abci.go

@@ -0,0 +1,16 @@
+package migrations
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+func (m Migrator) V7Migration(ctx sdk.Context) error {
+	// reset params
+	params := m.keeper.GetParams(ctx)
+	params.EnableTakerFeeSwap = true
+	params.TakerFeeCollectionInterval = 1000 // blocks
+
+	m.keeper.SetParams(ctx, params)
+
+	return nil
+}

x/parameter/keeper/msg_server.go

@@ -119,7 +119,7 @@ func (am AppModule) RegisterServices(cfg module.Configurator) {
 	types.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
 	types.RegisterQueryServer(cfg.QueryServer(), am.keeper)
 	m := migrations.NewMigrator(am.keeper)
-	err := cfg.RegisterMigration(types.ModuleName, 5, m.V6Migration)
+	err := cfg.RegisterMigration(types.ModuleName, 6, m.V7Migration)
 	if err != nil {
 		panic(err)
 	}
@@ -144,7 +144,7 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.Raw
 }
 
 // ConsensusVersion is a sequence number for state-breaking change of the module. It should be incremented on each consensus-breaking change introduced by the module. To avoid wrong/empty versions, the initial version should be set to 1
-func (AppModule) ConsensusVersion() uint64 { return 6 }
+func (AppModule) ConsensusVersion() uint64 { return 7 }
 
 // BeginBlock contains the logic that is automatically triggered at the beginning of each block
 func (am AppModule) BeginBlock(_ context.Context) error {

x/parameter/migrations/v7_migration.go

@@ -17,15 +17,19 @@ func NewParams(
 	rewardsDataLifeTime uint64,
 	takerFees sdkmath.LegacyDec,
 	takerFeeAddress string,
+	enableTakerFeeSwap bool,
+	takerFeeCollectionInterval uint64,
 ) Params {
 	return Params{
-		MinCommissionRate:         minCommissionRate,
-		MaxVotingPower:            maxVotingPower,
-		MinSelfDelegation:         minSelfDelegation,
-		TotalBlocksPerYear:        totalBlocksPerYear,
-		RewardsDataLifetime:       rewardsDataLifeTime,
-		TakerFees:                 takerFees,
-		TakerFeeCollectionAddress: takerFeeAddress,
+		MinCommissionRate:          minCommissionRate,
+		MaxVotingPower:             maxVotingPower,
+		MinSelfDelegation:          minSelfDelegation,
+		TotalBlocksPerYear:         totalBlocksPerYear,
+		RewardsDataLifetime:        rewardsDataLifeTime,
+		TakerFees:                  takerFees,
+		TakerFeeCollectionAddress:  takerFeeAddress,
+		EnableTakerFeeSwap:         enableTakerFeeSwap,
+		TakerFeeCollectionInterval: takerFeeCollectionInterval,
 	}
 }
 
@@ -39,6 +43,8 @@ func DefaultParams() Params {
 		86400, // 1 day
 		sdkmath.LegacyZeroDec(),
 		authtypes.NewModuleAddress("taker_fee_collection").String(),
+		true,
+		100,
 	)
 }
 
@@ -72,6 +78,12 @@ func (p Params) Validate() error {
 	if p.RewardsDataLifetime <= 0 {
 		return fmt.Errorf("rewards data lifetime cannot be negative or zero")
 	}
+
+	if p.EnableTakerFeeSwap {
+		if p.TakerFeeCollectionInterval <= 0 {
+			return fmt.Errorf("taker fee collection interval cannot be negative or zero")
+		}
+	}
 	return nil
 }