From eed34e740a6825da947823d2992ef15ad7230aef Mon Sep 17 00:00:00 2001
From: tersec <tersec@users.noreply.github.com>
Date: Tue, 11 Apr 2023 15:27:48 +0000
Subject: [PATCH] implement the getStateRandao Beacon API (#4799)

---
 beacon_chain/rpc/rest_beacon_api.nim       | 47 +++++++++++++++++
 beacon_chain/spec/eth2_apis/rest_types.nim |  3 ++
 ncli/resttest-rules.json                   | 60 ++++++++++++++++++++++
 3 files changed, 110 insertions(+)

diff --git a/beacon_chain/rpc/rest_beacon_api.nim b/beacon_chain/rpc/rest_beacon_api.nim
index 20dee631d..fddd57bfb 100644
--- a/beacon_chain/rpc/rest_beacon_api.nim
+++ b/beacon_chain/rpc/rest_beacon_api.nim
@@ -711,6 +711,53 @@ proc installBeaconApiHandlers*(router: var RestRouter, node: BeaconNode) =
 
     return RestApiResponse.jsonError(Http404, StateNotFoundError)
 
+  # https://ethereum.github.io/beacon-APIs/?urls.primaryName=dev#/Beacon/getStateRandao
+  # https://github.com/ethereum/beacon-APIs/blob/b3c4defa238aaa74bf22aa602aa1b24b68a4c78e/apis/beacon/states/randao.yaml
+  router.api(MethodGet,
+             "/eth/v1/beacon/states/{state_id}/randao") do (
+    state_id: StateIdent, epoch: Option[Epoch]) -> RestApiResponse:
+    let
+      sid = state_id.valueOr:
+        return RestApiResponse.jsonError(Http400, InvalidStateIdValueError,
+                                         $error)
+      bslot = node.getBlockSlotId(sid).valueOr:
+        if sid.kind == StateQueryKind.Root:
+          # TODO (cheatfate): Its impossible to retrieve state by `state_root`
+          # in current version of database.
+          return RestApiResponse.jsonError(Http500, NoImplementationError)
+        return RestApiResponse.jsonError(Http404, StateNotFoundError,
+                                          $error)
+
+    let qepoch =
+      if epoch.isSome():
+        let repoch = epoch.get()
+        if repoch.isErr():
+          return RestApiResponse.jsonError(Http400, InvalidEpochValueError,
+                                           $repoch.error())
+        let res = repoch.get()
+        if res > MaxEpoch:
+          return RestApiResponse.jsonError(Http400, EpochOverflowValueError)
+        if res < node.dag.cfg.ALTAIR_FORK_EPOCH:
+          return RestApiResponse.jsonError(Http400,
+                                           EpochFromTheIncorrectForkError)
+        if res > bslot.slot.epoch() + 1:
+          return RestApiResponse.jsonError(Http400,
+                                           EpochFromFutureError)
+        res
+      else:
+        # If ``epoch`` not present then the RANDAO mix for the epoch of
+        # the state will be obtained.
+        bslot.slot.epoch()
+
+    node.withStateForBlockSlotId(bslot):
+      withState(state):
+        return RestApiResponse.jsonResponseWOpt(
+          RestEpochRandao(randao: get_randao_mix(forkyState.data, qepoch)),
+          node.getStateOptimistic(state)
+        )
+
+    return RestApiResponse.jsonError(Http404, StateNotFoundError)
+
   # https://ethereum.github.io/beacon-APIs/#/Beacon/getBlockHeaders
   router.api(MethodGet, "/eth/v1/beacon/headers") do (
     slot: Option[Slot], parent_root: Option[Eth2Digest]) -> RestApiResponse:
diff --git a/beacon_chain/spec/eth2_apis/rest_types.nim b/beacon_chain/spec/eth2_apis/rest_types.nim
index 55f5605bd..399f09b3b 100644
--- a/beacon_chain/spec/eth2_apis/rest_types.nim
+++ b/beacon_chain/spec/eth2_apis/rest_types.nim
@@ -495,6 +495,9 @@ type
     validators*: seq[ValidatorIndex]
     validator_aggregates*: seq[seq[ValidatorIndex]]
 
+  RestEpochRandao* = object
+    randao*: Eth2Digest
+
   DataEnclosedObject*[T] = object
     data*: T
 
diff --git a/ncli/resttest-rules.json b/ncli/resttest-rules.json
index f7ff9563c..9a549597e 100644
--- a/ncli/resttest-rules.json
+++ b/ncli/resttest-rules.json
@@ -1561,6 +1561,66 @@
       "body": [{"operator": "jstructcmps", "start": ["data"], "value": [{"index": "", "slot": "", "validators": [""]}]}]
     }
   },
+  {
+    "topics": ["beacon", "states_randao_mix"],
+    "request": {
+      "url": "/eth/v1/beacon/states/head/randao",
+      "headers": {"Accept": "application/json"}
+    },
+    "response": {
+      "status": {"operator": "equals", "value": "200"},
+      "headers": [{"key": "Content-Type", "value": "application/json", "operator": "equals"}],
+      "body": [{"operator": "jstructcmps", "start": ["data"], "value": {"randao": ""}}]
+    }
+  },
+  {
+    "topics": ["beacon", "states_randao_mix"],
+    "request": {
+      "url": "/eth/v1/beacon/states/head/randao?epoch=0",
+      "headers": {"Accept": "application/json"}
+    },
+    "response": {
+      "status": {"operator": "equals", "value": "200"},
+      "headers": [{"key": "Content-Type", "value": "application/json", "operator": "equals"}],
+      "body": [{"operator": "jstructcmps", "start": ["data"], "value": {"randao": ""}}]
+    }
+  },
+  {
+    "topics": ["beacon", "states_randao_mix"],
+    "request": {
+      "url": "/eth/v1/beacon/states/head/randao?epoch=576460752303423488",
+      "headers": {"Accept": "application/json"}
+    },
+    "response": {
+      "status": {"operator": "equals", "value": "400"},
+      "headers": [{"key": "Content-Type", "value": "application/json", "operator": "equals"}],
+      "body": [{"operator": "jstructcmpns", "value": {"code": 400, "message": ""}}]
+    }
+  },
+  {
+    "topics": ["beacon", "states_randao_mix"],
+    "request": {
+      "url": "/eth/v1/beacon/states/head/randao?epoch=18446744073709551615",
+      "headers": {"Accept": "application/json"}
+    },
+    "response": {
+      "status": {"operator": "equals", "value": "400"},
+      "headers": [{"key": "Content-Type", "value": "application/json", "operator": "equals"}],
+      "body": [{"operator": "jstructcmpns", "value": {"code": 400, "message": ""}}]
+    }
+  },
+  {
+    "topics": ["beacon", "states_randao_mix"],
+    "request": {
+      "url": "/eth/v1/beacon/states/head/randao?epoch=18446744073709551616",
+      "headers": {"Accept": "application/json"}
+    },
+    "response": {
+      "status": {"operator": "equals", "value": "400"},
+      "headers": [{"key": "Content-Type", "value": "application/json", "operator": "equals"}],
+      "body": [{"operator": "jstructcmpns", "value": {"code": 400, "message": ""}}]
+    }
+  },
   {
     "topics": ["beacon", "beacon_headers"],
     "request": {