compass_api_sdk 1.1.1__py3-none-any.whl → 2.0.21rc1__py3-none-any.whl

compass_api_sdk/models/aavewithdrawrequest.py

@@ -1,14 +1,13 @@
 """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 compass_api_sdk.utils import validate_const
 from enum import Enum
 import pydantic
 from pydantic.functional_validators import AfterValidator
 from typing import Literal, Optional, Union
-from typing_extensions import Annotated, TypeAliasType, TypedDict
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 AaveWithdrawRequestAmountTypedDict = TypeAliasType(
@@ -30,12 +29,8 @@ class AaveWithdrawRequestChain(str, Enum):
 
 
 class AaveWithdrawRequestTypedDict(TypedDict):
-    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.
-    """
+    token: str
+    r"""The symbol of the underlying asset to withdraw.."""
     amount: AaveWithdrawRequestAmountTypedDict
     r"""The amount of the asset to withdraw"""
     recipient: str
@@ -44,15 +39,13 @@ class AaveWithdrawRequestTypedDict(TypedDict):
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["AAVE_WITHDRAW"]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class AaveWithdrawRequest(BaseModel):
-    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.
-    """
+    token: str
+    r"""The symbol of the underlying asset to withdraw.."""
 
     amount: AaveWithdrawRequestAmount
     r"""The amount of the asset to withdraw"""
@@ -72,3 +65,6 @@ class AaveWithdrawRequest(BaseModel):
         ],
         pydantic.Field(alias="action_type"),
     ] = "AAVE_WITHDRAW"
+
+    estimate_gas: Optional[bool] = None
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""

compass_api_sdk/models/aerodromeenrichedposition.py

@@ -0,0 +1,109 @@
+"""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 AerodromeEnrichedPositionTypedDict(TypedDict):
+    r"""Aerodrome LP position enriched with token amounts and USD values."""
+
+    nonce: int
+    r"""Position nonce"""
+    operator: str
+    r"""Operator address"""
+    token0: str
+    r"""Token0 address"""
+    token1: str
+    r"""Token1 address"""
+    tick_spacing: int
+    r"""Pool tick spacing"""
+    tick_lower: int
+    r"""Lower tick of the position"""
+    tick_upper: int
+    r"""Upper tick of the position"""
+    liquidity: int
+    r"""Position liquidity"""
+    fee_growth_inside0_last_x128: int
+    r"""Fee growth inside for token0"""
+    fee_growth_inside1_last_x128: int
+    r"""Fee growth inside for token1"""
+    tokens_owed0: int
+    r"""Uncollected fees for token0"""
+    tokens_owed1: int
+    r"""Uncollected fees for token1"""
+    token_id: int
+    r"""NFT token ID"""
+    pool_address: str
+    r"""Pool contract address"""
+    amount0: str
+    r"""Amount of token0 in the position (human readable)"""
+    amount1: str
+    r"""Amount of token1 in the position (human readable)"""
+    amount0_usd: str
+    r"""USD value of token0 in the position"""
+    amount1_usd: str
+    r"""USD value of token1 in the position"""
+    total_value_usd: str
+    r"""Total USD value of the position"""
+
+
+class AerodromeEnrichedPosition(BaseModel):
+    r"""Aerodrome LP position enriched with token amounts and USD values."""
+
+    nonce: int
+    r"""Position nonce"""
+
+    operator: str
+    r"""Operator address"""
+
+    token0: str
+    r"""Token0 address"""
+
+    token1: str
+    r"""Token1 address"""
+
+    tick_spacing: int
+    r"""Pool tick spacing"""
+
+    tick_lower: int
+    r"""Lower tick of the position"""
+
+    tick_upper: int
+    r"""Upper tick of the position"""
+
+    liquidity: int
+    r"""Position liquidity"""
+
+    fee_growth_inside0_last_x128: int
+    r"""Fee growth inside for token0"""
+
+    fee_growth_inside1_last_x128: int
+    r"""Fee growth inside for token1"""
+
+    tokens_owed0: int
+    r"""Uncollected fees for token0"""
+
+    tokens_owed1: int
+    r"""Uncollected fees for token1"""
+
+    token_id: int
+    r"""NFT token ID"""
+
+    pool_address: str
+    r"""Pool contract address"""
+
+    amount0: str
+    r"""Amount of token0 in the position (human readable)"""
+
+    amount1: str
+    r"""Amount of token1 in the position (human readable)"""
+
+    amount0_usd: str
+    r"""USD value of token0 in the position"""
+
+    amount1_usd: str
+    r"""USD value of token1 in the position"""
+
+    total_value_usd: str
+    r"""Total USD value of the position"""

compass_api_sdk/models/aerodromelppositionsresponse.py

