Skip to content

refactor(rpc): Deprecate get_block_height in favor of get_tick_info #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mazzya merged 1 commit into from
May 22, 2025
Merged

refactor(rpc): Deprecate get_block_height in favor of get_tick_info #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion qubipy/rpc/rpc_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import requests
from typing import Dict, Any
import json
import warnings

from qubipy.exceptions import *
from qubipy.config import *
Expand Down Expand Up @@ -586,14 +587,22 @@ def get_block_height(self) -> Dict[str, Any]:
"""
Retrieves the current block height from the API.

.. deprecated:: 0.4.0
Use :func:`get_tick_info` instead. This function will be removed in a future release.

Returns:
Dict[str, Any]: A dictionary containing the current block height.
If the block height is not found, an empty dictionary is returned.

Raises:
QubiPy_Exceptions: If there is an issue with the API request (e.g., network error, invalid response, or timeout).
"""

warnings.warn(
"The 'get_block_height()' function is deprecated and will be removed in a future version of QubiPy. "
"Please use 'get_tick_info()' instead for future compatibility.",
DeprecationWarning,
stacklevel=2
)
try:
response = requests.get(f'{self.rpc_url}{BLOCK_HEIGHT}', headers=HEADERS, timeout=self.timeout)
response.raise_for_status()
Expand Down