add claim msg

Author: keithsue

api/side/farming/farming.pulsar.go

@@ -62,8 +62,9 @@ message Staking {
       (gogoproto.nullable)   = false
     ];
   cosmos.base.v1beta1.Coin effective_amount = 7 [(gogoproto.nullable) = false];
-  google.protobuf.Timestamp start_time = 8 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
-  StakingStatus status = 9;
+  cosmos.base.v1beta1.Coin pending_reward = 8 [(gogoproto.nullable) = false];
+  google.protobuf.Timestamp start_time = 9 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
+  StakingStatus status = 10;
 }
 
 // TotalStaking defines total staking per phase and denom

api/side/farming/tx.pulsar.go

@@ -18,6 +18,7 @@ service Msg {
     rpc CreatePhase(MsgCreatePhase) returns (MsgCreatePhaseResponse);
     rpc Stake(MsgStake) returns (MsgStakeResponse);
     rpc Unstake(MsgUnstake) returns (MsgUnstakeResponse);
+    rpc Claim(MsgClaim) returns (MsgClaimResponse);
 
     // UpdateParams defines a governance operation for updating the x/farming module
     // parameters. The authority defaults to the x/gov module account.
@@ -73,6 +74,17 @@ message MsgUnstake {
 
 message MsgUnstakeResponse {}
 
+message MsgClaim {
+  option (cosmos.msg.v1.signer) = "staker";
+
+  // Staker address
+  string staker = 1;
+  // Staking id
+  uint64 id = 2;
+}
+
+message MsgClaimResponse {}
+
 // MsgUpdateParams is the Msg/UpdateParams request type.
 //
 // Since: cosmos-sdk 0.47

api/side/farming/tx_grpc.pb.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	errorsmod "cosmossdk.io/errors"
+	sdkmath "cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
 
@@ -98,6 +99,7 @@ func (m msgServer) Stake(goCtx context.Context, msg *types.MsgStake) (*types.Msg
 		LockDuration:    lockDuration,
 		LockMultiplier:  lockMultiplier,
 		EffectiveAmount: types.GetEffectiveAmount(msg.Amount, lockMultiplier),
+		PendingReward:   sdk.NewCoin(phase.RewardsPerInterval.Denom, sdkmath.ZeroInt()),
 		StartTime:       ctx.BlockTime(),
 		Status:          types.StakingStatus_STAKING_STATUS_STAKED,
 	}
@@ -141,6 +143,13 @@ func (m msgServer) Unstake(goCtx context.Context, msg *types.MsgUnstake) (*types
 		return nil, err
 	}
 
+	// claim pending reward if any
+	if staking.PendingReward.IsPositive() {
+		if err := m.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(msg.Staker), sdk.NewCoins(staking.PendingReward)); err != nil {
+			return nil, err
+		}
+	}
+
 	// update status
 	staking.Status = types.StakingStatus_STAKING_STATUS_UNSTAKED
 	m.SetStaking(ctx, staking)
@@ -151,6 +160,38 @@ func (m msgServer) Unstake(goCtx context.Context, msg *types.MsgUnstake) (*types
 	return &types.MsgUnstakeResponse{}, nil
 }
 
+// Claim implements types.MsgServer.
+func (m msgServer) Claim(goCtx context.Context, msg *types.MsgClaim) (*types.MsgClaimResponse, error) {
+	if err := msg.ValidateBasic(); err != nil {
+		return nil, err
+	}
+
+	ctx := sdk.UnwrapSDKContext(goCtx)
+
+	if !m.HasStaking(ctx, msg.Id) {
+		return nil, errorsmod.Wrapf(types.ErrStakingDoesNotExist, "id: %d", msg.Id)
+	}
+
+	staking := m.GetStaking(ctx, msg.Id)
+	if staking.Address != msg.Staker {
+		return nil, errorsmod.Wrap(types.ErrUnauthorized, "mismatched staker address")
+	}
+
+	if staking.Status == types.StakingStatus_STAKING_STATUS_UNSTAKED {
+		return nil, errorsmod.Wrapf(types.ErrInvalidStakingStatus, "already unstaked: %d", msg.Id)
+	}
+
+	if staking.PendingReward.IsZero() {
+		return nil, types.ErrNoPendingReward
+	}
+
+	if err := m.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(msg.Staker), sdk.NewCoins(staking.PendingReward)); err != nil {
+		return nil, err
+	}
+
+	return &types.MsgClaimResponse{}, nil
+}
+
 // UpdateParams updates the module params.
 func (m msgServer) UpdateParams(goCtx context.Context, msg *types.MsgUpdateParams) (*types.MsgUpdateParamsResponse, error) {
 	if m.authority != msg.Authority {

proto/side/farming/farming.proto

@@ -26,10 +26,11 @@ func distributeRewards(ctx sdk.Context, k keeper.Keeper) {
 			continue
 		}
 
+		// get the pending reward of the last distribution interval
 		pendingReward := k.GetPendingReward(ctx, staking.Id)
 
-		if err := k.BankKeeper().SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(""), sdk.NewCoins(pendingReward)); err != nil {
-			k.Logger(ctx).Error("Failed to distribute reward", "staker", "", "reward", pendingReward, "err", err)
-		}
+		// accumulate reward
+		staking.PendingReward = staking.PendingReward.Add(pendingReward)
+		k.SetStaking(ctx, staking)
 	}
 }

proto/side/farming/tx.proto

@@ -18,6 +18,7 @@ var (
 	ErrStakingDoesNotExist  = errorsmod.Register(ModuleName, 1008, "staking does not exist")
 	ErrInvalidStakingStatus = errorsmod.Register(ModuleName, 1009, "invalid staking status")
 	ErrLockDurationNotEnded = errorsmod.Register(ModuleName, 1010, "lock duration not ended")
+	ErrNoPendingReward      = errorsmod.Register(ModuleName, 1011, "no pending reward")
 
 	ErrInvalidParams = errorsmod.Register(ModuleName, 2000, "invalid params")
 )