compass_api_sdk 0.0.1__py3-none-any.whl

compass_api_sdk/models/morphosupplycollateralrequest.py

@@ -0,0 +1,91 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+MorphoSupplyCollateralRequestAmountTypedDict = TypeAliasType(
+    "MorphoSupplyCollateralRequestAmountTypedDict", Union[float, str]
+)
+r"""Amount of the token to supply to the market as collateral."""
+
+
+MorphoSupplyCollateralRequestAmount = TypeAliasType(
+    "MorphoSupplyCollateralRequestAmount", Union[float, str]
+)
+r"""Amount of the token to supply to the market as collateral."""
+
+
+class MorphoSupplyCollateralRequestTypedDict(TypedDict):
+    amount: MorphoSupplyCollateralRequestAmountTypedDict
+    r"""Amount of the token to supply to the market as collateral."""
+    unique_market_key: str
+    r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    on_behalf_of: NotRequired[Nullable[str]]
+    r"""The address on behalf of whom the supplied collateral is made. Defaults to sender."""
+    callback_data: NotRequired[Nullable[bytes]]
+    r"""An optional field for callback byte data that will be triggered upon successful supplying of collateral."""
+
+
+class MorphoSupplyCollateralRequest(BaseModel):
+    amount: MorphoSupplyCollateralRequestAmount
+    r"""Amount of the token to supply to the market as collateral."""
+
+    unique_market_key: str
+    r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    on_behalf_of: OptionalNullable[str] = UNSET
+    r"""The address on behalf of whom the supplied collateral is made. Defaults to sender."""
+
+    callback_data: OptionalNullable[bytes] = UNSET
+    r"""An optional field for callback byte data that will be triggered upon successful supplying of collateral."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["on_behalf_of", "callback_data"]
+        nullable_fields = ["on_behalf_of", "callback_data"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk/models/morphovault.py

@@ -0,0 +1,47 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chaininfo import ChainInfo, ChainInfoTypedDict
+from .compass_api_backend_models_morpho_read_response_get_vaults_asset import (
+    CompassAPIBackendModelsMorphoReadResponseGetVaultsAsset,
+    CompassAPIBackendModelsMorphoReadResponseGetVaultsAssetTypedDict,
+)
+from .vaultstate import VaultState, VaultStateTypedDict
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class MorphoVaultTypedDict(TypedDict):
+    address: str
+    symbol: str
+    name: str
+    creation_block_number: int
+    creation_timestamp: int
+    creator_address: str
+    whitelisted: bool
+    asset: CompassAPIBackendModelsMorphoReadResponseGetVaultsAssetTypedDict
+    chain: ChainInfoTypedDict
+    state: VaultStateTypedDict
+
+
+class MorphoVault(BaseModel):
+    address: str
+
+    symbol: str
+
+    name: str
+
+    creation_block_number: Annotated[int, pydantic.Field(alias="creationBlockNumber")]
+
+    creation_timestamp: Annotated[int, pydantic.Field(alias="creationTimestamp")]
+
+    creator_address: Annotated[str, pydantic.Field(alias="creatorAddress")]
+
+    whitelisted: bool
+
+    asset: CompassAPIBackendModelsMorphoReadResponseGetVaultsAsset
+
+    chain: ChainInfo
+
+    state: VaultState

compass_api_sdk/models/morphowithdrawcollateralrequest.py

@@ -0,0 +1,91 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+MorphoWithdrawCollateralRequestAmountTypedDict = TypeAliasType(
+    "MorphoWithdrawCollateralRequestAmountTypedDict", Union[float, str]
+)
+r"""Amount of the token to supply to the market as collateral."""
+
+
+MorphoWithdrawCollateralRequestAmount = TypeAliasType(
+    "MorphoWithdrawCollateralRequestAmount", Union[float, str]
+)
+r"""Amount of the token to supply to the market as collateral."""
+
+
+class MorphoWithdrawCollateralRequestTypedDict(TypedDict):
+    amount: MorphoWithdrawCollateralRequestAmountTypedDict
+    r"""Amount of the token to supply to the market as collateral."""
+    unique_market_key: str
+    r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    on_behalf_of: NotRequired[Nullable[str]]
+    r"""The address on behalf of whom the withdraw is made. Defaults to sender."""
+    receiver: NotRequired[Nullable[str]]
+    r"""The address where the withdrawn collateral will be received. Defaults to sender."""
+
+
+class MorphoWithdrawCollateralRequest(BaseModel):
+    amount: MorphoWithdrawCollateralRequestAmount
+    r"""Amount of the token to supply to the market as collateral."""
+
+    unique_market_key: str
+    r"""The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    on_behalf_of: OptionalNullable[str] = UNSET
+    r"""The address on behalf of whom the withdraw is made. Defaults to sender."""
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address where the withdrawn collateral will be received. Defaults to sender."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["on_behalf_of", "receiver"]
+        nullable_fields = ["on_behalf_of", "receiver"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk/models/morphowithdrawrequest.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Any
+from typing_extensions import NotRequired, TypedDict
+
+
+class MorphoWithdrawRequestTypedDict(TypedDict):
+    vault_address: str
+    r"""The vault address you are withdrawing from."""
+    amount: Any
+    r"""The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    receiver: NotRequired[Nullable[str]]
+    r"""The address which will receive the tokens withdrawn. Defaults to the sender."""
+
+
+class MorphoWithdrawRequest(BaseModel):
+    vault_address: str
+    r"""The vault address you are withdrawing from."""
+
+    amount: Any
+    r"""The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address which will receive the tokens withdrawn. Defaults to the sender."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["receiver"]
+        nullable_fields = ["receiver"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk/models/portfolio.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .tokenbalance import TokenBalance, TokenBalanceTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PortfolioTypedDict(TypedDict):
+    total_value_in_usd: str
+    r"""Total value of the portfolio in USD"""
+    token_balances: List[TokenBalanceTypedDict]
+    r"""List of token balances in the portfolio"""
+
+
+class Portfolio(BaseModel):
+    total_value_in_usd: str
+    r"""Total value of the portfolio in USD"""
+
+    token_balances: List[TokenBalance]
+    r"""List of token balances in the portfolio"""

compass_api_sdk/models/priceresponse.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class PriceResponseTypedDict(TypedDict):
+    token_price_in_usd: str
+    r"""Price of the token in USD"""
+
+
+class PriceResponse(BaseModel):
+    token_price_in_usd: str
+    r"""Price of the token in USD"""

compass_api_sdk/models/security.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import FieldMetadata, SecurityMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class SecurityTypedDict(TypedDict):
+    api_key_auth: str
+
+
+class Security(BaseModel):
+    api_key_auth: Annotated[
+        str,
+        FieldMetadata(
+            security=SecurityMetadata(
+                scheme=True,
+                scheme_type="apiKey",
+                sub_type="header",
+                field_name="x-api-key",
+            )
+        ),
+    ]

compass_api_sdk/models/token_addressop.py

@@ -0,0 +1,98 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TokenAddressChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class TokenAddressToken(str, Enum):
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+    ONE_INCH = "1INCH"
+    AAVE = "AAVE"
+    BAL = "BAL"
+    CB_BTC = "cbBTC"
+    CB_ETH = "cbETH"
+    CRV = "CRV"
+    CRV_USD = "crvUSD"
+    DAI = "DAI"
+    ENS = "ENS"
+    ET_HX = "ETHx"
+    FRAX = "FRAX"
+    FXS = "FXS"
+    GHO = "GHO"
+    KNC = "KNC"
+    LDO = "LDO"
+    LINK = "LINK"
+    LUSD = "LUSD"
+    MKR = "MKR"
+    OS_ETH = "osETH"
+    PYUSD = "PYUSD"
+    R_ETH = "rETH"
+    RPL = "RPL"
+    RS_ETH = "rsETH"
+    S_DAI = "sDAI"
+    SNX = "SNX"
+    STG = "STG"
+    S_US_DE = "sUSDe"
+    T_BTC = "tBTC"
+    UNI = "UNI"
+    USDC = "USDC"
+    US_DE = "USDe"
+    USDS = "USDS"
+    USDT = "USDT"
+    WBTC = "WBTC"
+    WE_ETH = "weETH"
+    WETH = "WETH"
+    WST_ETH = "wstETH"
+    ARB = "ARB"
+    EURS = "EURS"
+    MAI = "MAI"
+    USD_CE = "USDCe"
+    AERO = "AERO"
+    EUR = "EUR"
+    VIRTUAL = "VIRTUAL"
+
+
+class TokenAddressRequestTypedDict(TypedDict):
+    chain: NotRequired[TokenAddressChain]
+    r"""The chain to use."""
+    token: NotRequired[TokenAddressToken]
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+
+class TokenAddressRequest(BaseModel):
+    chain: Annotated[
+        Optional[TokenAddressChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = TokenAddressChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token: Annotated[
+        Optional[TokenAddressToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = TokenAddressToken.WETH
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """

compass_api_sdk/models/token_balanceop.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .token_enum import TokenEnum
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+from typing import Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+class TokenBalanceChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+TokenBalanceTokenTypedDict = TypeAliasType(
+    "TokenBalanceTokenTypedDict", Union[TokenEnum, str]
+)
+
+
+TokenBalanceToken = TypeAliasType("TokenBalanceToken", Union[TokenEnum, str])
+
+
+class TokenBalanceRequestTypedDict(TypedDict):
+    token: TokenBalanceTokenTypedDict
+    chain: TokenBalanceChain
+    r"""The chain to use."""
+    user: str
+
+
+class TokenBalanceRequest(BaseModel):
+    token: Annotated[
+        TokenBalanceToken,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+
+    chain: Annotated[
+        TokenBalanceChain,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = TokenBalanceChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

compass_api_sdk/models/token_enum.py

@@ -0,0 +1,57 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class TokenEnum(str, Enum):
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+    ONE_INCH = "1INCH"
+    AAVE = "AAVE"
+    BAL = "BAL"
+    CB_BTC = "cbBTC"
+    CB_ETH = "cbETH"
+    CRV = "CRV"
+    CRV_USD = "crvUSD"
+    DAI = "DAI"
+    ENS = "ENS"
+    ET_HX = "ETHx"
+    FRAX = "FRAX"
+    FXS = "FXS"
+    GHO = "GHO"
+    KNC = "KNC"
+    LDO = "LDO"
+    LINK = "LINK"
+    LUSD = "LUSD"
+    MKR = "MKR"
+    OS_ETH = "osETH"
+    PYUSD = "PYUSD"
+    R_ETH = "rETH"
+    RPL = "RPL"
+    RS_ETH = "rsETH"
+    S_DAI = "sDAI"
+    SNX = "SNX"
+    STG = "STG"
+    S_US_DE = "sUSDe"
+    T_BTC = "tBTC"
+    UNI = "UNI"
+    USDC = "USDC"
+    US_DE = "USDe"
+    USDS = "USDS"
+    USDT = "USDT"
+    WBTC = "WBTC"
+    WE_ETH = "weETH"
+    WETH = "WETH"
+    WST_ETH = "wstETH"
+    ARB = "ARB"
+    EURS = "EURS"
+    MAI = "MAI"
+    USD_CE = "USDCe"
+    AERO = "AERO"
+    EUR = "EUR"
+    VIRTUAL = "VIRTUAL"

compass_api_sdk/models/token_priceop.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+from typing_extensions import Annotated, TypedDict
+
+
+class TokenPriceChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class TokenPriceToken(str, Enum):
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+    ONE_INCH = "1INCH"
+    AAVE = "AAVE"
+    BAL = "BAL"
+    CB_BTC = "cbBTC"
+    CB_ETH = "cbETH"
+    CRV = "CRV"
+    CRV_USD = "crvUSD"
+    DAI = "DAI"
+    ENS = "ENS"
+    ET_HX = "ETHx"
+    FRAX = "FRAX"
+    FXS = "FXS"
+    GHO = "GHO"
+    KNC = "KNC"
+    LDO = "LDO"
+    LINK = "LINK"
+    LUSD = "LUSD"
+    MKR = "MKR"
+    OS_ETH = "osETH"
+    PYUSD = "PYUSD"
+    R_ETH = "rETH"
+    RPL = "RPL"
+    RS_ETH = "rsETH"
+    S_DAI = "sDAI"
+    SNX = "SNX"
+    STG = "STG"
+    S_US_DE = "sUSDe"
+    T_BTC = "tBTC"
+    UNI = "UNI"
+    USDC = "USDC"
+    US_DE = "USDe"
+    USDS = "USDS"
+    USDT = "USDT"
+    WBTC = "WBTC"
+    WE_ETH = "weETH"
+    WETH = "WETH"
+    WST_ETH = "wstETH"
+    ARB = "ARB"
+    EURS = "EURS"
+    MAI = "MAI"
+    USD_CE = "USDCe"
+    AERO = "AERO"
+    EUR = "EUR"
+    VIRTUAL = "VIRTUAL"
+
+
+class TokenPriceRequestTypedDict(TypedDict):
+    chain: TokenPriceChain
+    r"""The chain to use."""
+    token: TokenPriceToken
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """
+
+
+class TokenPriceRequest(BaseModel):
+    chain: Annotated[
+        TokenPriceChain,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = TokenPriceChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token: Annotated[
+        TokenPriceToken,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = TokenPriceToken.WBTC
+    r"""A class representing the token.
+
+    This class is used to represent the token in the system. Notice individual
+    endpoints' documentation where per chain tokens are presented.
+    """

compass_api_sdk/models/tokenaddressresponse.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class TokenAddressResponseTypedDict(TypedDict):
+    address: str
+    r"""Address of the token provided"""
+
+
+class TokenAddressResponse(BaseModel):
+    address: str
+    r"""Address of the token provided"""