Add 'inbound' field to admin_peers JSON-RPC Call (hyperledger#7461)

* Add 'inbound' field to admin_peers JSON-RPC Call Signed-off-by: 7suyash7 <suyashnyn1@gmail.com> * added changelog entry Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com> --------- Signed-off-by: 7suyash7 <suyashnyn1@gmail.com> Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: gconnect <agatevureglory@gmail.com>
gconnect · Aug 26, 2024 · b9bcd4a · b9bcd4a
1 parent 2795655
commit b9bcd4a
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@
 - Added support for tracing private transactions using `priv_traceTransaction` API. [#6161](https://github.com/hyperledger/besu/pull/6161)
 - Wrap WorldUpdater into EVMWorldupdater [#7434](https://github.com/hyperledger/besu/pull/7434)
 - Bump besu-native to 0.9.4 [#7456](https://github.com/hyperledger/besu/pull/7456)
+- Add 'inbound' field to admin_peers JSON-RPC Call [#7461](https://github.com/hyperledger/besu/pull/7461)
 
 
 ### Bug fixes

diff --git a/...c/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/NetworkResult.java b/...c/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/NetworkResult.java
@@ -24,10 +24,13 @@ public class NetworkResult {
 
   private final String localAddress;
   private final String remoteAddress;
+  private final boolean inbound;
 
-  public NetworkResult(final SocketAddress localAddress, final SocketAddress remoteAddress) {
+  public NetworkResult(
+      final SocketAddress localAddress, final SocketAddress remoteAddress, final boolean inbound) {
     this.localAddress = removeTrailingSlash(localAddress.toString());
     this.remoteAddress = removeTrailingSlash(remoteAddress.toString());
+    this.inbound = inbound;
   }
 
   @JsonGetter(value = "localAddress")
@@ -40,6 +43,11 @@ public String getRemoteAddress() {
     return remoteAddress;
   }
 
+  @JsonGetter(value = "inbound")
+  public boolean isInbound() {
+    return inbound;
+  }
+
   private String removeTrailingSlash(final String address) {
     if (address != null && address.startsWith("/")) {
       return address.substring(1);

diff --git a/.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/PeerResult.java b/.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/PeerResult.java
@@ -45,7 +45,11 @@ static PeerResult fromEthPeer(final EthPeer peer) {
                 .map(Capability::toString)
                 .map(TextNode::new)
                 .collect(Collectors.toList()))
-        .network(new NetworkResult(connection.getLocalAddress(), connection.getRemoteAddress()))
+        .network(
+            new NetworkResult(
+                connection.getLocalAddress(),
+                connection.getRemoteAddress(),
+                connection.inboundInitiated()))
         .port(Quantity.create(peerInfo.getPort()))
         .id(peerInfo.getNodeId().toString())
         .protocols(Map.of(peer.getProtocolName(), ProtocolsResult.fromEthPeer(peer)))

diff --git a/...st/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/NetworkResultTest.java b/...st/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/NetworkResultTest.java
@@ -26,9 +26,22 @@ public class NetworkResultTest {
   @Test
   public void localAndRemoteAddressShouldNotStartWithForwardSlash() {
     final SocketAddress socketAddress = new InetSocketAddress("1.2.3.4", 7890);
-    final NetworkResult networkResult = new NetworkResult(socketAddress, socketAddress);
+    final NetworkResult networkResult = new NetworkResult(socketAddress, socketAddress, true);
 
     assertThat(networkResult.getLocalAddress()).isEqualTo("1.2.3.4:7890");
     assertThat(networkResult.getRemoteAddress()).isEqualTo("1.2.3.4:7890");
+    assertThat(networkResult.isInbound()).isTrue();
+  }
+
+  @Test
+  public void inboundFieldShouldReflectConnectionDirection() {
+    final SocketAddress localAddress = new InetSocketAddress("192.168.0.1", 30303);
+    final SocketAddress remoteAddress = new InetSocketAddress("10.0.0.1", 30303);
+
+    final NetworkResult inboundConnection = new NetworkResult(localAddress, remoteAddress, true);
+    assertThat(inboundConnection.isInbound()).isTrue();
+
+    final NetworkResult outboundConnection = new NetworkResult(localAddress, remoteAddress, false);
+    assertThat(outboundConnection.isInbound()).isFalse();
   }
 }