compass_api_sdk 2.0.21rc1__py3-none-any.whl → 2.2.1rc3__py3-none-any.whl

compass_api_sdk/gas_sponsorship.py

@@ -26,13 +26,19 @@ class GasSponsorship(BaseSDK):
     ) -> models.SponsorGasResponse:
         r"""Prepare gas-sponsored transaction
 
-        Prepare a gas-sponsored transaction to be signed and submitted by `sender`.
+        Prepare a gas-sponsored transaction from signed EIP-712 typed data.
 
-        The `owner` submits their off-chain signature of EIP-712 typed data along with the data itself.
+        Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
 
-        The `sender` will sign and submit the transaction returned from this endpoint, effectively sponsoring the gas for the transaction on behalf of the `owner`.
+        **How gas sponsorship works:**
+        1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+        2. Owner signs the typed data off-chain
+        3. Submit signature + typed data to this endpoint
+        4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
 
-        :param owner: The owner of the smart account's address.
+        **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
+
+        :param owner: The wallet address that owns the Earn Account.
         :param chain: The chain to use.
         :param eip_712: The EIP-712 typed data that was signed.
         :param signature: The EIP-712 signed typed data signature.
@@ -135,13 +141,19 @@ class GasSponsorship(BaseSDK):
     ) -> models.SponsorGasResponse:
         r"""Prepare gas-sponsored transaction
 
-        Prepare a gas-sponsored transaction to be signed and submitted by `sender`.
+        Prepare a gas-sponsored transaction from signed EIP-712 typed data.
+
+        Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
 
-        The `owner` submits their off-chain signature of EIP-712 typed data along with the data itself.
+        **How gas sponsorship works:**
+        1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+        2. Owner signs the typed data off-chain
+        3. Submit signature + typed data to this endpoint
+        4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
 
-        The `sender` will sign and submit the transaction returned from this endpoint, effectively sponsoring the gas for the transaction on behalf of the `owner`.
+        **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
 
-        :param owner: The owner of the smart account's address.
+        :param owner: The wallet address that owns the Earn Account.
         :param chain: The chain to use.
         :param eip_712: The EIP-712 typed data that was signed.
         :param signature: The EIP-712 signed typed data signature.
@@ -241,18 +253,18 @@ class GasSponsorship(BaseSDK):
     ) -> models.ApproveTransferResponse:
         r"""Approve token transfer
 
-        Prepare a one-time permit2 approval transaction for a given token.
+        Set up a one-time Permit2 allowance for gas-sponsored token transfers.
 
-        This is only required if the `owner` would like to transfer tokens from their wallet to their Earn Account with gas-sponsorship.
+        Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
 
-        This approval transaction itself can be submitted with gas-sponsorship.
-        In this case, EIP-712 typed data will be returned and should be signed by the `owner` off-chain.
-        This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
-        Gas-sponsored approvals can only be achieved by ERC-20 tokens that support permit (EIP-2612).
-        Some tokens, like USDT and WETH, do not allow for this behavior.
-        In the case of non-permit tokens, the one-time approval transaction can be submitted in the conventional manner where the `owner` must sign, submit and pay gas for the transaction.
+        **With gas sponsorship (`gas_sponsorship=true`):**
+        - Returns EIP-712 typed data for the owner to sign off-chain
+        - Submit signature + typed data to [/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
+        - Only works for tokens that support EIP-2612 permit (e.g., USDC)
 
-        :param owner: The owner of the smart account's address.
+        Some tokens, like USDT and WETH, do not support EIP-2612 permit. For these tokens, set `gas_sponsorship=false` to receive an unsigned transaction that the owner must sign, submit, and pay gas for.
+
+        :param owner: The wallet address that owns the Earn Account.
         :param chain: The chain to use.
         :param token: The token you would like to transfer with gas sponsorship.
         :param gas_sponsorship: Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint.
@@ -350,18 +362,18 @@ class GasSponsorship(BaseSDK):
     ) -> models.ApproveTransferResponse:
         r"""Approve token transfer
 
-        Prepare a one-time permit2 approval transaction for a given token.
+        Set up a one-time Permit2 allowance for gas-sponsored token transfers.
+
+        Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
 
