feedback:Rename SummariesResponse & move interfaces to common

Author: Dominikkq

OpenApi.yml

@@ -683,34 +683,36 @@ components:
         rsk:
           type: string
       type: object
-    SummariesResponse:
-      properties:
-        peginSummary:
-          $ref: '#/components/schemas/SummaryData'
-          type: object
-        pegoutSummary:
-          $ref: '#/components/schemas/SummaryData'
-          type: object
-      type: object
     SummaryData:
       properties:
         confirmedQuotesCount:
           type: integer
         lpEarnings:
-          type: string
+          $ref: '#/components/schemas/Wei'
         refundedQuotesCount:
           type: integer
         totalAcceptedQuotedAmount:
-          type: string
+          $ref: '#/components/schemas/Wei'
         totalAcceptedQuotesCount:
           type: integer
         totalFeesCollected:
-          type: string
+          $ref: '#/components/schemas/Wei'
         totalPenaltyAmount:
-          type: string
+          $ref: '#/components/schemas/Wei'
         totalQuotedAmount:
-          type: string
+          $ref: '#/components/schemas/Wei'
+      type: object
+    SummaryResult:
+      properties:
+        peginSummary:
+          $ref: '#/components/schemas/SummaryData'
+          type: object
+        pegoutSummary:
+          $ref: '#/components/schemas/SummaryData'
+          type: object
       type: object
+    Wei: {}
+    entities.Wei: {}
     pkg.AcceptQuoteRequest:
       properties:
         quoteHash:
@@ -1086,7 +1088,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SummariesResponse'
+                $ref: '#/components/schemas/SummaryResult'
           description: Financial data for the given period
       summary: Summaries
   /userQuotes:

internal/adapters/entrypoints/rest/handlers/get_report_summaries.go

