feat: implement node rewards calculation and API endpoint

node-registrar/docs/docs.go

@@ -694,6 +694,52 @@ const docTemplate = `{
                 }
             }
         },
+        "/nodes/{node_id}/reward": {
+            "get": {
+                "description": "Retrieves reward calculation for a specific node based on resources and uptime",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "nodes"
+                ],
+                "summary": "Get node monthly reward information",
+                "parameters": [
+                    {
+                        "type": "integer",
+                        "description": "Node ID",
+                        "name": "node_id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Rewards details with the node uptime percentage",
+                        "schema": {
+                            "$ref": "#/definitions/server.Reward"
+                        }
+                    },
+                    "400": {
+                        "description": "Invalid node ID",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    },
+                    "404": {
+                        "description": "Node not found",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    }
+                }
+            }
+        },
         "/nodes/{node_id}/uptime": {
             "post": {
                 "description": "Submit uptime report for a node",

node-registrar/docs/swagger.json

@@ -687,6 +687,52 @@
                 }
             }
         },
+        "/nodes/{node_id}/rewards": {
+            "get": {
+                "description": "Retrieves reward calculation for a specific node based on resources and uptime",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "nodes"
+                ],
+                "summary": "Get node monthly reward information",
+                "parameters": [
+                    {
+                        "type": "integer",
+                        "description": "Node ID",
+                        "name": "node_id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Rewards details with the node uptime percentage",
+                        "schema": {
+                            "$ref": "#/definitions/server.Reward"
+                        }
+                    },
+                    "400": {
+                        "description": "Invalid node ID",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    },
+                    "404": {
+                        "description": "Node not found",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": true
+                        }
+                    }
+                }
+            }
+        },
         "/nodes/{node_id}/uptime": {
             "post": {
                 "description": "Submit uptime report for a node",
@@ -1104,7 +1150,27 @@
                 }
             }
         },
-        "server.UpdateAccountRequest": {
+        "server.Reward": {
+            "type": "object",
+            "properties": {
+                "farmerReward": {
+                    "type": "number"
+                },
+                "fpreward": {
+                    "type": "number"
+                },
+                "tfreward": {
+                    "type": "number"
+                },
+                "total": {
+                    "type": "number"
+                },
+                "upTimePercentage": {
+                    "type": "number"
+                }
+            }
+        },
+        "pkg_server.UpdateAccountRequest": {
             "type": "object",
             "properties": {
                 "relays": {

node-registrar/docs/swagger.yaml

@@ -170,6 +170,19 @@ definitions:
     - serial_number
     - twin_id
     type: object
+  server.Reward:
+    properties:
+      farmerReward:
+        type: number
+      fpreward:
+        type: number
+      tfreward:
+        type: number
+      total:
+        type: number
+      upTimePercentage:
+        type: number
+    type: object
   server.UpdateAccountRequest:
     properties:
       relays:
@@ -697,6 +710,38 @@ paths:
       summary: Update node
       tags:
       - nodes
+  /nodes/{node_id}/rewards:
+    get:
+      consumes:
+      - application/json
+      description: Retrieves reward calculation for a specific node based on resources
+        and uptime
+      parameters:
+      - description: Node ID
+        in: path
+        name: node_id
+        required: true
+        type: integer
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: Rewards details with the node uptime percentage
+          schema:
+            $ref: '#/definitions/server.Reward'
+        "400":
+          description: Invalid node ID
+          schema:
+            additionalProperties: true
+            type: object
+        "404":
+          description: Node not found
+          schema:
+            additionalProperties: true
+            type: object
+      summary: Get node monthly reward information
+      tags:
+      - nodes
   /nodes/{node_id}/uptime:
     post:
       consumes:

node-registrar/pkg/db/models.go

@@ -67,7 +67,7 @@ func (n *Node) BeforeCreate(tx *gorm.DB) (err error) {
 type UptimeReport struct {
 	ID         uint64        `gorm:"primaryKey;autoIncrement"`
 	NodeID     uint64        `gorm:"index" json:"node_id"`
-	Duration   time.Duration `json:"duration" swaggertype:"integer"` // Uptime duration for this period
+	Duration   time.Duration `json:"duration" swaggertype:"integer"` // Uptime duration for this period in seconds
 	Timestamp  time.Time     `json:"timestamp" gorm:"index"`
 	WasRestart bool          `json:"was_restart"` // True if this report followed a restart
 	CreatedAt  time.Time     `json:"created_at"`

node-registrar/pkg/server/handlers.go

@@ -281,6 +281,56 @@ func (s Server) getNodeHandler(c *gin.Context) {
 	c.JSON(http.StatusOK, node)
 }
 
+// @Summary Get node monthly reward information
+// @Description Retrieves reward calculation for a specific node based on resources and uptime
+// @Tags nodes
+// @Accept json
+// @Produce json
+// @Param node_id path int true "Node ID"
+// @Success 200 {object} Reward "Rewards details with the node uptime percentage"
+// @Failure 400 {object} map[string]any "Invalid node ID"
+// @Failure 404 {object} map[string]any "Node not found"
+// @Router /nodes/{node_id}/rewards [get]
+func (s Server) getNodeRewardHandler(c *gin.Context) {
+	nodeID := c.Param("node_id")
+
+	id, err := strconv.ParseUint(nodeID, 10, 64)
+	if err != nil {
+		c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid node id"})
+		return
+	}
+
+	node, err := s.db.GetNode(id)
+	if err != nil {
+		if errors.Is(err, db.ErrRecordNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": err.Error()})
+			return
+		}
+
+		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
+		return
+	}
+
+	now := time.Now()
+	currentPeriodStart := calculateCurrentPeriodStart(now)
+
+	reports, err := s.db.GetUptimeReports(id, currentPeriodStart, now)
+
+	if err != nil {
+		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
+		return
+	}
+
+	upTimePercentage := calculateUpTimePercentage(reports, currentPeriodStart, now)
+
+	rewards, err := CalculateMonthlyReward(node.Resources, upTimePercentage)
+	if err != nil {
+		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
+		return
+	}
+	c.JSON(http.StatusOK, rewards)
+}
+
 type NodeRegistrationRequest struct {
 	TwinID       uint64         `json:"twin_id" binding:"required,min=1"`
 	FarmID       uint64         `json:"farm_id" binding:"required,min=1"`
@@ -422,7 +472,7 @@ func (s *Server) updateNodeHandler(c *gin.Context) {
 }
 
 type UptimeReportRequest struct {
-	Uptime    uint64 `json:"uptime" binding:"required"`
+	Uptime    uint64 `json:"uptime" binding:"required"` // in seconds
 	Timestamp int64  `json:"timestamp" binding:"required"`
 }