compass_api_sdk 0.0.1__py3-none-any.whl

compass_api_sdk/models/tokenbalance.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 typing_extensions import TypedDict
+
+
+class TokenBalanceTypedDict(TypedDict):
+    amount: str
+    r"""Amount of tokens a particular address holds"""
+    decimals: int
+    r"""Number of decimals of the token"""
+    token_symbol: 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.
+    """
+    token_address: str
+    r"""Address of the token"""
+    price: str
+    r"""Price of the token in USD"""
+    token_value_in_usd: str
+    r"""Value of the token balance in USD"""
+
+
+class TokenBalance(BaseModel):
+    amount: str
+    r"""Amount of tokens a particular address holds"""
+
+    decimals: int
+    r"""Number of decimals of the token"""
+
+    token_symbol: 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.
+    """
+
+    token_address: str
+    r"""Address of the token"""
+
+    price: str
+    r"""Price of the token in USD"""
+
+    token_value_in_usd: str
+    r"""Value of the token balance in USD"""

compass_api_sdk/models/tokenbalanceresponse.py

@@ -0,0 +1,44 @@
+"""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 typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+TokenSymbolTypedDict = TypeAliasType("TokenSymbolTypedDict", Union[TokenEnum, str])
+r"""Symbol of the token."""
+
+
+TokenSymbol = TypeAliasType("TokenSymbol", Union[TokenEnum, str])
+r"""Symbol of the token."""
+
+
+class TokenBalanceResponseTypedDict(TypedDict):
+    r"""Response model for token balance information."""
+
+    amount: str
+    r"""Amount of tokens a particular address holds"""
+    decimals: int
+    r"""Number of decimals of the token"""
+    token_symbol: TokenSymbolTypedDict
+    r"""Symbol of the token."""
+    token_address: str
+    r"""Address of the token"""
+
+
+class TokenBalanceResponse(BaseModel):
+    r"""Response model for token balance information."""
+
+    amount: str
+    r"""Amount of tokens a particular address holds"""
+
+    decimals: int
+    r"""Number of decimals of the token"""
+
+    token_symbol: TokenSymbol
+    r"""Symbol of the token."""
+
+    token_address: str
+    r"""Address of the token"""

compass_api_sdk/models/tokeninfo.py

@@ -0,0 +1,17 @@
+"""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 typing import List
+from typing_extensions import TypedDict
+
+
+class TokenInfoTypedDict(TypedDict):
+    tokens: List[TokenEnum]
+    r"""List of supported tokens for a given chain"""
+
+
+class TokenInfo(BaseModel):
+    tokens: List[TokenEnum]
+    r"""List of supported tokens for a given chain"""

compass_api_sdk/models/tokenpriceresponse.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 TokenPriceResponseTypedDict(TypedDict):
+    price: str
+    r"""Price of the token in USD"""
+
+
+class TokenPriceResponse(BaseModel):
+    price: str
+    r"""Price of the token in USD"""

compass_api_sdk/models/tokentransferrequest.py

@@ -0,0 +1,66 @@
+"""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 typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+TokenTransferRequestAmountTypedDict = TypeAliasType(
+    "TokenTransferRequestAmountTypedDict", Union[float, str]
+)
+r"""Amount of token to transfer"""
+
+
+TokenTransferRequestAmount = TypeAliasType(
+    "TokenTransferRequestAmount", Union[float, str]
+)
+r"""Amount of token to transfer"""
+
+
+TokenTransferRequestTokenTypedDict = TypeAliasType(
+    "TokenTransferRequestTokenTypedDict", Union[TokenEnum, str]
+)
+r"""The symbol of the token to transfer.."""
+
+
+TokenTransferRequestToken = TypeAliasType(
+    "TokenTransferRequestToken", Union[TokenEnum, str]
+)
+r"""The symbol of the token to transfer.."""
+
+
+class TokenTransferRequestTypedDict(TypedDict):
+    r"""Request model for transferring ETH or ERC20 tokens."""
+
+    amount: TokenTransferRequestAmountTypedDict
+    r"""Amount of token to transfer"""
+    token: TokenTransferRequestTokenTypedDict
+    r"""The symbol of the token to transfer.."""
+    to: str
+    r"""The recipient of the tokens."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class TokenTransferRequest(BaseModel):
+    r"""Request model for transferring ETH or ERC20 tokens."""
+
+    amount: TokenTransferRequestAmount
+    r"""Amount of token to transfer"""
+
+    token: TokenTransferRequestToken
+    r"""The symbol of the token to transfer.."""
+
+    to: str
+    r"""The recipient of the tokens."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""

compass_api_sdk/models/transfererc20request.py

@@ -0,0 +1,62 @@
+"""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 typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+TransferErc20RequestAmountTypedDict = TypeAliasType(
+    "TransferErc20RequestAmountTypedDict", Union[float, str]
+)
+r"""Amount of token to transfer"""
+
+
+TransferErc20RequestAmount = TypeAliasType(
+    "TransferErc20RequestAmount", Union[float, str]
+)
+r"""Amount of token to transfer"""
+
+
+class TransferErc20RequestTypedDict(TypedDict):
+    r"""Request model for transferring ERC20 tokens."""
+
+    amount: TransferErc20RequestAmountTypedDict
+    r"""Amount of token to transfer"""
+    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.
+    """
+    to: str
+    r"""The recipient of the tokens."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class TransferErc20Request(BaseModel):
+    r"""Request model for transferring ERC20 tokens."""
+
+    amount: TransferErc20RequestAmount
+    r"""Amount of token to transfer"""
+
+    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.
+    """
+
+    to: str
+    r"""The recipient of the tokens."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""

