-
Notifications
You must be signed in to change notification settings - Fork 63
/
beaconstate.go
486 lines (468 loc) · 20.3 KB
/
beaconstate.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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
// Copyright © 2021 Attestant Limited.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package altair
import (
"bytes"
"encoding/hex"
"encoding/json"
"fmt"
"strconv"
"strings"
"github.com/attestantio/go-eth2-client/spec/phase0"
"github.com/goccy/go-yaml"
"github.com/pkg/errors"
bitfield "github.com/prysmaticlabs/go-bitfield"
)
// BeaconState represents a beacon state.
type BeaconState struct {
GenesisTime uint64
GenesisValidatorsRoot phase0.Root `ssz-size:"32"`
Slot phase0.Slot
Fork *phase0.Fork
LatestBlockHeader *phase0.BeaconBlockHeader
BlockRoots []phase0.Root `dynssz-size:"SLOTS_PER_HISTORICAL_ROOT,32" ssz-size:"8192,32"`
StateRoots []phase0.Root `dynssz-size:"SLOTS_PER_HISTORICAL_ROOT,32" ssz-size:"8192,32"`
HistoricalRoots []phase0.Root `ssz-max:"16777216" ssz-size:"?,32"`
ETH1Data *phase0.ETH1Data
ETH1DataVotes []*phase0.ETH1Data `ssz-max:"2048"`
ETH1DepositIndex uint64
Validators []*phase0.Validator `ssz-max:"1099511627776"`
Balances []phase0.Gwei `ssz-max:"1099511627776"`
RANDAOMixes []phase0.Root `dynssz-size:"EPOCHS_PER_HISTORICAL_VECTOR,32" ssz-size:"65536,32"`
Slashings []phase0.Gwei `dynssz-size:"EPOCHS_PER_SLASHINGS_VECTOR" ssz-size:"8192"`
PreviousEpochParticipation []ParticipationFlags `ssz-max:"1099511627776"`
CurrentEpochParticipation []ParticipationFlags `ssz-max:"1099511627776"`
JustificationBits bitfield.Bitvector4 `ssz-size:"1"`
PreviousJustifiedCheckpoint *phase0.Checkpoint
CurrentJustifiedCheckpoint *phase0.Checkpoint
FinalizedCheckpoint *phase0.Checkpoint
InactivityScores []uint64 `ssz-max:"1099511627776"`
CurrentSyncCommittee *SyncCommittee
NextSyncCommittee *SyncCommittee
}
// beaconStateJSON is the spec representation of the struct.
type beaconStateJSON struct {
GenesisTime string `json:"genesis_time"`
GenesisValidatorsRoot string `json:"genesis_validators_root"`
Slot string `json:"slot"`
Fork *phase0.Fork `json:"fork"`
LatestBlockHeader *phase0.BeaconBlockHeader `json:"latest_block_header"`
BlockRoots []string `json:"block_roots"`
StateRoots []string `json:"state_roots"`
HistoricalRoots []string `json:"historical_roots"`
ETH1Data *phase0.ETH1Data `json:"eth1_data"`
ETH1DataVotes []*phase0.ETH1Data `json:"eth1_data_votes"`
ETH1DepositIndex string `json:"eth1_deposit_index"`
Validators []*phase0.Validator `json:"validators"`
Balances []string `json:"balances"`
RANDAOMixes []string `json:"randao_mixes"`
Slashings []string `json:"slashings"`
PreviousEpochParticipation []string `json:"previous_epoch_participation"`
CurrentEpochParticipation []string `json:"current_epoch_participation"`
JustificationBits string `json:"justification_bits"`
PreviousJustifiedCheckpoint *phase0.Checkpoint `json:"previous_justified_checkpoint"`
CurrentJustifiedCheckpoint *phase0.Checkpoint `json:"current_justified_checkpoint"`
FinalizedCheckpoint *phase0.Checkpoint `json:"finalized_checkpoint"`
InactivityScores []string `json:"inactivity_scores"`
CurrentSyncCommittee *SyncCommittee `json:"current_sync_committee"`
NextSyncCommittee *SyncCommittee `json:"next_sync_committee"`
}
// beaconStateYAML is the spec representation of the struct.
type beaconStateYAML struct {
GenesisTime uint64 `json:"genesis_time"`
GenesisValidatorsRoot string `json:"genesis_validators_root"`
Slot uint64 `json:"slot"`
Fork *phase0.Fork `json:"fork"`
LatestBlockHeader *phase0.BeaconBlockHeader `json:"latest_block_header"`
BlockRoots []string `json:"block_roots"`
StateRoots []string `json:"state_roots"`
HistoricalRoots []string `json:"historical_roots"`
ETH1Data *phase0.ETH1Data `json:"eth1_data"`
ETH1DataVotes []*phase0.ETH1Data `json:"eth1_data_votes"`
ETH1DepositIndex uint64 `json:"eth1_deposit_index"`
Validators []*phase0.Validator `json:"validators"`
Balances []uint64 `json:"balances"`
RANDAOMixes []string `json:"randao_mixes"`
Slashings []uint64 `json:"slashings"`
PreviousEpochParticipation []uint8 `json:"previous_epoch_participation"`
CurrentEpochParticipation []uint8 `json:"current_epoch_participation"`
JustificationBits string `json:"justification_bits"`
PreviousJustifiedCheckpoint *phase0.Checkpoint `json:"previous_justified_checkpoint"`
CurrentJustifiedCheckpoint *phase0.Checkpoint `json:"current_justified_checkpoint"`
FinalizedCheckpoint *phase0.Checkpoint `json:"finalized_checkpoint"`
InactivityScores []uint64 `json:"inactivity_scores"`
CurrentSyncCommittee *SyncCommittee `json:"current_sync_committee"`
NextSyncCommittee *SyncCommittee `json:"next_sync_committee"`
}
// MarshalJSON implements json.Marshaler.
func (s *BeaconState) MarshalJSON() ([]byte, error) {
blockRoots := make([]string, len(s.BlockRoots))
for i := range s.BlockRoots {
blockRoots[i] = fmt.Sprintf("%#x", s.BlockRoots[i])
}
stateRoots := make([]string, len(s.StateRoots))
for i := range s.StateRoots {
stateRoots[i] = fmt.Sprintf("%#x", s.StateRoots[i])
}
historicalRoots := make([]string, len(s.HistoricalRoots))
for i := range s.HistoricalRoots {
historicalRoots[i] = fmt.Sprintf("%#x", s.HistoricalRoots[i])
}
balances := make([]string, len(s.Balances))
for i := range s.Balances {
balances[i] = fmt.Sprintf("%d", s.Balances[i])
}
randaoMixes := make([]string, len(s.RANDAOMixes))
for i := range s.RANDAOMixes {
randaoMixes[i] = fmt.Sprintf("%#x", s.RANDAOMixes[i])
}
slashings := make([]string, len(s.Slashings))
for i := range s.Slashings {
slashings[i] = fmt.Sprintf("%d", s.Slashings[i])
}
previousEpochParticipation := make([]string, len(s.PreviousEpochParticipation))
for i := range s.PreviousEpochParticipation {
previousEpochParticipation[i] = fmt.Sprintf("%d", s.PreviousEpochParticipation[i])
}
currentEpochParticipation := make([]string, len(s.CurrentEpochParticipation))
for i := range s.CurrentEpochParticipation {
currentEpochParticipation[i] = fmt.Sprintf("%d", s.CurrentEpochParticipation[i])
}
inactivityScores := make([]string, len(s.InactivityScores))
for i := range s.InactivityScores {
inactivityScores[i] = strconv.FormatUint(s.InactivityScores[i], 10)
}
return json.Marshal(&beaconStateJSON{
GenesisTime: strconv.FormatUint(s.GenesisTime, 10),
GenesisValidatorsRoot: fmt.Sprintf("%#x", s.GenesisValidatorsRoot),
Slot: fmt.Sprintf("%d", s.Slot),
Fork: s.Fork,
LatestBlockHeader: s.LatestBlockHeader,
BlockRoots: blockRoots,
StateRoots: stateRoots,
HistoricalRoots: historicalRoots,
ETH1Data: s.ETH1Data,
ETH1DataVotes: s.ETH1DataVotes,
ETH1DepositIndex: strconv.FormatUint(s.ETH1DepositIndex, 10),
Validators: s.Validators,
Balances: balances,
RANDAOMixes: randaoMixes,
Slashings: slashings,
PreviousEpochParticipation: previousEpochParticipation,
CurrentEpochParticipation: currentEpochParticipation,
JustificationBits: fmt.Sprintf("%#x", s.JustificationBits.Bytes()),
PreviousJustifiedCheckpoint: s.PreviousJustifiedCheckpoint,
CurrentJustifiedCheckpoint: s.CurrentJustifiedCheckpoint,
FinalizedCheckpoint: s.FinalizedCheckpoint,
InactivityScores: inactivityScores,
CurrentSyncCommittee: s.CurrentSyncCommittee,
NextSyncCommittee: s.NextSyncCommittee,
})
}
// UnmarshalJSON implements json.Unmarshaler.
func (s *BeaconState) UnmarshalJSON(input []byte) error {
var data beaconStateJSON
if err := json.Unmarshal(input, &data); err != nil {
return errors.Wrap(err, "invalid JSON")
}
return s.unpack(&data)
}
// unpack unpacks JSON data in to a spec representation.
//
//nolint:gocyclo
func (s *BeaconState) unpack(data *beaconStateJSON) error {
if data.GenesisTime == "" {
return errors.New("genesis time missing")
}
genesisTime, err := strconv.ParseUint(data.GenesisTime, 10, 64)
if err != nil {
return errors.Wrap(err, "invalid value for genesis time")
}
s.GenesisTime = genesisTime
if data.GenesisValidatorsRoot == "" {
return errors.New("genesis validators root missing")
}
genesisValidatorsRoot, err := hex.DecodeString(strings.TrimPrefix(data.GenesisValidatorsRoot, "0x"))
if err != nil {
return errors.Wrap(err, "invalid value for genesis validators root")
}
if len(genesisValidatorsRoot) != phase0.RootLength {
return fmt.Errorf("incorrect length %d for genesis validators root", len(genesisValidatorsRoot))
}
copy(s.GenesisValidatorsRoot[:], genesisValidatorsRoot)
if data.Slot == "" {
return errors.New("slot missing")
}
slot, err := strconv.ParseUint(data.Slot, 10, 64)
if err != nil {
return errors.Wrap(err, "invalid value for slot")
}
s.Slot = phase0.Slot(slot)
if data.Fork == nil {
return errors.New("fork missing")
}
s.Fork = data.Fork
if data.LatestBlockHeader == nil {
return errors.New("latest block header missing")
}
s.LatestBlockHeader = data.LatestBlockHeader
if len(data.BlockRoots) == 0 {
return errors.New("block roots missing")
}
s.BlockRoots = make([]phase0.Root, len(data.BlockRoots))
for i := range data.BlockRoots {
if data.BlockRoots[i] == "" {
return fmt.Errorf("block root %d missing", i)
}
blockRoot, err := hex.DecodeString(strings.TrimPrefix(data.BlockRoots[i], "0x"))
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for block root %d", i))
}
if len(blockRoot) != phase0.RootLength {
return fmt.Errorf("incorrect length %d for block root %d", len(blockRoot), i)
}
copy(s.BlockRoots[i][:], blockRoot)
}
s.StateRoots = make([]phase0.Root, len(data.StateRoots))
for i := range data.StateRoots {
if data.StateRoots[i] == "" {
return fmt.Errorf("state root %d missing", i)
}
stateRoot, err := hex.DecodeString(strings.TrimPrefix(data.StateRoots[i], "0x"))
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for state root %d", i))
}
if len(stateRoot) != phase0.RootLength {
return fmt.Errorf("incorrect length %d for state root %d", len(stateRoot), i)
}
copy(s.StateRoots[i][:], stateRoot)
}
s.HistoricalRoots = make([]phase0.Root, len(data.HistoricalRoots))
for i := range data.HistoricalRoots {
if data.HistoricalRoots[i] == "" {
return fmt.Errorf("historical root %d missing", i)
}
historicalRoot, err := hex.DecodeString(strings.TrimPrefix(data.HistoricalRoots[i], "0x"))
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for historical root %d", i))
}
if len(historicalRoot) != phase0.RootLength {
return fmt.Errorf("incorrect length %d for historical root %d", len(historicalRoot), i)
}
copy(s.HistoricalRoots[i][:], historicalRoot)
}
if data.ETH1Data == nil {
return errors.New("eth1 data missing")
}
s.ETH1Data = data.ETH1Data
// ETH1DataVotes can be empty, but if present the individual votes must not be null.
if data.ETH1DataVotes != nil {
for i := range data.Validators {
if data.Validators[i] == nil {
return fmt.Errorf("validators entry %d missing", i)
}
}
}
s.ETH1DataVotes = data.ETH1DataVotes
if data.Validators == nil {
return errors.New("validators missing")
}
for i := range data.Validators {
if data.Validators[i] == nil {
return fmt.Errorf("validators entry %d missing", i)
}
}
s.Validators = data.Validators
if data.ETH1DepositIndex == "" {
return errors.New("eth1 deposit index missing")
}
if s.ETH1DepositIndex, err = strconv.ParseUint(data.ETH1DepositIndex, 10, 64); err != nil {
return errors.Wrap(err, "invalid value for eth1 deposit index")
}
s.Balances = make([]phase0.Gwei, len(data.Balances))
for i := range data.Balances {
if data.Balances[i] == "" {
return fmt.Errorf("balance %d missing", i)
}
balance, err := strconv.ParseUint(data.Balances[i], 10, 64)
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for balance %d", i))
}
s.Balances[i] = phase0.Gwei(balance)
}
s.RANDAOMixes = make([]phase0.Root, len(data.RANDAOMixes))
for i := range data.RANDAOMixes {
if data.RANDAOMixes[i] == "" {
return fmt.Errorf("RANDAO mix %d missing", i)
}
randaoMix, err := hex.DecodeString(strings.TrimPrefix(data.RANDAOMixes[i], "0x"))
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for RANDAO mix %d", i))
}
if len(randaoMix) != phase0.RootLength {
return fmt.Errorf("incorrect length %d for RANDAO mix %d", len(randaoMix), i)
}
copy(s.RANDAOMixes[i][:], randaoMix)
}
s.Slashings = make([]phase0.Gwei, len(data.Slashings))
for i := range data.Slashings {
if data.Slashings[i] == "" {
return fmt.Errorf("slashing %d missing", i)
}
slashings, err := strconv.ParseUint(data.Slashings[i], 10, 64)
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for slashing %d", i))
}
s.Slashings[i] = phase0.Gwei(slashings)
}
s.PreviousEpochParticipation = make([]ParticipationFlags, len(data.PreviousEpochParticipation))
for i := range data.PreviousEpochParticipation {
if data.PreviousEpochParticipation[i] == "" {
return fmt.Errorf("previous epoch attestation %d missing", i)
}
previousEpochAttestation, err := strconv.ParseUint(data.PreviousEpochParticipation[i], 10, 8)
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for previous epoch attestation %d", i))
}
s.PreviousEpochParticipation[i] = ParticipationFlags(previousEpochAttestation)
}
s.CurrentEpochParticipation = make([]ParticipationFlags, len(data.CurrentEpochParticipation))
for i := range data.CurrentEpochParticipation {
if data.CurrentEpochParticipation[i] == "" {
return fmt.Errorf("current epoch attestation %d missing", i)
}
currentEpochAttestation, err := strconv.ParseUint(data.CurrentEpochParticipation[i], 10, 8)
if err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for current epoch attestation %d", i))
}
s.CurrentEpochParticipation[i] = ParticipationFlags(currentEpochAttestation)
}
if data.JustificationBits == "" {
return errors.New("justification bits missing")
}
if s.JustificationBits, err = hex.DecodeString(strings.TrimPrefix(data.JustificationBits, "0x")); err != nil {
return errors.Wrap(err, "invalid value for justification bits")
}
if data.PreviousJustifiedCheckpoint == nil {
return errors.New("previous justified checkpoint missing")
}
s.PreviousJustifiedCheckpoint = data.PreviousJustifiedCheckpoint
if data.CurrentJustifiedCheckpoint == nil {
return errors.New("current justified checkpoint missing")
}
s.CurrentJustifiedCheckpoint = data.CurrentJustifiedCheckpoint
if data.FinalizedCheckpoint == nil {
return errors.New("finalized checkpoint missing")
}
s.FinalizedCheckpoint = data.FinalizedCheckpoint
s.InactivityScores = make([]uint64, len(data.InactivityScores))
for i := range data.InactivityScores {
if data.InactivityScores[i] == "" {
return fmt.Errorf("inactivity score %d missing", i)
}
if s.InactivityScores[i], err = strconv.ParseUint(data.InactivityScores[i], 10, 64); err != nil {
return errors.Wrap(err, fmt.Sprintf("invalid value for inactivity score %d", i))
}
}
if data.CurrentSyncCommittee == nil {
return errors.New("current sync committee missing")
}
s.CurrentSyncCommittee = data.CurrentSyncCommittee
if data.NextSyncCommittee == nil {
return errors.New("next sync committee missing")
}
s.NextSyncCommittee = data.NextSyncCommittee
return nil
}
// MarshalYAML implements yaml.Marshaler.
func (s *BeaconState) MarshalYAML() ([]byte, error) {
blockRoots := make([]string, len(s.BlockRoots))
for i := range s.BlockRoots {
blockRoots[i] = fmt.Sprintf("%#x", s.BlockRoots[i])
}
stateRoots := make([]string, len(s.StateRoots))
for i := range s.StateRoots {
stateRoots[i] = fmt.Sprintf("%#x", s.StateRoots[i])
}
historicalRoots := make([]string, len(s.HistoricalRoots))
for i := range s.HistoricalRoots {
historicalRoots[i] = fmt.Sprintf("%#x", s.HistoricalRoots[i])
}
balances := make([]uint64, len(s.Balances))
for i := range s.Balances {
balances[i] = uint64(s.Balances[i])
}
randaoMixes := make([]string, len(s.RANDAOMixes))
for i := range s.RANDAOMixes {
randaoMixes[i] = fmt.Sprintf("%#x", s.RANDAOMixes[i])
}
slashings := make([]uint64, len(s.Slashings))
for i := range s.Slashings {
slashings[i] = uint64(s.Slashings[i])
}
previousEpochParticipation := make([]uint8, len(s.PreviousEpochParticipation))
for i := range s.PreviousEpochParticipation {
previousEpochParticipation[i] = uint8(s.PreviousEpochParticipation[i])
}
currentEpochParticipation := make([]uint8, len(s.CurrentEpochParticipation))
for i := range s.CurrentEpochParticipation {
currentEpochParticipation[i] = uint8(s.CurrentEpochParticipation[i])
}
yamlBytes, err := yaml.MarshalWithOptions(&beaconStateYAML{
GenesisTime: s.GenesisTime,
GenesisValidatorsRoot: fmt.Sprintf("%#x", s.GenesisValidatorsRoot),
Slot: uint64(s.Slot),
Fork: s.Fork,
LatestBlockHeader: s.LatestBlockHeader,
BlockRoots: blockRoots,
StateRoots: stateRoots,
HistoricalRoots: historicalRoots,
ETH1Data: s.ETH1Data,
ETH1DataVotes: s.ETH1DataVotes,
ETH1DepositIndex: s.ETH1DepositIndex,
Validators: s.Validators,
Balances: balances,
RANDAOMixes: randaoMixes,
Slashings: slashings,
PreviousEpochParticipation: previousEpochParticipation,
CurrentEpochParticipation: currentEpochParticipation,
JustificationBits: fmt.Sprintf("%#x", s.JustificationBits.Bytes()),
PreviousJustifiedCheckpoint: s.PreviousJustifiedCheckpoint,
CurrentJustifiedCheckpoint: s.CurrentJustifiedCheckpoint,
FinalizedCheckpoint: s.FinalizedCheckpoint,
InactivityScores: s.InactivityScores,
CurrentSyncCommittee: s.CurrentSyncCommittee,
NextSyncCommittee: s.NextSyncCommittee,
}, yaml.Flow(true))
if err != nil {
return nil, err
}
return bytes.ReplaceAll(yamlBytes, []byte(`"`), []byte(`'`)), nil
}
// UnmarshalYAML implements yaml.Unmarshaler.
func (s *BeaconState) UnmarshalYAML(input []byte) error {
// We unmarshal to the JSON struct to save on duplicate code.
var data beaconStateJSON
if err := yaml.Unmarshal(input, &data); err != nil {
return err
}
return s.unpack(&data)
}
// String returns a string version of the structure.
func (s *BeaconState) String() string {
data, err := yaml.Marshal(s)
if err != nil {
return fmt.Sprintf("ERR: %v", err)
}
return string(data)
}