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

compass_api_sdk/models/setallowancerequest.py

@@ -1,27 +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
-
-
-SetAllowanceRequestTokenTypedDict = TypeAliasType(
-    "SetAllowanceRequestTokenTypedDict", Union[TokenEnum, str]
-)
-r"""The symbol or address of the token for which the allowance is set.."""
-
-
-SetAllowanceRequestToken = TypeAliasType(
-    "SetAllowanceRequestToken", Union[TokenEnum, str]
-)
-r"""The symbol or address of the token for which the allowance is set.."""
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 class SetAllowanceRequestContractEnum(str, Enum):
@@ -33,11 +19,13 @@ class SetAllowanceRequestContractEnum(str, Enum):
     )
     UNISWAP_V3_ROUTER = "UniswapV3Router"
     UNISWAP_V3_NFT_POSITION_MANAGER = "UniswapV3NFTPositionManager"
-    MORPHO = "Morpho"
+    MORPHO_MARKET = "MorphoMarket"
     SKY_DAI_USDS_CONVERTER = "SkyDaiUsdsConverter"
     SKY_USDC_USDS_CONVERTER = "SkyUsdcUsdsConverter"
     SKY_USDS_VAULT = "SkyUsdsVault"
     PENDLE_ROUTER = "PendleRouter"
+    ODOS_ROUTER = "OdosRouter"
+    ETHENA_VAULT = "EthenaVault"
 
 
 SetAllowanceRequestContractUnionTypedDict = TypeAliasType(
@@ -65,26 +53,33 @@ SetAllowanceRequestAmount = TypeAliasType(
 r"""The amount to set the allowance to."""
 
 
+class SetAllowanceRequestChain(str, Enum):
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+    ETHEREUM = "ethereum"
+
+
 class SetAllowanceRequestTypedDict(TypedDict):
     r"""Request model for increasing token allowance for a contract."""
 
-    token: SetAllowanceRequestTokenTypedDict
+    token: str
     r"""The symbol or address of the token for which the allowance is set.."""
     contract: SetAllowanceRequestContractUnionTypedDict
     r"""The name or address of the contract to set spending allowance for."""
     amount: SetAllowanceRequestAmountTypedDict
     r"""The amount to set the allowance to."""
-    chain: Chain
-    r"""The chain to use."""
+    chain: SetAllowanceRequestChain
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["SET_ALLOWANCE"]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class SetAllowanceRequest(BaseModel):
     r"""Request model for increasing token allowance for a contract."""
 
-    token: SetAllowanceRequestToken
+    token: str
     r"""The symbol or address of the token for which the allowance is set.."""
 
     contract: SetAllowanceRequestContractUnion
@@ -93,8 +88,7 @@ class SetAllowanceRequest(BaseModel):
     amount: SetAllowanceRequestAmount
     r"""The amount to set the allowance to."""
 
-    chain: Chain
-    r"""The chain to use."""
+    chain: SetAllowanceRequestChain
 
     sender: str
     r"""The address of the transaction sender."""
@@ -106,3 +100,6 @@ class SetAllowanceRequest(BaseModel):
         ],
         pydantic.Field(alias="action_type"),
     ] = "SET_ALLOWANCE"
+
+    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/skybuyrequest.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
 
 
 class SkyBuyRequestTokenIn(str, Enum):
@@ -27,15 +27,21 @@ SkyBuyRequestAmount = TypeAliasType("SkyBuyRequestAmount", Union[float, str])
 r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
 
 
+class SkyBuyRequestChain(str, Enum):
+    ETHEREUM = "ethereum"
+
+
 class SkyBuyRequestTypedDict(TypedDict):
     token_in: SkyBuyRequestTokenIn
     r"""The token you would like to swap 1:1 for USDS. Choose from DAI or USDC."""
     amount: SkyBuyRequestAmountTypedDict
     r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
+    chain: SkyBuyRequestChain
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["SKY_BUY"]
-    chain: Literal["ethereum:mainnet"]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class SkyBuyRequest(BaseModel):
@@ -45,6 +51,8 @@ class SkyBuyRequest(BaseModel):
     amount: SkyBuyRequestAmount
     r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
 
+    chain: SkyBuyRequestChain
+
     sender: str
     r"""The address of the transaction sender."""
 
