-
Notifications
You must be signed in to change notification settings - Fork 665
/
metadata_validator.go
267 lines (234 loc) · 7.41 KB
/
metadata_validator.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
// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package state
import (
"time"
"github.com/ava-labs/avalanchego/codec"
"github.com/ava-labs/avalanchego/database"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/utils/constants"
"github.com/ava-labs/avalanchego/utils/set"
"github.com/ava-labs/avalanchego/utils/wrappers"
)
// preDelegateeRewardSize is the size of codec marshalling
// [preDelegateeRewardMetadata].
//
// CodecVersionLen + UpDurationLen + LastUpdatedLen + PotentialRewardLen
const preDelegateeRewardSize = codec.VersionSize + 3*wrappers.LongLen
var _ validatorState = (*metadata)(nil)
type preDelegateeRewardMetadata struct {
UpDuration time.Duration `v0:"true"`
LastUpdated uint64 `v0:"true"` // Unix time in seconds
PotentialReward uint64 `v0:"true"`
}
type validatorMetadata struct {
UpDuration time.Duration `v0:"true"`
LastUpdated uint64 `v0:"true"` // Unix time in seconds
PotentialReward uint64 `v0:"true"`
PotentialDelegateeReward uint64 `v0:"true"`
StakerStartTime uint64 ` v1:"true"`
txID ids.ID
lastUpdated time.Time
}
// Permissioned validators originally wrote their values as nil.
// With Banff we wrote the potential reward.
// With Cortina we wrote the potential reward with the potential delegatee reward.
// We now write the uptime, reward, and delegatee reward together.
func parseValidatorMetadata(bytes []byte, metadata *validatorMetadata) error {
switch len(bytes) {
case 0:
// nothing was stored
case database.Uint64Size:
// only potential reward was stored
var err error
metadata.PotentialReward, err = database.ParseUInt64(bytes)
if err != nil {
return err
}
case preDelegateeRewardSize:
// potential reward and uptime was stored but potential delegatee reward
// was not
tmp := preDelegateeRewardMetadata{}
if _, err := MetadataCodec.Unmarshal(bytes, &tmp); err != nil {
return err
}
metadata.UpDuration = tmp.UpDuration
metadata.LastUpdated = tmp.LastUpdated
metadata.PotentialReward = tmp.PotentialReward
default:
// everything was stored
if _, err := MetadataCodec.Unmarshal(bytes, metadata); err != nil {
return err
}
}
metadata.lastUpdated = time.Unix(int64(metadata.LastUpdated), 0)
return nil
}
type validatorState interface {
// LoadValidatorMetadata sets the [metadata] of [vdrID] on [subnetID].
// GetUptime and SetUptime will return an error if the [vdrID] and
// [subnetID] hasn't been loaded. This call will not result in a write to
// disk.
LoadValidatorMetadata(
vdrID ids.NodeID,
subnetID ids.ID,
metadata *validatorMetadata,
)
// GetUptime returns the current uptime measurements of [vdrID] on
// [subnetID].
GetUptime(
vdrID ids.NodeID,
subnetID ids.ID,
) (upDuration time.Duration, lastUpdated time.Time, err error)
// SetUptime updates the uptime measurements of [vdrID] on [subnetID].
// Unless these measurements are deleted first, the next call to
// WriteUptimes will write this update to disk.
SetUptime(
vdrID ids.NodeID,
subnetID ids.ID,
upDuration time.Duration,
lastUpdated time.Time,
) error
// GetDelegateeReward returns the current rewards accrued to [vdrID] on
// [subnetID].
GetDelegateeReward(
subnetID ids.ID,
vdrID ids.NodeID,
) (amount uint64, err error)
// SetDelegateeReward updates the rewards accrued to [vdrID] on [subnetID].
// Unless these measurements are deleted first, the next call to
// WriteUptimes will write this update to disk.
SetDelegateeReward(
subnetID ids.ID,
vdrID ids.NodeID,
amount uint64,
) error
// DeleteValidatorMetadata removes in-memory references to the metadata of
// [vdrID] on [subnetID]. If there were staged updates from a prior call to
// SetUptime or SetDelegateeReward, the updates will be dropped. This call
// will not result in a write to disk.
DeleteValidatorMetadata(vdrID ids.NodeID, subnetID ids.ID)
// WriteValidatorMetadata writes all staged updates from prior calls to
// SetUptime or SetDelegateeReward.
WriteValidatorMetadata(
dbPrimary database.KeyValueWriter,
dbSubnet database.KeyValueWriter,
codecVersion uint16,
) error
}
type metadata struct {
metadata map[ids.NodeID]map[ids.ID]*validatorMetadata // vdrID -> subnetID -> metadata
// updatedMetadata tracks the updates since WriteValidatorMetadata was last called
updatedMetadata map[ids.NodeID]set.Set[ids.ID] // vdrID -> subnetIDs
}
func newValidatorState() validatorState {
return &metadata{
metadata: make(map[ids.NodeID]map[ids.ID]*validatorMetadata),
updatedMetadata: make(map[ids.NodeID]set.Set[ids.ID]),
}
}
func (m *metadata) LoadValidatorMetadata(
vdrID ids.NodeID,
subnetID ids.ID,
uptime *validatorMetadata,
) {
subnetMetadata, ok := m.metadata[vdrID]
if !ok {
subnetMetadata = make(map[ids.ID]*validatorMetadata)
m.metadata[vdrID] = subnetMetadata
}
subnetMetadata[subnetID] = uptime
}
func (m *metadata) GetUptime(
vdrID ids.NodeID,
subnetID ids.ID,
) (time.Duration, time.Time, error) {
metadata, exists := m.metadata[vdrID][subnetID]
if !exists {
return 0, time.Time{}, database.ErrNotFound
}
return metadata.UpDuration, metadata.lastUpdated, nil
}
func (m *metadata) SetUptime(
vdrID ids.NodeID,
subnetID ids.ID,
upDuration time.Duration,
lastUpdated time.Time,
) error {
metadata, exists := m.metadata[vdrID][subnetID]
if !exists {
return database.ErrNotFound
}
metadata.UpDuration = upDuration
metadata.lastUpdated = lastUpdated
m.addUpdatedMetadata(vdrID, subnetID)
return nil
}
func (m *metadata) GetDelegateeReward(
subnetID ids.ID,
vdrID ids.NodeID,
) (uint64, error) {
metadata, exists := m.metadata[vdrID][subnetID]
if !exists {
return 0, database.ErrNotFound
}
return metadata.PotentialDelegateeReward, nil
}
func (m *metadata) SetDelegateeReward(
subnetID ids.ID,
vdrID ids.NodeID,
amount uint64,
) error {
metadata, exists := m.metadata[vdrID][subnetID]
if !exists {
return database.ErrNotFound
}
metadata.PotentialDelegateeReward = amount
m.addUpdatedMetadata(vdrID, subnetID)
return nil
}
func (m *metadata) DeleteValidatorMetadata(vdrID ids.NodeID, subnetID ids.ID) {
subnetMetadata := m.metadata[vdrID]
delete(subnetMetadata, subnetID)
if len(subnetMetadata) == 0 {
delete(m.metadata, vdrID)
}
subnetUpdatedMetadata := m.updatedMetadata[vdrID]
subnetUpdatedMetadata.Remove(subnetID)
if subnetUpdatedMetadata.Len() == 0 {
delete(m.updatedMetadata, vdrID)
}
}
func (m *metadata) WriteValidatorMetadata(
dbPrimary database.KeyValueWriter,
dbSubnet database.KeyValueWriter,
codecVersion uint16,
) error {
for vdrID, updatedSubnets := range m.updatedMetadata {
for subnetID := range updatedSubnets {
metadata := m.metadata[vdrID][subnetID]
metadata.LastUpdated = uint64(metadata.lastUpdated.Unix())
metadataBytes, err := MetadataCodec.Marshal(codecVersion, metadata)
if err != nil {
return err
}
db := dbSubnet
if subnetID == constants.PrimaryNetworkID {
db = dbPrimary
}
if err := db.Put(metadata.txID[:], metadataBytes); err != nil {
return err
}
}
delete(m.updatedMetadata, vdrID)
}
return nil
}
func (m *metadata) addUpdatedMetadata(vdrID ids.NodeID, subnetID ids.ID) {
updatedSubnetMetadata, ok := m.updatedMetadata[vdrID]
if !ok {
updatedSubnetMetadata = set.Set[ids.ID]{}
m.updatedMetadata[vdrID] = updatedSubnetMetadata
}
updatedSubnetMetadata.Add(subnetID)
}