@@ -1,21 +1,24 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .aerodromeposition import AerodromePosition, AerodromePositionTypedDict
+from .aerodromeenrichedposition import (
+    AerodromeEnrichedPosition,
+    AerodromeEnrichedPositionTypedDict,
+)
 from compass_api_sdk.types import BaseModel
 from typing import Dict
 from typing_extensions import TypedDict
 
 
 class AerodromeLPPositionsResponseTypedDict(TypedDict):
-    positions: Dict[str, AerodromePositionTypedDict]
-    r"""Liquidity provision positions belonging to a particular user. The key is a
-    tuple of the token0, token1, tick_spacing, tick_lower, and tick_upper of the position.
+    positions: Dict[str, AerodromeEnrichedPositionTypedDict]
+    r"""Liquidity provision positions belonging to a particular user, enriched with
+    token amounts and USD values. The key is the NFT token ID of the position.
     """
 
 
 class AerodromeLPPositionsResponse(BaseModel):
-    positions: Dict[str, AerodromePosition]
-    r"""Liquidity provision positions belonging to a particular user. The key is a
-    tuple of the token0, token1, tick_spacing, tick_lower, and tick_upper of the position.
+    positions: Dict[str, AerodromeEnrichedPosition]
+    r"""Liquidity provision positions belonging to a particular user, enriched with
+    token amounts and USD values. The key is the NFT token ID of the position.
     """

compass_api_sdk/models/aerodromeslipstreambuyexactlyparams.py

@@ -1,7 +1,6 @@
 """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 compass_api_sdk.utils import validate_const
 import pydantic
@@ -37,18 +36,10 @@ r"""The maximum amount of the token to swap from"""
 class AerodromeSlipstreamBuyExactlyParamsTypedDict(TypedDict):
     r"""Parameters model for buying 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.
-    """
+    token_in: str
+    r"""The symbol of the token to swap from."""
+    token_out: str
+    r"""The symbol of the token to swap to."""
     tick_spacing: int
     r"""The tick spacing of the pool"""
     amount_out: AerodromeSlipstreamBuyExactlyParamsAmountOutTypedDict
@@ -61,19 +52,11 @@ class AerodromeSlipstreamBuyExactlyParamsTypedDict(TypedDict):
 class AerodromeSlipstreamBuyExactlyParams(BaseModel):
     r"""Parameters model for buying 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.
+    token_in: str
+    r"""The symbol of the token to swap from."""
 
-    This class is used to represent the token in the system. Notice individual
-    endpoints' documentation where per chain tokens are presented.
-    """
+    token_out: str
+    r"""The symbol of the token to swap to."""
 
     tick_spacing: int
     r"""The tick spacing of the pool"""

compass_api_sdk/models/aerodromeslipstreambuyexactlyrequest.py

@@ -1,14 +1,13 @@
 """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 compass_api_sdk.utils import validate_const
 from enum import Enum
 import pydantic
 from pydantic.functional_validators import AfterValidator
 from typing import Literal, Optional, Union
-from typing_extensions import Annotated, TypeAliasType, TypedDict
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 AerodromeSlipstreamBuyExactlyRequestAmountOutTypedDict = TypeAliasType(
@@ -42,18 +41,10 @@ class AerodromeSlipstreamBuyExactlyRequestChain(str, Enum):
 class AerodromeSlipstreamBuyExactlyRequestTypedDict(TypedDict):
     r"""Request model for buying 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.
-    """
+    token_in: str
+    r"""The symbol of the token to swap from."""
+    token_out: str
+    r"""The symbol of the token to swap to."""
     tick_spacing: int
     r"""The tick spacing of the pool"""
     amount_out: AerodromeSlipstreamBuyExactlyRequestAmountOutTypedDict
@@ -64,24 +55,18 @@ class AerodromeSlipstreamBuyExactlyRequestTypedDict(TypedDict):
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["AERODROME_SLIPSTREAM_BUY_EXACTLY"]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class AerodromeSlipstreamBuyExactlyRequest(BaseModel):
     r"""Request model for buying 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_in: str
+    r"""The symbol of the token to swap from."""
 
-    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.
-    """
+    token_out: str
+    r"""The symbol of the token to swap to."""
 
     tick_spacing: int
     r"""The tick spacing of the pool"""
@@ -104,3 +89,6 @@ class AerodromeSlipstreamBuyExactlyRequest(BaseModel):
         ],
         pydantic.Field(alias="action_type"),
     ] = "AERODROME_SLIPSTREAM_BUY_EXACTLY"
+
+    estimate_gas: Optional[bool] = None
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""

compass_api_sdk/models/aerodromeslipstreamincreaseliquidityprovisionrequest.py

@@ -7,7 +7,7 @@ from enum import Enum
 import pydantic
 from pydantic.functional_validators import AfterValidator
 from typing import Literal, Optional, Union
