compass_api_sdk 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

compassapisdk/models/aerodromeslipstreammintliquidityprovisionparams.py

@@ -0,0 +1,175 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .token_enum import TokenEnum
+from compassapisdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount0DesiredTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount0DesiredTypedDict",
+    Union[float, str],
+)
+r"""The desired amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount0Desired = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount0Desired", Union[float, str]
+)
+r"""The desired amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount1DesiredTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount1DesiredTypedDict",
+    Union[float, str],
+)
+r"""The desired amount of the second token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount1Desired = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount1Desired", Union[float, str]
+)
+r"""The desired amount of the second token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount0MinTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount0MinTypedDict",
+    Union[float, str],
+)
+r"""The minimum amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount0Min = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount0Min", Union[float, str]
+)
+r"""The minimum amount of the first token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount1MinTypedDict = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount1MinTypedDict",
+    Union[float, str],
+)
+r"""The minimum amount of the second token to deposit"""
+
+
+AerodromeSlipstreamMintLiquidityProvisionParamsAmount1Min = TypeAliasType(
+    "AerodromeSlipstreamMintLiquidityProvisionParamsAmount1Min", Union[float, str]
+)
+r"""The minimum amount of the second token to deposit"""
+
+
+class AerodromeSlipstreamMintLiquidityProvisionParamsTypedDict(TypedDict):
+    r"""Parameters 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: (
+        AerodromeSlipstreamMintLiquidityProvisionParamsAmount0DesiredTypedDict
+    )
+    r"""The desired amount of the first token to deposit"""
+    amount1_desired: (
+        AerodromeSlipstreamMintLiquidityProvisionParamsAmount1DesiredTypedDict
+    )
+    r"""The desired amount of the second token to deposit"""
+    amount0_min: AerodromeSlipstreamMintLiquidityProvisionParamsAmount0MinTypedDict
+    r"""The minimum amount of the first token to deposit"""
+    amount1_min: AerodromeSlipstreamMintLiquidityProvisionParamsAmount1MinTypedDict
+    r"""The minimum amount of the second token to deposit"""
+    recipient: NotRequired[Nullable[str]]
+    r"""The address that will receive the LP tokens"""
+
+
+class AerodromeSlipstreamMintLiquidityProvisionParams(BaseModel):
+    r"""Parameters 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: AerodromeSlipstreamMintLiquidityProvisionParamsAmount0Desired
+    r"""The desired amount of the first token to deposit"""
+
+    amount1_desired: AerodromeSlipstreamMintLiquidityProvisionParamsAmount1Desired
+    r"""The desired amount of the second token to deposit"""
+
+    amount0_min: AerodromeSlipstreamMintLiquidityProvisionParamsAmount0Min
+    r"""The minimum amount of the first token to deposit"""
+
+    amount1_min: AerodromeSlipstreamMintLiquidityProvisionParamsAmount1Min
+    r"""The minimum amount of the second token to deposit"""
+
+    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 → compassapisdk}/models/aerodromeslipstreammintliquidityprovisionrequest.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 from .chain import Chain
 from .token_enum import TokenEnum
-from compass_api_sdk.types import (
+from compassapisdk.types import (
     BaseModel,
     Nullable,
     OptionalNullable,

{compass_api_sdk → compassapisdk}/models/aerodromeslipstreampoolpriceresponse.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 from .token_enum import TokenEnum
-from compass_api_sdk.types import BaseModel
+from compassapisdk.types import BaseModel
 from typing_extensions import TypedDict
 
 

compassapisdk/models/aerodromeslipstreamsellexactlyparams.py

@@ -0,0 +1,85 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .token_enum import TokenEnum
+from compassapisdk.types import BaseModel
+from typing import Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AerodromeSlipstreamSellExactlyParamsAmountInTypedDict = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyParamsAmountInTypedDict", Union[float, str]
+)
+r"""The amount of the token to swap from"""
+
+
+AerodromeSlipstreamSellExactlyParamsAmountIn = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyParamsAmountIn", Union[float, str]
+)
+r"""The amount of the token to swap from"""
+
+
+AerodromeSlipstreamSellExactlyParamsAmountOutMinimumTypedDict = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyParamsAmountOutMinimumTypedDict", Union[float, str]
+)
+r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+AerodromeSlipstreamSellExactlyParamsAmountOutMinimum = TypeAliasType(
+    "AerodromeSlipstreamSellExactlyParamsAmountOutMinimum", Union[float, str]
+)
+r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+class AerodromeSlipstreamSellExactlyParamsTypedDict(TypedDict):
+    r"""Parameters 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: AerodromeSlipstreamSellExactlyParamsAmountInTypedDict
+    r"""The amount of the token to swap from"""
+    amount_out_minimum: NotRequired[
+        AerodromeSlipstreamSellExactlyParamsAmountOutMinimumTypedDict
+    ]
+    r"""The minimum amount of the token to swap to, defaults to 0"""
+
+
+class AerodromeSlipstreamSellExactlyParams(BaseModel):
+    r"""Parameters 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: AerodromeSlipstreamSellExactlyParamsAmountIn
+    r"""The amount of the token to swap from"""
+
+    amount_out_minimum: Optional[
+        AerodromeSlipstreamSellExactlyParamsAmountOutMinimum
+    ] = None
+    r"""The minimum amount of the token to swap to, defaults to 0"""

