-
Notifications
You must be signed in to change notification settings - Fork 175
/
node_info.go
437 lines (385 loc) · 12.4 KB
/
node_info.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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
// Package bootstrap defines canonical models and encoding for bootstrapping.
package bootstrap
import (
"encoding/json"
"fmt"
"strings"
"github.com/onflow/crypto"
"golang.org/x/exp/slices"
sdk "github.com/onflow/flow-go-sdk"
sdkcrypto "github.com/onflow/flow-go-sdk/crypto"
"github.com/onflow/flow-go/model/encodable"
"github.com/onflow/flow-go/model/flow"
)
// NodeInfoType enumerates the two different options for
type NodeInfoType int
const (
NodeInfoTypeInvalid NodeInfoType = iota
NodeInfoTypePublic
NodeInfoTypePrivate
)
const (
DefaultMachineAccountSignAlgo = sdkcrypto.ECDSA_P256
DefaultMachineAccountHashAlgo = sdkcrypto.SHA3_256
DefaultMachineAccountKeyIndex uint = 0
)
// ErrMissingPrivateInfo is returned when a method is called on NodeInfo
// that is only valid on instances containing private info.
var ErrMissingPrivateInfo = fmt.Errorf("can not access private information for a public node type")
// NodeMachineAccountKey contains the private configration need to construct a
// NodeMachineAccountInfo object. This is used as an intemediary by the bootstrap scripts
// for storing the private key before generating a NodeMachineAccountInfo.
type NodeMachineAccountKey struct {
PrivateKey encodable.MachineAccountPrivKey
}
// NodeMachineAccountInfo defines the structure for a bootstrapping file containing
// private information about the node's machine account. The machine account is used
// by the protocol software to interact with Flow as a client autonomously as needed, in
// particular to run the DKG and generate root cluster quorum certificates when preparing
// for an epoch.
type NodeMachineAccountInfo struct {
// Address is the flow address of the machine account, not to be confused
// with the network address of the node.
Address string
// EncodedPrivateKey is the private key of the machine account
EncodedPrivateKey []byte
// KeyIndex is the index of the key in the associated machine account
KeyIndex uint
// SigningAlgorithm is the algorithm used by the machine account along with
// the above private key to create cryptographic signatures
SigningAlgorithm sdkcrypto.SignatureAlgorithm
// HashAlgorithm is the algorithm used for hashing
HashAlgorithm sdkcrypto.HashAlgorithm
}
func (info NodeMachineAccountInfo) FlowAddress() flow.Address {
// trim 0x-prefix if present
addr := info.Address
if strings.ToLower(addr[:2]) == "0x" {
addr = addr[2:]
}
return flow.HexToAddress(addr)
}
func (info NodeMachineAccountInfo) SDKAddress() sdk.Address {
flowAddr := info.FlowAddress()
var sdkAddr sdk.Address
copy(sdkAddr[:], flowAddr[:])
return sdkAddr
}
func (info NodeMachineAccountInfo) PrivateKey() (crypto.PrivateKey, error) {
sk, err := crypto.DecodePrivateKey(info.SigningAlgorithm, info.EncodedPrivateKey)
if err != nil {
return nil, fmt.Errorf("could not decode machine account private key: %w", err)
}
return sk, nil
}
func (info NodeMachineAccountInfo) MustPrivateKey() crypto.PrivateKey {
sk, err := info.PrivateKey()
if err != nil {
panic(err)
}
return sk
}
// NodeConfig contains configuration information used as input to the
// bootstrap process.
type NodeConfig struct {
// Role is the flow role of the node (ex Collection, Consensus, ...)
Role flow.Role
// Address is the networking address of the node (IP:PORT), not to be
// confused with the address of the flow account associated with the node's
// machine account.
Address string
// Weight is the weight of the node
Weight uint64
}
// decodableNodeConfig provides backward-compatible decoding of old models
// which use the Stake field in place of Weight.
type decodableNodeConfig struct {
Role flow.Role
Address string
Weight uint64
// Stake previously was used in place of the Weight field.
Stake uint64
}
func (conf *NodeConfig) UnmarshalJSON(b []byte) error {
var decodable decodableNodeConfig
err := json.Unmarshal(b, &decodable)
if err != nil {
return fmt.Errorf("could not decode json: %w", err)
}
// compat: translate Stake fields to Weight
if decodable.Stake != 0 {
if decodable.Weight != 0 {
return fmt.Errorf("invalid NodeConfig with both Stake and Weight fields")
}
decodable.Weight = decodable.Stake
}
conf.Role = decodable.Role
conf.Address = decodable.Address
conf.Weight = decodable.Weight
return nil
}
// NodeInfoPriv defines the canonical structure for encoding private node info.
type NodeInfoPriv struct {
Role flow.Role
Address string
NodeID flow.Identifier
NetworkPrivKey encodable.NetworkPrivKey
StakingPrivKey encodable.StakingPrivKey
}
// NodeInfoPub defines the canonical structure for encoding public node info.
type NodeInfoPub struct {
Role flow.Role
Address string
NodeID flow.Identifier
Weight uint64
NetworkPubKey encodable.NetworkPubKey
StakingPubKey encodable.StakingPubKey
}
// decodableNodeInfoPub provides backward-compatible decoding of old models
// which use the Stake field in place of Weight.
type decodableNodeInfoPub struct {
Role flow.Role
Address string
NodeID flow.Identifier
Weight uint64
NetworkPubKey encodable.NetworkPubKey
StakingPubKey encodable.StakingPubKey
// Stake previously was used in place of the Weight field.
// Deprecated: supported in decoding for backward-compatibility
Stake uint64
}
func (info *NodeInfoPub) Equals(other *NodeInfoPub) bool {
if other == nil {
return false
}
return info.Address == other.Address &&
info.NodeID == other.NodeID &&
info.Role == other.Role &&
info.Weight == other.Weight &&
info.NetworkPubKey.PublicKey.Equals(other.NetworkPubKey.PublicKey) &&
info.StakingPubKey.PublicKey.Equals(other.StakingPubKey.PublicKey)
}
func (info *NodeInfoPub) UnmarshalJSON(b []byte) error {
var decodable decodableNodeInfoPub
err := json.Unmarshal(b, &decodable)
if err != nil {
return fmt.Errorf("could not decode json: %w", err)
}
// compat: translate Stake fields to Weight
if decodable.Stake != 0 {
if decodable.Weight != 0 {
return fmt.Errorf("invalid NodeInfoPub with both Stake and Weight fields")
}
decodable.Weight = decodable.Stake
}
info.Role = decodable.Role
info.Address = decodable.Address
info.NodeID = decodable.NodeID
info.Weight = decodable.Weight
info.NetworkPubKey = decodable.NetworkPubKey
info.StakingPubKey = decodable.StakingPubKey
return nil
}
// NodePrivateKeys is a wrapper for the private keys for a node, comprising all
// sensitive information for a node.
type NodePrivateKeys struct {
StakingKey crypto.PrivateKey
NetworkKey crypto.PrivateKey
}
// NodeInfo contains information for a node. This is used during the bootstrapping
// process to represent each node. When writing node information to disk, use
// `Public` or `Private` to obtain the appropriate canonical structure.
//
// A NodeInfo instance can contain EITHER public keys OR private keys, not both.
// This can be ensured by using only using the provided constructors and NOT
// manually constructing an instance.
type NodeInfo struct {
// NodeID is the unique identifier of the node in the network
NodeID flow.Identifier
// Role is the flow role of the node (collection, consensus, etc...)
Role flow.Role
// Address is the networking address of the node (IP:PORT), not to be
// confused with the address of the flow account associated with the node's
// machine account.
Address string
// Weight is the weight of the node
Weight uint64
// key information is private
networkPubKey crypto.PublicKey
networkPrivKey crypto.PrivateKey
stakingPubKey crypto.PublicKey
stakingPrivKey crypto.PrivateKey
}
func NewPublicNodeInfo(
nodeID flow.Identifier,
role flow.Role,
addr string,
weight uint64,
networkKey crypto.PublicKey,
stakingKey crypto.PublicKey,
) NodeInfo {
return NodeInfo{
NodeID: nodeID,
Role: role,
Address: addr,
Weight: weight,
networkPubKey: networkKey,
stakingPubKey: stakingKey,
}
}
func NewPrivateNodeInfo(
nodeID flow.Identifier,
role flow.Role,
addr string,
weight uint64,
networkKey crypto.PrivateKey,
stakingKey crypto.PrivateKey,
) NodeInfo {
return NodeInfo{
NodeID: nodeID,
Role: role,
Address: addr,
Weight: weight,
networkPrivKey: networkKey,
stakingPrivKey: stakingKey,
networkPubKey: networkKey.PublicKey(),
stakingPubKey: stakingKey.PublicKey(),
}
}
// Type returns the type of the node info instance.
func (node NodeInfo) Type() NodeInfoType {
if node.networkPrivKey != nil && node.stakingPrivKey != nil {
return NodeInfoTypePrivate
}
if node.networkPubKey != nil && node.stakingPubKey != nil {
return NodeInfoTypePublic
}
return NodeInfoTypeInvalid
}
func (node NodeInfo) NetworkPubKey() crypto.PublicKey {
if node.networkPubKey != nil {
return node.networkPubKey
}
return node.networkPrivKey.PublicKey()
}
func (node NodeInfo) StakingPubKey() crypto.PublicKey {
if node.stakingPubKey != nil {
return node.stakingPubKey
}
return node.stakingPrivKey.PublicKey()
}
func (node NodeInfo) PrivateKeys() (*NodePrivateKeys, error) {
if node.Type() != NodeInfoTypePrivate {
return nil, ErrMissingPrivateInfo
}
return &NodePrivateKeys{
StakingKey: node.stakingPrivKey,
NetworkKey: node.networkPrivKey,
}, nil
}
// Private returns the canonical private encodable structure.
func (node NodeInfo) Private() (NodeInfoPriv, error) {
if node.Type() != NodeInfoTypePrivate {
return NodeInfoPriv{}, ErrMissingPrivateInfo
}
return NodeInfoPriv{
Role: node.Role,
Address: node.Address,
NodeID: node.NodeID,
NetworkPrivKey: encodable.NetworkPrivKey{PrivateKey: node.networkPrivKey},
StakingPrivKey: encodable.StakingPrivKey{PrivateKey: node.stakingPrivKey},
}, nil
}
// Public returns the canonical public encodable structure
func (node NodeInfo) Public() NodeInfoPub {
return NodeInfoPub{
Role: node.Role,
Address: node.Address,
NodeID: node.NodeID,
Weight: node.Weight,
NetworkPubKey: encodable.NetworkPubKey{PublicKey: node.NetworkPubKey()},
StakingPubKey: encodable.StakingPubKey{PublicKey: node.StakingPubKey()},
}
}
// PartnerPublic returns the public data for a partner node.
func (node NodeInfo) PartnerPublic() PartnerNodeInfoPub {
return PartnerNodeInfoPub{
Role: node.Role,
Address: node.Address,
NodeID: node.NodeID,
NetworkPubKey: encodable.NetworkPubKey{PublicKey: node.NetworkPubKey()},
StakingPubKey: encodable.StakingPubKey{PublicKey: node.StakingPubKey()},
}
}
// Identity returns the node info as a public Flow identity.
func (node NodeInfo) Identity() *flow.Identity {
identity := &flow.Identity{
IdentitySkeleton: flow.IdentitySkeleton{
NodeID: node.NodeID,
Address: node.Address,
Role: node.Role,
InitialWeight: node.Weight,
StakingPubKey: node.stakingPubKey,
NetworkPubKey: node.networkPubKey,
},
DynamicIdentity: flow.DynamicIdentity{
EpochParticipationStatus: flow.EpochParticipationStatusActive,
},
}
return identity
}
// NodeInfoFromIdentity converts an identity to a public NodeInfo
func NodeInfoFromIdentity(identity *flow.Identity) NodeInfo {
return NewPublicNodeInfo(
identity.NodeID,
identity.Role,
identity.Address,
identity.InitialWeight,
identity.NetworkPubKey,
identity.StakingPubKey)
}
func PrivateNodeInfoFromIdentity(identity *flow.Identity, networkKey, stakingKey crypto.PrivateKey) NodeInfo {
return NewPrivateNodeInfo(
identity.NodeID,
identity.Role,
identity.Address,
identity.InitialWeight,
networkKey,
stakingKey,
)
}
func FilterByRole(nodes []NodeInfo, role flow.Role) []NodeInfo {
var filtered []NodeInfo
for _, node := range nodes {
if node.Role != role {
continue
}
filtered = append(filtered, node)
}
return filtered
}
// Sort sorts the NodeInfo list using the given ordering.
//
// The sorted list is returned and the original list is untouched.
func Sort(nodes []NodeInfo, order flow.IdentityOrder[flow.Identity]) []NodeInfo {
dup := make([]NodeInfo, len(nodes))
copy(dup, nodes)
slices.SortFunc(dup, func(i, j NodeInfo) int {
return order(i.Identity(), j.Identity())
})
return dup
}
func ToIdentityList(nodes []NodeInfo) flow.IdentityList {
il := make(flow.IdentityList, 0, len(nodes))
for _, node := range nodes {
il = append(il, node.Identity())
}
return il
}
func ToPublicNodeInfoList(nodes []NodeInfo) []NodeInfoPub {
pub := make([]NodeInfoPub, 0, len(nodes))
for _, node := range nodes {
pub = append(pub, node.Public())
}
return pub
}