compass_api_sdk 0.1.14__py3-none-any.whl → 0.2.1__py3-none-any.whl

compass_api_sdk/morpho.py

@@ -3,7 +3,7 @@
 from .basesdk import BaseSDK
 from compass_api_sdk import errors, models, utils
 from compass_api_sdk._hooks import HookContext
-from compass_api_sdk.types import Nullable, OptionalNullable, UNSET
+from compass_api_sdk.types import OptionalNullable, UNSET
 from typing import Any, Mapping, Optional, Union
 
 
@@ -11,8 +11,10 @@ class Morpho(BaseSDK):
     def vaults(
         self,
         *,
-        chain: models.MorphoVaultsChain = models.MorphoVaultsChain.ETHEREUM_MAINNET,
-        deposit_token: Nullable[str],
+        chain: Optional[
+            models.MorphoVaultsChain
+        ] = models.MorphoVaultsChain.ETHEREUM_MAINNET,
+        deposit_token: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -26,7 +28,7 @@ class Morpho(BaseSDK):
         tokens into a vault you receive shares. You earn yield on these shares by their
         exchange value increasing over time.
 
-        :param chain: The chain to use.
+        :param chain:
         :param deposit_token:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -115,8 +117,10 @@ class Morpho(BaseSDK):
     async def vaults_async(
         self,
         *,
-        chain: models.MorphoVaultsChain = models.MorphoVaultsChain.ETHEREUM_MAINNET,
-        deposit_token: Nullable[str],
+        chain: Optional[
+            models.MorphoVaultsChain
+        ] = models.MorphoVaultsChain.ETHEREUM_MAINNET,
+        deposit_token: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -130,7 +134,7 @@ class Morpho(BaseSDK):
         tokens into a vault you receive shares. You earn yield on these shares by their
         exchange value increasing over time.
 
-        :param chain: The chain to use.
+        :param chain:
         :param deposit_token:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -219,9 +223,11 @@ class Morpho(BaseSDK):
     def vault_position(
         self,
         *,
-        chain: models.MorphoVaultPositionChain = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         vault_address: str = "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
+        chain: Optional[
+            models.MorphoVaultPositionChain
+        ] = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -232,9 +238,9 @@ class Morpho(BaseSDK):
         Check how many shares you own and the equivalent token amount of a given
         vault.
 
-        :param chain: The chain to use.
         :param user_address:
         :param vault_address:
+        :param chain:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -325,9 +331,11 @@ class Morpho(BaseSDK):
     async def vault_position_async(
         self,
         *,
-        chain: models.MorphoVaultPositionChain = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         vault_address: str = "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
+        chain: Optional[
+            models.MorphoVaultPositionChain
+        ] = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -338,9 +346,9 @@ class Morpho(BaseSDK):
         Check how many shares you own and the equivalent token amount of a given
         vault.
 
-        :param chain: The chain to use.
         :param user_address:
         :param vault_address:
+        :param chain:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -431,7 +439,9 @@ class Morpho(BaseSDK):
     def markets(
         self,
         *,
-        chain: models.MorphoMarketsChain = models.MorphoMarketsChain.ETHEREUM_MAINNET,
+        chain: Optional[
+            models.MorphoMarketsChain
+        ] = models.MorphoMarketsChain.ETHEREUM_MAINNET,
         collateral_token: OptionalNullable[str] = UNSET,
         loan_token: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -446,7 +456,7 @@ class Morpho(BaseSDK):
         Each market has one unique token that can be borrowed against one unique token that
         can be used as collateral.
 
-        :param chain: The chain to use.
+        :param chain:
         :param collateral_token:
         :param loan_token:
         :param retries: Override the default retry configuration for this method
@@ -537,7 +547,9 @@ class Morpho(BaseSDK):
     async def markets_async(
         self,
         *,
-        chain: models.MorphoMarketsChain = models.MorphoMarketsChain.ETHEREUM_MAINNET,
+        chain: Optional[
+            models.MorphoMarketsChain
+        ] = models.MorphoMarketsChain.ETHEREUM_MAINNET,
         collateral_token: OptionalNullable[str] = UNSET,
         loan_token: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -552,7 +564,7 @@ class Morpho(BaseSDK):
         Each market has one unique token that can be borrowed against one unique token that
         can be used as collateral.
 
-        :param chain: The chain to use.
+        :param chain:
         :param collateral_token:
         :param loan_token:
         :param retries: Override the default retry configuration for this method
@@ -643,9 +655,11 @@ class Morpho(BaseSDK):
     def market_position(
         self,
         *,
-        chain: models.MorphoMarketPositionChain = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         unique_market_key: str = "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
+        chain: Optional[
+            models.MorphoMarketPositionChain
+        ] = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -656,9 +670,9 @@ class Morpho(BaseSDK):
         Check how many shares you've borrowed and the equivalent token amount of a given
         market.
 
-        :param chain: The chain to use.
         :param user_address:
         :param unique_market_key:
+        :param chain:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -749,9 +763,11 @@ class Morpho(BaseSDK):
     async def market_position_async(
         self,
         *,
-        chain: models.MorphoMarketPositionChain = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         unique_market_key: str = "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
+        chain: Optional[
+            models.MorphoMarketPositionChain
+        ] = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -762,9 +778,9 @@ class Morpho(BaseSDK):
         Check how many shares you've borrowed and the equivalent token amount of a given
         market.
 
-        :param chain: The chain to use.
         :param user_address:
         :param unique_market_key:
+        :param chain:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -860,7 +876,7 @@ class Morpho(BaseSDK):
             models.MorphoSetVaultAllowanceRequestAmount,
             models.MorphoSetVaultAllowanceRequestAmountTypedDict,
         ],
-        chain: models.Chain,
+        chain: models.MorphoSetVaultAllowanceRequestChain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -877,7 +893,7 @@ class Morpho(BaseSDK):
 
         :param vault_address: The vault address you are increasing the allowance for.
         :param amount: The amount of tokens to increase the allowance by.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -976,7 +992,7 @@ class Morpho(BaseSDK):
             models.MorphoSetVaultAllowanceRequestAmount,
             models.MorphoSetVaultAllowanceRequestAmountTypedDict,
         ],
-        chain: models.Chain,
+        chain: models.MorphoSetVaultAllowanceRequestChain,
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -993,7 +1009,7 @@ class Morpho(BaseSDK):
 
         :param vault_address: The vault address you are increasing the allowance for.
         :param amount: The amount of tokens to increase the allowance by.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -1092,7 +1108,7 @@ class Morpho(BaseSDK):
             models.MorphoDepositRequestAmount,
             models.MorphoDepositRequestAmountTypedDict,
         ],
-        chain: models.Chain,
+        chain: models.MorphoDepositRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1116,7 +1132,7 @@ class Morpho(BaseSDK):
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -1217,7 +1233,7 @@ class Morpho(BaseSDK):
             models.MorphoDepositRequestAmount,
             models.MorphoDepositRequestAmountTypedDict,
         ],
-        chain: models.Chain,
+        chain: models.MorphoDepositRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1241,7 +1257,7 @@ class Morpho(BaseSDK):
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -1339,7 +1355,7 @@ class Morpho(BaseSDK):
         *,
         vault_address: str,
         amount: Any,
-        chain: models.Chain,
+        chain: models.MorphoWithdrawRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1363,7 +1379,7 @@ class Morpho(BaseSDK):
 
         :param vault_address: The vault address you are withdrawing from.
         :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the tokens withdrawn. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -1461,7 +1477,7 @@ class Morpho(BaseSDK):
         *,
         vault_address: str,
         amount: Any,
-        chain: models.Chain,
+        chain: models.MorphoWithdrawRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -1485,7 +1501,7 @@ class Morpho(BaseSDK):
 
         :param vault_address: The vault address you are withdrawing from.
         :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the tokens withdrawn. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -1586,7 +1602,7 @@ class Morpho(BaseSDK):
             models.MorphoSupplyCollateralRequestAmountTypedDict,
         ],
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoSupplyCollateralRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         callback_data: OptionalNullable[bytes] = UNSET,
@@ -1606,7 +1622,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address on behalf of whom the supplied collateral is made. Defaults to sender.
         :param callback_data: An optional field for callback byte data that will be triggered upon successful supplying of collateral.
@@ -1709,7 +1725,7 @@ class Morpho(BaseSDK):
             models.MorphoSupplyCollateralRequestAmountTypedDict,
         ],
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoSupplyCollateralRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         callback_data: OptionalNullable[bytes] = UNSET,
@@ -1729,7 +1745,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address on behalf of whom the supplied collateral is made. Defaults to sender.
         :param callback_data: An optional field for callback byte data that will be triggered upon successful supplying of collateral.
@@ -1832,7 +1848,7 @@ class Morpho(BaseSDK):
             models.MorphoWithdrawCollateralRequestAmountTypedDict,
         ],
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoWithdrawCollateralRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         receiver: OptionalNullable[str] = UNSET,
@@ -1852,7 +1868,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address on behalf of whom the withdraw is made. Defaults to sender.
         :param receiver: The address where the withdrawn collateral will be received. Defaults to sender.
@@ -1955,7 +1971,7 @@ class Morpho(BaseSDK):
             models.MorphoWithdrawCollateralRequestAmountTypedDict,
         ],
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoWithdrawCollateralRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         receiver: OptionalNullable[str] = UNSET,
@@ -1975,7 +1991,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to supply to the market as collateral.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address on behalf of whom the withdraw is made. Defaults to sender.
         :param receiver: The address where the withdrawn collateral will be received. Defaults to sender.
