compass_api_sdk 0.0.1__py3-none-any.whl

compass_api_sdk/models/aerodromeslipstreammintliquidityprovisionrequest.py

@@ -0,0 +1,186 @@
+"""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,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount0DesiredTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount0DesiredTypedDict",
+    Union[float, str],
+)
+r"""The desired amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Desired = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Desired", Union[float, str]
+)
+r"""The desired amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount1DesiredTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount1DesiredTypedDict",
+    Union[float, str],
+)
+r"""The desired amount of the second token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Desired = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Desired", Union[float, str]
+)
+r"""The desired amount of the second token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount0MinTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount0MinTypedDict",
+    Union[float, str],
+)
+r"""The minimum amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Min = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Min", Union[float, str]
+)
+r"""The minimum amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount1MinTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount1MinTypedDict",
+    Union[float, str],
+)
+r"""The minimum amount of the second token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Min = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Min", Union[float, str]
+)
+r"""The minimum amount of the second token to deposit"""
+
+
+class AerodromeSlipstreamMintLiquidityProvisionRequestTypedDict(TypedDict):
+    r"""Request model for minting a new liquidity position."""
+
+    token0: 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.
+    """
+    token1: 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.
+    """
+    tick_spacing: int
+    r"""The tick spacing of the pool"""
+    tick_lower: int
+    r"""The lower tick of the range to mint the position in"""
+    tick_upper: int
+    r"""The upper tick of the range to mint the position in"""
+    amount0_desired: (
+        AerodromeSlipstreamMintLiquidityProvisionRequestAmount0DesiredTypedDict
+    )
+    r"""The desired amount of the first token to deposit"""
+    amount1_desired: (
+        AerodromeSlipstreamMintLiquidityProvisionRequestAmount1DesiredTypedDict
+    )
+    r"""The desired amount of the second token to deposit"""
+    amount0_min: AerodromeSlipstreamMintLiquidityProvisionRequestAmount0MinTypedDict
+    r"""The minimum amount of the first token to deposit"""
+    amount1_min: AerodromeSlipstreamMintLiquidityProvisionRequestAmount1MinTypedDict
+    r"""The minimum amount of the second token to deposit"""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    recipient: NotRequired[Nullable[str]]
+    r"""The address that will receive the LP tokens"""
+
+
+class AerodromeSlipstreamMintLiquidityProvisionRequest(BaseModel):
+    r"""Request model for minting a new liquidity position."""
+
+    token0: 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.
+    """
+
+    token1: 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.
+    """
+
+    tick_spacing: int
+    r"""The tick spacing of the pool"""
+
+    tick_lower: int
+    r"""The lower tick of the range to mint the position in"""
+
+    tick_upper: int
+    r"""The upper tick of the range to mint the position in"""
+
+    amount0_desired: AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Desired
+    r"""The desired amount of the first token to deposit"""
+
+    amount1_desired: AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Desired
+    r"""The desired amount of the second token to deposit"""
+
+    amount0_min: AerodromeSlipstreamMintLiquidityProvisionRequestAmount0Min
+    r"""The minimum amount of the first token to deposit"""
+
+    amount1_min: AerodromeSlipstreamMintLiquidityProvisionRequestAmount1Min
+    r"""The minimum amount of the second token to deposit"""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    recipient: OptionalNullable[str] = UNSET
+    r"""The address that will receive the LP tokens"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["recipient"]
+        nullable_fields = ["recipient"]
+        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/aerodromeslipstreampoolpriceresponse.py

@@ -0,0 +1,57 @@
+"""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 AerodromeSlipstreamPoolPriceResponseTypedDict(TypedDict):
+    token_in: 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_out: 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.
+    """
+    price: str
+    r"""The price of the pool. This is expressed as an instantaneous amount of how
+    many token0 you need to buy 1 token1. In any swap this will not change during the trade; use
+    the quote endpoint to get a better idea of how much you will pay!
+    """
+    tick: int
+    r"""The current tick in the pool. This is a number that represents the price of
+    the pool according to the aerodrome_slipstream v3 concentrated liquidity concept.
+    """
+
+
+class AerodromeSlipstreamPoolPriceResponse(BaseModel):
+    token_in: 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_out: 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.
+    """
+
+    price: str
+    r"""The price of the pool. This is expressed as an instantaneous amount of how
+    many token0 you need to buy 1 token1. In any swap this will not change during the trade; use
+    the quote endpoint to get a better idea of how much you will pay!
+    """
+
+    tick: int
+    r"""The current tick in the pool. This is a number that represents the price of
+    the pool according to the aerodrome_slipstream v3 concentrated liquidity concept.
+    """

compass_api_sdk/models/aerodromeslipstreamsellexactlyrequest.py

