feat: implement node rewards calculation and API endpoint #64
Conversation
… uptime percentage
0oM4R
requested review from
mariobassem,
ashraffouda,
rawdaGastan,
Omarabdul3ziz,
AbdelrahmanElawady,
xmonader,
sameh-farouk and
Eslam-Nawara
as code owners
|
|
||
| upTimePercentage, err := calculateUpTimePercentage(reports, periodStart, now) | ||
| if err != nil { | ||
| if err == ErrReportsNotInAscOrder { |
There was a problem hiding this comment.
use errors.Is instead of ==
node-registrar/test/main.go
Outdated
There was a problem hiding this comment.
remove the test file
| if err == ErrReportsNotInAscOrder { | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
| if err == ErrNoReportsAvailable { | ||
| c.JSON(http.StatusUnprocessableEntity, gin.H{"error": err.Error()}) | ||
| return | ||
| } | ||
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | ||
| return |
There was a problem hiding this comment.
if you return status internal server error in case of ErrReportNotInAscOrder and in the default case then maybe you should just remove the check for ErrReportNotInAscOrder and only use the default
| if err == ErrReportsNotInAscOrder { | |
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | |
| return | |
| } | |
| if err == ErrNoReportsAvailable { | |
| c.JSON(http.StatusUnprocessableEntity, gin.H{"error": err.Error()}) | |
| return | |
| } | |
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | |
| return | |
| if errors.Is(err, ErrNoReportsAvailable) { | |
| c.JSON(http.StatusUnprocessableEntity, gin.H{"error": err.Error()}) | |
| return | |
| } | |
| c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) | |
| return | |
There was a problem hiding this comment.
I think we are passing the error, so it may help us in debugging.
There was a problem hiding this comment.
we're passing the error in both cases
Eslam-Nawara
force-pushed
the
development_rewards
branch
from
10c4a79 to
6646f65
Compare
|
|
||
| // Error check | ||
| if tt.wantError { | ||
| if err == nil { |
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } |
|
|
||
| // Use precise floating point comparison | ||
| const delta = 1e-9 // Very small acceptable difference | ||
| assert.InDelta(t, expected.FarmerReward, got.FarmerReward, delta) |
There was a problem hiding this comment.
all this values are rounded no?
| // secondsSinceCurrentPeriodStart := (tt.inputTime.Unix() - FirstPeriodStartTimestamp) % StandardPeriodDuration | ||
| // manualCalculation := time.Unix(FirstPeriodStartTimestamp+secondsSinceCurrentPeriodStart, 0) | ||
| // assert.Equal(t, manualCalculation.Unix(), result.Unix()) |
There was a problem hiding this comment.
remove extra comments
| } | ||
| } | ||
|
|
||
| func AssertCapacityReward(t testing.TB, resources db.Resources, upTimePercentage float64, got Reward) { |
There was a problem hiding this comment.
should the values we're testing against be pre-calculated?
| if err != nil { | ||
| return reward, errors.Wrap(err, "failed to send request to rewards endpoint") | ||
| } | ||
| defer resp.Body.Close() |
There was a problem hiding this comment.
please check that resp not nil
node-registrar/client/node.go
Outdated
| if resp.StatusCode == http.StatusUnprocessableEntity { | ||
| return reward, parseResponseError(resp.Body) | ||
| } | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| err = parseResponseError(resp.Body) | ||
| return reward, errors.Wrap(err, "failed to get node rewards") | ||
| } |
There was a problem hiding this comment.
the client responds the same for the two cases, why not removing the fist one?
…v4-sdk-go into development_rewards
…ed value checks in rewards tests
Description
This PR introduces a new API endpoint to calculate real-time node rewards based on node resources and uptime reports.
Please note that the network usage is not included
And please consider those concerns, comment
Changes
New Endpoint:
GET /nodes/{node_id}/rewards
Returns: Rewards
New Handler:
getNodeRewardsHandler – handles input validation and response logic.
New Reward Logic:
Added a pkg/server/rewards.go file with the logic to:
- Get uptime reports for the current month
- Calculate uptime percentage
- Apply reward formula
- Return reward values (or zeroes if uptime is too low)
Swagger Update:
API documentation updated with the new endpoint and response schema.
Tests
Add unit tests, create a fake node, and submit some reports
Related Issues
Checklist