implement batch reward claim

Author: keithsue

api/side/farming/tx.pulsar.go

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

api/side/farming/tx_grpc.pb.go

@@ -181,6 +181,31 @@ func (m msgServer) Claim(goCtx context.Context, msg *types.MsgClaim) (*types.Msg
 	return &types.MsgClaimResponse{}, nil
 }
 
+// ClaimAll implements types.MsgServer.
+func (m msgServer) ClaimAll(goCtx context.Context, msg *types.MsgClaimAll) (*types.MsgClaimAllResponse, error) {
+	if err := msg.ValidateBasic(); err != nil {
+		return nil, err
+	}
+
+	ctx := sdk.UnwrapSDKContext(goCtx)
+
+	pendingRewards, err := m.ClaimAllRewards(ctx, msg.Staker)
+	if err != nil {
+		return nil, err
+	}
+
+	// emit events
+	ctx.EventManager().EmitEvent(
+		sdk.NewEvent(
+			types.EventTypeClaim,
+			sdk.NewAttribute(types.AttributeKeyStaker, msg.Staker),
+			sdk.NewAttribute(types.AttributeKeyRewards, pendingRewards.String()),
+		),
+	)
+
+	return &types.MsgClaimAllResponse{}, nil
+}
+
 // UpdateParams updates the module params.
 func (m msgServer) UpdateParams(goCtx context.Context, msg *types.MsgUpdateParams) (*types.MsgUpdateParamsResponse, error) {
 	if m.authority != msg.Authority {

docs/static/openapi.yml

@@ -54,3 +54,29 @@ func (k Keeper) GetRewards(ctx sdk.Context, address string) (sdk.Coin, sdk.Coin)
 
 	return pendingRewards, totalRewards
 }
+
+// ClaimAllRewards claims all pending rewards of the given address
+func (k Keeper) ClaimAllRewards(ctx sdk.Context, address string) (sdk.Coin, error) {
+	pendingRewards := sdk.NewCoin(k.RewardPerEpoch(ctx).Denom, sdkmath.ZeroInt())
+
+	k.IterateStakingsByAddress(ctx, address, func(staking *types.Staking) (stop bool) {
+		// accumulate pending rewards
+		pendingRewards = pendingRewards.Add(staking.PendingRewards)
+
+		// reset pending rewards
+		staking.PendingRewards = sdk.NewCoin(k.RewardPerEpoch(ctx).Denom, sdkmath.ZeroInt())
+		k.SetStaking(ctx, staking)
+
+		return false
+	})
+
+	if pendingRewards.IsZero() {
+		return pendingRewards, types.ErrNoPendingRewards
+	}
+
+	if err := k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, sdk.MustAccAddressFromBech32(address), sdk.NewCoins(pendingRewards)); err != nil {
+		return pendingRewards, err
+	}
+
+	return pendingRewards, nil
+}

proto/side/farming/tx.proto

@@ -10,13 +10,17 @@ import (
 func RegisterCodec(cdc *codec.LegacyAmino) {
 	cdc.RegisterConcrete(&MsgStake{}, "farming/MsgStake", nil)
 	cdc.RegisterConcrete(&MsgUnstake{}, "farming/MsgUnstake", nil)
+	cdc.RegisterConcrete(&MsgClaim{}, "farming/MsgClaim", nil)
+	cdc.RegisterConcrete(&MsgClaimAll{}, "farming/MsgClaimAll", nil)
 	cdc.RegisterConcrete(&MsgUpdateParams{}, "farming/MsgUpdateParams", nil)
 	// this line is used by starport scaffolding # 2
 }
 
 func RegisterInterfaces(registry cdctypes.InterfaceRegistry) {
 	registry.RegisterImplementations((*sdk.Msg)(nil), &MsgStake{})
 	registry.RegisterImplementations((*sdk.Msg)(nil), &MsgUnstake{})
+	registry.RegisterImplementations((*sdk.Msg)(nil), &MsgClaim{})
+	registry.RegisterImplementations((*sdk.Msg)(nil), &MsgClaimAll{})
 	registry.RegisterImplementations((*sdk.Msg)(nil), &MsgUpdateParams{})
 
 	// this line is used by starport scaffolding # 3

x/farming/keeper/msg_server.go

@@ -0,0 +1,23 @@
+package types
+
+import (
+	errorsmod "cosmossdk.io/errors"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+var _ sdk.Msg = &MsgClaimAll{}
+
+func NewMsgClaimAll(staker string) *MsgClaimAll {
+	return &MsgClaimAll{
+		Staker: staker,
+	}
+}
+
+// ValidateBasic performs basic message validation.
+func (m *MsgClaimAll) ValidateBasic() error {
+	if _, err := sdk.AccAddressFromBech32(m.Staker); err != nil {
+		return errorsmod.Wrap(err, "invalid sender address")
+	}
+
+	return nil
+}