Support websockets API #1515
Merged
Support websockets API #1515
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
…ub.com/software-mansion/starknet.py into franciszekjob/1498-3-websockets
…tware-mansion/starknet.py into franciszekjob/1498-2-get-compiled-casm
…ub.com/software-mansion/starknet.py into franciszekjob/1498-3-websockets
franciszekjob
commented
Apr 2, 2025
Comment on lines
+91
to
+120
| def get_block_identifier( | ||
| block_hash: Optional[Union[Hash, Tag]] = None, | ||
| block_number: Optional[Union[int, Tag]] = None, | ||
| default_tag: Optional[Tag] = "pending", | ||
| ) -> dict: | ||
| return { | ||
| "block_id": _get_raw_block_identifier(block_hash, block_number, default_tag) | ||
| } | ||
|
|
||
|
|
||
| def _get_raw_block_identifier( | ||
| block_hash: Optional[Union[Hash, Tag]] = None, | ||
| block_number: Optional[Union[int, Tag]] = None, | ||
| default_tag: Optional[Tag] = "pending", | ||
| ) -> Union[dict, Hash, Tag, None]: | ||
| if block_hash is not None and block_number is not None: | ||
| raise ValueError( | ||
| "Arguments block_hash and block_number are mutually exclusive." | ||
| ) | ||
|
|
||
| if block_hash in ("latest", "pending") or block_number in ("latest", "pending"): | ||
| return block_hash or block_number | ||
|
|
||
| if block_hash is not None: | ||
| return {"block_hash": _to_rpc_felt(block_hash)} | ||
|
|
||
| if block_number is not None: | ||
| return {"block_number": block_number} | ||
|
|
||
| return default_tag |
There was a problem hiding this comment.
note: Moved it to it doesn't sit in full node client's file. It could be theoretically placed in a file which is not client specific or we could rename this file to e.g. rpc_utils.py.
franciszekjob
commented
Apr 2, 2025
Comment on lines
+81
to
+84
| @post_load | ||
| def make_dataclass(self, data, **kwargs) -> BlockHeader: | ||
| return BlockHeader(**data) | ||
|
|
There was a problem hiding this comment.
note: It was missing.
franciszekjob
commented
Apr 2, 2025
Comment on lines
+322
to
+337
| def _handle_received_message(self, message: Union[str, bytes]): | ||
| """ | ||
| Handles the received message. | ||
|
|
||
| :param message: The message received from the WebSocket server. | ||
| """ | ||
| data = cast(Dict, json.loads(message)) | ||
|
|
||
| # case when the message is a response to `subscribe_{method}` | ||
| if "id" in data and data["id"] in self._pending_responses: | ||
| future = self._pending_responses.pop(data["id"]) | ||
| future.set_result(data) | ||
|
|
||
| # case when the message is a notification | ||
| elif "method" in data: | ||
| self._handle_notification(data) |
There was a problem hiding this comment.
note: Both subscription responses and notifications are handled via recv_streaming (used in async iterator for the connection) because we cannot simultaneously use recv for immediate responses and maintain a continuous listener with recv_streaming. Consequently, all incoming messages are processed through the streaming interface.
ddoktorski
reviewed
Apr 7, 2025
ddoktorski
approved these changes
Apr 8, 2025
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.
Relates #1498
Introduced changes
Support websockets API
WebsocketClient