compass_api_sdk 0.0.1__py3-none-any.whl

compass_api_sdk/models/uniswapmintliquidityprovisionrequest.py

@@ -0,0 +1,185 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .feeenum import FeeEnum
+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
+
+
+UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict", Union[float, str]
+)
+r"""The desired amount of the first token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount0Desired = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount0Desired", Union[float, str]
+)
+r"""The desired amount of the first token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict", Union[float, str]
+)
+r"""The desired amount of the second token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount1Desired = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount1Desired", Union[float, str]
+)
+r"""The desired amount of the second token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount0MinTypedDict = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount0MinTypedDict", Union[float, str]
+)
+r"""The minimum amount of the first token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount0Min = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount0Min", Union[float, str]
+)
+r"""The minimum amount of the first token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount1MinTypedDict = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount1MinTypedDict", Union[float, str]
+)
+r"""The minimum amount of the second token to deposit"""
+
+
+UniswapMintLiquidityProvisionRequestAmount1Min = TypeAliasType(
+    "UniswapMintLiquidityProvisionRequestAmount1Min", Union[float, str]
+)
+r"""The minimum amount of the second token to deposit"""
+
+
+class UniswapMintLiquidityProvisionRequestTypedDict(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.
+    """
+    fee: FeeEnum
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """
+    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: UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict
+    r"""The desired amount of the first token to deposit"""
+    amount1_desired: UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict
+    r"""The desired amount of the second token to deposit"""
+    amount0_min: UniswapMintLiquidityProvisionRequestAmount0MinTypedDict
+    r"""The minimum amount of the first token to deposit"""
+    amount1_min: UniswapMintLiquidityProvisionRequestAmount1MinTypedDict
+    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 UniswapMintLiquidityProvisionRequest(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.
+    """
+
+    fee: FeeEnum
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """
+
+    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: UniswapMintLiquidityProvisionRequestAmount0Desired
+    r"""The desired amount of the first token to deposit"""
+
+    amount1_desired: UniswapMintLiquidityProvisionRequestAmount1Desired
+    r"""The desired amount of the second token to deposit"""
+
+    amount0_min: UniswapMintLiquidityProvisionRequestAmount0Min
+    r"""The minimum amount of the first token to deposit"""
+
+    amount1_min: UniswapMintLiquidityProvisionRequestAmount1Min
+    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/uniswappoolpriceresponse.py

@@ -0,0 +1,47 @@
+"""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 UniswapPoolPriceResponseTypedDict(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 instantanteous 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 uniswap v3 concentrated liquidity concept."""
+
+
+class UniswapPoolPriceResponse(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 instantanteous 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 uniswap v3 concentrated liquidity concept."""

compass_api_sdk/models/uniswappositionssolidityresponse.py

@@ -0,0 +1,46 @@
+"""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 UniswapPositionsSolidityResponseTypedDict(TypedDict):
+    nonce: int
+    operator: str
+    token0: str
+    token1: str
+    fee: int
+    tick_lower: int
+    tick_upper: int
+    liquidity: int
+    fee_growth_inside0_last_x128: int
+    fee_growth_inside1_last_x128: int
+    tokens_owed0: int
+    tokens_owed1: int
+
+
+class UniswapPositionsSolidityResponse(BaseModel):
+    nonce: int
+
+    operator: str
+
+    token0: str
+
+    token1: str
+
+    fee: int
+
+    tick_lower: int
+
+    tick_upper: int
+
+    liquidity: int
+
+    fee_growth_inside0_last_x128: int
+
+    fee_growth_inside1_last_x128: int
+
+    tokens_owed0: int
+
+    tokens_owed1: int

compass_api_sdk/models/uniswapsellexactlyrequest.py

@@ -0,0 +1,104 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .feeenum import FeeEnum
+from .token_enum import TokenEnum
+from compass_api_sdk.types import BaseModel
+from typing import Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+UniswapSellExactlyRequestAmountInTypedDict = TypeAliasType(
+    "UniswapSellExactlyRequestAmountInTypedDict", Union[float, str]
+)
+r"""The amount of the token to swap from"""
+
+
+UniswapSellExactlyRequestAmountIn = TypeAliasType(
+    "UniswapSellExactlyRequestAmountIn", Union[float, str]
+)
+r"""The amount of the token to swap from"""
+
+
+UniswapSellExactlyRequestAmountOutMinimumTypedDict = TypeAliasType(
+    "UniswapSellExactlyRequestAmountOutMinimumTypedDict", Union[float, str]
+)
+r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+UniswapSellExactlyRequestAmountOutMinimum = TypeAliasType(
+    "UniswapSellExactlyRequestAmountOutMinimum", Union[float, str]
+)
+r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+class UniswapSellExactlyRequestTypedDict(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.
+    """
+    fee: FeeEnum
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """
+    amount_in: UniswapSellExactlyRequestAmountInTypedDict
+    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[UniswapSellExactlyRequestAmountOutMinimumTypedDict]
+    r"""The minimum amount of the token to swap to, defaults to 0"""
+    wrap_eth: NotRequired[bool]
+    r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""
+
+
+class UniswapSellExactlyRequest(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.
+    """
+
+    fee: FeeEnum
+    r"""The transaction fee of a Uniswap pool in bips.
+
+    Uniswap supports 4 different fee levels.
+    """
+
+    amount_in: UniswapSellExactlyRequestAmountIn
+    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[UniswapSellExactlyRequestAmountOutMinimum] = None
+    r"""The minimum amount of the token to swap to, defaults to 0"""
+
+    wrap_eth: Optional[bool] = False
+    r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""

compass_api_sdk/models/uniswapsellquoteinforesponse.py

@@ -0,0 +1,20 @@
+"""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 UniswapSellQuoteInfoResponseTypedDict(TypedDict):
+    amount_out: str
+    r"""The amount of token_out you would receive from the pool."""
+    price_after: str
+    r"""The price of the pool after this trade would happen. (How much token0 you need to buy 1 token1.)"""
+
+
+class UniswapSellQuoteInfoResponse(BaseModel):
+    amount_out: str
+    r"""The amount of token_out you would receive from the pool."""
+
+    price_after: str
+    r"""The price of the pool after this trade would happen. (How much token0 you need to buy 1 token1.)"""

compass_api_sdk/models/uniswapwithdrawliquidityprovisionrequest.py

@@ -0,0 +1,51 @@
+"""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
+
+
+UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict = (
+    TypeAliasType(
+        "UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict",
+        Union[float, str],
+    )
+)
+r"""How much liquidity to take out in percentage."""
+
+
+UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal = TypeAliasType(
+    "UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal", Union[float, str]
+)
+r"""How much liquidity to take out in percentage."""
+
+
+class UniswapWithdrawLiquidityProvisionRequestTypedDict(TypedDict):
+    token_id: int
+    r"""Token ID of the NFT representing the liquidity provisioned position."""
+    percentage_for_withdrawal: (
+        UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict
+    )
+    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 UniswapWithdrawLiquidityProvisionRequest(BaseModel):
+    token_id: int
+    r"""Token ID of the NFT representing the liquidity provisioned position."""
+
+    percentage_for_withdrawal: (
+        UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal
+    )
+    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/unsignedtransaction.py

@@ -0,0 +1,58 @@
+"""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 UnsignedTransactionTypedDict(TypedDict):
+    chain_id: int
+    r"""The chain id of the transaction"""
+    data: str
+    r"""The data of the transaction"""
+    from_: str
+    r"""The sender of the transaction"""
+    gas: int
+    r"""The gas of the transaction"""
+    to: str
+    r"""The recipient of the transaction"""
+    value: int
+    r"""The value of the transaction"""
+    nonce: int
+    r"""The nonce of the address"""
+    max_fee_per_gas: int
+    r"""The max fee per gas of the transaction"""
+    max_priority_fee_per_gas: int
+    r"""The max priority fee per gas of the transaction"""
+
+
+class UnsignedTransaction(BaseModel):
+    chain_id: Annotated[int, pydantic.Field(alias="chainId")]
+    r"""The chain id of the transaction"""
+
+    data: str
+    r"""The data of the transaction"""
+
+    from_: Annotated[str, pydantic.Field(alias="from")]
+    r"""The sender of the transaction"""
+
+    gas: int
+    r"""The gas of the transaction"""
+
+    to: str
+    r"""The recipient of the transaction"""
+
+    value: int
+    r"""The value of the transaction"""
+
+    nonce: int
+    r"""The nonce of the address"""
+
+    max_fee_per_gas: Annotated[int, pydantic.Field(alias="maxFeePerGas")]
+    r"""The max fee per gas of the transaction"""
+
+    max_priority_fee_per_gas: Annotated[
+        int, pydantic.Field(alias="maxPriorityFeePerGas")
+    ]
+    r"""The max priority fee per gas of the transaction"""

compass_api_sdk/models/unwrapwethrequest.py

@@ -0,0 +1,41 @@
+"""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
+
+
+UnwrapWethRequestAmountTypedDict = TypeAliasType(
+    "UnwrapWethRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of WETH to unwrap."""
+
+
+UnwrapWethRequestAmount = TypeAliasType("UnwrapWethRequestAmount", Union[float, str])
+r"""The amount of WETH to unwrap."""
+
+
+class UnwrapWethRequestTypedDict(TypedDict):
+    r"""Request model for unwrapping WETH back to native ETH."""
+
+    amount: UnwrapWethRequestAmountTypedDict
+    r"""The amount of WETH to unwrap."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class UnwrapWethRequest(BaseModel):
+    r"""Request model for unwrapping WETH back to native ETH."""
+
+    amount: UnwrapWethRequestAmount
+    r"""The amount of WETH to unwrap."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""

compass_api_sdk/models/validationerror.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing import List, Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+LocTypedDict = TypeAliasType("LocTypedDict", Union[str, int])
+
+
+Loc = TypeAliasType("Loc", Union[str, int])
+
+
+class ValidationErrorTypedDict(TypedDict):
+    loc: List[LocTypedDict]
+    msg: str
+    type: str
+
+
+class ValidationError(BaseModel):
+    loc: List[Loc]
+
+    msg: str
+
+    type: str

compass_api_sdk/models/vaultstate.py

@@ -0,0 +1,32 @@
+"""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 VaultStateTypedDict(TypedDict):
+    id: str
+    apy: float
+    net_apy: float
+    total_assets: int
+    total_assets_usd: float
+    fee: float
+    timelock: int
+
+
+class VaultState(BaseModel):
+    id: str
+
+    apy: float
+
+    net_apy: Annotated[float, pydantic.Field(alias="netApy")]
+
+    total_assets: Annotated[int, pydantic.Field(alias="totalAssets")]
+
+    total_assets_usd: Annotated[float, pydantic.Field(alias="totalAssetsUsd")]
+
+    fee: float
+
+    timelock: int

compass_api_sdk/models/weeklyapys.py

@@ -0,0 +1,23 @@
+"""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 WeeklyApysTypedDict(TypedDict):
+    supply_apy: float
+    net_supply_apy: float
+    borrow_apy: float
+    net_borrow_apy: float
+
+
+class WeeklyApys(BaseModel):
+    supply_apy: Annotated[float, pydantic.Field(alias="supplyApy")]
+
+    net_supply_apy: Annotated[float, pydantic.Field(alias="netSupplyApy")]
+
+    borrow_apy: Annotated[float, pydantic.Field(alias="borrowApy")]
+
+    net_borrow_apy: Annotated[float, pydantic.Field(alias="netBorrowApy")]

compass_api_sdk/models/wrapethrequest.py

@@ -0,0 +1,41 @@
+"""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
+
+
+WrapEthRequestAmountTypedDict = TypeAliasType(
+    "WrapEthRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of ETH to wrap."""
+
+
+WrapEthRequestAmount = TypeAliasType("WrapEthRequestAmount", Union[float, str])
+r"""The amount of ETH to wrap."""
+
+
+class WrapEthRequestTypedDict(TypedDict):
+    r"""Request model for wrapping ETH into WETH."""
+
+    amount: WrapEthRequestAmountTypedDict
+    r"""The amount of ETH to wrap."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+
+
+class WrapEthRequest(BaseModel):
+    r"""Request model for wrapping ETH into WETH."""
+
+    amount: WrapEthRequestAmount
+    r"""The amount of ETH to wrap."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""