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

compass_api_sdk/models/{compass_api_backend_models_morpho_read_response_get_vaults_vaultstate.py → compass_api_backend_v1_models_morpho_read_response_get_vaults_vaultstate.py}

@@ -13,7 +13,9 @@ from pydantic import model_serializer
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class CompassAPIBackendModelsMorphoReadResponseGetVaultsVaultStateTypedDict(TypedDict):
+class CompassAPIBackendV1ModelsMorphoReadResponseGetVaultsVaultStateTypedDict(
+    TypedDict
+):
     id: str
     apy: float
     net_apy: float
@@ -23,7 +25,7 @@ class CompassAPIBackendModelsMorphoReadResponseGetVaultsVaultStateTypedDict(Type
     total_assets_usd: NotRequired[Nullable[float]]
 
 
-class CompassAPIBackendModelsMorphoReadResponseGetVaultsVaultState(BaseModel):
+class CompassAPIBackendV1ModelsMorphoReadResponseGetVaultsVaultState(BaseModel):
     id: str
 
     apy: float

compass_api_sdk/models/{compass_api_backend_models_pendle_read_response_market_userposition.py → compass_api_backend_v1_models_pendle_read_response_market_userposition.py}

@@ -12,7 +12,7 @@ from pydantic import model_serializer
 from typing_extensions import NotRequired, TypedDict
 
 
-class CompassAPIBackendModelsPendleReadResponseMarketUserPositionTypedDict(TypedDict):
+class CompassAPIBackendV1ModelsPendleReadResponseMarketUserPositionTypedDict(TypedDict):
     claimable_yield: str
     r"""The amount of yield that can be claimed in the underlying token."""
     sy_balance: str
@@ -29,7 +29,7 @@ class CompassAPIBackendModelsPendleReadResponseMarketUserPositionTypedDict(Typed
     r"""The amount of accounting assets the user currently holds."""
 
 
-class CompassAPIBackendModelsPendleReadResponseMarketUserPosition(BaseModel):
+class CompassAPIBackendV1ModelsPendleReadResponseMarketUserPosition(BaseModel):
     claimable_yield: str
     r"""The amount of yield that can be claimed in the underlying token."""
 

compass_api_sdk/models/{compass_api_backend_models_pendle_read_response_positions_tokenbalance.py → compass_api_backend_v1_models_pendle_read_response_positions_tokenbalance.py}

@@ -5,14 +5,14 @@ from compass_api_sdk.types import BaseModel
 from typing_extensions import TypedDict
 
 
-class CompassAPIBackendModelsPendleReadResponsePositionsTokenBalanceTypedDict(
+class CompassAPIBackendV1ModelsPendleReadResponsePositionsTokenBalanceTypedDict(
     TypedDict
 ):
     valuation: float
     balance: str
 
 
-class CompassAPIBackendModelsPendleReadResponsePositionsTokenBalance(BaseModel):
+class CompassAPIBackendV1ModelsPendleReadResponsePositionsTokenBalance(BaseModel):
     valuation: float
 
     balance: str

compass_api_sdk/models/{compass_api_backend_models_vaults_read_response_vault_userposition.py → compass_api_backend_v1_models_vaults_read_response_vault_userposition.py}

@@ -5,14 +5,14 @@ from compass_api_sdk.types import BaseModel
 from typing_extensions import TypedDict
 
 
-class CompassAPIBackendModelsVaultsReadResponseVaultUserPositionTypedDict(TypedDict):
+class CompassAPIBackendV1ModelsVaultsReadResponseVaultUserPositionTypedDict(TypedDict):
     amount_of_shares: str
     r"""The number of vault share tokens representing the user’s proportional ownership of the assets in the vault."""
     amount_in_underlying_token: str
     r"""The equivalent value of the user’s vault shares, denominated in the vault’s underlying asset (deposit token)."""
 
 
-class CompassAPIBackendModelsVaultsReadResponseVaultUserPosition(BaseModel):
+class CompassAPIBackendV1ModelsVaultsReadResponseVaultUserPosition(BaseModel):
     amount_of_shares: str
     r"""The number of vault share tokens representing the user’s proportional ownership of the assets in the vault."""
 

compass_api_sdk/models/compass_api_backend_v1_models_wildcat_read_response_market_userposition.py

@@ -0,0 +1,22 @@
+"""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 CompassAPIBackendV1ModelsWildcatReadResponseMarketUserPositionTypedDict(
+    TypedDict
+):
+    market_token_balance: str
+    r"""The quantity of market share tokens the user holds."""
+    underlying_token_balance: str
+    r"""The total current value of the user's market tokens, denominated in the underlying asset."""
+
+
+class CompassAPIBackendV1ModelsWildcatReadResponseMarketUserPosition(BaseModel):
+    market_token_balance: str
+    r"""The quantity of market share tokens the user holds."""
+
+    underlying_token_balance: str
+    r"""The total current value of the user's market tokens, denominated in the underlying asset."""

compass_api_sdk/models/compass_api_backend_v2_models_earn_read_response_positions_vaultposition.py

@@ -0,0 +1,49 @@
+"""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 CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPositionTypedDict(
+    TypedDict
+):
+    id: str
+    r"""Base64-encoded position identifier."""
+    vault_address: str
+    r"""The vault address you are depositing to."""
+    amount_in_underlying_token: str
+    r"""The user's position value denominated in the underlying token."""
+    token_name: str
+    r"""Symbol of the underlying token (e.g., USDC)."""
+    vault_name: str
+    r"""Name of the vault token (share token)."""
+    type: Literal["VAULT"]
+    r"""The market type discriminator."""
+
+
+class CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPosition(BaseModel):
+    id: str
+    r"""Base64-encoded position identifier."""
+
+    vault_address: str
+    r"""The vault address you are depositing to."""
+
+    amount_in_underlying_token: str
+    r"""The user's position value denominated in the underlying token."""
+
+    token_name: str
+    r"""Symbol of the underlying token (e.g., USDC)."""
+
+    vault_name: str
+    r"""Name of the vault token (share token)."""
+
+    TYPE: Annotated[
+        Annotated[Literal["VAULT"], AfterValidator(validate_const("VAULT"))],
+        pydantic.Field(alias="type"),
+    ] = "VAULT"
+    r"""The market type discriminator."""

compass_api_sdk/models/compass_api_backend_v2_models_gas_sponsorship_permit_2_typed_data_eip712domain.py

@@ -0,0 +1,36 @@
+"""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
+from typing_extensions import Annotated, TypedDict
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermit2TypedDataEip712DomainTypedDict(
+    TypedDict
+):
+    chain_id: int
+    r"""EVM chain ID"""
+    verifying_contract: str
+    r"""Permit2 contract address"""
+    name: Literal["Permit2"]
+    r"""Must be 'Permit2'"""
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Domain(BaseModel):
+    chain_id: Annotated[int, pydantic.Field(alias="chainId")]
+    r"""EVM chain ID"""
+
+    verifying_contract: Annotated[str, pydantic.Field(alias="verifyingContract")]
+    r"""Permit2 contract address"""
+
+    NAME: Annotated[
+        Annotated[
+            Optional[Literal["Permit2"]], AfterValidator(validate_const("Permit2"))
+        ],
+        pydantic.Field(alias="name"),
+    ] = "Permit2"
+    r"""Must be 'Permit2'"""

compass_api_sdk/models/compass_api_backend_v2_models_gas_sponsorship_permit_2_typed_data_eip712types.py

@@ -0,0 +1,36 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .eip712field import Eip712Field, Eip712FieldTypedDict
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermit2TypedDataEip712TypesTypedDict(
+    TypedDict
+):
+    eip712_domain: NotRequired[List[Eip712FieldTypedDict]]
+    r"""Standard EIP-712 domain type"""
+    token_permissions: NotRequired[List[Eip712FieldTypedDict]]
+    r"""TokenPermissions struct"""
+    permit_transfer_from: NotRequired[List[Eip712FieldTypedDict]]
+    r"""Main permit message type"""
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Types(BaseModel):
+    eip712_domain: Annotated[
+        Optional[List[Eip712Field]], pydantic.Field(alias="EIP712Domain")
+    ] = None
+    r"""Standard EIP-712 domain type"""
+
+    token_permissions: Annotated[
+        Optional[List[Eip712Field]], pydantic.Field(alias="TokenPermissions")
+    ] = None
+    r"""TokenPermissions struct"""
+
+    permit_transfer_from: Annotated[
+        Optional[List[Eip712Field]], pydantic.Field(alias="PermitTransferFrom")
+    ] = None
+    r"""Main permit message type"""

compass_api_sdk/models/compass_api_backend_v2_models_gas_sponsorship_permit_typed_data_eip712domain.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermitTypedDataEip712DomainTypedDict(
+    TypedDict
+):
+    r"""The EIP-712 domain separator for ERC-20 Permit."""
+
+    name: str
+    r"""Token name"""
+    version: str
+    r"""Token version (usually '1' or '2')"""
+    chain_id: int
+    r"""Chain ID"""
+    verifying_contract: str
+    r"""Token contract address"""
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermitTypedDataEip712Domain(BaseModel):
+    r"""The EIP-712 domain separator for ERC-20 Permit."""
+
+    name: str
+    r"""Token name"""
+
+    version: str
+    r"""Token version (usually '1' or '2')"""
+
+    chain_id: Annotated[int, pydantic.Field(alias="chainId")]
+    r"""Chain ID"""
+
+    verifying_contract: Annotated[str, pydantic.Field(alias="verifyingContract")]
+    r"""Token contract address"""

compass_api_sdk/models/compass_api_backend_v2_models_gas_sponsorship_permit_typed_data_eip712types.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .eip712domainfield import Eip712DomainField, Eip712DomainFieldTypedDict
+from .permitfield import PermitField, PermitFieldTypedDict
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermitTypedDataEip712TypesTypedDict(
+    TypedDict
+):
+    r"""The type definitions for EIP-712 structured data (ERC-20 Permit)."""
+
+    eip712_domain: List[Eip712DomainFieldTypedDict]
+    r"""EIP712Domain type definition"""
+    permit: List[PermitFieldTypedDict]
+    r"""Permit type definition"""
+
+
+class CompassAPIBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types(BaseModel):
+    r"""The type definitions for EIP-712 structured data (ERC-20 Permit)."""
+
+    eip712_domain: Annotated[
+        List[Eip712DomainField], pydantic.Field(alias="EIP712Domain")
+    ]
+    r"""EIP712Domain type definition"""
+
+    permit: Annotated[List[PermitField], pydantic.Field(alias="Permit")]
+    r"""Permit type definition"""

compass_api_sdk/models/compass_api_backend_v2_models_safe_transact_response_batched_safe_operations_eip712domain.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712DomainTypedDict(
+    TypedDict
+):
+    r"""The EIP-712 domain separator for Safe transactions."""
+
+    chain_id: int
+    r"""Chain ID for the Safe transaction"""
+    verifying_contract: str
+    r"""Address of the Safe contract"""
+
+
+class CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain(
+    BaseModel
+):
+    r"""The EIP-712 domain separator for Safe transactions."""
+
+    chain_id: Annotated[int, pydantic.Field(alias="chainId")]
+    r"""Chain ID for the Safe transaction"""
+
+    verifying_contract: Annotated[str, pydantic.Field(alias="verifyingContract")]
+    r"""Address of the Safe contract"""

compass_api_sdk/models/compass_api_backend_v2_models_safe_transact_response_batched_safe_operations_eip712types.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .eip712domainfield import Eip712DomainField, Eip712DomainFieldTypedDict
+from .safetxfield import SafeTxField, SafeTxFieldTypedDict
+from compass_api_sdk.types import BaseModel
+import pydantic
+from typing import List
+from typing_extensions import Annotated, TypedDict
+
+
+class CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712TypesTypedDict(
+    TypedDict
+):
+    r"""The type definitions for EIP-712 structured data."""
+
+    eip712_domain: List[Eip712DomainFieldTypedDict]
+    r"""EIP712Domain type definition"""
+    safe_tx: List[SafeTxFieldTypedDict]
+    r"""SafeTx type definition"""
+
+
+class CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types(
+    BaseModel
+):
+    r"""The type definitions for EIP-712 structured data."""
+
+    eip712_domain: Annotated[
+        List[Eip712DomainField], pydantic.Field(alias="EIP712Domain")
+    ]
+    r"""EIP712Domain type definition"""
+
+    safe_tx: Annotated[List[SafeTxField], pydantic.Field(alias="SafeTx")]
+    r"""SafeTx type definition"""

compass_api_sdk/models/createaccountrequest.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from enum import Enum
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CreateAccountRequestChain(str, Enum):
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+    ETHEREUM = "ethereum"
+
+
+class CreateAccountRequestTypedDict(TypedDict):
+    r"""Request to create a compass account."""
+
+    chain: CreateAccountRequestChain
+    sender: str
+    r"""The address of the transaction sender."""
+    owner: str
+    r"""The address that will own and control the compass account"""
+    estimate_gas: NotRequired[bool]
+    r"""Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed."""
+
+
+class CreateAccountRequest(BaseModel):
+    r"""Request to create a compass account."""
+
+    chain: CreateAccountRequestChain
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    owner: str
+    r"""The address that will own and control the compass account"""
+
+    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/createaccountresponse.py

@@ -0,0 +1,56 @@
+"""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, Nullable, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import TypedDict
+
+
+class CreateAccountResponseTypedDict(TypedDict):
+    r"""Response containing unsigned transaction to create compass Earn account."""
+
+    transaction: Nullable[UnsignedTransactionTypedDict]
+    r"""Transaction to create compass account"""
+    earn_account_address: str
+    r"""Predicted address of the compass earn account that will be deployed"""
+
+
+class CreateAccountResponse(BaseModel):
+    r"""Response containing unsigned transaction to create compass Earn account."""
+
+    transaction: Nullable[UnsignedTransaction]
+    r"""Transaction to create compass account"""
+
+    earn_account_address: str
+    r"""Predicted address of the compass earn account that will be deployed"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["transaction"]
+        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/models/depositforburnrequest.py

@@ -0,0 +1,77 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from enum import Enum
+from typing import Optional, Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+class DepositForBurnRequestChain(str, Enum):
+    r"""The source chain where USDC will be burned."""
+
+    ETHEREUM = "ethereum"
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+
+
+DepositForBurnRequestAmountTypedDict = TypeAliasType(
+    "DepositForBurnRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC)."""
+
+
+DepositForBurnRequestAmount = TypeAliasType(
+    "DepositForBurnRequestAmount", Union[float, str]
+)
+r"""The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC)."""
+
+
+class DestinationChain(str, Enum):
+    r"""The destination chain where USDC will be minted."""
+
+    ETHEREUM = "ethereum"
+    ARBITRUM = "arbitrum"
+    BASE = "base"
+
+
+class DepositForBurnRequestTransferMode(str, Enum):
+    r"""Transfer speed mode. 'fast': ~30 second transfers using confirmed finality (requires a small fee taken from transfer amount). 'standard': ~15-19 minute transfers using full finality (free, no fee). Default is 'standard'."""
+
+    FAST = "fast"
+    STANDARD = "standard"
+
+
+class DepositForBurnRequestTypedDict(TypedDict):
+    owner: str
+    r"""The primary wallet address that owns and controls the Product Account."""
+    chain: DepositForBurnRequestChain
+    r"""The source chain where USDC will be burned."""
+    amount: DepositForBurnRequestAmountTypedDict
+    r"""The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC)."""
+    destination_chain: DestinationChain
+    r"""The destination chain where USDC will be minted."""
+    gas_sponsorship: NotRequired[bool]
+    r"""Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`)."""
+    transfer_mode: NotRequired[DepositForBurnRequestTransferMode]
+    r"""Transfer speed mode. 'fast': ~30 second transfers using confirmed finality (requires a small fee taken from transfer amount). 'standard': ~15-19 minute transfers using full finality (free, no fee). Default is 'standard'."""
+
+
+class DepositForBurnRequest(BaseModel):
+    owner: str
+    r"""The primary wallet address that owns and controls the Product Account."""
+
+    chain: DepositForBurnRequestChain
+    r"""The source chain where USDC will be burned."""
+
+    amount: DepositForBurnRequestAmount
+    r"""The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC)."""
+
+    destination_chain: DestinationChain
+    r"""The destination chain where USDC will be minted."""
+
+    gas_sponsorship: Optional[bool] = None
+    r"""Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`)."""
+
+    transfer_mode: Optional[DepositForBurnRequestTransferMode] = None
+    r"""Transfer speed mode. 'fast': ~30 second transfers using confirmed finality (requires a small fee taken from transfer amount). 'standard': ~15-19 minute transfers using full finality (free, no fee). Default is 'standard'."""

compass_api_sdk/models/depositforburnresponse.py

@@ -0,0 +1,100 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_output import (
+    BatchedSafeOperationsResponseOutput,
+    BatchedSafeOperationsResponseOutputTypedDict,
+)
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from enum import Enum
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class DepositForBurnResponseTransferMode(str, Enum):
+    r"""The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min)."""
+
+    FAST = "fast"
+    STANDARD = "standard"
+
+
+class DepositForBurnResponseTypedDict(TypedDict):
+    r"""Response model for CCTP depositForBurn transaction from a smart account.
+
+    Contains either an unsigned transaction for direct submission or EIP-712 typed data
+    for gas-sponsored transactions. Also includes a bridge_id for tracking the cross-
+    chain transfer.
+    """
+
+    transaction: Nullable[UnsignedTransactionTypedDict]
+    eip_712: Nullable[BatchedSafeOperationsResponseOutputTypedDict]
+    transfer_mode: DepositForBurnResponseTransferMode
+    r"""The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min)."""
+    estimated_time_seconds: int
+    r"""Estimated time to complete the bridge in seconds."""
+    bridge_id: NotRequired[Nullable[str]]
+    r"""Unique bridge identifier for tracking this cross-chain transfer. Use this ID when calling /mint/prepare to complete the transfer. Only present when Redis is configured on the server."""
+    fee: NotRequired[Nullable[str]]
+    r"""Fee amount in USDC charged for this transfer. Only present for fast mode. Standard mode transfers are free (fee is None or 0)."""
+
+
+class DepositForBurnResponse(BaseModel):
+    r"""Response model for CCTP depositForBurn transaction from a smart account.
+
+    Contains either an unsigned transaction for direct submission or EIP-712 typed data
+    for gas-sponsored transactions. Also includes a bridge_id for tracking the cross-
+    chain transfer.
+    """
+
+    transaction: Nullable[UnsignedTransaction]
+
+    eip_712: Nullable[BatchedSafeOperationsResponseOutput]
+
+    transfer_mode: DepositForBurnResponseTransferMode
+    r"""The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min)."""
+
+    estimated_time_seconds: int
+    r"""Estimated time to complete the bridge in seconds."""
+
+    bridge_id: OptionalNullable[str] = UNSET
+    r"""Unique bridge identifier for tracking this cross-chain transfer. Use this ID when calling /mint/prepare to complete the transfer. Only present when Redis is configured on the server."""
+
+    fee: OptionalNullable[str] = UNSET
+    r"""Fee amount in USDC charged for this transfer. Only present for fast mode. Standard mode transfers are free (fee is None or 0)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["bridge_id", "fee"]
+        nullable_fields = ["bridge_id", "transaction", "eip_712", "fee"]
+        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