-        This is only required if the `owner` would like to transfer tokens from their wallet to their Earn Account with gas-sponsorship.
+        **With gas sponsorship (`gas_sponsorship=true`):**
+        - Returns EIP-712 typed data for the owner to sign off-chain
+        - Submit signature + typed data to [/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
+        - Only works for tokens that support EIP-2612 permit (e.g., USDC)
 
-        This approval transaction itself can be submitted with gas-sponsorship.
-        In this case, EIP-712 typed data will be returned and should be signed by the `owner` off-chain.
-        This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
-        Gas-sponsored approvals can only be achieved by ERC-20 tokens that support permit (EIP-2612).
-        Some tokens, like USDT and WETH, do not allow for this behavior.
-        In the case of non-permit tokens, the one-time approval transaction can be submitted in the conventional manner where the `owner` must sign, submit and pay gas for the transaction.
+        Some tokens, like USDT and WETH, do not support EIP-2612 permit. For these tokens, set `gas_sponsorship=false` to receive an unsigned transaction that the owner must sign, submit, and pay gas for.
 
-        :param owner: The owner of the smart account's address.
+        :param owner: The wallet address that owns the Earn Account.
         :param chain: The chain to use.
         :param token: The token you would like to transfer with gas sponsorship.
         :param gas_sponsorship: Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint.

compass_api_sdk/models/__init__.py

@@ -377,6 +377,7 @@ if TYPE_CHECKING:
         CreateAccountResponse,
         CreateAccountResponseTypedDict,
     )
+    from .depositevent import DepositEvent, DepositEventTypedDict
     from .depositforburnrequest import (
         DepositForBurnRequest,
         DepositForBurnRequestAmount,
@@ -410,8 +411,6 @@ if TYPE_CHECKING:
     from .earnpositionsresponse import (
         EarnPositionsResponse,
         EarnPositionsResponseTypedDict,
-        UserPosition,
-        UserPositionTypedDict,
     )
     from .earnswapparams import (
         EarnSwapParams,
@@ -642,6 +641,7 @@ if TYPE_CHECKING:
     )
     from .openposition import OpenPosition, OpenPositionTypedDict
     from .operationtype import OperationType
+    from .pendledepositevent import PendleDepositEvent, PendleDepositEventTypedDict
     from .pendlegetmarketresponse import (
         PendleGetMarketResponse,
         PendleGetMarketResponseTypedDict,
@@ -670,6 +670,13 @@ if TYPE_CHECKING:
         PendleManageLiquidityRequestTypedDict,
     )
     from .pendlemarket import PendleMarket, PendleMarketTypedDict
+    from .pendlemarketinfo import PendleMarketInfo, PendleMarketInfoTypedDict
+    from .pendlemarketsresponse import (
+        PendleMarketsResponse,
+        PendleMarketsResponseTypedDict,
+    )
+    from .pendleptposition import PendlePTPosition, PendlePTPositionTypedDict
+    from .pendleptvenue import PendlePTVenue, PendlePTVenueTypedDict
     from .pendleredeemyieldparams import (
         PendleRedeemYieldParams,
         PendleRedeemYieldParamsTypedDict,
@@ -715,6 +722,10 @@ if TYPE_CHECKING:
         PendleTxResponseTransactionTypedDict,
         PendleTxResponseTypedDict,
     )
+    from .pendlewithdrawalevent import (
+        PendleWithdrawalEvent,
+        PendleWithdrawalEventTypedDict,
+    )
     from .permit2typeddata_input import (
         Permit2TypedDataInput,
         Permit2TypedDataInputTypedDict,
@@ -739,6 +750,7 @@ if TYPE_CHECKING:
     )
     from .portfolio import Portfolio, PortfolioTypedDict
     from .position import Position, PositionTypedDict
+    from .positionpnl import PositionPnL, PositionPnLTypedDict
     from .protocol import Protocol
     from .repay import Repay, RepayTypedDict
     from .reserve import Reserve, ReserveTypedDict
@@ -1236,13 +1248,18 @@ if TYPE_CHECKING:
         V2EarnAaveMarketsRequest,
         V2EarnAaveMarketsRequestTypedDict,
     )
+    from .v2_earn_pendle_marketsop import (
+        V2EarnPendleMarketsDirection,
+        V2EarnPendleMarketsRequest,
+        V2EarnPendleMarketsRequestTypedDict,
+    )
     from .v2_earn_positionsop import (
         V2EarnPositionsChain,
         V2EarnPositionsRequest,
         V2EarnPositionsRequestTypedDict,
     )
     from .v2_earn_vaultsop import (
-        Direction,
+        V2EarnVaultsDirection,
         V2EarnVaultsRequest,
         V2EarnVaultsRequestTypedDict,
     )
