strideutils 0.1.7__tar.gz → 0.1.8__tar.gz

{strideutils-0.1.7 → strideutils-0.1.8}/PKG-INFO

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

{strideutils-0.1.7 → strideutils-0.1.8}/pyproject.toml

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

{strideutils-0.1.7 → strideutils-0.1.8}/strideutils/stride_requests.py

@@ -15,6 +15,9 @@ from strideutils import stride_upstash
 from strideutils.stride_config import config
 
 ACCOUNT_QUERY = "cosmos/auth/v1beta1/accounts/{address}"
+ACCOUNT_BALANCE_QUERY = 'cosmos/bank/v1beta1/balances/{address}'
+ACCOUNT_DELEGATIONS_QUERY = 'cosmos/staking/v1beta1/delegations/{delegator_address}'
+ACCOUNT_UNBONDINGS_QUERY = "cosmos/staking/v1beta1/delegators/{delegator_address}/unbonding_delegations"
 TX_QUERY = "cosmos/tx/v1beta1/txs?events=tx.acc_seq%3D%27{address}/{sequence}%27"
 
 HOST_ZONE_QUERY = "Stride-Labs/stride/stakeibc/host_zone"
@@ -287,10 +290,10 @@ def get_celestia_redemption_records(
     Queries the celestia redemption records from staketia
     Optionally include archive records
     """
-    params = {}
+    params: Dict[str, Any] = {}
     if address:
         params["address"] = address
-    if unbonding_record_id:
+    if unbonding_record_id is not None:
         params["unbonding_record_id"] = unbonding_record_id
 
     url = f"{config.stride.api_endpoint}/{STAKETIA_REDEMPTION_RECORDS_QUERY}"
@@ -370,7 +373,7 @@ def get_balance(address: str, block_height: int = 0, api_endpoint: str = config.
     Returns the balance of the given address across all tokens,
     returned as a dictionary of token -> balance
     """
-    url = f"{api_endpoint}/cosmos/bank/v1beta1/balances/{address}"
+    url = f"{api_endpoint}/{ACCOUNT_BALANCE_QUERY.format(address=address)}"
     balance_list = request(url, block_height=block_height)['balances']
     out = {x['denom']: int(x['amount']) for x in balance_list}
     return out
@@ -565,18 +568,73 @@ def get_sttoken_apr(token: str) -> Optional[float]:
 def get_delegated_tokens_on_address(
     delegator_address: str,
     api_endpoint: str = config.stride.api_endpoint,
-) -> Dict[str, float]:
+) -> Dict[str, int]:
     """
     Returns a dict mapping from "validator_address" to "num tokens delegated", given a delegator address
+
+    Raw response example (stake_endpoint)
+    {
+      "delegation_responses": [
+        {"delegation": {
+            "delegator_address": "cosmos10...28",
+            "validator_address": "cosmosvaloper1p..r2qs",
+            "shares":"1.180957009445999997"},
+            "balance":{"denom":"uatom","amount":"1"}
+        }, ...],
+      "pagination": {...}
+    }
+
+    Returns
+      e.g. {'valoper1': 10, 'valoper2': 20}
     """
-    stake_endpoint = f'{api_endpoint}/cosmos/staking/v1beta1/delegations/{delegator_address}'
-    host_zone_balance = request(stake_endpoint)['delegation_responses']
-    stake_amounts = {}
+    stake_endpoint = f'{api_endpoint}/{ACCOUNT_DELEGATIONS_QUERY.format(delegator_address=delegator_address)}'
+    host_zone_balance = query_list_with_pagination(stake_endpoint, rel_key='delegation_responses')
+    stake_amounts: Dict[str, int] = {}
     for hzb in host_zone_balance:
-        stake_amounts[hzb['delegation']['validator_address']] = float(hzb['balance']['amount'])
+        stake_amounts[hzb['delegation']['validator_address']] = int(hzb['balance']['amount'])
     return stake_amounts
 
 
+def get_unbonding_tokens_on_address(
+    delegator_address: str,
+    api_endpoint: str = config.stride.api_endpoint,
+) -> Dict[str, int]:
+    """
+    Returns a dict mapping from "validator_address" to "num tokens delegated", given a delegator address
+
+    Raw response example (unbonding_endpoint)
+    {
+      "unbonding_responses": [
+        {
+          "delegator_address": "cosmos10...28",
+          "validator_address": "cosmosvaloper1d...h9",
+          "entries": [
+            {
+              "creation_height": "18749801",
+              "completion_time": "2024-02-06T19:00:28.676639972Z",
+              "initial_balance": "3727000742",
+              "balance": "3727000742",
+              "unbonding_id": "334505",
+              "unbonding_on_hold_ref_count": "1"
+            }
+          ]
+        }, ...],
+      "pagination": {...}
+    }
+
+    Returns
+      e.g. {'valoper1': 10, 'valoper2': 20}
+    """
+    unbonding_endpoint = f'{api_endpoint}/{ACCOUNT_UNBONDINGS_QUERY.format(delegator_address=delegator_address)}'
+    unbondings = query_list_with_pagination(unbonding_endpoint, rel_key='unbonding_responses')
+    unbonding_amounts: Dict[str, int] = {}
+    for unbonding in unbondings:
+        unbonding_amounts[unbonding['validator_address']] = sum(
+            int(entry['initial_balance']) for entry in unbonding['entries']
+        )
+    return unbonding_amounts
+
+
 def get_host_zone_delegations(host_zone_id: str, ground_truth_included: bool = True) -> pd.DataFrame:
     """
     Given a host zone id, returns a Dataframe of validator delegations.