Skip to content

Commit e111ef9

Browse files
committed
feedback:SummaryData types
1 parent 43942df commit e111ef9

File tree

3 files changed

+60
-59
lines changed

3 files changed

+60
-59
lines changed

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"time"
1111

1212
"github.com/rsksmart/liquidity-provider-server/internal/adapters/entrypoints/rest"
13+
"github.com/rsksmart/liquidity-provider-server/internal/entities"
1314
"github.com/rsksmart/liquidity-provider-server/internal/usecases/liquidity_provider"
1415
"github.com/stretchr/testify/assert"
1516
"github.com/stretchr/testify/mock"
@@ -64,22 +65,22 @@ func TestGetReportSummariesHandler(t *testing.T) { //nolint:funlen
6465
PeginSummary: liquidity_provider.SummaryData{
6566
TotalAcceptedQuotesCount: 10,
6667
ConfirmedQuotesCount: 8,
67-
TotalQuotedAmount: "1000",
68-
TotalAcceptedQuotedAmount: "800",
69-
TotalFeesCollected: "50",
68+
TotalQuotedAmount: entities.NewWei(1000),
69+
TotalAcceptedQuotedAmount: entities.NewWei(800),
70+
TotalFeesCollected: entities.NewWei(50),
7071
RefundedQuotesCount: 2,
71-
TotalPenaltyAmount: "20",
72-
LpEarnings: "30",
72+
TotalPenaltyAmount: entities.NewWei(20),
73+
LpEarnings: entities.NewWei(30),
7374
},
7475
PegoutSummary: liquidity_provider.SummaryData{
7576
TotalAcceptedQuotesCount: 5,
7677
ConfirmedQuotesCount: 4,
77-
TotalQuotedAmount: "500",
78-
TotalAcceptedQuotedAmount: "400",
79-
TotalFeesCollected: "40",
78+
TotalQuotedAmount: entities.NewWei(500),
79+
TotalAcceptedQuotedAmount: entities.NewWei(400),
80+
TotalFeesCollected: entities.NewWei(40),
8081
RefundedQuotesCount: 1,
81-
TotalPenaltyAmount: "0",
82-
LpEarnings: "20",
82+
TotalPenaltyAmount: entities.NewWei(0),
83+
LpEarnings: entities.NewWei(20),
8384
},
8485
},
8586
mockErr: nil,

internal/usecases/liquidity_provider/summaries.go

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ type SummariesResponse struct {
2020
}
2121

2222
type SummaryData struct {
23-
TotalAcceptedQuotesCount int64 `json:"totalAcceptedQuotesCount"`
24-
ConfirmedQuotesCount int64 `json:"confirmedQuotesCount"`
25-
TotalQuotedAmount string `json:"totalQuotedAmount"`
26-
TotalAcceptedQuotedAmount string `json:"totalAcceptedQuotedAmount"`
27-
TotalFeesCollected string `json:"totalFeesCollected"`
28-
RefundedQuotesCount int64 `json:"refundedQuotesCount"`
29-
TotalPenaltyAmount string `json:"totalPenaltyAmount"`
30-
LpEarnings string `json:"lpEarnings"`
23+
TotalAcceptedQuotesCount int64 `json:"totalAcceptedQuotesCount"`
24+
ConfirmedQuotesCount int64 `json:"confirmedQuotesCount"`
25+
TotalQuotedAmount *entities.Wei `json:"totalQuotedAmount"`
26+
TotalAcceptedQuotedAmount *entities.Wei `json:"totalAcceptedQuotedAmount"`
27+
TotalFeesCollected *entities.Wei `json:"totalFeesCollected"`
28+
RefundedQuotesCount int64 `json:"refundedQuotesCount"`
29+
TotalPenaltyAmount *entities.Wei `json:"totalPenaltyAmount"`
30+
LpEarnings *entities.Wei `json:"lpEarnings"`
3131
}
3232

