compass_api_sdk 0.9.0__py3-none-any.whl → 0.9.1__py3-none-any.whl

compass_api_sdk/models/skywithdrawrequest.py

@@ -21,6 +21,7 @@ class SkyWithdrawRequestTypedDict(TypedDict):
     r"""The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["SKY_WITHDRAW"]
     receiver: NotRequired[Nullable[str]]
     r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
     chain: Literal["ethereum:mainnet"]
@@ -33,6 +34,14 @@ class SkyWithdrawRequest(BaseModel):
     sender: str
     r"""The address of the transaction sender."""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["SKY_WITHDRAW"]],
+            AfterValidator(validate_const("SKY_WITHDRAW")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "SKY_WITHDRAW"
+
     receiver: OptionalNullable[str] = UNSET
     r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
 
@@ -46,7 +55,7 @@ class SkyWithdrawRequest(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["receiver", "chain"]
+        optional_fields = ["action_type", "receiver", "chain"]
         nullable_fields = ["receiver"]
         null_default_fields = []
 

compass_api_sdk/models/tokentransfererc20params.py

@@ -3,8 +3,11 @@
 from __future__ import annotations
 from .token_enum import TokenEnum
 from compass_api_sdk.types import BaseModel
-from typing import Union
-from typing_extensions import TypeAliasType, TypedDict
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 TokenTransferErc20ParamsAmountTypedDict = TypeAliasType(
@@ -32,6 +35,7 @@ class TokenTransferErc20ParamsTypedDict(TypedDict):
     """
     to: str
     r"""The recipient of the tokens."""
+    action_type: Literal["TOKEN_TRANSFER_ERC20"]
 
 
 class TokenTransferErc20Params(BaseModel):
@@ -49,3 +53,11 @@ class TokenTransferErc20Params(BaseModel):
 
     to: str
     r"""The recipient of the tokens."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["TOKEN_TRANSFER_ERC20"]],
+            AfterValidator(validate_const("TOKEN_TRANSFER_ERC20")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "TOKEN_TRANSFER_ERC20"

compass_api_sdk/models/tokentransferrequest.py

@@ -4,8 +4,11 @@ from __future__ import annotations
 from .chain import Chain
 from .token_enum import TokenEnum
 from compass_api_sdk.types import BaseModel
-from typing import Union
-from typing_extensions import TypeAliasType, TypedDict
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 TokenTransferRequestAmountTypedDict = TypeAliasType(
@@ -45,6 +48,7 @@ class TokenTransferRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["TOKEN_TRANSFER"]
 
 
 class TokenTransferRequest(BaseModel):
@@ -64,3 +68,11 @@ class TokenTransferRequest(BaseModel):
 
     sender: str
     r"""The address of the transaction sender."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["TOKEN_TRANSFER"]],
