strideutils 0.3.3__tar.gz → 0.3.4__tar.gz

{strideutils-0.3.3 → strideutils-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strideutils
-Version: 0.3.3
+Version: 0.3.4
 Summary: 
 Author: Your Name
 Author-email: you@example.com

{strideutils-0.3.3 → strideutils-0.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "strideutils"
-version = "0.3.3"
+version = "0.3.4"
 description = ""
 authors = ["Your Name <you@example.com>"]
 readme = "README.md"

{strideutils-0.3.3 → strideutils-0.3.4}/strideutils/stride_config.py

@@ -105,6 +105,8 @@ class HostChainConfig(ChainConfig):
     denom_on_stride: str = ""
     # Indicates whether the chain has ICA enabled
     ica_enabled: bool = True
+    # Indicates whether the chain has LSM enabled
+    lsm_enabled: bool = False
 
     def __repr__(self) -> str:
         return f"HostChainConfig(name={self.name}, id={self.id})"

{strideutils-0.3.3 → strideutils-0.3.4}/strideutils/stride_requests.py

@@ -13,7 +13,7 @@ import pytz
 import requests
 from requests.adapters import HTTPAdapter, Retry
 
-from strideutils import stride_upstash
+from strideutils import stride_upstash, types
 from strideutils.stride_config import config
 
 ACCOUNT_QUERY = "cosmos/auth/v1beta1/accounts/{address}"
@@ -34,8 +34,12 @@ TX_BY_ACCOUNT_EVENT = "tx.acc_seq='{address}/{sequence}'"
 
 HOST_ZONE_QUERY = "Stride-Labs/stride/stakeibc/host_zone"
 EPOCHS_QUERY = "Stridelabs/stride/epochs"
-
+PENDING_ICQ_QUERY = "Stride-Labs/stride/interchainquery/pending_queries"
 RATE_LIMIT_QUERY = "Stride-Labs/ibc-rate-limiting/ratelimit/ratelimits"
+DEPOSIT_RECORDS_QUERY = "Stride-Labs/stride/records/deposit_record_by_host_zone/{chain_id}"
+UNBONDING_RECORDS_QUERY = "Stride-Labs/stride/records/epoch_unbonding_record"
+LSM_RECORDS_QUERY = "Stride-Labs/stride/stakeibc/lsm_deposits"
+CALLBACK_DATA_QUERY = "Stride-Labs/stride/icacallbacks/callback_data"
 
 STAKETIA = "staketia"
 STAKEDYM = "stakedym"
@@ -50,6 +54,8 @@ MULTISIG_REDEMPTION_RECORDS_QUERY = "Stride-Labs/stride/{module}/redemption_reco
 
 COSMWASM_CONTRACT_QUERY = "cosmwasm/wasm/v1/contract/{contract_address}/smart/{query}"
 
+HOST_CHANNELS_QUERY = "https://channels.main.stridenet.co/api/data/{chain_id}"
+
 requests_session = requests.Session()
 
 retries = Retry(total=5, backoff_factor=0.5, status_forcelist=[400, 403, 404, 500, 502, 503, 504])
@@ -244,6 +250,106 @@ def get_host_zone(chain_id: str, cast_types: bool = True, **kwargs) -> Dict[str,
     return host_zone
 
 
+def get_deposit_records(
+    chain_id: str,
+    status: Optional[types.DepositRecordStatus] = None,
+    block_height: int = 0,
+) -> List[Dict[str, Any]]:
+    """
+    Queries all the deposit records for a given host zone with optional status filter
+
+    E.g.
+    [
+        {
+            "id": "36310",
+            "amount": "5305210",
+            "denom": "uluna",
+            "host_zone_id": "phoenix-1",
+            "status": "DELEGATION_QUEUE",
+            "deposit_epoch_number": "2424",
+            "source": "STRIDE"
+        },
+    ]
+    """
+    url = f"{config.stride.api_endpoint}/{DEPOSIT_RECORDS_QUERY.format(chain_id=chain_id)}"
+    deposit_records = request(url, block_height=block_height)["deposit_record"]
+    if status:
+        deposit_records = [dr for dr in deposit_records if dr["status"] == status]
+    return deposit_records
+
+
+def get_unbonding_records(
+    chain_id: str,
+    status: Optional[types.UnbondingRecordStatus] = None,
+    block_height: int = 0,
+) -> List[Dict[str, Any]]:
+    """
+    Queries all the unbonding records for a given host zone with optional status filter
+
+    E.g.
+    [
+        {
+            "st_token_amount": "3218590",
+            "native_token_amount": "0",
+            "denom": "ucmdx",
+            "host_zone_id": "comdex-1",
+            "unbonding_time": "1713812526371636619",
+            "status": "CLAIMABLE",
+            "user_redemption_records": [
+                "comdex-1.575.comdex1gwnfjj65zhxmtnpxzy625cpx692lfjuwlqeg8p",
+                ...
+            ]
+        },
+        ...
+    ]
+    """
+    # Query the epoch unbonding records
+    url = f"{config.stride.api_endpoint}/{UNBONDING_RECORDS_QUERY}"
+    epoch_unbondings = query_list_with_pagination(url, rel_key="epoch_unbonding_record", block_height=block_height)
+
+    # The structure from the response consists of:
+    # - List of epoch unbonding records - one record per epoch
+    # - Within each epoch unbonding record, there's one host zone unbonding record per host
+    # This function returns the host zone unbonding record
+    host_zone_unbondings = []
+    for epoch_unbonding in epoch_unbondings:
+        for host_zone_unbonding in epoch_unbonding["host_zone_unbondings"]:
+
+            chain_id_match = host_zone_unbonding["host_zone_id"] == chain_id
+            status_match = not status or host_zone_unbonding["status"] == status
+
+            if chain_id_match and status_match:
+                host_zone_unbondings.append(host_zone_unbonding)
+
+    return host_zone_unbondings
+
+
+def get_lsm_deposit_records(chain_id: str) -> List[Dict[str, Any]]:
+    """
+    Queries all the LSM deposit records
+
+    [
+        {
+            "deposit_id": "800000.cosmoshub-4.strideXXX.cosmosvaloperXXX/1",
+            "chain_id": "cosmoshub-4",
+            "ibc_denom": "ibc/cosmosvaloperXXX/1",
+            "staker_address": "strideXXX",
+            "validator_address": "cosmosvaloperXXX",
+            "amount": "10000",
+            "st_token": {
+                "amount": "10000",
+                "denom": "stuatom"
+            }
+            "status": "DEPOSIT_PENDING"
+        },
+    ]
+    """
+    params = {"chain_id": chain_id}
+    url = f"{config.stride.api_endpoint}/{LSM_RECORDS_QUERY}"
+    deposit_records = request(url, params=params)["deposits"]
+    return deposit_records
+
+
 def get_multisig_delegation_records(module: str, include_archived: bool = False) -> List[Dict]:
     """
     Queries the delegation records from staketia or stakedym
@@ -338,6 +444,76 @@ def get_rate_limits(**kwargs):
     return host_zone
 
 
+def get_pending_interchain_queries(chain_id: Optional[str] = None, block_height: int = 0) -> List[Dict[str, Any]]:
+    """
+    Gets the list of all pending ICQs on stride
+
+    E.g.
+    [
+        {
+            "id": "86170fade2b01f18a1f5e448c8a9dabdc60293151828f881a40708396ec383e0",
+            "connection_id": "connection-0",
+            "chain_id": "cosmoshub-4",
+            "query_type": "store/bank/key",
+            "request_data": ...bytestring...,
+            "callback_module": "stakeibc",
+            "callback_id": "withdrawalbalance",
+            "callback_data": ...bytestring...,
+            "timeout_policy": "REJECT_QUERY_RESPONSE",
+            "timeout_duration": "1hr",
+            "timeout_timestamp": "1714689884000000000",
+            "request_sent": true,
+            "submission_height": 80000
+        }
+        ...
+    ]
+    """
+    url = f"{config.stride.api_endpoint}/{PENDING_ICQ_QUERY}"
+    queries = request(url, block_height=block_height)["pending_queries"]
+    if chain_id:
+        queries = [query for query in queries if query["chain_id"] == chain_id]
+    return queries
+
+
+def get_callback_data(
+    chain_id: Optional[str] = None,
+    channel_id: Optional[str] = None,
+    port_id: Optional[str] = None,
+    callback_id: Optional[str] = None,
+    block_height: int = 0,
+) -> List[Dict[str, Any]]:
+    """
+    Gets all the ica or ibc callback data stored on stride, with optional filters
+
+    E.g.
+    [
+        {
+            "callback_key": "icacontroller-cosmoshub-4.DELEGATION.channel-1.23",
+            "port_id": "icacontroller-cosmoshub-4.DELEGATION",
+            "channel_id": "channel-1",
+            "sequence": "23",
+            "callback_id": "delegate",
+            "callback_args": "...bytestring..."
+        }
+    ]
+    """
+    url = f"{config.stride.api_endpoint}/{CALLBACK_DATA_QUERY}"
+    callback_data = query_list_with_pagination(url, rel_key="callback_data", block_height=block_height)
+
+    filtered_callback_data = []
+    for data in callback_data:
+
+        chain_id_match = not chain_id or chain_id in data["port_id"]
+        channel_id_match = not channel_id or data["channel_id"] == channel_id
+        port_id_match = not port_id or data["port_id"] == port_id
+        callback_id_match = not callback_id or data["callback_id"] == callback_id
+
+        if all([chain_id_match, channel_id_match, port_id_match, callback_id_match]):
+            filtered_callback_data.append(data)
+
+    return filtered_callback_data
+
+
 def get_validators(api_endpoint: str = config.stride.api_endpoint) -> List[Dict[str, Any]]:
     """
     Queries the list of validators from a chain
@@ -790,17 +966,124 @@ def get_epochs() -> List[Dict]:
     return epochs["epochs"]
 
 
-def get_day_epoch() -> int:
+def get_day_epoch() -> Dict[str, Any]:
     """
-    Get the day epoch from the stride-labs/stride/epochs endpoint
+    Returns the "day" epoch struct on Stride
+
+    E.g.
+    {
+        "identifier": "day",
+        "start_time": "2022-09-04T19:00:00.451745Z",
+        "duration": "86400s",
+        "current_epoch": "607",
+        "current_epoch_start_time": "2024-05-02T19:00:00.451745Z",
+        "epoch_counting_started": true,
+        "current_epoch_start_height": "8829138"
+    }
     """
-    epochs_request = f"{config.stride.api_endpoint}/Stridelabs/stride/epochs"
-    epochs = request(epochs_request)["epochs"]
-    epochs_df = pd.DataFrame(epochs)
-    day_epoch = int(epochs_df[epochs_df["identifier"] == "day"]["current_epoch"].values[0])
+    epochs = get_epochs()
+    day_epoch = [epoch for epoch in epochs if epoch["identifier"] == "day"][0]
     return day_epoch
 
 
+def get_stride_epoch() -> Dict[str, Any]:
+    """
+    Returns the "stride" epoch struct on stride
+
+    E.g.
+    {
+        "identifier": "stride_epoch",
+        "start_time": "2022-09-04T19:00:00.451745Z",
+        "duration": "21600s",
+        "current_epoch": "2425",
+        "current_epoch_start_time": "2024-05-02T19:00:00.451745Z",
+        "epoch_counting_started": true,
+        "current_epoch_start_height": "8829138"
+    }
+    """
+    epochs = get_epochs()
+    stride_epoch = [epoch for epoch in epochs if epoch["identifier"] == "stride_epoch"][0]
+    return stride_epoch
+
+
+def get_stride_epoch_number() -> int:
+    """
+    Returns the epoch number for the current "stride" epoch
+    """
+    stride_epoch = get_stride_epoch()
+    return int(stride_epoch["current_epoch"])
+
+
+def get_day_epoch_number() -> int:
+    """
+    Returns the epoch number for the current "day" epoch
+    """
+    day_epoch = get_day_epoch()
+    return int(day_epoch["current_epoch"])
+
+
+def get_stride_epoch_start_time() -> datetime.datetime:
+    """
+    Returns the epoch start time for the current "stride" epoch
+    """
+    stride_epoch = get_stride_epoch()
+    return dateutil.parser.parse(stride_epoch["current_epoch_start_time"]).replace(tzinfo=None)
+
+
+def get_day_epoch_start_time() -> datetime.datetime:
+    """
+    Returns the epoch start time for the current "day" epoch
+    """
+    day_epoch = get_day_epoch()
+    return dateutil.parser.parse(day_epoch["current_epoch_start_time"]).replace(tzinfo=None)
+
+
+def get_stride_epoch_start_height() -> int:
+    """
+    Returns the epoch start time for the current "stride" epoch
+    """
+    stride_epoch = get_stride_epoch()
+    return int(stride_epoch["current_epoch_start_height"])
+
+
+def get_day_epoch_start_height() -> int:
+    """
+    Returns the epoch start time for the current "day" epoch
+    """
+    day_epoch = get_day_epoch()
+    return int(day_epoch["current_epoch_start_height"])
+
+
+def get_host_zone_channels(chain_id: str) -> Dict[str, Any]:
+    """
+    Returns the JSON response from the channels endpoint, which holds the client and connection info,
+    as well as all the ICA channels
+
+    E.g.
+    {
+        "chain_id": "cosmoshub-4",
+        "client_id": "07-tendermint-0",
+        "counterparty_client_id": "07-tendermint-913",
+        "connection_id": "connection-0",
+        "counterparty_connection_id": "connection-635",
+        "transfer_channel_id": "channel-0",
+        "counterparty_transfer_channel_id": "channel-391",
+        "ica_channels": [
+            {
+            "type": "DELEGATION",
+            "port_id": "icacontroller-cosmoshub-4.DELEGATION",
+            "channel_id": "channel-203",
+            "counterparty_channel_id": "channel-810",
+            "state": "STATE_OPEN",
+            "counterparty_state": "STATE_OPEN"
+            },
+        ...
+        ]
+    }
+    """
+    return request(HOST_CHANNELS_QUERY.format(chain_id=chain_id))
+
+
 def query_wasm_contract(contract_address: str, query_msg: Dict, api_endpoint: str, block_height: int = 0) -> Dict:
     """
     Queries a cosmowasm contract address with the provided query message

strideutils-0.3.4/strideutils/types.py

@@ -0,0 +1,23 @@
+from enum import Enum
+
+
+class DepositRecordStatus(str, Enum):
+    TRANSFER_QUEUE = "TRANSFER_QUEUE"
+    TRANSFER_IN_PROGRESS = "TRANSFER_IN_PROGRESS"
+    DELEGATION_QUEUE = "DELEGATION_QUEUE"
+    DELEGATION_IN_PROGRESS = "DELEGATION_IN_PROGRESS"
+
+
+class CallbackId(str, Enum):
+    TRANSFER = "transfer"
+    DELEGATE = "delegate"
+    UNDELEGATE = "undelegate"
+    REDEMPTION = "redemption"
+
+
+class UnbondingRecordStatus(str, Enum):
+    UNBONDING_QUEUE = "UNBONDING_QUEUE"
+    UNBONDING_IN_PROGRESS = "UNBONDING_IN_PROGRESS"
+    EXIT_TRANSFER_QUEUE = "EXIT_TRANSFER_QUEUE"
+    EXIT_TRANSFER_IN_PROGRESS = "EXIT_TRANSFER_IN_PROGRESS"
+    CLAIMABLE = "CLAIMABLE"