Implement admin_peerEvents for rpc module #7999

StevenChongHuo · 2025-01-03T15:48:52Z

These changes allow real time pub-sub through websocket on peer-related events (peerEvents), specifically, peerAdded and peerRemoved events. Once a client subscribes for peerEvents, A JSON-RPC notification with event payload and subscription id is sent to this client for every event matching the subscription topic (peerAdded or peerRemoved).

Users subscribe to peerEvents by sending a request as such:
{"jsonrpc": "2.0", "id": 1, "method": "admin_subscribe", "params": ["peerEvents"]}

Resolves #7816

Changes

Adds a new subscription type peerEvents.
Implements logic to create corresponding JsonRpc response.
Subscribes to IPeerPool.peerAdded and IPeerPool.peerRemoved events when requested.
Allows a differentiation between eth_subscribe and admin_subscribe in JsonRpcSubscriptionResponse class.

Types of changes

What types of changes does your code introduce?

Bugfix (a non-breaking change that fixes an issue)
New feature (a non-breaking change that adds functionality)
Breaking change (a change that causes existing functionality not to work as expected)
Optimization
Refactoring
Documentation update
Build-related changes
Other

Testing

Requires testing

Yes
No

If yes, did you write tests?

Yes
No

Allow real time pub-sub through websocket on peer_added and peer_removed events.

…dule

LukaszRozmej

Potentially we also need msgsend and msgrecv subscriptions, but they will be a bit harder to add as I believe we don't expose events yet.

LukaszRozmej · 2025-01-06T09:12:39Z

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/ISubscribeRpcModule.cs

+        ResultWrapper<string> admin_subscribe(string subscriptionName, string? args = null);
+        [JsonRpcMethod(Description = "Unsubscribes from a subscription.", IsImplemented = true, IsSharable = false, Availability = RpcEndpoint.All & ~RpcEndpoint.Http)]
+        ResultWrapper<bool> admin_unsubscribe(string subscriptionId);


I think those methods need to be moved to AdminModule as we need to guarantee that they are available only when admin module is enabled? Or we can try adding that logic explicitly for subscriptions in RpcModuleProvider?

Thank you for your comments! I am still looking into msgsend and msgrecv subscriptions. For now, these commits only deals with subscriptions to peerAdded and peerRemoved events.

I have moved the admin_subscribe and admin_unsubscribe methods to AdminRpcModule in the most recent commits. Previously, these methods are available when the Subscribe module is enabled; now they are only available when the Admin module is enabled.

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/AdminSubscriptionType.cs

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/DroppedPendingTransactionsSubscription.cs

LukaszRozmej · 2025-01-06T09:15:52Z

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/PeerAddDropResponse.cs

+    [JsonPropertyName("type")]
+    public string Type { get; set; }
+
+    [JsonPropertyName("peer")]
+    public string PeerId { get; set; }
+
+    [JsonPropertyName("local")]
+    public string LocalAddr { get; set; }
+
+    [JsonPropertyName("remote")]
+    public string RemoteAddr { get; set; }
+
+    [JsonPropertyName("error")]
+    public string? Err { get; set; }


Imo name properties as they should be in response and you can drop JsonPropertyName attributes. Casing will be handled by default.

Could you please explain the benefits of this? I haven't changed these codes for this reason: I think the content of a variable is clearer when the variable name is more explicit, e.g. LocalAddr is less ambiguous than local.

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/PeerAddDropResponse.cs

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/NewHeadSubscription.cs

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/peerEventsSubscription.cs

…dule

+ Move admin_subscribe and admin_unsubsribe methods into the AdminRpcModule. + Move relevant tests to AdminModuleTest + Deal with other comments in PR review.

…dule

LukaszRozmej

Almost done - what do you think about moving subscription registrations from SubscriptionManager to be close to actual modules themselves?

LukaszRozmej · 2025-01-10T16:16:10Z

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/SubscriptionFactory.cs

@@ -38,7 +40,8 @@ public SubscriptionFactory(ILogManager? logManager,
        IFilterStore? filterStore,
        IEthSyncingInfo ethSyncingInfo,
        ISpecProvider specProvider,
-        IJsonSerializer jsonSerializer)
+        IJsonSerializer jsonSerializer,
+        IPeerPool peerPool)


