feat(rpc): implement starknet_subscribeEvents WebSocket endpoint #466
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbcaron
force-pushed
the
feat/subscribe-events
branch
from
008a6c2 to
0bd7a8f
Compare
Trantorian1
requested changes
Jan 15, 2025
crates/madara/client/rpc/src/versions/user/v0_7_1/methods/read/get_events.rs
Outdated
Show resolved
Hide resolved
| @@ -54,8 +55,16 @@ pub struct GetStorageProofResult { | |||
|
|
|||
| #[versioned_rpc("V0_8_0", "starknet")] | |||
| pub trait StarknetWsRpcApi { | |||
| #[subscription(name = "subscribeNewHeads", unsubscribe = "unsubscribe", item = NewHead, param_kind = map)] | |||
| async fn subscribe_new_heads(&self, block_id: BlockId) -> jsonrpsee::core::SubscriptionResult; | |||
| #[subscription(name = "subscribeNewHeads", unsubscribe = "unsubscribeNewHeads", item = NewHead, param_kind = map)] | |||
There was a problem hiding this comment.
Suggested change
| #[subscription(name = "subscribeNewHeads", unsubscribe = "unsubscribeNewHeads", item = NewHead, param_kind = map)] | |
| #[subscription(name = "subscribeNewHeads", unsubscribe = "unsubscribe", item = NewHead, param_kind = map)] |
We want the call to unsubscribe to be starknet_unsunscribe as per the specs.
There was a problem hiding this comment.
I cannot have the same name for unsubscribe for both methods. This seems strange because during an unsubscribe, the ID is provided, so there shouldn't be any conflict.
There was a problem hiding this comment.
Actually, the problem lies with our versioned_rpc macro
| // Each block contains two receipts: | ||
| // 1. First receipt with 1 event and 1 key | ||
| // 2. Second receipt with 2 events and 2 keys | ||
| fn block_generator(backend: &mc_db::MadaraBackend) -> impl Iterator<Item = Vec<EmittedEvent<Felt>>> + '_ { |
There was a problem hiding this comment.
Consider moving this to a parametrised #[rstest::fixture]. Tbf this might not be worth it though as it would require refactoring rpc_test_setup.
crates/madara/client/rpc/src/versions/user/v0_8_0/methods/ws/subscribe_events.rs
Outdated
Show resolved
Hide resolved
| ]; | ||
|
|
||
| for _ in 0..10 { | ||
| let _ = generator.next().expect("Retrieving block"); |
There was a problem hiding this comment.
It might be more maintainable to generate expected_events procedurally by collecting generator and filtering to the desired keys. I quite like how readable the declarative approach is though so idk.
crates/madara/client/rpc/src/versions/user/v0_8_0/methods/ws/subscribe_events.rs
Outdated
Show resolved
Hide resolved
| @@ -1,4 +1,4 @@ | |||
| [toolchain] | |||
| channel = "1.81" | |||
| components = ["rustfmt", "clippy", "rust-analyzer"] | |||
| components = ["rust-src", "rustfmt", "clippy", "rust-analyzer"] | |||
There was a problem hiding this comment.
Why do we need rust-src?
Trantorian1
approved these changes
Jan 21, 2025
Comment on lines
+277
to
+287
| /// EventChannels manages a highly efficient and scalable pub/sub system for events with 16 specific channels | ||
| /// plus one "all" channel. This architecture provides several key benefits: | ||
| /// | ||
| /// Benefits: | ||
| /// - Selective Subscription: Subscribers can choose between receiving all events or filtering for specific | ||
| /// senders, optimizing network and processing resources | ||
| /// - Memory Efficiency: The fixed number of channels (16) provides a good balance between granularity | ||
| /// and memory overhead | ||
| /// - Predictable Routing: The XOR-based hash function ensures consistent and fast mapping of sender | ||
| /// addresses to channels | ||
| /// |
There was a problem hiding this comment.
The idea for this implementation originally came from @cchudant
jbcaron
force-pushed
the
feat/subscribe-events
branch
2 times, most recently
from
05d9b9c to
241e9ee
Compare
jbcaron
force-pushed
the
feat/subscribe-events
branch
2 times, most recently
from
6658df0 to
c808572
Compare
jbcaron
force-pushed
the
feat/subscribe-events
branch
from
c808572 to
27cc861
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request type
Please add the labels corresponding to the type of changes your PR introduces:
What is the current behavior?
Currently, Madara does not implement the
starknet_subscribeEventsWebSocket RPC method from Starknet RPC v0.8.0. This feature is needed to allow clients to subscribe to and receive real-time Starknet events with filtering capabilities.Resolves: #337
What is the new behavior?
starknet_subscribeEventsWebSocket endpoint following v0.8.0 specificationsstarknet_subscribeEventsin the supported JSON-RPC methods sectionDoes this introduce a breaking change?
No
Other information