compass_api_sdk 0.0.1__py3-none-any.whl

compass_api_sdk/models/generic_allowanceop.py

@@ -0,0 +1,121 @@
+"""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 GenericAllowanceChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericAllowanceToken(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 GenericAllowanceContractName(str, Enum):
+    AAVE_V3_POOL = "AaveV3Pool"
+    AERODROME_BASIC_ROUTER = "AerodromeBasicRouter"
+    AERODROME_SLIPSTREAM_ROUTER = "AerodromeSlipstreamRouter"
+    AERODROME_SLIPSTREAM_NONFUNGIBLE_POSITION_MANAGER = (
+        "AerodromeSlipstreamNonfungiblePositionManager"
+    )
+    UNISWAP_V3_ROUTER = "UniswapV3Router"
+    UNISWAP_V3_NFT_POSITION_MANAGER = "UniswapV3NFTPositionManager"
+
+
+class GenericAllowanceRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericAllowanceChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+    token: NotRequired[GenericAllowanceToken]
+    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.
+    """
+    contract_name: GenericAllowanceContractName
+
+
+class GenericAllowanceRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericAllowanceChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericAllowanceChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
+
+    token: Annotated[
+        Optional[GenericAllowanceToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericAllowanceToken.USDC
+    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.
+    """
+
+    contract_name: Annotated[
+        GenericAllowanceContractName,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericAllowanceContractName.AAVE_V3_POOL

compass_api_sdk/models/generic_balanceop.py

@@ -0,0 +1,104 @@
+"""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 GenericBalanceChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericBalanceToken(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 GenericBalanceRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericBalanceChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+    token: NotRequired[GenericBalanceToken]
+    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 GenericBalanceRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericBalanceChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericBalanceChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
+
+    token: Annotated[
+        Optional[GenericBalanceToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericBalanceToken.USDC
+    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/generic_ensop.py

@@ -0,0 +1,35 @@
+"""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 GenericEnsChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericEnsRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericEnsChain]
+    r"""The chain to use."""
+    ens_name: NotRequired[str]
+
+
+class GenericEnsRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericEnsChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericEnsChain.ETHEREUM_MAINNET
+    r"""The chain to use."""
+
+    ens_name: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "vitalik.eth"

compass_api_sdk/models/generic_portfolioop.py

@@ -0,0 +1,35 @@
+"""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 GenericPortfolioChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericPortfolioRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericPortfolioChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+
+
+class GenericPortfolioRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericPortfolioChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericPortfolioChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

compass_api_sdk/models/generic_price_usdop.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 GenericPriceUsdChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericPriceUsdToken(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 GenericPriceUsdRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericPriceUsdChain]
+    r"""The chain to use."""
+    token: NotRequired[GenericPriceUsdToken]
+    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 GenericPriceUsdRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericPriceUsdChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericPriceUsdChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token: Annotated[
+        Optional[GenericPriceUsdToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericPriceUsdToken.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/generic_supported_tokensop.py

@@ -0,0 +1,29 @@
+"""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 GenericSupportedTokensChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericSupportedTokensRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericSupportedTokensChain]
+    r"""The chain to use."""
+
+
+class GenericSupportedTokensRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericSupportedTokensChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericSupportedTokensChain.ARBITRUM_MAINNET
+    r"""The chain to use."""

compass_api_sdk/models/generic_visualize_portfolioop.py

@@ -0,0 +1,35 @@
+"""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 GenericVisualizePortfolioChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class GenericVisualizePortfolioRequestTypedDict(TypedDict):
+    chain: NotRequired[GenericVisualizePortfolioChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+
+
+class GenericVisualizePortfolioRequest(BaseModel):
+    chain: Annotated[
+        Optional[GenericVisualizePortfolioChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = GenericVisualizePortfolioChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

compass_api_sdk/models/image.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 ImageTypedDict(TypedDict):
+    image: str
+    r"""Base64 encoded SVG image"""
+
+
+class Image(BaseModel):
+    image: str
+    r"""Base64 encoded SVG image"""

compass_api_sdk/models/increaseallowancerequest.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .token_enum import TokenEnum
+from compass_api_sdk.types import BaseModel
+from enum import Enum
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+class ContractName(str, Enum):
+    r"""The name of the contract to increase allowance for."""
+
+    AAVE_V3_POOL = "AaveV3Pool"
+    AERODROME_BASIC_ROUTER = "AerodromeBasicRouter"
+    AERODROME_SLIPSTREAM_ROUTER = "AerodromeSlipstreamRouter"
+    AERODROME_SLIPSTREAM_NONFUNGIBLE_POSITION_MANAGER = (
+        "AerodromeSlipstreamNonfungiblePositionManager"
+    )
+    UNISWAP_V3_ROUTER = "UniswapV3Router"
+    UNISWAP_V3_NFT_POSITION_MANAGER = "UniswapV3NFTPositionManager"
+    MORPHO = "Morpho"
+
+
+IncreaseAllowanceRequestAmountTypedDict = TypeAliasType(
+    "IncreaseAllowanceRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of tokens to increase the allowance by."""
+
+
+IncreaseAllowanceRequestAmount = TypeAliasType(
+    "IncreaseAllowanceRequestAmount", Union[float, str]
+)
+r"""The amount of tokens to increase the allowance by."""
+
+
+class IncreaseAllowanceRequestTypedDict(TypedDict):
+    r"""Request model for increasing token allowance for a contract."""
+
+    token: TokenEnum
+    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.
+    """
+    contract_name: ContractName
+    r"""The name of the contract to increase allowance for."""
+    amount: IncreaseAllowanceRequestAmountTypedDict
+    r"""The amount of tokens to increase the allowance by."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class IncreaseAllowanceRequest(BaseModel):
+    r"""Request model for increasing token allowance for a contract."""
+
+    token: TokenEnum
+    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.
+    """
+
+    contract_name: ContractName
+    r"""The name of the contract to increase allowance for."""
+
+    amount: IncreaseAllowanceRequestAmount
+    r"""The amount of tokens to increase the allowance by."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""

compass_api_sdk/models/interestratemode.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class InterestRateMode(str, Enum):
+    r"""On AAVE there are 2 different interest modes.
+
+    A stable (but typically higher rate), or a variable rate.
+    """
+
+    STABLE = "stable"
+    VARIABLE = "variable"

compass_api_sdk/models/marketstate.py

@@ -0,0 +1,35 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class MarketStateTypedDict(TypedDict):
+    borrow_apy: float
+    borrow_assets: int
+    borrow_assets_usd: float
+    supply_apy: float
+    supply_assets: int
+    supply_assets_usd: float
+    fee: float
+    utilization: float
+
+
+class MarketState(BaseModel):
+    borrow_apy: Annotated[float, pydantic.Field(alias="borrowApy")]
+
+    borrow_assets: Annotated[int, pydantic.Field(alias="borrowAssets")]
+
+    borrow_assets_usd: Annotated[float, pydantic.Field(alias="borrowAssetsUsd")]
+
+    supply_apy: Annotated[float, pydantic.Field(alias="supplyApy")]
+
+    supply_assets: Annotated[int, pydantic.Field(alias="supplyAssets")]
+
+    supply_assets_usd: Annotated[float, pydantic.Field(alias="supplyAssetsUsd")]
+
+    fee: float
+
+    utilization: float

compass_api_sdk/models/morpho_market_positionop.py

@@ -0,0 +1,39 @@
+"""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 MorphoMarketPositionChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class MorphoMarketPositionRequestTypedDict(TypedDict):
+    chain: NotRequired[MorphoMarketPositionChain]
+    r"""The chain to use."""
+    user_address: str
+    unique_market_key: str
+
+
+class MorphoMarketPositionRequest(BaseModel):
+    chain: Annotated[
+        Optional[MorphoMarketPositionChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = MorphoMarketPositionChain.ETHEREUM_MAINNET
+    r"""The chain to use."""
+
+    user_address: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B"
+
+    unique_market_key: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4"