@@ -0,0 +1,96 @@
+"""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 Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AerodromeSlipstreamSellExactlyRequestAmountInTypedDict = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyRequestAmountInTypedDict", Union[float, str]
+)
+r"""The amount of the token to swap from"""
+
+
+AerodromeSlipstreamSellExactlyRequestAmountIn = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyRequestAmountIn", Union[float, str]
+)
+r"""The amount of the token to swap from"""
+
+
+AerodromeSlipstreamSellExactlyRequestAmountOutMinimumTypedDict = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyRequestAmountOutMinimumTypedDict", Union[float, str]
+)
+r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+AerodromeSlipstreamSellExactlyRequestAmountOutMinimum = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyRequestAmountOutMinimum", Union[float, str]
+)
+r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+class AerodromeSlipstreamSellExactlyRequestTypedDict(TypedDict):
+    r"""Request model for selling exactly an amount of tokens."""
+
+    token_in: 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_out: 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.
+    """
+    tick_spacing: int
+    r"""The tick spacing of the pool"""
+    amount_in: AerodromeSlipstreamSellExactlyRequestAmountInTypedDict
+    r"""The amount of the token to swap from"""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    amount_out_minimum: NotRequired[
+        AerodromeSlipstreamSellExactlyRequestAmountOutMinimumTypedDict
+    ]
+    r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+class AerodromeSlipstreamSellExactlyRequest(BaseModel):
+    r"""Request model for selling exactly an amount of tokens."""
+
+    token_in: 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_out: 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.
+    """
+
+    tick_spacing: int
+    r"""The tick spacing of the pool"""
+
+    amount_in: AerodromeSlipstreamSellExactlyRequestAmountIn
+    r"""The amount of the token to swap from"""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    amount_out_minimum: Optional[
+        AerodromeSlipstreamSellExactlyRequestAmountOutMinimum
+    ] = None
+    r"""The minimum amount of the token to swap to, defaults to 0"""

compass_api_sdk/models/aerodromeslipstreamwithdrawliquidityprovisionrequest.py

@@ -0,0 +1,50 @@
+"""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
+
+
+AerodromeSlipstreamWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict = TypeAliasType(
+    "AerodromeSlipstreamWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict",
+    Union[float, str],
+)
+r"""How much liquidity to take out in percentage."""
+
+
+AerodromeSlipstreamWithdrawLiquidityProvisionRequestPercentageForWithdrawal = (
+    TypeAliasType(
+        "AerodromeSlipstreamWithdrawLiquidityProvisionRequestPercentageForWithdrawal",
+        Union[float, str],
+    )
+)
+r"""How much liquidity to take out in percentage."""
+
+
+class AerodromeSlipstreamWithdrawLiquidityProvisionRequestTypedDict(TypedDict):
+    token_id: int
+    r"""Token ID of the NFT representing the liquidity provisioned position."""
+    percentage_for_withdrawal: AerodromeSlipstreamWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict
+    r"""How much liquidity to take out in percentage."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class AerodromeSlipstreamWithdrawLiquidityProvisionRequest(BaseModel):
+    token_id: int
+    r"""Token ID of the NFT representing the liquidity provisioned position."""
+
+    percentage_for_withdrawal: (
+        AerodromeSlipstreamWithdrawLiquidityProvisionRequestPercentageForWithdrawal
+    )
+    r"""How much liquidity to take out in percentage."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""

compass_api_sdk/models/allowanceinforesponse.py

@@ -0,0 +1,48 @@
+"""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 AllowanceInfoResponseTypedDict(TypedDict):
+    r"""Response model for token allowance information."""
+
+    amount: str
+    r"""Amount of tokens allowed to be spent by spender"""
+    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"""
+    contract_address: str
+    r"""Address of the contract"""
+
+
+class AllowanceInfoResponse(BaseModel):
+    r"""Response model for token allowance information."""
+
+    amount: str
+    r"""Amount of tokens allowed to be spent by spender"""
+
+    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"""
+
+    contract_address: str
+    r"""Address of the contract"""

compass_api_sdk/models/balanceinforesponse.py

@@ -0,0 +1,43 @@
+"""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 BalanceInfoResponseTypedDict(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: 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"""
+
+
+class BalanceInfoResponse(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: 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"""

compass_api_sdk/models/chain.py

@@ -0,0 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class Chain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"

compass_api_sdk/models/chaininfo.py

@@ -0,0 +1,53 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class ChainInfoTypedDict(TypedDict):
+    id: int
+    network: NotRequired[Nullable[str]]
+
+
+class ChainInfo(BaseModel):
+    id: int
+
+    network: OptionalNullable[str] = UNSET
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["network"]
+        nullable_fields = ["network"]
+        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/compass_api_backend_models_morpho_read_response_get_markets_asset.py

@@ -0,0 +1,22 @@
+"""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 CompassAPIBackendModelsMorphoReadResponseGetMarketsAssetTypedDict(TypedDict):
+    address: str
+    symbol: str
+    name: str
+    decimals: int
+
+
+class CompassAPIBackendModelsMorphoReadResponseGetMarketsAsset(BaseModel):
+    address: str
+
+    symbol: str
+
+    name: str
+
+    decimals: int

compass_api_sdk/models/compass_api_backend_models_morpho_read_response_get_vaults_asset.py

@@ -0,0 +1,23 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chaininfo import ChainInfo, ChainInfoTypedDict
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class CompassAPIBackendModelsMorphoReadResponseGetVaultsAssetTypedDict(TypedDict):
+    symbol: str
+    address: str
+    decimals: int
+    chain: ChainInfoTypedDict
+
+
+class CompassAPIBackendModelsMorphoReadResponseGetVaultsAsset(BaseModel):
+    symbol: str
+
+    address: str
+
+    decimals: int
+
+    chain: ChainInfo

compass_api_sdk/models/ensnameinforesponse.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 typing_extensions import TypedDict
+
+
+class EnsNameInfoResponseTypedDict(TypedDict):
+    r"""Response model for ENS name details."""
+
+    wallet_address: str
+    r"""The wallet address of the user"""
+    registrant: str
+    r"""The registrant of the ENS"""
+
+
+class EnsNameInfoResponse(BaseModel):
+    r"""Response model for ENS name details."""
+
+    wallet_address: str
+    r"""The wallet address of the user"""
+
+    registrant: str
+    r"""The registrant of the ENS"""

compass_api_sdk/models/feeenum.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class FeeEnum(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"