@@ -55,10 +63,5 @@ class SkyBuyRequest(BaseModel):
         pydantic.Field(alias="action_type"),
     ] = "SKY_BUY"
 
-    CHAIN: Annotated[
-        Annotated[
-            Optional[Literal["ethereum:mainnet"]],
-            AfterValidator(validate_const("ethereum:mainnet")),
-        ],
-        pydantic.Field(alias="chain"),
-    ] = "ethereum:mainnet"
+    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/skydepositrequest.py

@@ -9,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
@@ -26,6 +27,10 @@ SkyDepositRequestAmount = TypeAliasType("SkyDepositRequestAmount", Union[float,
 r"""The amount of USDS you would like to deposit for sUSDS to earn yield."""
 
 
+class SkyDepositRequestChain(str, Enum):
+    ETHEREUM = "ethereum"
+
+
 class SkyDepositRequestTypedDict(TypedDict):
     amount: SkyDepositRequestAmountTypedDict
     r"""The amount of USDS you would like to deposit for sUSDS to earn yield."""
@@ -34,7 +39,9 @@ class SkyDepositRequestTypedDict(TypedDict):
     action_type: Literal["SKY_DEPOSIT"]
     receiver: NotRequired[Nullable[str]]
     r"""The address which will receive the sUSDS. Defaults to the sender."""
-    chain: Literal["ethereum:mainnet"]
+    chain: NotRequired[SkyDepositRequestChain]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class SkyDepositRequest(BaseModel):
@@ -55,17 +62,14 @@ class SkyDepositRequest(BaseModel):
     receiver: OptionalNullable[str] = UNSET
     r"""The address which will receive the sUSDS. Defaults to the sender."""
 
-    CHAIN: Annotated[
-        Annotated[
-            Optional[Literal["ethereum:mainnet"]],
-            AfterValidator(validate_const("ethereum:mainnet")),
-        ],
-        pydantic.Field(alias="chain"),
-    ] = "ethereum:mainnet"
+    chain: Optional[SkyDepositRequestChain] = None
+
+    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", "receiver", "chain"]
+        optional_fields = ["action_type", "receiver", "chain", "estimate_gas"]
         nullable_fields = ["receiver"]
         null_default_fields = []
 

compass_api_sdk/models/skysellrequest.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
 
 
 class SkySellRequestTokenOut(str, Enum):
@@ -27,15 +27,21 @@ SkySellRequestAmount = TypeAliasType("SkySellRequestAmount", Union[float, str])
 r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
 
 
+class SkySellRequestChain(str, Enum):
+    ETHEREUM = "ethereum"
+
+
 class SkySellRequestTypedDict(TypedDict):
     token_out: SkySellRequestTokenOut
     r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
     amount: SkySellRequestAmountTypedDict
     r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+    chain: SkySellRequestChain
     sender: str
     r"""The address of the transaction sender."""
     action_type: Literal["SKY_SELL"]
-    chain: Literal["ethereum:mainnet"]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class SkySellRequest(BaseModel):
@@ -45,6 +51,8 @@ class SkySellRequest(BaseModel):
     amount: SkySellRequestAmount
     r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
 
+    chain: SkySellRequestChain
+
     sender: str
     r"""The address of the transaction sender."""
 
@@ -55,10 +63,5 @@ class SkySellRequest(BaseModel):
         pydantic.Field(alias="action_type"),
     ] = "SKY_SELL"
 
-    CHAIN: Annotated[
-        Annotated[
-            Optional[Literal["ethereum:mainnet"]],
-            AfterValidator(validate_const("ethereum:mainnet")),
-        ],
-        pydantic.Field(alias="chain"),
-    ] = "ethereum:mainnet"
+    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/skywithdrawrequest.py

@@ -9,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
@@ -16,6 +17,10 @@ from typing import Any, Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
+class SkyWithdrawRequestChain(str, Enum):
+    ETHEREUM = "ethereum"
+
+
 class SkyWithdrawRequestTypedDict(TypedDict):
     amount: Any
     r"""The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn."""
@@ -24,7 +29,9 @@ class SkyWithdrawRequestTypedDict(TypedDict):
     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"]
+    chain: NotRequired[SkyWithdrawRequestChain]
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
 
 
 class SkyWithdrawRequest(BaseModel):
@@ -45,17 +52,14 @@ class SkyWithdrawRequest(BaseModel):
     receiver: OptionalNullable[str] = UNSET
     r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
 
-    CHAIN: Annotated[
-        Annotated[
-            Optional[Literal["ethereum:mainnet"]],
-            AfterValidator(validate_const("ethereum:mainnet")),
-        ],
-        pydantic.Field(alias="chain"),
-    ] = "ethereum:mainnet"
+    chain: Optional[SkyWithdrawRequestChain] = None
+
+    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", "receiver", "chain"]
+        optional_fields = ["action_type", "receiver", "chain", "estimate_gas"]
         nullable_fields = ["receiver"]
         null_default_fields = []
 

compass_api_sdk/models/sponsorgasrequest.py

@@ -0,0 +1,71 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_input import (
+    BatchedSafeOperationsResponseInput,
+    BatchedSafeOperationsResponseInputTypedDict,
+)
+from .chain import Chain
+from .permit2typeddata_input import (
+    Permit2TypedDataInput,
+    Permit2TypedDataInputTypedDict,
+)
+from .permittypeddataresponse_input import (
+    PermitTypedDataResponseInput,
+    PermitTypedDataResponseInputTypedDict,
+)
+from compass_api_sdk.types import BaseModel
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+SponsorGasRequestEip712TypedDict = TypeAliasType(
+    "SponsorGasRequestEip712TypedDict",
+    Union[
+        BatchedSafeOperationsResponseInputTypedDict,
+        PermitTypedDataResponseInputTypedDict,
+        Permit2TypedDataInputTypedDict,
+    ],
+)
+r"""The EIP-712 typed data that was signed."""
+
+
+SponsorGasRequestEip712 = TypeAliasType(
+    "SponsorGasRequestEip712",
+    Union[
+        BatchedSafeOperationsResponseInput,
+        PermitTypedDataResponseInput,
+        Permit2TypedDataInput,
+    ],
+)
+r"""The EIP-712 typed data that was signed."""
+
+
+class SponsorGasRequestTypedDict(TypedDict):
+    owner: str
+    r"""The owner of the smart account's address."""
+    chain: Chain
+    r"""The chain to use."""
+    eip_712: SponsorGasRequestEip712TypedDict
+    r"""The EIP-712 typed data that was signed."""
+    signature: str
+    r"""The EIP-712 signed typed data signature."""
+    sender: str
+    r"""The address of the wallet which will send the transaction."""
+
+
+class SponsorGasRequest(BaseModel):
+    owner: str
+    r"""The owner of the smart account's address."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    eip_712: SponsorGasRequestEip712
+    r"""The EIP-712 typed data that was signed."""
+
+    signature: str
+    r"""The EIP-712 signed typed data signature."""
+
+    sender: str
+    r"""The address of the wallet which will send the transaction."""

compass_api_sdk/models/sponsorgasresponse.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class SponsorGasResponseTypedDict(TypedDict):
+    transaction: UnsignedTransactionTypedDict
+
+
+class SponsorGasResponse(BaseModel):
+    transaction: UnsignedTransaction

compass_api_sdk/models/supportedchaininfo.py

@@ -0,0 +1,19 @@
+"""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 List
+from typing_extensions import TypedDict
+
+
+class SupportedChainInfoTypedDict(TypedDict):
+    r"""Response model for a chain."""
+
+    chains: List[Chain]
+
+
+class SupportedChainInfo(BaseModel):
+    r"""Response model for a chain."""
+
+    chains: List[Chain]

compass_api_sdk/models/tokenbalanceresponse.py

@@ -1,18 +1,8 @@
 """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 import Union
-from typing_extensions import TypeAliasType, TypedDict
-
-
-TokenSymbolTypedDict = TypeAliasType("TokenSymbolTypedDict", Union[TokenEnum, str])
-r"""Symbol of the token."""
-
-
-TokenSymbol = TypeAliasType("TokenSymbol", Union[TokenEnum, str])
-r"""Symbol of the token."""
+from typing_extensions import TypedDict
 
 
 class TokenBalanceResponseTypedDict(TypedDict):
@@ -22,8 +12,8 @@ class TokenBalanceResponseTypedDict(TypedDict):
     r"""Amount of tokens a particular address holds"""
     decimals: int
     r"""Number of decimals of the token"""
-    token_symbol: TokenSymbolTypedDict
-    r"""Symbol of the token."""
+    token_symbol: str
+    r"""Symbol of the token"""
     token_address: str
     r"""Address of the token"""
 
@@ -37,8 +27,8 @@ class TokenBalanceResponse(BaseModel):
     decimals: int
     r"""Number of decimals of the token"""
 
-    token_symbol: TokenSymbol
-    r"""Symbol of the token."""
+    token_symbol: str
+    r"""Symbol of the token"""
 
     token_address: str
     r"""Address of the token"""

compass_api_sdk/models/tokenconfig.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 TokenConfigTypedDict(TypedDict):
+    address: str
+    r"""Deployed address of the token"""
+    decimals: int
+    r"""Token decimals"""
+    name: str
+    r"""Name of the token"""
+    symbol: str
+    r"""Token symbol"""
+
+
+class TokenConfig(BaseModel):
+    address: str
+    r"""Deployed address of the token"""
+
+    decimals: int
+    r"""Token decimals"""
+
+    name: str
+    r"""Name of the token"""
+
+    symbol: str
+    r"""Token symbol"""

compass_api_sdk/models/tokenlistresponse.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .tokenconfig import TokenConfig, TokenConfigTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class TokenListResponseTypedDict(TypedDict):
+    r"""Response model for token list."""
+
+    tokens: List[TokenConfigTypedDict]
+    r"""List of known tokens"""
+
+
+class TokenListResponse(BaseModel):
+    r"""Response model for token list."""
+
+    tokens: List[TokenConfig]
+    r"""List of known tokens"""

compass_api_sdk/models/tokenmarketdata.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chainmarketinfo import ChainMarketInfo, ChainMarketInfoTypedDict
+from .maxsupplyapyinfo import MaxSupplyApyInfo, MaxSupplyApyInfoTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import Dict
+from typing_extensions import TypedDict
+
+
+class TokenMarketDataTypedDict(TypedDict):
+    r"""Market data for a single token across all chains."""
+
+    chains: Dict[str, ChainMarketInfoTypedDict]
+    r"""Market data per chain. Keys are chain names (ethereum, base, arbitrum)."""
+    max_supply_apy: MaxSupplyApyInfoTypedDict
+    r"""Information about the chain with the highest supply APY for a token."""
+
+
+class TokenMarketData(BaseModel):
+    r"""Market data for a single token across all chains."""
+
+    chains: Dict[str, ChainMarketInfo]
+    r"""Market data per chain. Keys are chain names (ethereum, base, arbitrum)."""
+
+    max_supply_apy: MaxSupplyApyInfo
+    r"""Information about the chain with the highest supply APY for a token."""

compass_api_sdk/models/tokenpermissions.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 TokenPermissionsTypedDict(TypedDict):
+    token: str
+    r"""ERC-20 token address"""
+    amount: int
+    r"""Maximum amount allowed to transfer"""
+
+
+class TokenPermissions(BaseModel):
+    token: str
+    r"""ERC-20 token address"""
+
+    amount: int
+    r"""Maximum amount allowed to transfer"""

compass_api_sdk/models/tokentransferparams.py

@@ -0,0 +1,54 @@
+"""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, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+TokenTransferParamsAmountTypedDict = TypeAliasType(
+    "TokenTransferParamsAmountTypedDict", Union[float, str]
+)
+r"""Amount of token to transfer"""
+
+
+TokenTransferParamsAmount = TypeAliasType(
+    "TokenTransferParamsAmount", Union[float, str]
+)
+r"""Amount of token to transfer"""
+
+
+class TokenTransferParamsTypedDict(TypedDict):
+    r"""Parameters model for transferring ETH or ERC20 tokens."""
+
+    to: str
+    r"""The recipient of the tokens."""
+    token: str
+    r"""The symbol or address of the token to transfer."""
+    amount: TokenTransferParamsAmountTypedDict
+    r"""Amount of token to transfer"""
+    action_type: Literal["TOKEN_TRANSFER"]
+
+
+class TokenTransferParams(BaseModel):
+    r"""Parameters model for transferring ETH or ERC20 tokens."""
+
+    to: str
+    r"""The recipient of the tokens."""
+
+    token: str
+    r"""The symbol or address of the token to transfer."""
+
+    amount: TokenTransferParamsAmount
+    r"""Amount of token to transfer"""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["TOKEN_TRANSFER"]],
+            AfterValidator(validate_const("TOKEN_TRANSFER")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "TOKEN_TRANSFER"