fix: clean up 2

Author: sbackend123

openapi/Swarm.yaml

@@ -2558,7 +2558,11 @@ paths:
               schema:
                 $ref: "SwarmCommon.yaml#/components/schemas/StakeTransactionResponse"
         "400":
-          $ref: "SwarmCommon.yaml#/components/responses/400"
+          description: Deposit amount is below the required minimum.
+          content:
+            application/json:
+              schema:
+                $ref: "SwarmCommon.yaml#/components/schemas/StakeDepositErrorResponse"
         "500":
           $ref: "SwarmCommon.yaml#/components/responses/500"
         default:

openapi/SwarmCommon.yaml

@@ -684,6 +684,16 @@ components:
         minimumDeposit:
           $ref: "#/components/schemas/BigInt"
 
+    StakeDepositErrorResponse:
+      type: object
+      properties:
+        code:
+          type: integer
+        message:
+          type: string
+        minimumDeposit:
+          $ref: "#/components/schemas/BigInt"
+
     GetWithdrawableResponse:
       type: object
       properties:

pkg/api/export_test.go

@@ -94,6 +94,7 @@ type (
 	WalletResponse                    = walletResponse
 	WalletTxResponse                  = walletTxResponse
 	GetStakeResponse                  = getStakeResponse
+	StakeDepositErrorResponse         = stakeDepositErrorResponse
 	GetWithdrawableResponse           = getWithdrawableResponse
 	StakeTransactionReponse           = stakeTransactionReponse
 	StatusSnapshotResponse            = statusSnapshotResponse

pkg/api/staking.go

@@ -6,7 +6,6 @@ package api
 
 import (
 	"errors"
-	"fmt"
 	"math/big"
 	"net/http"
 
@@ -43,6 +42,12 @@ type stakeTransactionReponse struct {
 	TxHash string `json:"txHash"`
 }
 
+type stakeDepositErrorResponse struct {
+	Code           int            `json:"code"`
+	Message        string         `json:"message"`
+	MinimumDeposit *bigint.BigInt `json:"minimumDeposit"`
+}
+
 func (s *Service) stakingDepositHandler(w http.ResponseWriter, r *http.Request) {
 	logger := s.logger.WithName("post_stake_deposit").Build()
 
@@ -56,16 +61,15 @@ func (s *Service) stakingDepositHandler(w http.ResponseWriter, r *http.Request)
 
 	txHash, err := s.stakingContract.DepositStake(r.Context(), paths.Amount)
 	if err != nil {
-		if errors.Is(err, staking.ErrInsufficientStakeAmount) {
-			minDeposit := staking.MinimumStakeAmount
-			var minErr *staking.MinDepositError
-			if errors.As(err, &minErr) && minErr.Minimum != nil {
-				minDeposit = minErr.Minimum
-			}
-			msg := fmt.Sprintf("insufficient stake amount, minimum is %s", minDeposit)
-			logger.Debug("insufficient stake amount", "minimum_stake", minDeposit, "error", err)
+		var minErr *staking.MinDepositError
+		if errors.As(err, &minErr) {
+			logger.Debug("insufficient stake amount", "minimum_deposit", minErr.Minimum, "error", err)
 			logger.Error(nil, "insufficient stake amount")
-			jsonhttp.BadRequest(w, msg)
+			jsonhttp.BadRequest(w, stakeDepositErrorResponse{
+				Code:           http.StatusBadRequest,
+				Message:        "insufficient stake amount",
+				MinimumDeposit: bigint.Wrap(minErr.Minimum),
+			})
 			return
 		}
 		if errors.Is(err, staking.ErrNotImplemented) {

pkg/api/staking_test.go

@@ -43,20 +43,6 @@ func TestDepositStake(t *testing.T) {
 		jsonhttptest.Request(t, ts, http.MethodPost, depositStake(minStake), http.StatusOK)
 	})
 
-	t.Run("with invalid stake amount", func(t *testing.T) {
-		t.Parallel()
-
-		invalidMinStake := big.NewInt(0).String()
-		contract := stakingContractMock.New(
-			stakingContractMock.WithDepositStake(func(ctx context.Context, stakedAmount *big.Int) (common.Hash, error) {
-				return common.Hash{}, staking.ErrInsufficientStakeAmount
-			}),
-		)
-		ts, _, _, _ := newTestServer(t, testServerOptions{StakingContract: contract})
-		jsonhttptest.Request(t, ts, http.MethodPost, depositStake(invalidMinStake), http.StatusBadRequest,
-			jsonhttptest.WithExpectedJSONResponse(&jsonhttp.StatusResponse{Code: http.StatusBadRequest, Message: "insufficient stake amount, minimum is 100000000000000000"}))
-	})
-
 	t.Run("with insufficient amount reports minimum", func(t *testing.T) {
 		t.Parallel()
 
@@ -68,7 +54,11 @@ func TestDepositStake(t *testing.T) {
 		)
 		ts, _, _, _ := newTestServer(t, testServerOptions{StakingContract: contract})
 		jsonhttptest.Request(t, ts, http.MethodPost, depositStake("1"), http.StatusBadRequest,
-			jsonhttptest.WithExpectedJSONResponse(&jsonhttp.StatusResponse{Code: http.StatusBadRequest, Message: "insufficient stake amount, minimum is 123"}))
+			jsonhttptest.WithExpectedJSONResponse(&api.StakeDepositErrorResponse{
+				Code:           http.StatusBadRequest,
+				Message:        "insufficient stake amount",
+				MinimumDeposit: bigint.Wrap(minDeposit),
+			}))
 	})
 
 	t.Run("out of funds", func(t *testing.T) {