@@ -14,7 +14,7 @@ import (
 // @Description Returns financial data for a given period
 // @Param startDate query string true "Start date in YYYY-MM-DD format" Format(date)
 // @Param endDate query string true "End date in YYYY-MM-DD format" Format(date)
-// @Success 200 {object} liquidity_provider.SummariesResponse "Financial data for the given period"
+// @Success 200 {object} liquidity_provider.SummaryResult "Financial data for the given period"
 // @Router /report/summaries [get]
 func NewGetReportSummariesHandler(useCase *liquidity_provider.SummariesUseCase) http.HandlerFunc {
 	return func(w http.ResponseWriter, req *http.Request) {

internal/adapters/entrypoints/rest/handlers/get_report_summaries_test.go

@@ -21,14 +21,14 @@ type MockSummariesUseCase struct {
 	mock.Mock
 }
 
-func (m *MockSummariesUseCase) Run(ctx context.Context, startDate, endDate time.Time) (liquidity_provider.SummariesResponse, error) {
+func (m *MockSummariesUseCase) Run(ctx context.Context, startDate, endDate time.Time) (liquidity_provider.SummaryResult, error) {
 	args := m.Called(ctx, startDate, endDate)
 	if args.Get(0) == nil {
-		return liquidity_provider.SummariesResponse{}, args.Error(1)
+		return liquidity_provider.SummaryResult{}, args.Error(1)
 	}
-	response, ok := args.Get(0).(liquidity_provider.SummariesResponse)
+	response, ok := args.Get(0).(liquidity_provider.SummaryResult)
 	if !ok {
-		return liquidity_provider.SummariesResponse{}, errors.New("invalid response type")
+		return liquidity_provider.SummaryResult{}, errors.New("invalid response type")
 	}
 	return response, args.Error(1)
 }
@@ -54,14 +54,14 @@ func TestGetReportSummariesHandler(t *testing.T) { //nolint:funlen
 		name           string
 		url            string
 		expectedStatus int
-		mockResponse   liquidity_provider.SummariesResponse
+		mockResponse   liquidity_provider.SummaryResult
 		mockErr        error
 	}{
 		{
 			name:           "Success with valid date range",
 			url:            "/report/summaries?startDate=2023-01-01&endDate=2023-01-31",
 			expectedStatus: http.StatusOK,
-			mockResponse: liquidity_provider.SummariesResponse{
+			mockResponse: liquidity_provider.SummaryResult{
 				PeginSummary: liquidity_provider.SummaryData{
 					TotalAcceptedQuotesCount:  10,
 					ConfirmedQuotesCount:      8,
@@ -89,42 +89,42 @@ func TestGetReportSummariesHandler(t *testing.T) { //nolint:funlen
 			name:           "Missing startDate parameter",
 			url:            "/report/summaries?endDate=2023-01-31",
 			expectedStatus: http.StatusBadRequest,
-			mockResponse:   liquidity_provider.SummariesResponse{},
+			mockResponse:   liquidity_provider.SummaryResult{},
 			mockErr:        nil,
 		},
 		{
 			name:           "Missing endDate parameter",
 			url:            "/report/summaries?startDate=2023-01-01",
 			expectedStatus: http.StatusBadRequest,
-			mockResponse:   liquidity_provider.SummariesResponse{},
+			mockResponse:   liquidity_provider.SummaryResult{},
 			mockErr:        nil,
 		},
 		{
 			name:           "Invalid startDate format",
 			url:            "/report/summaries?startDate=01/01/2023&endDate=2023-01-31",
 			expectedStatus: http.StatusBadRequest,
-			mockResponse:   liquidity_provider.SummariesResponse{},
+			mockResponse:   liquidity_provider.SummaryResult{},
 			mockErr:        nil,
 		},
 		{
 			name:           "Invalid endDate format",
 			url:            "/report/summaries?startDate=2023-01-01&endDate=31/01/2023",
 			expectedStatus: http.StatusBadRequest,
-			mockResponse:   liquidity_provider.SummariesResponse{},
+			mockResponse:   liquidity_provider.SummaryResult{},
 			mockErr:        nil,
 		},
 		{
 			name:           "EndDate before StartDate",
 			url:            "/report/summaries?startDate=2023-02-01&endDate=2023-01-31",
 			expectedStatus: http.StatusBadRequest,
-			mockResponse:   liquidity_provider.SummariesResponse{},
+			mockResponse:   liquidity_provider.SummaryResult{},
 			mockErr:        nil,
 		},
 		{
 			name:           "Error in use case",
 			url:            "/report/summaries?startDate=2023-01-01&endDate=2023-01-31",
 			expectedStatus: http.StatusInternalServerError,
-			mockResponse:   liquidity_provider.SummariesResponse{},
+			mockResponse:   liquidity_provider.SummaryResult{},
 			mockErr:        errors.New("test error"),
 		},
 	}
@@ -146,7 +146,7 @@ func TestGetReportSummariesHandler(t *testing.T) { //nolint:funlen
 			handler.ServeHTTP(rr, req)
 			assert.Equal(t, tt.expectedStatus, rr.Code)
 			if tt.expectedStatus == http.StatusOK {
-				var response liquidity_provider.SummariesResponse
+				var response liquidity_provider.SummaryResult
 				err = json.Unmarshal(rr.Body.Bytes(), &response)
 				require.NoError(t, err)
 

internal/entities/quote/common.go

@@ -4,10 +4,11 @@ import (
 	"encoding/hex"
 	"errors"
 	"fmt"
+	"math/big"
+
 	"github.com/rsksmart/liquidity-provider-server/internal/entities"
 	"github.com/rsksmart/liquidity-provider-server/internal/entities/utils"
 	log "github.com/sirupsen/logrus"
-	"math/big"
 )
 
 type AcceptedQuote struct {
@@ -28,6 +29,27 @@ type PegConfiguration interface {
 	ValidateAmount(amount *entities.Wei) error
 }
 
+type Quote interface {
+	Total() *entities.Wei
+}
+
+type RetainedQuote interface {
+	GetQuoteHash() string
+}
+
+type FeeProvider interface {
+	GetCallFee() *entities.Wei
+	GetGasFee() *entities.Wei
+	GetProductFee() *entities.Wei
+	GetPenaltyFee() *entities.Wei
+}
+
+type QuoteResult[Q any, R RetainedQuote] interface {
+	GetQuotes() []Q
+	GetRetainedQuotes() []R
+	GetQuoteHashToIndex() map[string]int
+}
+
 // ValidateQuoteHash checks if a given string is a valid 32-byte quote hash
 // Returns nil if valid, error otherwise
 func ValidateQuoteHash(hash string) error {

internal/usecases/liquidity_provider/summaries.go

@@ -14,7 +14,7 @@ const (
 	DateFormat = time.DateOnly
 )
 
-type SummariesResponse struct {
+type SummaryResult struct {
 	PeginSummary  SummaryData `json:"peginSummary"`
 	PegoutSummary SummaryData `json:"pegoutSummary"`
 }
@@ -30,35 +30,14 @@ type SummaryData struct {
 	LpEarnings                *entities.Wei `json:"lpEarnings"`
 }
 
-type Quote interface {
-	Total() *entities.Wei
-}
-
-type RetainedQuote interface {
-	GetQuoteHash() string
-}
-
-type FeeProvider interface {
-	GetCallFee() *entities.Wei
-	GetGasFee() *entities.Wei
-	GetProductFee() *entities.Wei
-	GetPenaltyFee() *entities.Wei
-}
-
 type feeAdapter struct {
 	callFee    *entities.Wei
 	gasFee     *entities.Wei
 	productFee *entities.Wei
 	penaltyFee *entities.Wei
 }
 
-type QuoteResult[Q any, R RetainedQuote] interface {
-	GetQuotes() []Q
-	GetRetainedQuotes() []R
-	GetQuoteHashToIndex() map[string]int
-}
-
-type quoteResultAdapter[Q any, R RetainedQuote] struct {
+type quoteResultAdapter[Q any, R quote.RetainedQuote] struct {
 	quotes           []Q
 	retainedQuotes   []R
 	quoteHashToIndex map[string]int
@@ -92,24 +71,24 @@ func NewSummariesUseCase(
 	}
 }
 
-func (u *SummariesUseCase) Run(ctx context.Context, startDate, endDate time.Time) (SummariesResponse, error) {
+func (u *SummariesUseCase) Run(ctx context.Context, startDate, endDate time.Time) (SummaryResult, error) {
 	peginData, err := u.aggregatePeginData(ctx, startDate, endDate)
 	if err != nil {
 		log.Errorf("Error aggregating pegin data: %v", err)
-		return SummariesResponse{}, err
+		return SummaryResult{}, err
 	}
 	pegoutData, err := u.aggregatePegoutData(ctx, startDate, endDate)
 	if err != nil {
 		log.Errorf("Error aggregating pegout data: %v", err)
-		return SummariesResponse{}, err
+		return SummaryResult{}, err
 	}
-	return SummariesResponse{
+	return SummaryResult{
 		PeginSummary:  peginData,
 		PegoutSummary: pegoutData,
 	}, nil
 }
 
-func mapPeginQuote(q *quote.PeginQuote) FeeProvider {
+func mapPeginQuote(q *quote.PeginQuote) quote.FeeProvider {
 	if q == nil {
 		return &feeAdapter{}
 	}
@@ -121,7 +100,7 @@ func mapPeginQuote(q *quote.PeginQuote) FeeProvider {
 	}
 }
 
-func mapPegoutQuote(q *quote.PegoutQuote) FeeProvider {
+func mapPegoutQuote(q *quote.PegoutQuote) quote.FeeProvider {
 	if q == nil {
 		return &feeAdapter{}
 	}
@@ -133,7 +112,7 @@ func mapPegoutQuote(q *quote.PegoutQuote) FeeProvider {
 	}
 }
 
-func processQuoteData[Q any, R RetainedQuote, F FeeProvider](
+func processQuoteData[Q any, R quote.RetainedQuote, F quote.FeeProvider](
 	ctx context.Context,
 	quotes []Q,
 	retainedQuotes []R,
@@ -167,7 +146,7 @@ func processQuoteData[Q any, R RetainedQuote, F FeeProvider](
 		fees := feeProvider(quoteObj)
 		if isAccepted(retained) {
 			data.ConfirmedQuotesCount++
-			if q, ok := any(quoteObj).(Quote); ok {
+			if q, ok := any(quoteObj).(quote.Quote); ok {
 				acceptedTotalAmount.Add(acceptedTotalAmount, q.Total())
 			}
 			callFee := fees.GetCallFee()
@@ -194,7 +173,7 @@ func calculateTotalAmount[T any](quotes []T) *entities.Wei {
 	totalAmount := entities.NewWei(0)
 	for i := range quotes {
 		var total *entities.Wei
-		if q, ok := any(&quotes[i]).(Quote); ok {
+		if q, ok := any(&quotes[i]).(quote.Quote); ok {
 			total = q.Total()
 		}
 		if total != nil {
@@ -215,7 +194,7 @@ func createQuoteHashMap[T any](quotes []T, quoteHashToIndex map[string]int) map[
 	return quotesByHash
 }
 
-func fetchMissingQuotes[Q any, R RetainedQuote](
+func fetchMissingQuotes[Q any, R quote.RetainedQuote](
 	ctx context.Context,
 	quotesByHash map[string]*Q,
 	retainedQuotes []R,
@@ -237,36 +216,36 @@ func fetchMissingQuotes[Q any, R RetainedQuote](
 			continue
 		}
 		quotesByHash[quoteHash] = quoteObj
-		if q, ok := any(quoteObj).(Quote); ok {
+		if q, ok := any(quoteObj).(quote.Quote); ok {
 			totalAmount.Add(totalAmount, q.Total())
 		}
 	}
 }
 
-func adaptPeginResult(result quote.PeginQuoteResult) QuoteResult[quote.PeginQuote, quote.RetainedPeginQuote] {
+func adaptPeginResult(result quote.PeginQuoteResult) quote.QuoteResult[quote.PeginQuote, quote.RetainedPeginQuote] {
 	return quoteResultAdapter[quote.PeginQuote, quote.RetainedPeginQuote]{
 		quotes:           result.Quotes,
 		retainedQuotes:   result.RetainedQuotes,
 		quoteHashToIndex: result.QuoteHashToIndex,
 	}
 }
 
-func adaptPegoutResult(result quote.PegoutQuoteResult) QuoteResult[quote.PegoutQuote, quote.RetainedPegoutQuote] {
+func adaptPegoutResult(result quote.PegoutQuoteResult) quote.QuoteResult[quote.PegoutQuote, quote.RetainedPegoutQuote] {
 	return quoteResultAdapter[quote.PegoutQuote, quote.RetainedPegoutQuote]{
 		quotes:           result.Quotes,
 		retainedQuotes:   result.RetainedQuotes,
 		quoteHashToIndex: result.QuoteHashToIndex,
 	}
 }
 
-func aggregateData[Q any, RQ RetainedQuote](
+func aggregateData[Q any, RQ quote.RetainedQuote](
 	ctx context.Context,
 	startDate, endDate time.Time,
-	listQuotes func(context.Context, time.Time, time.Time) (QuoteResult[Q, RQ], error),
+	listQuotes func(context.Context, time.Time, time.Time) (quote.QuoteResult[Q, RQ], error),
 	getQuote func(context.Context, string) (*Q, error),
 	isAccepted func(RQ) bool,
 	isRefunded func(RQ) bool,
-	toFeeProvider func(*Q) FeeProvider,
+	toFeeProvider func(*Q) quote.FeeProvider,
 ) (SummaryData, error) {
 	result, err := listQuotes(ctx, startDate, endDate)
 	if err != nil {
@@ -286,7 +265,7 @@ func aggregateData[Q any, RQ RetainedQuote](
 }
 
 func (u *SummariesUseCase) aggregatePeginData(ctx context.Context, startDate, endDate time.Time) (SummaryData, error) {
-	listPeginQuotes := func(ctx context.Context, start, end time.Time) (QuoteResult[quote.PeginQuote, quote.RetainedPeginQuote], error) {
+	listPeginQuotes := func(ctx context.Context, start, end time.Time) (quote.QuoteResult[quote.PeginQuote, quote.RetainedPeginQuote], error) {
 		result, err := u.peginRepo.ListQuotesByDateRange(ctx, start, end)
 		if err != nil {
 			return nil, err
@@ -304,7 +283,7 @@ func (u *SummariesUseCase) aggregatePeginData(ctx context.Context, startDate, en
 }
 
 func (u *SummariesUseCase) aggregatePegoutData(ctx context.Context, startDate, endDate time.Time) (SummaryData, error) {
-	listPegoutQuotes := func(ctx context.Context, start, end time.Time) (QuoteResult[quote.PegoutQuote, quote.RetainedPegoutQuote], error) {
+	listPegoutQuotes := func(ctx context.Context, start, end time.Time) (quote.QuoteResult[quote.PegoutQuote, quote.RetainedPegoutQuote], error) {
 		result, err := u.pegoutRepo.ListQuotesByDateRange(ctx, start, end)
 		if err != nil {
 			return nil, err