Fix #3650 (participation format in BeaconState result is out of spec)

status-im · Jun 19, 2022 · 3856dfd · 3856dfd
1 parent c4383e2
commit 3856dfd
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 7 deletions.
diff --git a/AllTests-mainnet.md b/AllTests-mainnet.md
@@ -339,6 +339,11 @@ OK: 12/12 Fail: 0/12 Skip: 0/12
 + vesion 2 single remote                                                                     OK
 ```
 OK: 3/3 Fail: 0/3 Skip: 0/3
+## Serialization/deserialization  [Preset: mainnet]
+```diff
++ Deserialization test vectors                                                               OK
+```
+OK: 1/1 Fail: 0/1 Skip: 0/1
 ## Slashing Interchange tests  [Preset: mainnet]
 ```diff
 + Slashing test: duplicate_pubkey_not_slashable.json                                         OK
@@ -568,4 +573,4 @@ OK: 1/1 Fail: 0/1 Skip: 0/1
 OK: 9/9 Fail: 0/9 Skip: 0/9
 
 ---TOTAL---
-OK: 317/322 Fail: 0/322 Skip: 5/322
+OK: 318/323 Fail: 0/323 Skip: 5/323
diff --git a/beacon_chain/spec/eth2_apis/eth2_rest_serialization.nim b/beacon_chain/spec/eth2_apis/eth2_rest_serialization.nim
@@ -128,8 +128,51 @@ type
     GetPhase0StateSszResponse |
     GetPhase0BlockSszResponse
 
+  AltairBeaconState = altair.BeaconState
+  BellatrixBeaconState = bellatrix.BeaconState
+
 {.push raises: [Defect].}
 
+proc writePreviousEpochParticipation(writer: var JsonWriter[RestJson],
+                                     values: EpochParticipationFlags)
+                                    {.raises: [IOError, Defect].} =
+  for e in writer.stepwiseArrayCreation(values):
+    writer.writeValue $e
+
+proc readPreviousEpochParticipation(
+    reader: var JsonReader[RestJson]): EpochParticipationFlags
+    {.raises: [SerializationError, IOError, Defect].} =
+  # Please note that this function won't compute the cached hash tree roots
+  # immediately. They will be computed on the first HTR attempt.
+
+  for e in reader.readArray(string):
+    let parsed = try:
+      parseBiggestUint(e)
+    except ValueError as err:
+      reader.raiseUnexpectedValue("A string-encoded 8-bit usigned integer value expected")
+
+    if parsed > uint8.high:
+      reader.raiseUnexpectedValue("The usigned integer value should fit in 8 bits")
+
+    if not result.data.add(uint8(parsed)):
+      reader.raiseUnexpectedValue("The participation flags list size exceeds limit")
+
+RestJson.useCustomSerialization(AltairBeaconState.current_epoch_participation):
+  read: readPreviousEpochParticipation(reader)
+  write: writePreviousEpochParticipation(writer, value)
+
+RestJson.useCustomSerialization(BellatrixBeaconState.current_epoch_participation):
+  read: readPreviousEpochParticipation(reader)
+  write: writePreviousEpochParticipation(writer, value)
+
+RestJson.useCustomSerialization(AltairBeaconState.previous_epoch_participation):
+  read: readPreviousEpochParticipation(reader)
+  write: writePreviousEpochParticipation(writer, value)
+
+RestJson.useCustomSerialization(BellatrixBeaconState.previous_epoch_participation):
+  read: readPreviousEpochParticipation(reader)
+  write: writePreviousEpochParticipation(writer, value)
+
 proc prepareJsonResponse*(t: typedesc[RestApiResponse], d: auto): seq[byte] =
   let res =
     block:
@@ -1261,8 +1304,8 @@ proc readValue*(reader: var JsonReader[RestJson],
       reader.raiseUnexpectedValue("Incorrect altair beacon state format")
     toValue(bellatrixData)
 
-proc writeValue*(writer: var JsonWriter[RestJson], value: ForkedHashedBeaconState) {.
-     raises: [IOError, Defect].} =
+proc writeValue*(writer: var JsonWriter[RestJson], value: ForkedHashedBeaconState)
+                {.raises: [IOError, Defect].} =
   writer.beginRecord()
   case value.kind
   of BeaconStateFork.Phase0:

diff --git a/vendor/nim-confutils b/vendor/nim-confutils
diff --git a/vendor/nim-json-serialization b/vendor/nim-json-serialization
diff --git a/vendor/nim-serialization b/vendor/nim-serialization
diff --git a/vendor/nim-toml-serialization b/vendor/nim-toml-serialization
+1 −2		confutils/envvar/writer.nim
+1 −2		confutils/winreg/writer.nim
+1 −1		json_serialization/reader.nim
+13 −1		json_serialization/std/options.nim
+32 −0		json_serialization/stew/results.nim
+26 −9		json_serialization/writer.nim
+32 −2		tests/test_serialization.nim
+0 −4		.github/workflows/ci.yml
+19 −39		README.md
+5 −0		nim.cfg
+23 −12		serialization/object_serialization.nim
+5 −0		tests/nim.cfg
+1 −0		.github/workflows/ci.yml
+3 −1		README.md
+2 −1		tests/test_all.nim
+62 −1		tests/test_decoder.nim
+0 −249		tests/test_lexer.nim
+269 −0		tests/test_lexer_float.nim
+18 −14		tests/test_spec.nim
+26 −1		tests/test_value_ops.nim
+2 −3		toml_serialization.nimble
+27 −13		toml_serialization/lexer.nim
+11 −2		toml_serialization/reader.nim
+79 −7		toml_serialization/types.nim
+3 −3		toml_serialization/writer.nim