Maybe instead of passing IPeerPool here and other specialized types from different modules, we should register subscriptions from the outside of this class?

LukaszRozmej · 2025-01-10T16:17:57Z

src/Nethermind/Nethermind.JsonRpc/Modules/Subscribe/SubscriptionFactory.cs

+            [SubscriptionType.AdminSubscription.PeerEvents] = CreateSubscriptionType((jsonRpcDuplexClient) =>
+                new PeerEventsSubscription(jsonRpcDuplexClient, logManager, _peerPool)),


I mean this kind of registrations could be done when setting up AdminModule and previous ones when setting up SubscribeModule. Would make this class bit simpler to construct and use. We could use extension methods for those registrations.

StevenChongHuo and others added 2 commits January 3, 2025 09:35

Implement admin_peerEvents for rpc module

6167b5d

Allow real time pub-sub through websocket on peer_added and peer_removed events.

Merge branch 'master' into 7816_implement_admin_peerevents_for_rpc_mo…

bd38be7

…dule

StevenChongHuo self-assigned this Jan 3, 2025

LukaszRozmej requested changes Jan 6, 2025

View reviewed changes

StevenChongHuo added 4 commits January 7, 2025 11:26

Merge branch 'master' into 7816_implement_admin_peerevents_for_rpc_mo…

2f59bed

…dule

Move admin_subscribe method into the AdminRpcModule

4a051e6

+ Move admin_subscribe and admin_unsubsribe methods into the AdminRpcModule. + Move relevant tests to AdminModuleTest + Deal with other comments in PR review.

Merge branch 'master' into 7816_implement_admin_peerevents_for_rpc_mo…

0527c65

…dule

Deal with failed code formatting check

a433375

StevenChongHuo requested a review from LukaszRozmej January 8, 2025 12:22

LukaszRozmej reviewed Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement admin_peerEvents for rpc module #7999

Implement admin_peerEvents for rpc module #7999

StevenChongHuo commented Jan 3, 2025

LukaszRozmej left a comment

LukaszRozmej Jan 6, 2025

StevenChongHuo Jan 8, 2025 •

edited

Loading

LukaszRozmej Jan 6, 2025

StevenChongHuo Jan 8, 2025

LukaszRozmej Jan 10, 2025

LukaszRozmej left a comment

LukaszRozmej Jan 10, 2025

LukaszRozmej Jan 10, 2025

		[SubscriptionType.AdminSubscription.PeerEvents] = CreateSubscriptionType((jsonRpcDuplexClient) =>
		new PeerEventsSubscription(jsonRpcDuplexClient, logManager, _peerPool)),

Implement admin_peerEvents for rpc module #7999

Are you sure you want to change the base?

Implement admin_peerEvents for rpc module #7999

Conversation

StevenChongHuo commented Jan 3, 2025

Changes

Types of changes

What types of changes does your code introduce?

Testing

Requires testing

If yes, did you write tests?

LukaszRozmej left a comment

Choose a reason for hiding this comment

LukaszRozmej Jan 6, 2025

Choose a reason for hiding this comment

StevenChongHuo Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Thank you for your comments! I am still looking into msgsend and msgrecv subscriptions. For now, these commits only deals with subscriptions to peerAdded and peerRemoved events.

LukaszRozmej Jan 6, 2025

Choose a reason for hiding this comment

StevenChongHuo Jan 8, 2025

Choose a reason for hiding this comment

LukaszRozmej Jan 10, 2025

Choose a reason for hiding this comment

LukaszRozmej left a comment

Choose a reason for hiding this comment

LukaszRozmej Jan 10, 2025

Choose a reason for hiding this comment

LukaszRozmej Jan 10, 2025

Choose a reason for hiding this comment

StevenChongHuo Jan 8, 2025 •

edited

Loading

Thank you for your comments! I am still looking into `msgsend` and `msgrecv` subscriptions. For now, these commits only deals with subscriptions to `peerAdded` and `peerRemoved` events.