compass_api_sdk 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

compass_api_sdk/morpho.py

@@ -20,7 +20,7 @@ class Morpho(BaseSDK):
     ) -> models.MorphoGetVaultsResponse:
         r"""Get Vaults
 
-        Query a list of available vaults for deposit token.
+        Query a list of vaults you can deposit into.
 
         Each vault has one unique token that can be deposited. In exchange for depositing
         tokens into a vault you receive shares. You earn yield on these shares by their
@@ -124,7 +124,7 @@ class Morpho(BaseSDK):
     ) -> models.MorphoGetVaultsResponse:
         r"""Get Vaults
 
-        Query a list of available vaults for deposit token.
+        Query a list of vaults you can deposit into.
 
         Each vault has one unique token that can be deposited. In exchange for depositing
         tokens into a vault you receive shares. You earn yield on these shares by their
@@ -230,6 +230,13 @@ class Morpho(BaseSDK):
 
         Get data & metrics for a specific Morpho vault.
 
+        Including:
+        - Current, daily, weekly, monthly, yearly APY
+        - Underlying asset data
+        - Total liquidity
+        - Pertinent metadata
+        - Whitelist status
+
         :param chain:
         :param vault_address: The vault address of the desired vault data & metrics.
         :param retries: Override the default retry configuration for this method
@@ -330,6 +337,13 @@ class Morpho(BaseSDK):
 
         Get data & metrics for a specific Morpho vault.
 
+        Including:
+        - Current, daily, weekly, monthly, yearly APY
+        - Underlying asset data
+        - Total liquidity
+        - Pertinent metadata
+        - Whitelist status
+
         :param chain:
         :param vault_address: The vault address of the desired vault data & metrics.
         :param retries: Override the default retry configuration for this method
@@ -854,6 +868,15 @@ class Morpho(BaseSDK):
 
         Get data & metrics for a specific Morpho market.
 
+        Including:
+        - Current, daily, weekly, monthly, yearly APY
+        - Collateral & loan asset data
+        - Liquidation loan-to-value ratio
+        - Collateral, borrow & liquidity value
+        - Utilization ratio
+        - Pertinent metadata
+        - Whitelist status
+
         :param chain:
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
         :param retries: Override the default retry configuration for this method
@@ -954,6 +977,15 @@ class Morpho(BaseSDK):
 
         Get data & metrics for a specific Morpho market.
 
+        Including:
+        - Current, daily, weekly, monthly, yearly APY
+        - Collateral & loan asset data
+        - Liquidation loan-to-value ratio
+        - Collateral, borrow & liquidity value
+        - Utilization ratio
+        - Pertinent metadata
+        - Whitelist status
+
         :param chain:
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
         :param retries: Override the default retry configuration for this method
@@ -1266,6 +1298,9 @@ class Morpho(BaseSDK):
 
         Check user's overall position across the entire Morpho ecosystem.
 
+        Inlcuding all vault and market position metrics and relavant metadata of said vaults
+        and markets.
+
         :param chain:
         :param user_address: The user wallet address of the desired user position.
         :param retries: Override the default retry configuration for this method
@@ -1368,6 +1403,9 @@ class Morpho(BaseSDK):
 
         Check user's overall position across the entire Morpho ecosystem.
 
+        Inlcuding all vault and market position metrics and relavant metadata of said vaults
+        and markets.
+
         :param chain:
         :param user_address: The user wallet address of the desired user position.
         :param retries: Override the default retry configuration for this method
@@ -1470,7 +1508,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Set Allowance for Vault
 
         Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.
@@ -1546,7 +1584,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -1586,7 +1624,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Set Allowance for Vault
 
         Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.
@@ -1662,7 +1700,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -1703,7 +1741,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Deposit to Vault
 
         Deposit tokens into a Morpho Vault to earn passive yield from interest paid by
@@ -1787,7 +1825,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -1828,7 +1866,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Deposit to Vault
 
         Deposit tokens into a Morpho Vault to earn passive yield from interest paid by
@@ -1912,7 +1950,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -1950,7 +1988,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Withdraw from Vault
 
         Withdraw deposited tokens from a Morpho Vault.
@@ -2034,7 +2072,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2072,7 +2110,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Withdraw from Vault
 
         Withdraw deposited tokens from a Morpho Vault.
@@ -2156,7 +2194,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2198,7 +2236,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Supply Collateral to Market
 
         Supply collateral to a Morpho Market in order to borrow against it.
@@ -2279,7 +2317,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2321,7 +2359,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Supply Collateral to Market
 
         Supply collateral to a Morpho Market in order to borrow against it.
@@ -2402,7 +2440,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2444,7 +2482,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Withdraw Collateral from Market
 
         Withdraw collateral that has been supplied to a Morpho Market.
@@ -2525,7 +2563,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2567,7 +2605,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Withdraw Collateral from Market
 
         Withdraw collateral that has been supplied to a Morpho Market.
@@ -2648,7 +2686,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2689,7 +2727,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Borrow from Market
 
         Borrow tokens from a Morpho Market against supplied collateral.
@@ -2773,7 +2811,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2814,7 +2852,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Borrow from Market
 
         Borrow tokens from a Morpho Market against supplied collateral.
@@ -2898,7 +2936,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -2937,7 +2975,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Repay to Market
 
         Repay borrowed tokens to a market in order to reduce or eliminate debt.
@@ -3018,7 +3056,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -3057,7 +3095,7 @@ class Morpho(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Repay to Market
 
         Repay borrowed tokens to a market in order to reduce or eliminate debt.
@@ -3138,7 +3176,7 @@ class Morpho(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData

compass_api_sdk/sky.py

@@ -212,7 +212,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Buy USDS
 
         Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
@@ -288,7 +288,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -324,7 +324,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Buy USDS
 
         Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
@@ -400,7 +400,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -438,7 +438,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Sell USDS
 
         Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
@@ -514,7 +514,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -552,7 +552,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Sell USDS
 
         Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
@@ -628,7 +628,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -666,7 +666,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Deposit USDS
 
         Deposit USDS for sUSDS to earn yield.
@@ -738,7 +738,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -776,7 +776,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Deposit USDS
 
         Deposit USDS for sUSDS to earn yield.
@@ -848,7 +848,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -884,7 +884,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Withdraw USDS
 
         Withdraw USDS for sUSDS to stop earning yield.
@@ -954,7 +954,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -990,7 +990,7 @@ class Sky(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Withdraw USDS
 
         Withdraw USDS for sUSDS to stop earning yield.
@@ -1060,7 +1060,7 @@ class Sky(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData

compass_api_sdk/token_sdk.py

@@ -639,7 +639,7 @@ class TokenSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Transfer ETH or ERC20 Tokens.
 
         Sends native ETH or ERC20 tokens from the sender's address to another address.
@@ -713,7 +713,7 @@ class TokenSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData
@@ -756,7 +756,7 @@ class TokenSDK(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.UnsignedTransaction:
+    ) -> models.TxResponse:
         r"""Transfer ETH or ERC20 Tokens.
 
         Sends native ETH or ERC20 tokens from the sender's address to another address.
@@ -830,7 +830,7 @@ class TokenSDK(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json(http_res.text, models.UnsignedTransaction)
+            return utils.unmarshal_json(http_res.text, models.TxResponse)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = utils.unmarshal_json(
                 http_res.text, errors.HTTPValidationErrorData