{compass_api_sdk → compassapisdk}/models/aerodromeslipstreamsellexactlyrequest.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 from .chain import Chain
 from .token_enum import TokenEnum
-from compass_api_sdk.types import BaseModel
+from compassapisdk.types import BaseModel
 from typing import Optional, Union
 from typing_extensions import NotRequired, TypeAliasType, TypedDict
 

compassapisdk/models/aerodromeslipstreamwithdrawliquidityprovisionparams.py

@@ -0,0 +1,51 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import BaseModel
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawalTypedDict = TypeAliasType(
+    "AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawalTypedDict",
+    Union[float, str],
+)
+r"""How much liquidity to take out in percentage."""
+
+
+AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawal = (
+    TypeAliasType(
+        "AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawal",
+        Union[float, str],
+    )
+)
+r"""How much liquidity to take out in percentage."""
+
+
+class AerodromeSlipstreamWithdrawLiquidityProvisionParamsTypedDict(TypedDict):
+    r"""Endpoint parameters for liquidity provision withdrawal on aerodrome slipstream.
+
+    This action is performed in a multicall on the NonfungiblePosition Manager: https://github.com/AerodromeSlipstream/v3-periphery/blob/0682387198a24c7cd63566a2c58398533860a5d1/contracts/base/Multicall.sol#L11-L27
+    First, we call decrease liquidity then collect the tokens owed to the user.
+    """
+
+    token_id: int
+    r"""Token ID of the NFT representing the liquidity provisioned position."""
+    percentage_for_withdrawal: AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawalTypedDict
+    r"""How much liquidity to take out in percentage."""
+
+
+class AerodromeSlipstreamWithdrawLiquidityProvisionParams(BaseModel):
+    r"""Endpoint parameters for liquidity provision withdrawal on aerodrome slipstream.
+
+    This action is performed in a multicall on the NonfungiblePosition Manager: https://github.com/AerodromeSlipstream/v3-periphery/blob/0682387198a24c7cd63566a2c58398533860a5d1/contracts/base/Multicall.sol#L11-L27
+    First, we call decrease liquidity then collect the tokens owed to the user.
+    """
+
+    token_id: int
+    r"""Token ID of the NFT representing the liquidity provisioned position."""
+
+    percentage_for_withdrawal: (
+        AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawal
+    )
+    r"""How much liquidity to take out in percentage."""

{compass_api_sdk → compassapisdk}/models/aerodromeslipstreamwithdrawliquidityprovisionrequest.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 from .chain import Chain
-from compass_api_sdk.types import BaseModel
+from compassapisdk.types import BaseModel
 from typing import Union
 from typing_extensions import TypeAliasType, TypedDict
 

compassapisdk/models/aerodromeswapethfortokenparams.py

