-
Notifications
You must be signed in to change notification settings - Fork 166
/
final_list.go
322 lines (267 loc) · 10.2 KB
/
final_list.go
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
package cmd
import (
"fmt"
"github.com/spf13/cobra"
"github.com/onflow/flow-go/cmd"
"github.com/onflow/flow-go/cmd/util/cmd/common"
model "github.com/onflow/flow-go/model/bootstrap"
"github.com/onflow/flow-go/model/flow"
)
var (
flagStakingNodesPath string
)
// finalListCmd represents the final list command
var finalListCmd = &cobra.Command{
Use: "finallist",
Short: "generates a final list of nodes to be used for next network",
Long: "generates a final list of nodes to be used for next network after validating node data and matching against staking contract nodes ",
Run: finalList,
}
func init() {
rootCmd.AddCommand(finalListCmd)
addFinalListFlags()
}
func addFinalListFlags() {
// partner node info flag
finalListCmd.Flags().StringVar(&flagPartnerNodeInfoDir, "partner-infos", "", "path to a directory containing all parnter nodes details")
cmd.MarkFlagRequired(finalListCmd, "partner-infos")
// internal/flow node info flag
finalListCmd.Flags().StringVar(&flagInternalNodePrivInfoDir, "flow-infos", "", "path to a directory containing all internal/flow nodes details")
cmd.MarkFlagRequired(finalListCmd, "flow-infos")
// staking nodes dir containing staking nodes json
finalListCmd.Flags().StringVar(&flagStakingNodesPath, "staking-nodes", "", "path to a JSON file of all staking nodes")
cmd.MarkFlagRequired(finalListCmd, "staking-nodes")
finalListCmd.Flags().UintVar(&flagCollectionClusters, "collection-clusters", 2,
"number of collection clusters")
}
func finalList(cmd *cobra.Command, args []string) {
// read public partner node infos
log.Info().Msgf("reading partner public node information: %s", flagPartnerNodeInfoDir)
partnerNodes := assemblePartnerNodesWithoutWeight()
// read internal private node infos
log.Info().Msgf("reading internal/flow private node information: %s", flagInternalNodePrivInfoDir)
internalNodes := assembleInternalNodesWithoutWeight()
log.Info().Msg("checking constraints on consensus/cluster nodes")
checkConstraints(partnerNodes, internalNodes)
// nodes which are registered on-chain
log.Info().Msgf("reading staking contract node information: %s", flagStakingNodesPath)
registeredNodes := readStakingContractDetails()
// merge internal and partner node infos (from local files)
localNodes := mergeNodeInfos(internalNodes, partnerNodes)
// reconcile nodes from staking contract nodes
validateNodes(localNodes, registeredNodes)
// write node-config.json with the new list of nodes to be used for the `finalize` command
err := common.WriteJSON(model.PathFinallist, flagOutdir, model.ToPublicNodeInfoList(localNodes))
if err != nil {
log.Fatal().Err(err).Msg("failed to write json")
}
log.Info().Msgf("wrote file %s/%s", flagOutdir, model.PathFinallist)
}
func validateNodes(localNodes []model.NodeInfo, registeredNodes []model.NodeInfo) {
// check node count
if len(localNodes) != len(registeredNodes) {
log.Error().
Int("local", len(localNodes)).
Int("onchain", len(registeredNodes)).
Msg("onchain node count does not match local internal+partner node count")
}
// check registered and local nodes to make sure node ID are not missing
validateNodeIDs(localNodes, registeredNodes)
// print mismatching nodes
checkMismatchingNodes(localNodes, registeredNodes)
// create map
localNodeMap := make(map[flow.Identifier]model.NodeInfo)
for _, node := range localNodes {
localNodeMap[node.NodeID] = node
}
// check node type mismatch
for _, registeredNode := range registeredNodes {
// win have matching node as we have a check before
matchingNode := localNodeMap[registeredNode.NodeID]
// check node type and error if mismatch
if matchingNode.Role != registeredNode.Role {
log.Error().
Str("registered node id", registeredNode.NodeID.String()).
Str("registered node role", registeredNode.Role.String()).
Str("local node", matchingNode.NodeID.String()).
Str("local node role", matchingNode.Role.String()).
Msg("node role does not match")
}
if matchingNode.Address != registeredNode.Address {
log.Error().
Str("registered node id", registeredNode.NodeID.String()).
Str("registered node address", registeredNode.Address).
Str("local node", matchingNode.NodeID.String()).
Str("local node address", matchingNode.Address).
Msg("node address does not match")
}
// check address match
if matchingNode.Address != registeredNode.Address {
log.Warn().
Str("registered node", registeredNode.NodeID.String()).
Str("node id", matchingNode.NodeID.String()).
Msg("address do not match")
}
// flow localNodes contain private key info
if matchingNode.NetworkPubKey().String() != "" {
// check networking pubkey match
matchNodeKey := matchingNode.NetworkPubKey().String()
registeredNodeKey := registeredNode.NetworkPubKey().String()
if matchNodeKey != registeredNodeKey {
log.Error().
Str("registered network key", registeredNodeKey).
Str("network key", matchNodeKey).
Msg("networking keys do not match")
}
}
// flow localNodes contain privatekey info
if matchingNode.StakingPubKey().String() != "" {
matchNodeKey := matchingNode.StakingPubKey().String()
registeredNodeKey := registeredNode.StakingPubKey().String()
if matchNodeKey != registeredNodeKey {
log.Error().
Str("registered staking key", registeredNodeKey).
Str("staking key", matchNodeKey).
Msg("staking keys do not match")
}
}
}
}
// validateNodeIDs will go through both sets of nodes and ensure that no node-id
// are missing. It will log all missing node ID's and throw an error.
func validateNodeIDs(localNodes []model.NodeInfo, registeredNodes []model.NodeInfo) {
// go through registered nodes
invalidStakingNodes := make([]model.NodeInfo, 0)
for _, node := range registeredNodes {
if node.NodeID.String() == "" {
// we warn here but exit later
invalidStakingNodes = append(invalidStakingNodes, node)
log.Warn().
Str("node-address", node.Address).
Msg("missing node-id from registered nodes")
}
}
// go through local nodes
invalidNodes := make([]model.NodeInfo, 0)
for _, node := range localNodes {
if node.NodeID.String() == "" {
// we warn here but exit later
invalidNodes = append(invalidNodes, node)
log.Warn().
Str("node-address", node.Address).
Msg("missing node-id from local nodes")
}
}
if len(invalidNodes) != 0 || len(invalidStakingNodes) != 0 {
log.Fatal().Msg("found missing nodes ids. fix and re-run")
}
}
func checkMismatchingNodes(localNodes []model.NodeInfo, registeredNodes []model.NodeInfo) {
localNodesByID := make(map[flow.Identifier]model.NodeInfo)
for _, node := range localNodes {
localNodesByID[node.NodeID] = node
}
registeredNodesByID := make(map[flow.Identifier]model.NodeInfo)
for _, node := range registeredNodes {
registeredNodesByID[node.NodeID] = node
}
// try match local nodes to registered nodes
invalidLocalNodes := make([]model.NodeInfo, 0)
for _, node := range localNodes {
if _, ok := registeredNodesByID[node.NodeID]; !ok {
log.Warn().
Str("local-node-id", node.NodeID.String()).
Str("role", node.Role.String()).
Str("address", node.Address).
Msg("matching registered node not found for local node")
invalidLocalNodes = append(invalidLocalNodes, node)
}
}
invalidRegisteredNodes := make([]model.NodeInfo, 0)
for _, node := range registeredNodes {
if _, ok := localNodesByID[node.NodeID]; !ok {
log.Warn().
Str("registered-node-id", node.NodeID.String()).
Str("role", node.Role.String()).
Str("address", node.Address).
Msg("matching local node not found for local node")
invalidRegisteredNodes = append(invalidRegisteredNodes, node)
}
}
if len(invalidLocalNodes) != 0 || len(invalidRegisteredNodes) != 0 {
log.Fatal().Msg("found missing mismatching nodes")
}
}
func assembleInternalNodesWithoutWeight() []model.NodeInfo {
privInternals, err := common.ReadInternalNodeInfos(flagInternalNodePrivInfoDir)
if err != nil {
log.Fatal().Err(err).Msg("failed to read internal node infos")
}
log.Info().Msgf("read %v internal private node-info files", len(privInternals))
var nodes []model.NodeInfo
for _, internal := range privInternals {
// check if address is valid format
common.ValidateAddressFormat(log, internal.Address)
// validate every single internal node
err := common.ValidateNodeID(internal.NodeID)
if err != nil {
log.Fatal().Err(err).Msg(fmt.Sprintf("invalid node ID: %s", internal.NodeID))
}
node := model.NewPrivateNodeInfo(
internal.NodeID,
internal.Role,
internal.Address,
flow.DefaultInitialWeight,
internal.NetworkPrivKey,
internal.StakingPrivKey,
)
nodes = append(nodes, node)
}
return nodes
}
func assemblePartnerNodesWithoutWeight() []model.NodeInfo {
partners, err := common.ReadPartnerNodeInfos(flagPartnerNodeInfoDir)
if err != nil {
log.Fatal().Err(err).Msg("failed to read partner node infos")
}
log.Info().Msgf("read %v partner node configuration files", len(partners))
return createPublicNodeInfo(partners)
}
func readStakingContractDetails() []model.NodeInfo {
var stakingNodes []model.NodeInfoPub
err := common.ReadJSON(flagStakingNodesPath, &stakingNodes)
if err != nil {
log.Fatal().Err(err).Msg("failed to read json")
}
return createPublicNodeInfo(stakingNodes)
}
func createPublicNodeInfo(nodes []model.NodeInfoPub) []model.NodeInfo {
var publicInfoNodes []model.NodeInfo
for _, n := range nodes {
common.ValidateAddressFormat(log, n.Address)
// validate every single partner node
err := common.ValidateNodeID(n.NodeID)
if err != nil {
log.Fatal().Err(err).Msg(fmt.Sprintf("invalid node ID: %s", n.NodeID))
}
err = common.ValidateNetworkPubKey(n.NetworkPubKey)
if err != nil {
log.Fatal().Err(err).Msg(fmt.Sprintf("invalid network public key: %s", n.NetworkPubKey))
}
err = common.ValidateStakingPubKey(n.StakingPubKey)
if err != nil {
log.Fatal().Err(err).Msg(fmt.Sprintf("invalid staking public key: %s", n.StakingPubKey))
}
// all nodes should have equal weight (this might change in the future)
node := model.NewPublicNodeInfo(
n.NodeID,
n.Role,
n.Address,
flow.DefaultInitialWeight,
n.NetworkPubKey,
n.StakingPubKey,
)
publicInfoNodes = append(publicInfoNodes, node)
}
return publicInfoNodes
}