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

compass_api_sdk/models/aavesupplyparams.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,
@@ -28,12 +27,8 @@ r"""The amount of the asset to supply"""
 
 
 class AaveSupplyParamsTypedDict(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 or address of the underlying asset to supply as collateral. You can borrow against it.."""
     amount: AaveSupplyParamsAmountTypedDict
     r"""The amount of the asset to supply"""
     action_type: Literal["AAVE_SUPPLY"]
@@ -42,12 +37,8 @@ class AaveSupplyParamsTypedDict(TypedDict):
 
 
 class AaveSupplyParams(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 or address of the underlying asset to supply as collateral. You can borrow against it.."""
 
     amount: AaveSupplyParamsAmount
     r"""The amount of the asset to supply"""

compass_api_sdk/models/aavesupplyrequest.py

@@ -1,8 +1,6 @@
 """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,
@@ -11,6 +9,7 @@ from compass_api_sdk.types import (
     UNSET_SENTINEL,
 )
 from compass_api_sdk.utils import validate_const
+from enum import Enum
 import pydantic
 from pydantic import model_serializer
 from pydantic.functional_validators import AfterValidator
@@ -28,37 +27,35 @@ AaveSupplyRequestAmount = TypeAliasType("AaveSupplyRequestAmount", Union[float,
 r"""The amount of the asset to supply"""
 
 
-class AaveSupplyRequestTypedDict(TypedDict):
-    token: TokenEnum
-    r"""A class representing the token.
+class AaveSupplyRequestChain(str, Enum):
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+    ETHEREUM = "ethereum"
+
 
-    This class is used to represent the token in the system. Notice individual
-    endpoints' documentation where per chain tokens are presented.
-    """
+class AaveSupplyRequestTypedDict(TypedDict):
+    token: str
+    r"""The symbol or address of the underlying asset to supply as collateral. You can borrow against it.."""
     amount: AaveSupplyRequestAmountTypedDict
     r"""The amount of the asset to supply"""
-    chain: Chain
-    r"""The chain to use."""
+    chain: AaveSupplyRequestChain
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["AAVE_SUPPLY"]
     on_behalf_of: NotRequired[Nullable[str]]
     r"""The address on behalf of whom the supply is made. Defaults to the transaction sender."""
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class AaveSupplyRequest(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 or address of the underlying asset to supply as collateral. You can borrow against it.."""
 
     amount: AaveSupplyRequestAmount
     r"""The amount of the asset to supply"""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: AaveSupplyRequestChain
 
     sender: str
     r"""The address of the transaction sender."""
@@ -74,9 +71,12 @@ class AaveSupplyRequest(BaseModel):
     on_behalf_of: OptionalNullable[str] = UNSET
     r"""The address on behalf of whom the supply is made. Defaults to the transaction sender."""
 
+    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", "on_behalf_of"]
+        optional_fields = ["action_type", "on_behalf_of", "estimate_gas"]
         nullable_fields = ["on_behalf_of"]
         null_default_fields = []
 

compass_api_sdk/models/aavesupportedtokenmetadata.py

@@ -0,0 +1,30 @@
+"""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 AaveSupportedTokenMetadataTypedDict(TypedDict):
+    symbol: str
+    r"""Token symbol (e.g., 'WETH', 'DAI')."""
+    address: str
+    r"""Token contract address."""
+    supplying_enabled: bool
+    r"""Whether the token can be used as collateral."""
+    borrowing_enabled: bool
+    r"""Whether the token can be borrowed."""
+
+
+class AaveSupportedTokenMetadata(BaseModel):
+    symbol: str
+    r"""Token symbol (e.g., 'WETH', 'DAI')."""
+
+    address: str
+    r"""Token contract address."""
+
+    supplying_enabled: bool
+    r"""Whether the token can be used as collateral."""
+
+    borrowing_enabled: bool
+    r"""Whether the token can be borrowed."""

compass_api_sdk/models/aavesupportedtokensresponse.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .aavesupportedtokenmetadata import (
+    AaveSupportedTokenMetadata,
+    AaveSupportedTokenMetadataTypedDict,
+)
+from compass_api_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class AaveSupportedTokensResponseTypedDict(TypedDict):
+    tokens: List[AaveSupportedTokenMetadataTypedDict]
+    r"""List of supported tokens with configuration metadata for a given chain."""
+
+
+class AaveSupportedTokensResponse(BaseModel):
+    tokens: List[AaveSupportedTokenMetadata]
+    r"""List of supported tokens with configuration metadata for a given chain."""

compass_api_sdk/models/aavevenue.py

@@ -0,0 +1,27 @@
+"""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 validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal
+from typing_extensions import Annotated, TypedDict
+
+
+class AaveVenueTypedDict(TypedDict):
+    token: str
+    r"""The reserve token for the Aave pool you are interacting with."""
+    type: Literal["AAVE"]
+    r"""The venue type discriminator."""
+
+
+class AaveVenue(BaseModel):
+    token: str
+    r"""The reserve token for the Aave pool you are interacting with."""
+
+    TYPE: Annotated[
+        Annotated[Literal["AAVE"], AfterValidator(validate_const("AAVE"))],
+        pydantic.Field(alias="type"),
+    ] = "AAVE"
+    r"""The venue type discriminator."""

compass_api_sdk/models/aavewithdrawparams.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
@@ -21,12 +20,8 @@ r"""The amount of the asset to withdraw"""
 
 
 class AaveWithdrawParamsTypedDict(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: AaveWithdrawParamsAmountTypedDict
     r"""The amount of the asset to withdraw"""
     recipient: str
@@ -35,12 +30,8 @@ class AaveWithdrawParamsTypedDict(TypedDict):
 
 
 class AaveWithdrawParams(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: AaveWithdrawParamsAmount
     r"""The amount of the asset to withdraw"""

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 .chain import Chain
-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(
@@ -23,31 +22,30 @@ AaveWithdrawRequestAmount = TypeAliasType(
 r"""The amount of the asset to withdraw"""
 
 
-class AaveWithdrawRequestTypedDict(TypedDict):
-    token: TokenEnum
-    r"""A class representing the token.
+class AaveWithdrawRequestChain(str, Enum):
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+    ETHEREUM = "ethereum"
+
 
-    This class is used to represent the token in the system. Notice individual
-    endpoints' documentation where per chain tokens are presented.
-    """
+class AaveWithdrawRequestTypedDict(TypedDict):
+    token: str
+    r"""The symbol of the underlying asset to withdraw.."""
     amount: AaveWithdrawRequestAmountTypedDict
     r"""The amount of the asset to withdraw"""
     recipient: str
     r"""The address of the recipient of the withdrawn funds."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: AaveWithdrawRequestChain
     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"""
@@ -55,8 +53,7 @@ class AaveWithdrawRequest(BaseModel):
     recipient: str
     r"""The address of the recipient of the withdrawn funds."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: AaveWithdrawRequestChain
 
     sender: str
     r"""The address of the transaction sender."""
@@ -68,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 .chain import Chain
-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(
@@ -35,50 +34,39 @@ AerodromeSlipstreamBuyExactlyRequestAmountInMaximum = TypeAliasType(
 r"""The maximum amount of the token to swap from"""
 
 
-class AerodromeSlipstreamBuyExactlyRequestTypedDict(TypedDict):
-    r"""Request model for buying exactly an amount of tokens."""
+class AerodromeSlipstreamBuyExactlyRequestChain(str, Enum):
+    BASE = "base"
 
-    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.
+class AerodromeSlipstreamBuyExactlyRequestTypedDict(TypedDict):
+    r"""Request model for buying exactly an amount of tokens."""
 
-    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
     r"""The amount of the token to swap to"""
     amount_in_maximum: AerodromeSlipstreamBuyExactlyRequestAmountInMaximumTypedDict
     r"""The maximum amount of the token to swap from"""
-    chain: Chain
-    r"""The chain to use."""
+    chain: AerodromeSlipstreamBuyExactlyRequestChain
     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.
+    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: 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"""
@@ -89,8 +77,7 @@ class AerodromeSlipstreamBuyExactlyRequest(BaseModel):
     amount_in_maximum: AerodromeSlipstreamBuyExactlyRequestAmountInMaximum
     r"""The maximum amount of the token to swap from"""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: AerodromeSlipstreamBuyExactlyRequestChain
 
     sender: str
     r"""The address of the transaction sender."""
@@ -102,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."""