optimize farming reward estimation

Author: keithsue

api/side/farming/query.pulsar.go

@@ -49,8 +49,8 @@ service Query {
         option (google.api.http).get = "/side/farming/current_epoch/pending_reward/{address}";
     }
 
-    rpc EstimateReward(QueryEstimateRewardRequest) returns (QueryEstimateRewardResponse) {
-        option (google.api.http).get = "/side/farming/estimate_reward";
+    rpc EstimatedReward(QueryEstimatedRewardRequest) returns (QueryEstimatedRewardResponse) {
+        option (google.api.http).get = "/side/farming/estimated_reward";
     }
 }
 
@@ -139,15 +139,16 @@ message QueryPendingRewardByAddressResponse {
     AccountRewardPerEpoch pending_reward = 1;
 }
 
-// QueryEstimateRewardRequest is request type for the Query/EstimateReward RPC method.
-message QueryEstimateRewardRequest {
-    string amount = 1;
-    google.protobuf.Duration lock_duration = 2 [(gogoproto.nullable) = false, (gogoproto.stdduration) = true];
+// QueryEstimatedRewardRequest is request type for the Query/EstimatedReward RPC method.
+message QueryEstimatedRewardRequest {
+    string address = 1;
+    string amount = 2;
+    google.protobuf.Duration lock_duration = 3 [(gogoproto.nullable) = false, (gogoproto.stdduration) = true];
 }
 
-// QueryEstimateRewardResponse is response type for the Query/EstimateReward RPC method.
-message QueryEstimateRewardResponse {
-    string reward = 1;
+// QueryEstimatedRewardResponse is response type for the Query/EstimatedReward RPC method.
+message QueryEstimatedRewardResponse {
+    AccountRewardPerEpoch reward = 1;
 }
 
 // QueryParamsRequest is request type for the Query/Params RPC method.

api/side/farming/query_grpc.pb.go

@@ -137,13 +137,18 @@ func (k Keeper) PendingRewardByAddress(goCtx context.Context, req *types.QueryPe
 	return &types.QueryPendingRewardByAddressResponse{PendingReward: k.GetPendingRewardByAddress(ctx, req.Address)}, nil
 }
 
-func (k Keeper) EstimateReward(goCtx context.Context, req *types.QueryEstimateRewardRequest) (*types.QueryEstimateRewardResponse, error) {
+func (k Keeper) EstimatedReward(goCtx context.Context, req *types.QueryEstimatedRewardRequest) (*types.QueryEstimatedRewardResponse, error) {
 	if req == nil {
 		return nil, status.Error(codes.InvalidArgument, "invalid request")
 	}
 
 	ctx := sdk.UnwrapSDKContext(goCtx)
 
+	_, err := sdk.AccAddressFromBech32(req.Address)
+	if err != nil {
+		return nil, status.Error(codes.InvalidArgument, "invalid address")
+	}
+
 	amount, err := sdk.ParseCoinNormalized(req.Amount)
 	if err != nil || !amount.IsPositive() {
 		return nil, status.Error(codes.InvalidArgument, "invalid amount")
@@ -157,7 +162,7 @@ func (k Keeper) EstimateReward(goCtx context.Context, req *types.QueryEstimateRe
 		return nil, status.Error(codes.InvalidArgument, "invalid lock duration")
 	}
 
-	estimatedReward := k.GetEstimatedReward(ctx, amount, req.LockDuration)
+	estimatedReward := k.GetEstimatedReward(ctx, req.Address, amount, req.LockDuration)
 
-	return &types.QueryEstimateRewardResponse{Reward: estimatedReward.String()}, nil
+	return &types.QueryEstimatedRewardResponse{Reward: estimatedReward}, nil
 }

proto/side/farming/query.proto

@@ -54,19 +54,25 @@ func (k Keeper) GetRewards(ctx sdk.Context, address string) (sdk.Coin, sdk.Coin)
 
 // GetEstimatedReward gets the estimated epoch reward for the given params
 // Assume that the given params are valid
-func (k Keeper) GetEstimatedReward(ctx sdk.Context, amount sdk.Coin, lockDuration time.Duration) sdk.Coin {
+func (k Keeper) GetEstimatedReward(ctx sdk.Context, address string, amount sdk.Coin, lockDuration time.Duration) *types.AccountRewardPerEpoch {
 	nextEpoch := k.GetNextEpochSnapshot(ctx)
 
 	staking := &types.Staking{
+		Address:         address,
 		Amount:          amount,
 		EffectiveAmount: types.GetEffectiveAmount(amount, types.GetLockMultiplier(lockDuration)),
 	}
 
 	types.UpdateEpochTotalStakings(nextEpoch, staking)
 
-	asset := types.GetAsset(k.EligibleAssets(ctx), staking.Amount.Denom)
+	totalStakings := []types.TotalStaking{}
+	for _, staking := range k.GetStakingsByAddress(ctx, address) {
+		if !staking.StartTime.Add(staking.LockDuration).Before(nextEpoch.StartTime) {
+			totalStakings = types.UpdateAccountTotalStakings(totalStakings, staking)
+		}
+	}
 
-	return types.GetEpochReward(ctx, staking, nextEpoch, k.RewardPerEpoch(ctx), asset.RewardRatio)
+	return types.GetAccountRewardPerEpoch(address, totalStakings, nextEpoch, k.RewardPerEpoch(ctx), k.EligibleAssets(ctx))
 }
 
 // ClaimAllRewards claims all pending rewards of the given address