+            AfterValidator(validate_const("TOKEN_TRANSFER")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "TOKEN_TRANSFER"

compass_api_sdk/models/uniswapbuyexactlyparams.py

@@ -4,8 +4,11 @@ from __future__ import annotations
 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 UniswapBuyExactlyParamsAmountTypedDict = TypeAliasType(
@@ -42,6 +45,7 @@ class UniswapBuyExactlyParamsTypedDict(TypedDict):
     r"""The amount of the token to swap to"""
     max_slippage_percent: float
     r"""The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed."""
+    action_type: Literal["UNISWAP_BUY_EXACTLY"]
     wrap_eth: NotRequired[bool]
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""
 
@@ -73,5 +77,13 @@ class UniswapBuyExactlyParams(BaseModel):
     max_slippage_percent: float
     r"""The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed."""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_BUY_EXACTLY"]],
+            AfterValidator(validate_const("UNISWAP_BUY_EXACTLY")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_BUY_EXACTLY"
+
     wrap_eth: Optional[bool] = False
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""

compass_api_sdk/models/uniswapbuyexactlyrequest.py

@@ -5,8 +5,11 @@ 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 UniswapBuyExactlyRequestAmountTypedDict = TypeAliasType(
@@ -49,6 +52,7 @@ class UniswapBuyExactlyRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["UNISWAP_BUY_EXACTLY"]
     wrap_eth: NotRequired[bool]
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""
 
@@ -88,5 +92,13 @@ class UniswapBuyExactlyRequest(BaseModel):
     sender: str
     r"""The address of the transaction sender."""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_BUY_EXACTLY"]],
+            AfterValidator(validate_const("UNISWAP_BUY_EXACTLY")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_BUY_EXACTLY"
+
     wrap_eth: Optional[bool] = False
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""

compass_api_sdk/models/uniswapincreaseliquidityprovisionparams.py

@@ -2,8 +2,11 @@
 
 from __future__ import annotations
 from compass_api_sdk.types import BaseModel
-from typing import Union
-from typing_extensions import TypeAliasType, TypedDict
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 UniswapIncreaseLiquidityProvisionParamsAmount0DesiredTypedDict = TypeAliasType(
@@ -65,6 +68,7 @@ class UniswapIncreaseLiquidityProvisionParamsTypedDict(TypedDict):
     r"""The minimum amount of the first token to deposit"""
     amount1_min: UniswapIncreaseLiquidityProvisionParamsAmount1MinTypedDict
     r"""The minimum amount of the second token to deposit"""
+    action_type: Literal["UNISWAP_INCREASE_LIQUIDITY_PROVISION"]
 
 
 class UniswapIncreaseLiquidityProvisionParams(BaseModel):
@@ -82,3 +86,11 @@ class UniswapIncreaseLiquidityProvisionParams(BaseModel):
 
     amount1_min: UniswapIncreaseLiquidityProvisionParamsAmount1Min
     r"""The minimum amount of the second token to deposit"""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_INCREASE_LIQUIDITY_PROVISION"]],
+            AfterValidator(validate_const("UNISWAP_INCREASE_LIQUIDITY_PROVISION")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_INCREASE_LIQUIDITY_PROVISION"

compass_api_sdk/models/uniswapincreaseliquidityprovisionrequest.py

@@ -3,8 +3,11 @@
 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 UniswapIncreaseLiquidityProvisionRequestAmount0DesiredTypedDict = TypeAliasType(
@@ -72,6 +75,7 @@ class UniswapIncreaseLiquidityProvisionRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["UNISWAP_INCREASE_LIQUIDITY_PROVISION"]
 
 
 class UniswapIncreaseLiquidityProvisionRequest(BaseModel):
@@ -97,3 +101,11 @@ class UniswapIncreaseLiquidityProvisionRequest(BaseModel):
 
     sender: str
     r"""The address of the transaction sender."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_INCREASE_LIQUIDITY_PROVISION"]],
+            AfterValidator(validate_const("UNISWAP_INCREASE_LIQUIDITY_PROVISION")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_INCREASE_LIQUIDITY_PROVISION"

compass_api_sdk/models/uniswapmintliquidityprovisionparams.py

@@ -10,9 +10,12 @@ from compass_api_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from compass_api_sdk.utils import validate_const
+import pydantic
 from pydantic import model_serializer
-from typing import Union
-from typing_extensions import NotRequired, TypeAliasType, TypedDict
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 UniswapMintLiquidityProvisionParamsAmount0DesiredTypedDict = TypeAliasType(
@@ -93,6 +96,7 @@ class UniswapMintLiquidityProvisionParamsTypedDict(TypedDict):
     r"""The minimum amount of the first token to deposit"""
     amount1_min: UniswapMintLiquidityProvisionParamsAmount1MinTypedDict
     r"""The minimum amount of the second token to deposit"""
+    action_type: Literal["UNISWAP_MINT_LIQUIDITY_PROVISION"]
     recipient: NotRequired[Nullable[str]]
     r"""The address that will receive the LP tokens"""
 
@@ -136,12 +140,20 @@ class UniswapMintLiquidityProvisionParams(BaseModel):
     amount1_min: UniswapMintLiquidityProvisionParamsAmount1Min
     r"""The minimum amount of the second token to deposit"""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_MINT_LIQUIDITY_PROVISION"]],
+            AfterValidator(validate_const("UNISWAP_MINT_LIQUIDITY_PROVISION")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_MINT_LIQUIDITY_PROVISION"
+
     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"]
+        optional_fields = ["action_type", "recipient"]
         nullable_fields = ["recipient"]
         null_default_fields = []
 

compass_api_sdk/models/uniswapmintliquidityprovisionrequest.py

@@ -11,9 +11,12 @@ from compass_api_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from compass_api_sdk.utils import validate_const
+import pydantic
 from pydantic import model_serializer
-from typing import Union
-from typing_extensions import NotRequired, TypeAliasType, TypedDict
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict = TypeAliasType(
@@ -100,6 +103,7 @@ class UniswapMintLiquidityProvisionRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["UNISWAP_MINT_LIQUIDITY_PROVISION"]
     recipient: NotRequired[Nullable[str]]
     r"""The address that will receive the LP tokens"""
 
@@ -151,12 +155,20 @@ class UniswapMintLiquidityProvisionRequest(BaseModel):
     sender: str
     r"""The address of the transaction sender."""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_MINT_LIQUIDITY_PROVISION"]],
+            AfterValidator(validate_const("UNISWAP_MINT_LIQUIDITY_PROVISION")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_MINT_LIQUIDITY_PROVISION"
+
     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"]
+        optional_fields = ["action_type", "recipient"]
         nullable_fields = ["recipient"]
         null_default_fields = []
 

compass_api_sdk/models/uniswapsellexactlyparams.py

@@ -4,8 +4,11 @@ from __future__ import annotations
 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 UniswapSellExactlyParamsAmountTypedDict = TypeAliasType(
@@ -44,6 +47,7 @@ class UniswapSellExactlyParamsTypedDict(TypedDict):
     r"""The amount of the token to swap from"""
     max_slippage_percent: float
     r"""The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed."""
+    action_type: Literal["UNISWAP_SELL_EXACTLY"]
     wrap_eth: NotRequired[bool]
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""
 
@@ -77,5 +81,13 @@ class UniswapSellExactlyParams(BaseModel):
     max_slippage_percent: float
     r"""The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed."""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_SELL_EXACTLY"]],
+            AfterValidator(validate_const("UNISWAP_SELL_EXACTLY")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_SELL_EXACTLY"
+
     wrap_eth: Optional[bool] = False
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""

compass_api_sdk/models/uniswapsellexactlyrequest.py

@@ -5,8 +5,11 @@ 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 UniswapSellExactlyRequestAmountTypedDict = TypeAliasType(
@@ -49,6 +52,7 @@ class UniswapSellExactlyRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["UNISWAP_SELL_EXACTLY"]
     wrap_eth: NotRequired[bool]
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""
 
@@ -88,5 +92,13 @@ class UniswapSellExactlyRequest(BaseModel):
     sender: str
     r"""The address of the transaction sender."""
 
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_SELL_EXACTLY"]],
+            AfterValidator(validate_const("UNISWAP_SELL_EXACTLY")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_SELL_EXACTLY"
+
     wrap_eth: Optional[bool] = False
     r"""Whether to wrap ETH to WETH, only use when swapping WETH into something"""

compass_api_sdk/models/uniswapwithdrawliquidityprovisionparams.py

@@ -2,8 +2,11 @@
 
 from __future__ import annotations
 from compass_api_sdk.types import BaseModel
-from typing import Union
-from typing_extensions import TypeAliasType, TypedDict
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 UniswapWithdrawLiquidityProvisionParamsPercentageForWithdrawalTypedDict = TypeAliasType(
@@ -32,6 +35,7 @@ class UniswapWithdrawLiquidityProvisionParamsTypedDict(TypedDict):
         UniswapWithdrawLiquidityProvisionParamsPercentageForWithdrawalTypedDict
     )
     r"""How much liquidity to take out in percentage."""
+    action_type: Literal["UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"]
 
 
 class UniswapWithdrawLiquidityProvisionParams(BaseModel):
@@ -48,3 +52,11 @@ class UniswapWithdrawLiquidityProvisionParams(BaseModel):
         UniswapWithdrawLiquidityProvisionParamsPercentageForWithdrawal
     )
     r"""How much liquidity to take out in percentage."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"]],
+            AfterValidator(validate_const("UNISWAP_WITHDRAW_LIQUIDITY_PROVISION")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"

compass_api_sdk/models/uniswapwithdrawliquidityprovisionrequest.py

@@ -3,8 +3,11 @@
 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawalTypedDict = (
@@ -33,6 +36,7 @@ class UniswapWithdrawLiquidityProvisionRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"]
 
 
 class UniswapWithdrawLiquidityProvisionRequest(BaseModel):
@@ -49,3 +53,11 @@ class UniswapWithdrawLiquidityProvisionRequest(BaseModel):
 
     sender: str
     r"""The address of the transaction sender."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"]],
+            AfterValidator(validate_const("UNISWAP_WITHDRAW_LIQUIDITY_PROVISION")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"

compass_api_sdk/models/unwrapwethparams.py

@@ -2,8 +2,11 @@
 
 from __future__ import annotations
 from compass_api_sdk.types import BaseModel
-from typing import Union
-from typing_extensions import TypeAliasType, TypedDict
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 UnwrapWethParamsAmountTypedDict = TypeAliasType(
@@ -21,6 +24,7 @@ class UnwrapWethParamsTypedDict(TypedDict):
 
     amount: UnwrapWethParamsAmountTypedDict
     r"""The amount of WETH to unwrap."""
+    action_type: Literal["UNWRAP_WETH"]
 
 
 class UnwrapWethParams(BaseModel):
@@ -28,3 +32,11 @@ class UnwrapWethParams(BaseModel):
 
     amount: UnwrapWethParamsAmount
     r"""The amount of WETH to unwrap."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNWRAP_WETH"]],
+            AfterValidator(validate_const("UNWRAP_WETH")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNWRAP_WETH"

compass_api_sdk/models/unwrapwethrequest.py

@@ -3,8 +3,11 @@
 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
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 UnwrapWethRequestAmountTypedDict = TypeAliasType(
@@ -26,6 +29,7 @@ class UnwrapWethRequestTypedDict(TypedDict):
     r"""The chain to use."""
     sender: str
     r"""The address of the transaction sender."""
+    action_type: Literal["UNWRAP_WETH"]
 
 
 class UnwrapWethRequest(BaseModel):
@@ -39,3 +43,11 @@ class UnwrapWethRequest(BaseModel):
 
     sender: str
     r"""The address of the transaction sender."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["UNWRAP_WETH"]],
+            AfterValidator(validate_const("UNWRAP_WETH")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "UNWRAP_WETH"