-from typing_extensions import Annotated, TypeAliasType, TypedDict
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 AerodromeSlipstreamIncreaseLiquidityProvisionRequestAmount0DesiredTypedDict = (
@@ -91,6 +91,8 @@ class AerodromeSlipstreamIncreaseLiquidityProvisionRequestTypedDict(TypedDict):
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION"]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class AerodromeSlipstreamIncreaseLiquidityProvisionRequest(BaseModel):
@@ -123,3 +125,6 @@ class AerodromeSlipstreamIncreaseLiquidityProvisionRequest(BaseModel):
         ],
         pydantic.Field(alias="action_type"),
     ] = "AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION"
+
+    estimate_gas: Optional[bool] = None
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""

compass_api_sdk/models/aerodromeslipstreammintliquidityprovisionparams.py

@@ -1,7 +1,6 @@
 """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,
     Nullable,
@@ -72,18 +71,10 @@ 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.
-    """
+    token0: str
+    r"""The symbol or address of the first token in the pair."""
+    token1: str
+    r"""The symbol or address of the second token in the pair."""
     tick_spacing: int
     r"""The tick spacing of the pool"""
     tick_lower: int
@@ -110,19 +101,11 @@ class AerodromeSlipstreamMintLiquidityProvisionParamsTypedDict(TypedDict):
 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.
+    token0: str
+    r"""The symbol or address of the first token in the pair."""
 
-    This class is used to represent the token in the system. Notice individual
-    endpoints' documentation where per chain tokens are presented.
-    """
+    token1: str
+    r"""The symbol or address of the second token in the pair."""
 
     tick_spacing: int
     r"""The tick spacing of the pool"""

compass_api_sdk/models/aerodromeslipstreammintliquidityprovisionrequest.py

@@ -1,7 +1,6 @@
 """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,
     Nullable,
@@ -77,18 +76,10 @@ class AerodromeSlipstreamMintLiquidityProvisionRequestChain(str, Enum):
 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.
-    """
+    token0: str
+    r"""The symbol or address of the first token in the pair."""
+    token1: str
+    r"""The symbol or address of the second token in the pair."""
     tick_spacing: int
     r"""The tick spacing of the pool"""
     tick_lower: int
@@ -113,24 +104,18 @@ class AerodromeSlipstreamMintLiquidityProvisionRequestTypedDict(TypedDict):
     action_type: Literal["AERODROME_SLIPSTREAM_MINT_LIQUIDITY_PROVISION"]
     recipient: NotRequired[Nullable[str]]
     r"""The address that will receive the LP tokens"""
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 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.
-    """
+    token0: str
+    r"""The symbol or address of the first token in the pair."""
 
-    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.
-    """
+    token1: str
+    r"""The symbol or address of the second token in the pair."""
 
     tick_spacing: int
     r"""The tick spacing of the pool"""
@@ -171,9 +156,12 @@ class AerodromeSlipstreamMintLiquidityProvisionRequest(BaseModel):
     recipient: OptionalNullable[str] = UNSET
     r"""The address that will receive the LP tokens"""
 
+    estimate_gas: Optional[bool] = None
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["action_type", "recipient"]
+        optional_fields = ["action_type", "recipient", "estimate_gas"]
         nullable_fields = ["recipient"]
         null_default_fields = []
 

compass_api_sdk/models/aerodromeslipstreampoolpriceresponse.py

@@ -1,24 +1,15 @@
 """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.
-    """
+    token_in: str
+    r"""The first token in the pool."""
+    token_out: str
+    r"""The second token in the pool."""
     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
@@ -31,19 +22,11 @@ class AerodromeSlipstreamPoolPriceResponseTypedDict(TypedDict):
 
 
 class AerodromeSlipstreamPoolPriceResponse(BaseModel):
-    token_in: TokenEnum
-    r"""A class representing the token.
+    token_in: str
+    r"""The first token in the pool."""
 
-    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.
-    """
+    token_out: str
+    r"""The second token in the pool."""
 
     price: str
     r"""The price of the pool. This is expressed as an instantaneous amount of how

compass_api_sdk/models/aerodromeslipstreamsellexactlyparams.py

@@ -1,7 +1,6 @@
 """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 compass_api_sdk.utils import validate_const
 import pydantic
@@ -37,18 +36,10 @@ 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.
-    """
+    token_in: str
+    r"""The symbol or address of the token to swap from."""
+    token_out: str
+    r"""The symbol or address of the token to swap to."""
     tick_spacing: int
     r"""The tick spacing of the pool"""
     amount_in: AerodromeSlipstreamSellExactlyParamsAmountInTypedDict
@@ -63,19 +54,11 @@ class AerodromeSlipstreamSellExactlyParamsTypedDict(TypedDict):
 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.
+    token_in: str
+    r"""The symbol or address of the token to swap from."""
 
-    This class is used to represent the token in the system. Notice individual
-    endpoints' documentation where per chain tokens are presented.
-    """
+    token_out: str
+    r"""The symbol or address of the token to swap to."""
 
     tick_spacing: int
     r"""The tick spacing of the pool"""