Chore: Claim Deposits in Batches (#318) (#319)

* add batch claim deposits

* remove old claimdeposit msg

(cherry picked from commit cdc0e4f)

Co-authored-by: tkernell <[email protected]>

proto/layer/bridge/tx.proto

@@ -13,7 +13,7 @@ service Msg {
   option (cosmos.msg.v1.service) = true;
   rpc RequestAttestations(MsgRequestAttestations) returns (MsgRequestAttestationsResponse);
   rpc WithdrawTokens(MsgWithdrawTokens) returns (MsgWithdrawTokensResponse);
-  rpc ClaimDeposit(MsgClaimDepositRequest) returns (MsgClaimDepositResponse);
+  rpc ClaimDeposits(MsgClaimDepositsRequest) returns (MsgClaimDepositsResponse);
 }
 
 message MsgRequestAttestations {
@@ -36,12 +36,12 @@ message MsgWithdrawTokens {
 
 message MsgWithdrawTokensResponse {}
 
-message MsgClaimDepositRequest {
+message MsgClaimDepositsRequest {
   option (cosmos.msg.v1.signer) = "creator";
 
   string creator = 1;
-  uint64 deposit_id = 2;
-  uint64 index = 3;
+  repeated uint64 deposit_ids = 2;
+  repeated uint64 indices = 3;
 }
 
-message MsgClaimDepositResponse {}
+message MsgClaimDepositsResponse {}

x/bridge/autocli.go

@@ -97,10 +97,10 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
 					PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "creator"}, {ProtoField: "recipient"}, {ProtoField: "amount"}},
 				},
 				{
-					RpcMethod:      "ClaimDeposit",
-					Use:            "claim-deposit [creator] [deposit-id] [index]",
-					Short:          "Execute the ClaimDeposit RPC method",
-					PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "creator"}, {ProtoField: "deposit_id"}, {ProtoField: "index"}},
+					RpcMethod:      "ClaimDeposits",
+					Use:            "claim-deposits [creator] [deposit-ids] [indices]",
+					Short:          "Execute the ClaimDeposits RPC method",
+					PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "creator"}, {ProtoField: "deposit_ids"}, {ProtoField: "indices"}},
 				},
 				// this line is used by ignite scaffolding # autocli/tx
 			},

x/bridge/keeper/msg_server_claim_deposits.go

@@ -0,0 +1,32 @@
+package keeper
+
+import (
+	"context"
+	"strconv"
+
+	"github.com/tellor-io/layer/x/bridge/types"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+func (k msgServer) ClaimDeposits(goCtx context.Context, msg *types.MsgClaimDepositsRequest) (*types.MsgClaimDepositsResponse, error) {
+	sdkCtx := sdk.UnwrapSDKContext(goCtx)
+	if len(msg.DepositIds) != len(msg.Indices) {
+		return nil, types.ErrInvalidDepositIdsAndIndicesLength
+	}
+	msgSender := sdk.MustAccAddressFromBech32(msg.Creator)
+	for i, depositId := range msg.DepositIds {
+		index := msg.Indices[i]
+		if err := k.Keeper.ClaimDeposit(sdkCtx, depositId, index, msgSender); err != nil {
+			return nil, err
+		}
+		sdk.UnwrapSDKContext(goCtx).EventManager().EmitEvents(sdk.Events{
+			sdk.NewEvent(
+				"deposit_claimed",
+				sdk.NewAttribute("deposit_id", strconv.FormatUint(depositId, 10)),
+			),
+		})
+	}
+
+	return &types.MsgClaimDepositsResponse{}, nil
+}

x/bridge/keeper/msg_server_claim_deposit_test.go → x/bridge/keeper/msg_server_claim_deposits_test.go

@@ -17,12 +17,12 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
-func TestMsgClaimDeposit(t *testing.T) {
+func TestMsgClaimDeposits(t *testing.T) {
 	k, _, bk, ok, _, _, ctx := setupKeeper(t)
 	msgServer := keeper.NewMsgServerImpl(k)
 
 	require.Panics(t, func() {
-		_, err := msgServer.ClaimDeposit(ctx, nil)
+		_, err := msgServer.ClaimDeposits(ctx, nil)
 		require.Error(t, err)
 	})
 
@@ -73,10 +73,10 @@ func TestMsgClaimDeposit(t *testing.T) {
 	depositId := uint64(0)
 	reportIndex := uint64(0)
 
-	result, err := msgServer.ClaimDeposit(sdkCtx, &bridgetypes.MsgClaimDepositRequest{
-		Creator:   msgSender.String(),
-		DepositId: depositId,
-		Index:     reportIndex,
+	result, err := msgServer.ClaimDeposits(sdkCtx, &bridgetypes.MsgClaimDepositsRequest{
+		Creator:    msgSender.String(),
+		DepositIds: []uint64{depositId},
+		Indices:    []uint64{reportIndex},
 	})
 	require.NoError(t, err)
 	require.NotNil(t, result)

x/bridge/types/errors.go

@@ -8,11 +8,12 @@ import (
 
 // x/bridge module sentinel errors
 var (
-	ErrSample                    = sdkerrors.Register(ModuleName, 1100, "sample error")
-	ErrNoAggregate               = sdkerrors.Register(ModuleName, 1101, "no aggregate found")
-	ErrAggregateFlagged          = sdkerrors.Register(ModuleName, 1102, "aggregate flagged")
-	ErrInsufficientReporterPower = sdkerrors.Register(ModuleName, 1103, "insufficient reporter power")
-	ErrReportTooYoung            = sdkerrors.Register(ModuleName, 1104, "report too young")
-	ErrInvalidDepositReportValue = sdkerrors.Register(ModuleName, 1105, "invalid deposit report value")
-	ErrDepositAlreadyClaimed     = sdkerrors.Register(ModuleName, 1106, "deposit already claimed")
+	ErrSample                            = sdkerrors.Register(ModuleName, 1100, "sample error")
+	ErrNoAggregate                       = sdkerrors.Register(ModuleName, 1101, "no aggregate found")
+	ErrAggregateFlagged                  = sdkerrors.Register(ModuleName, 1102, "aggregate flagged")
+	ErrInsufficientReporterPower         = sdkerrors.Register(ModuleName, 1103, "insufficient reporter power")
+	ErrReportTooYoung                    = sdkerrors.Register(ModuleName, 1104, "report too young")
+	ErrInvalidDepositReportValue         = sdkerrors.Register(ModuleName, 1105, "invalid deposit report value")
+	ErrDepositAlreadyClaimed             = sdkerrors.Register(ModuleName, 1106, "deposit already claimed")
+	ErrInvalidDepositIdsAndIndicesLength = sdkerrors.Register(ModuleName, 1107, "invalid deposit ids and indices length")
 )