[alpha] move from devel (#103)

* torrent_peers_stat (#99)

* 📝 Update component diagram with UML compliant diagram. (#72)

* sentry.proto: rename Peers to PeerEvents (#101)

* rename Peers() -> PeerEvents()
* rename PeersRequest -> PeerEventsRequest
* rename PeerEvent -> PeerEventId
* rename PeersReply -> PeerEvent

* RPC/Sentry: Peers method (#102)

Add a method to return information about all connected peers.
This is needed to implement admin_peers RPC call.

Co-authored-by: Alex Sharov <[email protected]>
Co-authored-by: Daniel At Cosmic DNA <[email protected]>
Co-authored-by: battlmonstr <[email protected]>

Author: 4 people

p2psentry/sentry.proto

@@ -123,18 +123,23 @@ message MessagesRequest {
   repeated MessageId ids = 1;
 }
 
+message PeersReply {
+  repeated types.PeerInfo peers = 1;
+}
+
 message PeerCountRequest {}
 
 message PeerCountReply {uint64 count = 1;}
 
-message PeersRequest {}
-message PeersReply {
-  enum PeerEvent {
+message PeerEventsRequest {}
+message PeerEvent {
+  enum PeerEventId {
+    // Happens after after a successful sub-protocol handshake.
     Connect = 0;
     Disconnect = 1;
   }
   types.H512 peer_id = 1;
-  PeerEvent event = 2;
+  PeerEventId event_id = 2;
 }
 
 service Sentry {
@@ -153,15 +158,16 @@ service Sentry {
       returns (SentPeers);
   rpc SendMessageToAll(OutboundMessageData) returns (SentPeers);
 
-
   // Subscribe to receive messages.
   // Calling multiple times with a different set of ids starts separate streams.
   // It is possible to subscribe to the same set if ids more than once.
   rpc Messages(MessagesRequest) returns (stream InboundMessage);
+
+  rpc Peers(google.protobuf.Empty) returns (PeersReply);
   rpc PeerCount(PeerCountRequest) returns (PeerCountReply);
+  // Subscribe to notifications about connected or lost peers.
+  rpc PeerEvents(PeerEventsRequest) returns (stream PeerEvent);
 
-  // Notifications about connected (after sub-protocol handshake) or lost peer
-  rpc Peers(PeersRequest) returns (stream PeersReply);
   // NodeInfo returns a collection of metadata known about the host.
   rpc NodeInfo(google.protobuf.Empty) returns(types.NodeInfoReply);
 }

remote/ethbackend.proto

@@ -47,11 +47,16 @@ service ETHBACKEND {
   // it doesn't provide consistency
   // Request fields are optional - it's ok to request block only by hash or only by number
   rpc Block(BlockRequest) returns (BlockReply);
+
   // High-level method - can find block number by txn hash
   // it doesn't provide consistency
   rpc TxnLookup(TxnLookupRequest) returns (TxnLookupReply);
-  // NodeInfo collects and returns NodeInfo from all running celery instances.
-  rpc NodeInfo(NodesInfoRequest) returns(NodesInfoReply);
+
+  // NodeInfo collects and returns NodeInfo from all running sentry instances.
+  rpc NodeInfo(NodesInfoRequest) returns (NodesInfoReply);
+
+  // Peers collects and returns peers information from all running sentry instances.
+  rpc Peers(google.protobuf.Empty) returns (PeersReply);
 }
 
 enum Event {
@@ -179,3 +184,7 @@ message NodesInfoRequest {
 message NodesInfoReply {
   repeated types.NodeInfoReply nodesInfo = 1;
 }
+
+message PeersReply {
+  repeated types.PeerInfo peers = 1;
+}

turbo-geth-architecture.png

@@ -89,3 +89,16 @@ message NodeInfoReply {
   string listenerAddr = 6;
   bytes protocols = 7;
 }
+
+message PeerInfo {
+  string id = 1;
+  string name = 2;
+  string enode = 3;
+  string enr = 4;
+  repeated string caps = 5;
+  string connLocalAddr = 6;
+  string connRemoteAddr = 7;
+  bool connIsInbound = 8;
+  bool connIsTrusted = 9;
+  bool connIsStatic = 10;
+}