@@ -1293,6 +1310,7 @@ if TYPE_CHECKING:
         WildcatGetMarketResponseTypedDict,
     )
     from .withdraw import Withdraw, WithdrawTypedDict
+    from .withdrawalevent import WithdrawalEvent, WithdrawalEventTypedDict
     from .wrapethparams import (
         WrapEthParams,
         WrapEthParamsAmount,
@@ -1549,6 +1567,8 @@ __all__ = [
     "CreateAccountResponse",
     "CreateAccountResponseTypedDict",
     "Denomination",
+    "DepositEvent",
+    "DepositEventTypedDict",
     "DepositForBurnRequest",
     "DepositForBurnRequestAmount",
     "DepositForBurnRequestAmountTypedDict",
@@ -1561,7 +1581,6 @@ __all__ = [
     "DestinationChain",
     "Details",
     "DetailsTypedDict",
-    "Direction",
     "EarnManageParams",
     "EarnManageParamsAction",
     "EarnManageParamsTypedDict",
@@ -1760,6 +1779,8 @@ __all__ = [
     "OpenPosition",
     "OpenPositionTypedDict",
     "OperationType",
+    "PendleDepositEvent",
+    "PendleDepositEventTypedDict",
     "PendleGetMarketResponse",
     "PendleGetMarketResponseTypedDict",
     "PendleListMarketsResponse",
@@ -1778,7 +1799,15 @@ __all__ = [
     "PendleManageLiquidityRequestChain",
     "PendleManageLiquidityRequestTypedDict",
     "PendleMarket",
+    "PendleMarketInfo",
+    "PendleMarketInfoTypedDict",
     "PendleMarketTypedDict",
+    "PendleMarketsResponse",
+    "PendleMarketsResponseTypedDict",
+    "PendlePTPosition",
+    "PendlePTPositionTypedDict",
+    "PendlePTVenue",
+    "PendlePTVenueTypedDict",
     "PendleRedeemYieldParams",
     "PendleRedeemYieldParamsTypedDict",
     "PendleRedeemYieldRequest",
@@ -1810,6 +1839,8 @@ __all__ = [
     "PendleTxResponseTransaction",
     "PendleTxResponseTransactionTypedDict",
     "PendleTxResponseTypedDict",
+    "PendleWithdrawalEvent",
+    "PendleWithdrawalEventTypedDict",
     "Permit2TypedDataInput",
     "Permit2TypedDataInputTypedDict",
     "Permit2TypedDataOutput",
@@ -1827,6 +1858,8 @@ __all__ = [
     "Portfolio",
     "PortfolioTypedDict",
     "Position",
+    "PositionPnL",
+    "PositionPnLTypedDict",
     "PositionTypedDict",
     "Protocol",
     "R",
@@ -2057,8 +2090,6 @@ __all__ = [
     "UserOperationResponse",
     "UserOperationResponseTypedDict",
     "UserOperationTypedDict",
-    "UserPosition",
-    "UserPositionTypedDict",
     "UserState",
     "UserStateTypedDict",
     "V1AaveAaveSupportedTokensChain",
@@ -2189,9 +2220,13 @@ __all__ = [
     "V2CctpMintResponseTypedDict",
     "V2EarnAaveMarketsRequest",
     "V2EarnAaveMarketsRequestTypedDict",
+    "V2EarnPendleMarketsDirection",
+    "V2EarnPendleMarketsRequest",
+    "V2EarnPendleMarketsRequestTypedDict",
     "V2EarnPositionsChain",
     "V2EarnPositionsRequest",
     "V2EarnPositionsRequestTypedDict",
+    "V2EarnVaultsDirection",
     "V2EarnVaultsRequest",
     "V2EarnVaultsRequestTypedDict",
     "V2UserOperation",
@@ -2230,6 +2265,8 @@ __all__ = [
     "WildcatGetMarketResponseTypedDict",
     "Withdraw",
     "WithdrawTypedDict",
+    "WithdrawalEvent",
+    "WithdrawalEventTypedDict",
     "WrapEthParams",
     "WrapEthParamsAmount",
     "WrapEthParamsAmountTypedDict",
@@ -2491,6 +2528,8 @@ _dynamic_imports: dict[str, str] = {
     "CreateAccountRequestTypedDict": ".createaccountrequest",
     "CreateAccountResponse": ".createaccountresponse",
     "CreateAccountResponseTypedDict": ".createaccountresponse",
+    "DepositEvent": ".depositevent",
+    "DepositEventTypedDict": ".depositevent",
     "DepositForBurnRequest": ".depositforburnrequest",
     "DepositForBurnRequestAmount": ".depositforburnrequest",
     "DepositForBurnRequestAmountTypedDict": ".depositforburnrequest",
@@ -2517,8 +2556,6 @@ _dynamic_imports: dict[str, str] = {
     "EarnManageResponseTypedDict": ".earnmanageresponse",
     "EarnPositionsResponse": ".earnpositionsresponse",
     "EarnPositionsResponseTypedDict": ".earnpositionsresponse",
-    "UserPosition": ".earnpositionsresponse",
-    "UserPositionTypedDict": ".earnpositionsresponse",
     "EarnSwapParams": ".earnswapparams",
     "EarnSwapParamsAmountIn": ".earnswapparams",
     "EarnSwapParamsAmountInTypedDict": ".earnswapparams",
@@ -2694,6 +2731,8 @@ _dynamic_imports: dict[str, str] = {
     "OpenPosition": ".openposition",
     "OpenPositionTypedDict": ".openposition",
     "OperationType": ".operationtype",
+    "PendleDepositEvent": ".pendledepositevent",
+    "PendleDepositEventTypedDict": ".pendledepositevent",
     "PendleGetMarketResponse": ".pendlegetmarketresponse",
     "PendleGetMarketResponseTypedDict": ".pendlegetmarketresponse",
     "PendleListMarketsResponse": ".pendlelistmarketsresponse",
@@ -2713,6 +2752,14 @@ _dynamic_imports: dict[str, str] = {
     "PendleManageLiquidityRequestTypedDict": ".pendlemanageliquidityrequest",
     "PendleMarket": ".pendlemarket",
     "PendleMarketTypedDict": ".pendlemarket",
+    "PendleMarketInfo": ".pendlemarketinfo",
+    "PendleMarketInfoTypedDict": ".pendlemarketinfo",
+    "PendleMarketsResponse": ".pendlemarketsresponse",
+    "PendleMarketsResponseTypedDict": ".pendlemarketsresponse",
+    "PendlePTPosition": ".pendleptposition",
+    "PendlePTPositionTypedDict": ".pendleptposition",
+    "PendlePTVenue": ".pendleptvenue",
+    "PendlePTVenueTypedDict": ".pendleptvenue",
     "PendleRedeemYieldParams": ".pendleredeemyieldparams",
     "PendleRedeemYieldParamsTypedDict": ".pendleredeemyieldparams",
     "PendleRedeemYieldRequest": ".pendleredeemyieldrequest",
@@ -2744,6 +2791,8 @@ _dynamic_imports: dict[str, str] = {
     "PendleTxResponseTransaction": ".pendletxresponse",
     "PendleTxResponseTransactionTypedDict": ".pendletxresponse",
     "PendleTxResponseTypedDict": ".pendletxresponse",
+    "PendleWithdrawalEvent": ".pendlewithdrawalevent",
+    "PendleWithdrawalEventTypedDict": ".pendlewithdrawalevent",
     "Permit2TypedDataInput": ".permit2typeddata_input",
     "Permit2TypedDataInputTypedDict": ".permit2typeddata_input",
     "Permit2TypedDataOutput": ".permit2typeddata_output",
@@ -2762,6 +2811,8 @@ _dynamic_imports: dict[str, str] = {
     "PortfolioTypedDict": ".portfolio",
     "Position": ".position",
     "PositionTypedDict": ".position",
+    "PositionPnL": ".positionpnl",
+    "PositionPnLTypedDict": ".positionpnl",
     "Protocol": ".protocol",
     "Repay": ".repay",
     "RepayTypedDict": ".repay",
@@ -3117,10 +3168,13 @@ _dynamic_imports: dict[str, str] = {
     "V2CctpMintResponseTypedDict": ".v2_cctp_mintop",
     "V2EarnAaveMarketsRequest": ".v2_earn_aave_marketsop",
     "V2EarnAaveMarketsRequestTypedDict": ".v2_earn_aave_marketsop",
+    "V2EarnPendleMarketsDirection": ".v2_earn_pendle_marketsop",
+    "V2EarnPendleMarketsRequest": ".v2_earn_pendle_marketsop",
+    "V2EarnPendleMarketsRequestTypedDict": ".v2_earn_pendle_marketsop",
     "V2EarnPositionsChain": ".v2_earn_positionsop",
     "V2EarnPositionsRequest": ".v2_earn_positionsop",
     "V2EarnPositionsRequestTypedDict": ".v2_earn_positionsop",
-    "Direction": ".v2_earn_vaultsop",
+    "V2EarnVaultsDirection": ".v2_earn_vaultsop",
     "V2EarnVaultsRequest": ".v2_earn_vaultsop",
     "V2EarnVaultsRequestTypedDict": ".v2_earn_vaultsop",
     "V2BundleRequest": ".v2bundlerequest",
@@ -3165,6 +3219,8 @@ _dynamic_imports: dict[str, str] = {
     "WildcatGetMarketResponseTypedDict": ".wildcatgetmarketresponse",
     "Withdraw": ".withdraw",
     "WithdrawTypedDict": ".withdraw",
+    "WithdrawalEvent": ".withdrawalevent",
+    "WithdrawalEventTypedDict": ".withdrawalevent",
     "WrapEthParams": ".wrapethparams",
     "WrapEthParamsAmount": ".wrapethparams",
     "WrapEthParamsAmountTypedDict": ".wrapethparams",

compass_api_sdk/models/aaveposition.py

@@ -1,36 +1,62 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from compass_api_sdk.types import BaseModel
+from .depositevent import DepositEvent, DepositEventTypedDict
+from .positionpnl import PositionPnL, PositionPnLTypedDict
+from .withdrawalevent import WithdrawalEvent, WithdrawalEventTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
 from compass_api_sdk.utils import validate_const
 import pydantic
+from pydantic import model_serializer
 from pydantic.functional_validators import AfterValidator
-from typing import Literal, Optional
-from typing_extensions import Annotated, TypedDict
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class AavePositionTypedDict(TypedDict):
-    id: str
-    r"""Base64-encoded position identifier."""
-    amount_in_underlying_token: str
-    r"""The user's position value denominated in the supplied asset."""
-    token_name: str
-    r"""Symbol of the Aave reserve asset (e.g., USDC)."""
+    r"""Aave V3 lending position.
+
+    Note: Unlike the old model, this no longer has vault_address/vault_name fields
+    as they were nonsensical for Aave positions.
+    """
+
+    reserve_address: str
+    r"""The reserve (underlying token) address."""
+    reserve_symbol: str
+    r"""Symbol of the reserve asset (e.g., USDC)."""
+    balance: str
+    r"""The user's position value (aToken balance)."""
     type: Literal["AAVE"]
     r"""The market type discriminator."""
-    vault_address: Literal["None"]
-    vault_name: Literal["None"]
+    pnl: NotRequired[Nullable[PositionPnLTypedDict]]
+    r"""PnL metrics for this position."""
+    deposits: NotRequired[List[DepositEventTypedDict]]
+    r"""All deposit events for this position."""
+    withdrawals: NotRequired[List[WithdrawalEventTypedDict]]
+    r"""All withdrawal events for this position."""
 
 
 class AavePosition(BaseModel):
-    id: str
-    r"""Base64-encoded position identifier."""
+    r"""Aave V3 lending position.
+
+    Note: Unlike the old model, this no longer has vault_address/vault_name fields
+    as they were nonsensical for Aave positions.
+    """
 
-    amount_in_underlying_token: str
-    r"""The user's position value denominated in the supplied asset."""
+    reserve_address: str
+    r"""The reserve (underlying token) address."""
 
-    token_name: str
-    r"""Symbol of the Aave reserve asset (e.g., USDC)."""
+    reserve_symbol: str
+    r"""Symbol of the reserve asset (e.g., USDC)."""
+
+    balance: str
+    r"""The user's position value (aToken balance)."""
 
     TYPE: Annotated[
         Annotated[Literal["AAVE"], AfterValidator(validate_const("AAVE"))],
@@ -38,12 +64,41 @@ class AavePosition(BaseModel):
     ] = "AAVE"
     r"""The market type discriminator."""
 
-    VAULT_ADDRESS: Annotated[
-        Annotated[Optional[Literal["None"]], AfterValidator(validate_const("None"))],
-        pydantic.Field(alias="vault_address"),
-    ] = "None"
+    pnl: OptionalNullable[PositionPnL] = UNSET
+    r"""PnL metrics for this position."""
+
+    deposits: Optional[List[DepositEvent]] = None
+    r"""All deposit events for this position."""
+
+    withdrawals: Optional[List[WithdrawalEvent]] = None
+    r"""All withdrawal events for this position."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["pnl", "deposits", "withdrawals"]
+        nullable_fields = ["pnl"]
+        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
 
-    VAULT_NAME: Annotated[
-        Annotated[Optional[Literal["None"]], AfterValidator(validate_const("None"))],
-        pydantic.Field(alias="vault_name"),
-    ] = "None"
+        return m

compass_api_sdk/models/approvetransferrequest.py

@@ -9,7 +9,7 @@ from typing_extensions import NotRequired, TypedDict
 
 class ApproveTransferRequestTypedDict(TypedDict):
     owner: str
-    r"""The owner of the smart account's address."""
+    r"""The wallet address that owns the Earn Account."""
     chain: Chain
     r"""The chain to use."""
     token: str
@@ -20,7 +20,7 @@ class ApproveTransferRequestTypedDict(TypedDict):
 
 class ApproveTransferRequest(BaseModel):
     owner: str
-    r"""The owner of the smart account's address."""
+    r"""The wallet address that owns the Earn Account."""
 
     chain: Chain
     r"""The chain to use."""

compass_api_sdk/models/batchedsafeoperationsresponse_input.py

@@ -22,11 +22,11 @@ class BatchedSafeOperationsResponseInputTypedDict(TypedDict):
     r"""Response containing EIP-712 typed data for Safe transaction signing."""
 
     domain: CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712DomainTypedDict
-    r"""The EIP-712 domain separator for Safe transactions."""
+    r"""The EIP-712 domain separator."""
     types: CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712TypesTypedDict
     r"""The type definitions for EIP-712 structured data."""
     message: SafeTxMessageTypedDict
-    r"""The message data for a Safe transaction."""
+    r"""The message data for the transaction."""
     primary_type: Literal["SafeTx"]
     r"""Primary type for the structured data"""
 
@@ -37,13 +37,13 @@ class BatchedSafeOperationsResponseInput(BaseModel):
     domain: (
         CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain
     )
-    r"""The EIP-712 domain separator for Safe transactions."""
+    r"""The EIP-712 domain separator."""
 
     types: CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types
     r"""The type definitions for EIP-712 structured data."""
 
     message: SafeTxMessage
-    r"""The message data for a Safe transaction."""
+    r"""The message data for the transaction."""
 
     PRIMARY_TYPE: Annotated[
         Annotated[Literal["SafeTx"], AfterValidator(validate_const("SafeTx"))],

compass_api_sdk/models/batchedsafeoperationsresponse_output.py

@@ -22,11 +22,11 @@ class BatchedSafeOperationsResponseOutputTypedDict(TypedDict):
     r"""Response containing EIP-712 typed data for Safe transaction signing."""
 
     domain: CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712DomainTypedDict
-    r"""The EIP-712 domain separator for Safe transactions."""
+    r"""The EIP-712 domain separator."""
     types: CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712TypesTypedDict
     r"""The type definitions for EIP-712 structured data."""
     message: SafeTxMessageTypedDict
-    r"""The message data for a Safe transaction."""
+    r"""The message data for the transaction."""
     primary_type: Literal["SafeTx"]
     r"""Primary type for the structured data"""
 
@@ -37,13 +37,13 @@ class BatchedSafeOperationsResponseOutput(BaseModel):
     domain: (
         CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain
     )
-    r"""The EIP-712 domain separator for Safe transactions."""
+    r"""The EIP-712 domain separator."""
 
     types: CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types
     r"""The type definitions for EIP-712 structured data."""
 
     message: SafeTxMessage
-    r"""The message data for a Safe transaction."""
+    r"""The message data for the transaction."""
 
     PRIMARY_TYPE: Annotated[
         Annotated[Literal["SafeTx"], AfterValidator(validate_const("SafeTx"))],