3333
type Quote interface {
@@ -73,12 +73,12 @@ func NewSummaryData() SummaryData {
7373
return SummaryData{
7474
TotalAcceptedQuotesCount: 0,
7575
ConfirmedQuotesCount: 0,
76-
TotalQuotedAmount: "0",
77-
TotalAcceptedQuotedAmount: "0",
78-
TotalFeesCollected: "0",
76+
TotalQuotedAmount: entities.NewWei(0),
77+
TotalAcceptedQuotedAmount: entities.NewWei(0),
78+
TotalFeesCollected: entities.NewWei(0),
7979
RefundedQuotesCount: 0,
80-
TotalPenaltyAmount: "0",
81-
LpEarnings: "0",
80+
TotalPenaltyAmount: entities.NewWei(0),
81+
LpEarnings: entities.NewWei(0),
8282
}
8383
}
8484

@@ -147,13 +147,13 @@ func processQuoteData[Q any, R RetainedQuote, F FeeProvider](
147147
totalAmount := calculateTotalAmount(quotes)
148148
if len(retainedQuotes) == 0 {
149149
data.TotalAcceptedQuotesCount = int64(len(quotes))
150-
data.TotalQuotedAmount = totalAmount.String()
150+
data.TotalQuotedAmount = totalAmount
151151
return data
152152
}
153153
data.TotalAcceptedQuotesCount = int64(len(retainedQuotes))
154154
quotesByHash := createQuoteHashMap(quotes, quoteHashToIndex)
155155
fetchMissingQuotes(ctx, quotesByHash, retainedQuotes, totalAmount, getQuote)
156-
data.TotalQuotedAmount = totalAmount.String()
156+
data.TotalQuotedAmount = totalAmount
157157
acceptedTotalAmount := entities.NewWei(0)
158158
totalFees := entities.NewWei(0)
159159
callFees := entities.NewWei(0)
@@ -183,10 +183,10 @@ func processQuoteData[Q any, R RetainedQuote, F FeeProvider](
183183
}
184184
lpEarnings := new(entities.Wei)
185185
lpEarnings.Sub(callFees, totalPenalty)
186-
data.TotalAcceptedQuotedAmount = acceptedTotalAmount.String()
187-
data.TotalFeesCollected = totalFees.String()
188-
data.TotalPenaltyAmount = totalPenalty.String()
189-
data.LpEarnings = lpEarnings.String()
186+
data.TotalAcceptedQuotedAmount = acceptedTotalAmount
187+
data.TotalFeesCollected = totalFees
188+
data.TotalPenaltyAmount = totalPenalty
189+
data.LpEarnings = lpEarnings
190190
return data
191191
}
192192

internal/usecases/liquidity_provider/summaries_test.go

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -299,19 +299,19 @@ func TestSummariesUseCase_Run(t *testing.T) { //nolint:funlen,maintidx
299299
assert.Equal(t, int64(len(retainedPeginQuotes)), result.PeginSummary.TotalAcceptedQuotesCount)
300300
assert.Equal(t, int64(1), result.PeginSummary.ConfirmedQuotesCount)
301301
assert.Equal(t, int64(0), result.PeginSummary.RefundedQuotesCount)
302-
assert.Equal(t, "660", result.PeginSummary.TotalQuotedAmount)
303-
assert.Equal(t, "110", result.PeginSummary.TotalAcceptedQuotedAmount)
304-
assert.Equal(t, "10", result.PeginSummary.TotalFeesCollected)
305-
assert.Equal(t, "0", result.PeginSummary.TotalPenaltyAmount)
306-
assert.Equal(t, "5", result.PeginSummary.LpEarnings)
302+
assert.Equal(t, 0, result.PeginSummary.TotalQuotedAmount.Cmp(entities.NewWei(660)))
303+
assert.Equal(t, 0, result.PeginSummary.TotalAcceptedQuotedAmount.Cmp(entities.NewWei(110)))
304+
assert.Equal(t, 0, result.PeginSummary.TotalFeesCollected.Cmp(entities.NewWei(10)))
305+
assert.Equal(t, 0, result.PeginSummary.TotalPenaltyAmount.Cmp(entities.NewWei(0)))
306+
assert.Equal(t, 0, result.PeginSummary.LpEarnings.Cmp(entities.NewWei(5)))
307307
assert.Equal(t, int64(len(retainedPegoutQuotes)), result.PegoutSummary.TotalAcceptedQuotesCount)
308308
assert.Equal(t, int64(1), result.PegoutSummary.ConfirmedQuotesCount)
309309
assert.Equal(t, int64(0), result.PegoutSummary.RefundedQuotesCount)
310-
assert.Equal(t, "1540", result.PegoutSummary.TotalQuotedAmount)
311-
assert.Equal(t, "330", result.PegoutSummary.TotalAcceptedQuotedAmount)
312-
assert.Equal(t, "30", result.PegoutSummary.TotalFeesCollected)
313-
assert.Equal(t, "0", result.PegoutSummary.TotalPenaltyAmount)
314-
assert.Equal(t, "15", result.PegoutSummary.LpEarnings)
310+
assert.Equal(t, 0, result.PegoutSummary.TotalQuotedAmount.Cmp(entities.NewWei(1540)))
311+
assert.Equal(t, 0, result.PegoutSummary.TotalAcceptedQuotedAmount.Cmp(entities.NewWei(330)))
312+
assert.Equal(t, 0, result.PegoutSummary.TotalFeesCollected.Cmp(entities.NewWei(30)))
313+
assert.Equal(t, 0, result.PegoutSummary.TotalPenaltyAmount.Cmp(entities.NewWei(0)))
314+
assert.Equal(t, 0, result.PegoutSummary.LpEarnings.Cmp(entities.NewWei(15)))
315315
peginRepo.AssertExpectations(t)
316316
pegoutRepo.AssertExpectations(t)
317317
})
@@ -361,19 +361,19 @@ func TestSummariesUseCase_Run(t *testing.T) { //nolint:funlen,maintidx
361361
assert.Equal(t, int64(len(peginQuotes)), result.PeginSummary.TotalAcceptedQuotesCount)
362362
assert.Equal(t, int64(0), result.PeginSummary.ConfirmedQuotesCount)
363363
assert.Equal(t, int64(0), result.PeginSummary.RefundedQuotesCount)
364-
assert.Equal(t, "330", result.PeginSummary.TotalQuotedAmount)
365-
assert.Equal(t, "0", result.PeginSummary.TotalAcceptedQuotedAmount)
366-
assert.Equal(t, "0", result.PeginSummary.TotalFeesCollected)
367-
assert.Equal(t, "0", result.PeginSummary.TotalPenaltyAmount)
368-
assert.Equal(t, "0", result.PeginSummary.LpEarnings)
364+
assert.Equal(t, 0, result.PeginSummary.TotalQuotedAmount.Cmp(entities.NewWei(330)))
365+
assert.Equal(t, 0, result.PeginSummary.TotalAcceptedQuotedAmount.Cmp(entities.NewWei(0)))
366+
assert.Equal(t, 0, result.PeginSummary.TotalFeesCollected.Cmp(entities.NewWei(0)))
367+
assert.Equal(t, 0, result.PeginSummary.TotalPenaltyAmount.Cmp(entities.NewWei(0)))
368+
assert.Equal(t, 0, result.PeginSummary.LpEarnings.Cmp(entities.NewWei(0)))
369369
assert.Equal(t, int64(len(pegoutQuotes)), result.PegoutSummary.TotalAcceptedQuotesCount)
370370
assert.Equal(t, int64(0), result.PegoutSummary.ConfirmedQuotesCount)
371371
assert.Equal(t, int64(0), result.PegoutSummary.RefundedQuotesCount)
372-
assert.Equal(t, "330", result.PegoutSummary.TotalQuotedAmount)
373-
assert.Equal(t, "0", result.PegoutSummary.TotalAcceptedQuotedAmount)
374-
assert.Equal(t, "0", result.PegoutSummary.TotalFeesCollected)
375-
assert.Equal(t, "0", result.PegoutSummary.TotalPenaltyAmount)
376-
assert.Equal(t, "0", result.PegoutSummary.LpEarnings)
372+
assert.Equal(t, 0, result.PegoutSummary.TotalQuotedAmount.Cmp(entities.NewWei(330)))
373+
assert.Equal(t, 0, result.PegoutSummary.TotalAcceptedQuotedAmount.Cmp(entities.NewWei(0)))
374+
assert.Equal(t, 0, result.PegoutSummary.TotalFeesCollected.Cmp(entities.NewWei(0)))
375+
assert.Equal(t, 0, result.PegoutSummary.TotalPenaltyAmount.Cmp(entities.NewWei(0)))
376+
assert.Equal(t, 0, result.PegoutSummary.LpEarnings.Cmp(entities.NewWei(0)))
377377
peginRepo.AssertExpectations(t)
378378
pegoutRepo.AssertExpectations(t)
379379
})
@@ -433,19 +433,19 @@ func TestSummariesUseCase_Run(t *testing.T) { //nolint:funlen,maintidx
433433
assert.Equal(t, int64(len(retainedPeginQuotes)), result.PeginSummary.TotalAcceptedQuotesCount)
434434
assert.Equal(t, int64(1), result.PeginSummary.ConfirmedQuotesCount)
435435
assert.Equal(t, int64(0), result.PeginSummary.RefundedQuotesCount)
436-
assert.Equal(t, "110", result.PeginSummary.TotalQuotedAmount)
437-
assert.Equal(t, "110", result.PeginSummary.TotalAcceptedQuotedAmount)
438-
assert.Equal(t, "10", result.PeginSummary.TotalFeesCollected)
439-
assert.Equal(t, "0", result.PeginSummary.TotalPenaltyAmount)
440-
assert.Equal(t, "5", result.PeginSummary.LpEarnings)
436+
assert.Equal(t, 0, result.PeginSummary.TotalQuotedAmount.Cmp(entities.NewWei(110)))
437+
assert.Equal(t, 0, result.PeginSummary.TotalAcceptedQuotedAmount.Cmp(entities.NewWei(110)))
438+
assert.Equal(t, 0, result.PeginSummary.TotalFeesCollected.Cmp(entities.NewWei(10)))
439+
assert.Equal(t, 0, result.PeginSummary.TotalPenaltyAmount.Cmp(entities.NewWei(0)))
440+
assert.Equal(t, 0, result.PeginSummary.LpEarnings.Cmp(entities.NewWei(5)))
441441
assert.Equal(t, int64(len(retainedPegoutQuotes)), result.PegoutSummary.TotalAcceptedQuotesCount)
442442
assert.Equal(t, int64(1), result.PegoutSummary.ConfirmedQuotesCount)
443443
assert.Equal(t, int64(0), result.PegoutSummary.RefundedQuotesCount)
444-
assert.Equal(t, "330", result.PegoutSummary.TotalQuotedAmount)
445-
assert.Equal(t, "330", result.PegoutSummary.TotalAcceptedQuotedAmount)
446-
assert.Equal(t, "30", result.PegoutSummary.TotalFeesCollected)
447-
assert.Equal(t, "0", result.PegoutSummary.TotalPenaltyAmount)
448-
assert.Equal(t, "15", result.PegoutSummary.LpEarnings)
444+
assert.Equal(t, 0, result.PegoutSummary.TotalQuotedAmount.Cmp(entities.NewWei(330)))
445+
assert.Equal(t, 0, result.PegoutSummary.TotalAcceptedQuotedAmount.Cmp(entities.NewWei(330)))
446+
assert.Equal(t, 0, result.PegoutSummary.TotalFeesCollected.Cmp(entities.NewWei(30)))
447+
assert.Equal(t, 0, result.PegoutSummary.TotalPenaltyAmount.Cmp(entities.NewWei(0)))
448+
assert.Equal(t, 0, result.PegoutSummary.LpEarnings.Cmp(entities.NewWei(15)))
449449
peginRepo.AssertExpectations(t)
450450
pegoutRepo.AssertExpectations(t)
451451
})

0 commit comments

Comments
 (0)