Adding portal_HistoryRoutingTable and tests (#148)

Author: meldsun0

README.md

@@ -125,7 +125,7 @@ View logs output and results:
 ```shell script
 ./hiveview --serve --logdir ./workspace/logs
 ```
-## [JSON-RPC API (20)](https://samba-portal-node.postman.co/workspace/Samba-Portal-Node-Workspace~8bf54719-5e6d-4476-8b33-6434dc57d833/request/33150235-eb63c4bf-82ff-477e-a17d-616657e9cdbc?action=share&creator=33150235&ctx=documentation&active-environment=33150235-5c222146-bd60-431b-bb15-f3f9dc8fc9cc)
+## [JSON-RPC API (23)](https://samba-portal-node.postman.co/workspace/Samba-Portal-Node-Workspace~8bf54719-5e6d-4476-8b33-6434dc57d833/request/33150235-eb63c4bf-82ff-477e-a17d-616657e9cdbc?action=share&creator=33150235&ctx=documentation&active-environment=33150235-5c222146-bd60-431b-bb15-f3f9dc8fc9cc)
 
 #### History
 - portal_historyAddEnr
@@ -140,6 +140,7 @@ View logs output and results:
 - portal_historyPing
 - portal_historyStore
 - portal_historyPutContent
+- portal_historyRoutingTableInfo
 
 #### Discv5
 - discv5_getEnr,

core/src/main/java/samba/api/HistoryAPI.java

@@ -48,6 +48,8 @@ Optional<Bytes> offer(
 
   Optional<RecursiveFindNodesResult> recursiveFindNodes(final String nodeId);
 
+  Optional<List<List<String>>> getRoutingTable();
+
   // For Besu
 
   Optional<BlockHeader> getBlockHeaderByBlockHash(Hash blockHash);

core/src/main/java/samba/api/HistoryAPIClient.java

@@ -93,6 +93,11 @@ public Optional<RecursiveFindNodesResult> recursiveFindNodes(String nodeId) {
     return RecursiveFindNodes.execute(this.historyNetworkInternalAPI, nodeId);
   }
 
+  @Override
+  public Optional<List<List<String>>> getRoutingTable() {
+    return GetRoutingTable.execute(this.historyNetworkInternalAPI);
+  }
+
   @Override
   public Optional<BlockHeader> getBlockHeaderByBlockHash(Hash blockHash) {
     return GetBlockHeaderByBlockHash.execute(this.historyNetworkInternalAPI, blockHash);

core/src/main/java/samba/api/jsonrpc/PortalHistoryRoutingTableInfo.java

@@ -0,0 +1,45 @@
+package samba.api.jsonrpc;
+
+import samba.api.Discv5API;
+import samba.api.HistoryAPI;
+import samba.api.jsonrpc.results.RoutingTableInfoResult;
+import samba.jsonrpc.config.RpcMethod;
+import samba.jsonrpc.reponse.JsonRpcMethod;
+import samba.jsonrpc.reponse.JsonRpcRequestContext;
+import samba.jsonrpc.reponse.JsonRpcResponse;
+import samba.jsonrpc.reponse.RpcErrorType;
+
+public class PortalHistoryRoutingTableInfo implements JsonRpcMethod {
+
+  private final HistoryAPI historyAPI;
+  private final Discv5API discv5API;
+
+  public PortalHistoryRoutingTableInfo(final HistoryAPI historyAPI, final Discv5API discv5API) {
+    this.historyAPI = historyAPI;
+    this.discv5API = discv5API;
+  }
+
+  @Override
+  public String getName() {
+    return RpcMethod.PORTAL_HISTORY_ROUTING_TABLE_INFO.getMethodName();
+  }
+
+  @Override
+  public JsonRpcResponse response(JsonRpcRequestContext requestContext) {
+    return this.discv5API
+        .getNodeInfo()
+        .flatMap(
+            info ->
+                this.historyAPI
+                    .getRoutingTable()
+                    .map(
+                        table -> {
+                          RoutingTableInfoResult result =
+                              new RoutingTableInfoResult(info.getNodeId(), table);
+                          return createSuccessResponse(requestContext, result);
+                        }))
+        .orElseGet(
+            () ->
+                createJsonRpcInvalidRequestResponse(requestContext, RpcErrorType.INVALID_REQUEST));
+  }
+}

core/src/main/java/samba/domain/dht/NodeTable.java

@@ -3,6 +3,7 @@
 import java.time.Clock;
 import java.util.Comparator;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Spliterator;
@@ -95,4 +96,8 @@ private Optional<KBucket> getBucket(final int distance) {
   public boolean isNodeIgnored(NodeRecord nodeRecord) {
     return this.livenessManager.isABadPeer(nodeRecord);
   }
+
+  public List<List<NodeRecord>> getNodeRecordBuckets() {
+    return this.buckets.values().stream().map(KBucket::getAllNodes).toList();
+  }
 }

core/src/main/java/samba/network/history/HistoryNetwork.java

@@ -816,6 +816,11 @@ public Optional<TraceGetContentResult> traceGetContent(
     }
   }
 
+  @Override
+  public List<List<NodeRecord>> getRoutingTable() {
+    return this.routingTable.getNodeRecordBuckets();
+  }
+
   @Override
   public Optional<RecursiveFindNodesResult> recursiveFindNodes(
       final String nodeId, Set<NodeRecord> excludedNodes, final int timeout) {

core/src/main/java/samba/network/history/api/HistoryNetworkInternalAPI.java

@@ -61,4 +61,6 @@ Optional<RecursiveFindNodesResult> recursiveFindNodes(
 
   Optional<TraceGetContentResult> traceGetContent(
       ContentKey contentKey, int timeout, long startTime);
+
+  List<List<NodeRecord>> getRoutingTable();
 }

core/src/main/java/samba/network/history/api/methods/GetRoutingTable.java

@@ -0,0 +1,49 @@
+package samba.network.history.api.methods;
+
+import samba.network.history.api.HistoryNetworkInternalAPI;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.apache.tuweni.bytes.Bytes;
+import org.ethereum.beacon.discovery.schema.NodeRecord;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class GetRoutingTable {
+
+  private static final Logger LOG = LoggerFactory.getLogger(GetRoutingTable.class);
+  public static final int MAX_ROUTING_TABLE_SIZE = 16;
+
+  private final HistoryNetworkInternalAPI historyNetworkInternalAPI;
+
+  public GetRoutingTable(final HistoryNetworkInternalAPI historyNetworkInternalAPI) {
+    this.historyNetworkInternalAPI = historyNetworkInternalAPI;
+  }
+
+  private Optional<List<List<String>>> execute() {
+    List<List<NodeRecord>> routingTable = historyNetworkInternalAPI.getRoutingTable();
+    return Optional.of(
+        routingTable.stream()
+            .map(
+                innerList -> {
+                  List<String> reversed =
+                      innerList.stream()
+                          .map(NodeRecord::getNodeId)
+                          .map(Bytes::toHexString)
+                          .limit(MAX_ROUTING_TABLE_SIZE)
+                          .collect(Collectors.toList());
+                  Collections.reverse(reversed); // ordered from least-recently to most-recently
+                  return reversed;
+                })
+            .collect(Collectors.toList()));
+  }
+
+  public static Optional<List<List<String>>> execute(
+      final HistoryNetworkInternalAPI historyNetworkInternalAPI) {
+    LOG.debug("Executing GetRoutingTable");
+    return new GetRoutingTable(historyNetworkInternalAPI).execute();
+  }
+}

core/src/main/java/samba/network/history/routingtable/HistoryRoutingTable.java

@@ -6,6 +6,7 @@
 
 import java.util.Comparator;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
@@ -103,6 +104,11 @@ public boolean isNodeIgnored(NodeRecord nodeRecord) {
     return this.nodeTable.isNodeIgnored(nodeRecord);
   }
 
+  @Override
+  public List<List<NodeRecord>> getNodeRecordBuckets() {
+    return this.nodeTable.getNodeRecordBuckets();
+  }
+
   @Override
   public Optional<NodeRecord> findClosestNodeToKey(Bytes key) {
     return radiusMap.entrySet().stream()

core/src/main/java/samba/network/history/routingtable/RoutingTable.java

@@ -1,5 +1,6 @@
 package samba.network.history.routingtable;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Stream;
@@ -33,4 +34,7 @@ public interface RoutingTable {
   boolean isNodeConnected(Bytes nodeId);
 
   boolean isNodeIgnored(NodeRecord nodeRecord);
+
+  /** Recently nodes are at the start of the list with older at the end. */
+  List<List<NodeRecord>> getNodeRecordBuckets();
 }