@@ -0,0 +1,110 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .token_enum import TokenEnum
+from compassapisdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AerodromeSwapEthForTokenParamsAmountInTypedDict = TypeAliasType(
+    "AerodromeSwapEthForTokenParamsAmountInTypedDict", Union[float, str]
+)
+r"""The amount of ETH you will give to aerodrome_basic for this trade"""
+
+
+AerodromeSwapEthForTokenParamsAmountIn = TypeAliasType(
+    "AerodromeSwapEthForTokenParamsAmountIn", Union[float, str]
+)
+r"""The amount of ETH you will give to aerodrome_basic for this trade"""
+
+
+AerodromeSwapEthForTokenParamsAmountOutMinTypedDict = TypeAliasType(
+    "AerodromeSwapEthForTokenParamsAmountOutMinTypedDict", Union[float, str]
+)
+r"""The minimal amount of token you are willing to receive (will revert if the swap gives you less)"""
+
+
+AerodromeSwapEthForTokenParamsAmountOutMin = TypeAliasType(
+    "AerodromeSwapEthForTokenParamsAmountOutMin", Union[float, str]
+)
+r"""The minimal amount of token you are willing to receive (will revert if the swap gives you less)"""
+
+
+class AerodromeSwapEthForTokenParamsTypedDict(TypedDict):
+    r"""Parameters model for swapping ETH for tokens."""
+
+    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.
+    """
+    amount_in: AerodromeSwapEthForTokenParamsAmountInTypedDict
+    r"""The amount of ETH you will give to aerodrome_basic for this trade"""
+    amount_out_min: AerodromeSwapEthForTokenParamsAmountOutMinTypedDict
+    r"""The minimal amount of token you are willing to receive (will revert if the swap gives you less)"""
+    stable: bool
+    r"""If true, try to trade on a stable pool with a bonding curve of K=x^3y+y^3x. If false, try to trade on a volatile pool with a bonding curve of K=xy"""
+    to: NotRequired[Nullable[str]]
+    r"""The receiver of the funds from this trade, default to sender"""
+
+
+class AerodromeSwapEthForTokenParams(BaseModel):
+    r"""Parameters model for swapping ETH for tokens."""
+
+    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.
+    """
+
+    amount_in: AerodromeSwapEthForTokenParamsAmountIn
+    r"""The amount of ETH you will give to aerodrome_basic for this trade"""
+
+    amount_out_min: AerodromeSwapEthForTokenParamsAmountOutMin
+    r"""The minimal amount of token you are willing to receive (will revert if the swap gives you less)"""
+
+    stable: bool
+    r"""If true, try to trade on a stable pool with a bonding curve of K=x^3y+y^3x. If false, try to trade on a volatile pool with a bonding curve of K=xy"""
+
+    to: OptionalNullable[str] = UNSET
+    r"""The receiver of the funds from this trade, default to sender"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["to"]
+        nullable_fields = ["to"]
+        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

compassapisdk/models/aerodromeswaptokenforethparams.py

@@ -0,0 +1,110 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .token_enum import TokenEnum
+from compassapisdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AerodromeSwapTokenForEthParamsAmountInTypedDict = TypeAliasType(
+    "AerodromeSwapTokenForEthParamsAmountInTypedDict", Union[float, str]
+)
+r"""The amount of tokens you will give to aerodrome_basic for this trade"""
+
+
+AerodromeSwapTokenForEthParamsAmountIn = TypeAliasType(
+    "AerodromeSwapTokenForEthParamsAmountIn", Union[float, str]
+)
+r"""The amount of tokens you will give to aerodrome_basic for this trade"""
+
+
+AerodromeSwapTokenForEthParamsAmountOutMinTypedDict = TypeAliasType(
+    "AerodromeSwapTokenForEthParamsAmountOutMinTypedDict", Union[float, str]
+)
+r"""The minimal amount of ETH you are willing to receive (will revert if the swap gives you less)"""
+
+
+AerodromeSwapTokenForEthParamsAmountOutMin = TypeAliasType(
+    "AerodromeSwapTokenForEthParamsAmountOutMin", Union[float, str]
+)
+r"""The minimal amount of ETH you are willing to receive (will revert if the swap gives you less)"""
+
+
+class AerodromeSwapTokenForEthParamsTypedDict(TypedDict):
+    r"""Parameters model for swapping tokens for ETH."""
+
+    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.
+    """
+    amount_in: AerodromeSwapTokenForEthParamsAmountInTypedDict
+    r"""The amount of tokens you will give to aerodrome_basic for this trade"""
+    amount_out_min: AerodromeSwapTokenForEthParamsAmountOutMinTypedDict
+    r"""The minimal amount of ETH you are willing to receive (will revert if the swap gives you less)"""
+    stable: bool
+    r"""If true, try to trade on a stable pool with a bonding curve of K=x^3y+y^3x. If false, try to trade on a volatile pool with a bonding curve of K=xy"""
+    to: NotRequired[Nullable[str]]
+    r"""The receiver of the funds from this trade, default to sender"""
+
+
+class AerodromeSwapTokenForEthParams(BaseModel):
+    r"""Parameters model for swapping tokens for ETH."""
+
+    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.
+    """
+
+    amount_in: AerodromeSwapTokenForEthParamsAmountIn
+    r"""The amount of tokens you will give to aerodrome_basic for this trade"""
+
+    amount_out_min: AerodromeSwapTokenForEthParamsAmountOutMin
+    r"""The minimal amount of ETH you are willing to receive (will revert if the swap gives you less)"""
+
+    stable: bool
+    r"""If true, try to trade on a stable pool with a bonding curve of K=x^3y+y^3x. If false, try to trade on a volatile pool with a bonding curve of K=xy"""
+
+    to: OptionalNullable[str] = UNSET
+    r"""The receiver of the funds from this trade, default to sender"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["to"]
+        nullable_fields = ["to"]
+        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