@@ -2077,7 +2093,7 @@ class Morpho(BaseSDK):
             models.MorphoBorrowRequestAmount, models.MorphoBorrowRequestAmountTypedDict
         ],
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoBorrowRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         receiver: OptionalNullable[str] = UNSET,
@@ -2100,7 +2116,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to borrow from the market.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address where the collateral is borrowed against. Defaults to sender.
         :param receiver: The address of the receiver of the tokens borrowed. Defaults to the transaction sender.
@@ -2202,7 +2218,7 @@ class Morpho(BaseSDK):
             models.MorphoBorrowRequestAmount, models.MorphoBorrowRequestAmountTypedDict
         ],
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoBorrowRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         receiver: OptionalNullable[str] = UNSET,
@@ -2225,7 +2241,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to borrow from the market.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address where the collateral is borrowed against. Defaults to sender.
         :param receiver: The address of the receiver of the tokens borrowed. Defaults to the transaction sender.
@@ -2325,7 +2341,7 @@ class Morpho(BaseSDK):
         *,
         amount: Any,
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoRepayRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         callback_data: OptionalNullable[bytes] = UNSET,
@@ -2345,7 +2361,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address on behalf of whom the repayment is made. Defaults to sender.
         :param callback_data: An optional field for callback byte data that will be triggered upon successful repaying of debt.
@@ -2445,7 +2461,7 @@ class Morpho(BaseSDK):
         *,
         amount: Any,
         unique_market_key: str,
-        chain: models.Chain,
+        chain: models.MorphoRepayRequestChain,
         sender: str,
         on_behalf_of: OptionalNullable[str] = UNSET,
         callback_data: OptionalNullable[bytes] = UNSET,
@@ -2465,7 +2481,7 @@ class Morpho(BaseSDK):
 
         :param amount: Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param on_behalf_of: The address on behalf of whom the repayment is made. Defaults to sender.
         :param callback_data: An optional field for callback byte data that will be triggered upon successful repaying of debt.