compass_api_sdk/models/transferethrequest.py

@@ -0,0 +1,46 @@
+"""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
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+TransferEthRequestAmountTypedDict = TypeAliasType(
+    "TransferEthRequestAmountTypedDict", Union[float, str]
+)
+r"""Amount of ETH to transfer"""
+
+
+TransferEthRequestAmount = TypeAliasType("TransferEthRequestAmount", Union[float, str])
+r"""Amount of ETH to transfer"""
+
+
+class TransferEthRequestTypedDict(TypedDict):
+    r"""Request model for transferring native ETH."""
+
+    amount: TransferEthRequestAmountTypedDict
+    r"""Amount of ETH to transfer"""
+    to: str
+    r"""The recipient of the ETH."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class TransferEthRequest(BaseModel):
+    r"""Request model for transferring native ETH."""
+
+    amount: TransferEthRequestAmount
+    r"""Amount of ETH to transfer"""
+
+    to: str
+    r"""The recipient of the ETH."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""

compass_api_sdk/models/uniswap_liquidity_provision_in_rangeop.py

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

compass_api_sdk/models/uniswap_liquidity_provision_positionsop.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 UniswapLiquidityProvisionPositionsChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class UniswapLiquidityProvisionPositionsRequestTypedDict(TypedDict):
+    chain: NotRequired[UniswapLiquidityProvisionPositionsChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+
+
+class UniswapLiquidityProvisionPositionsRequest(BaseModel):
+    chain: Annotated[
+        Optional[UniswapLiquidityProvisionPositionsChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UniswapLiquidityProvisionPositionsChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

compass_api_sdk/models/uniswap_pool_priceop.py

@@ -0,0 +1,193 @@
+"""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 UniswapPoolPriceChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class UniswapPoolPriceTokenInToken(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 UniswapPoolPriceTokenOutToken(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 UniswapPoolPriceFeeEnum(str, Enum):
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """
+
+    ZERO_DOT_01 = "0.01"
+    ZERO_DOT_05 = "0.05"
+    ZERO_DOT_3 = "0.3"
+    ONE_DOT_0 = "1.0"
+
+
+class UniswapPoolPriceRequestTypedDict(TypedDict):
+    chain: NotRequired[UniswapPoolPriceChain]
+    r"""The chain to use."""
+    token_in: UniswapPoolPriceTokenInToken
+    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.
+    """
+    token_out: UniswapPoolPriceTokenOutToken
+    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.
+    """
+    fee: UniswapPoolPriceFeeEnum
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """
+
+
+class UniswapPoolPriceRequest(BaseModel):
+    chain: Annotated[
+        Optional[UniswapPoolPriceChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UniswapPoolPriceChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token_in: Annotated[
+        UniswapPoolPriceTokenInToken,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UniswapPoolPriceTokenInToken.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.
+    """
+
+    token_out: Annotated[
+        UniswapPoolPriceTokenOutToken,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UniswapPoolPriceTokenOutToken.USDT
+    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.
+    """
+
+    fee: Annotated[
+        UniswapPoolPriceFeeEnum,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UniswapPoolPriceFeeEnum.ZERO_DOT_01
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """