1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package common
import (
"encoding/json"
"fmt"
"net/http"
"github.com/labstack/echo/v4"
"github.com/algorand/go-algorand/agreement"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/daemon/algod/api"
"github.com/algorand/go-algorand/daemon/algod/api/server/lib"
"github.com/algorand/go-algorand/daemon/algod/api/spec/common"
"github.com/algorand/go-algorand/node"
)
// GenesisJSON is an httpHandler for route GET /genesis
func GenesisJSON(ctx lib.ReqContext, context echo.Context) {
// swagger:operation GET /genesis GenesisJSON
//---
// Summary: Gets the genesis information
// Description: Returns the entire genesis file in json.
// Produces:
// - application/json
// Schemes:
// - http
// Responses:
// 200:
// description: The current genesis information
// schema: {type: string}
// default: { description: Unknown Error }
w := context.Response().Writer
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte(lib.GenesisJSONText))
}
// SwaggerJSON is an httpHandler for route GET /swagger.json
func SwaggerJSON(ctx lib.ReqContext, context echo.Context) {
// swagger:operation GET /swagger.json SwaggerJSON
//---
// Summary: Gets the current swagger spec.
// Description: Returns the entire swagger spec in json.
// Produces:
// - application/json
// Schemes:
// - http
// Responses:
// 200:
// description: The current swagger spec
// schema: {type: string}
// default: { description: Unknown Error }
w := context.Response().Writer
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(api.SwaggerSpecJSONEmbed))
}
// HealthCheck is an httpHandler for route GET /health
func HealthCheck(ctx lib.ReqContext, context echo.Context) {
// swagger:operation GET /health HealthCheck
//---
// Summary: Returns OK if healthy.
// Produces:
// - application/json
// Schemes:
// - http
// Responses:
// 200:
// description: OK.
// default: { description: Unknown Error }
w := context.Response().Writer
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
json.NewEncoder(w).Encode(nil)
}
// Ready is a httpHandler for route GET /ready
// it serves "readiness" probe on if the node is healthy and fully caught-up.
func Ready(ctx lib.ReqContext, context echo.Context) {
// swagger:operation GET /ready Ready
//---
// Summary: Returns OK if healthy and fully caught up.
// Produces:
// - application/json
// Schemes:
// - http
// Responses:
// 200:
// description: OK.
// 500:
// description: Internal Error.
// 503:
// description: Node not ready yet.
// default: { description: Unknown Error }
w := context.Response().Writer
w.Header().Set("Content-Type", "application/json")
stat, err := ctx.Node.Status()
code := http.StatusOK
// isReadyFromStat checks the `Node.Status()` result
// and decide if the node is at the latest round
// must satisfy following sub conditions:
// 1. the node is not in a fast-catchup stage
// 2. the node's time since last round should be [0, deadline),
// while deadline = agreement.DefaultDeadlineTimeout = 17s
// 3. the node's catchup time is 0
isReadyFromStat := func(status node.StatusReport) bool {
timeSinceLastRound := status.TimeSinceLastRound().Milliseconds()
return len(status.Catchpoint) == 0 &&
timeSinceLastRound >= 0 &&
timeSinceLastRound < agreement.DefaultDeadlineTimeout().Milliseconds() &&
status.CatchupTime.Milliseconds() == 0
}
if err != nil {
code = http.StatusInternalServerError
ctx.Log.Error(err)
} else if stat.StoppedAtUnsupportedRound {
code = http.StatusInternalServerError
err = fmt.Errorf("stopped at an unsupported round")
ctx.Log.Error(err)
} else if !isReadyFromStat(stat) {
code = http.StatusServiceUnavailable
err = fmt.Errorf("ready failed as the node is catching up")
ctx.Log.Info(err)
}
w.WriteHeader(code)
_ = json.NewEncoder(w).Encode(nil)
}
// VersionsHandler is an httpHandler for route GET /versions
func VersionsHandler(ctx lib.ReqContext, context echo.Context) {
// swagger:route GET /versions GetVersion
//
// Retrieves the current version
//
// Produces:
// - application/json
//
// Schemes: http
//
// Responses:
// 200: VersionsResponse
w := context.Response().Writer
gh := ctx.Node.GenesisHash()
currentVersion := config.GetCurrentVersion()
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
response := VersionsResponse{
Body: common.Version{
Versions: []string{"v2"},
GenesisID: ctx.Node.GenesisID(),
GenesisHash: gh[:],
Build: common.BuildVersion{
Major: currentVersion.Major,
Minor: currentVersion.Minor,
BuildNumber: currentVersion.BuildNumber,
CommitHash: currentVersion.CommitHash,
Branch: currentVersion.Branch,
Channel: currentVersion.Channel,
},
},
}
json.NewEncoder(w).Encode(response.Body)
return
}
// CORS
func optionsHandler(ctx lib.ReqContext, context echo.Context) {
context.Response().Writer.WriteHeader(http.StatusOK)
}
|
