compass_api_sdk 2.2.25__tar.gz → 2.2.26__tar.gz

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.25
+Version: 2.2.26
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.25"
+version = "2.2.26"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -14,7 +14,7 @@ dependencies = [
 
 [tool.poetry]
 name = "compass_api_sdk"
-version = "2.2.25"
+version = "2.2.26"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/src/compass_api_sdk/earn.py

@@ -1475,6 +1475,7 @@ class Earn(BaseSDK):
         action: models.EarnTransferRequestAction,
         gas_sponsorship: Optional[bool] = None,
         spender: OptionalNullable[str] = UNSET,
+        recipient: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -1507,6 +1508,7 @@ class Earn(BaseSDK):
         :param action: Whether you are depositing to or withdrawing from your earn account.
         :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.
         :param spender: The address that will call Permit2's permitTransferFrom to execute the transfer. When `action` is 'DEPOSIT' and `gas_sponsorship` is `true`: - If provided, the signature will authorize this address (typically a gas sponsor) to pull tokens. - If not provided, defaults to the Earn Account (Safe) address, allowing the transfer to be included in a bundle transaction where the Safe pulls the tokens itself.
+        :param recipient: Optional recipient address for withdrawals. When `action` is 'WITHDRAW': - If provided, tokens will be sent to this address instead of the owner. - If not provided, defaults to the owner's address.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1530,6 +1532,7 @@ class Earn(BaseSDK):
             action=action,
             gas_sponsorship=gas_sponsorship,
             spender=spender,
+            recipient=recipient,
         )
 
         req = self._build_request(
@@ -1602,6 +1605,7 @@ class Earn(BaseSDK):
         action: models.EarnTransferRequestAction,
         gas_sponsorship: Optional[bool] = None,
         spender: OptionalNullable[str] = UNSET,
+        recipient: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -1634,6 +1638,7 @@ class Earn(BaseSDK):
         :param action: Whether you are depositing to or withdrawing from your earn account.
         :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.
         :param spender: The address that will call Permit2's permitTransferFrom to execute the transfer. When `action` is 'DEPOSIT' and `gas_sponsorship` is `true`: - If provided, the signature will authorize this address (typically a gas sponsor) to pull tokens. - If not provided, defaults to the Earn Account (Safe) address, allowing the transfer to be included in a bundle transaction where the Safe pulls the tokens itself.
+        :param recipient: Optional recipient address for withdrawals. When `action` is 'WITHDRAW': - If provided, tokens will be sent to this address instead of the owner. - If not provided, defaults to the owner's address.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1657,6 +1662,7 @@ class Earn(BaseSDK):
             action=action,
             gas_sponsorship=gas_sponsorship,
             spender=spender,
+            recipient=recipient,
         )
 
         req = self._build_request_async(

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/src/compass_api_sdk/models/__init__.py

@@ -554,6 +554,12 @@ if TYPE_CHECKING:
         EarnTransferResponseEip712TypedDict,
         EarnTransferResponseTypedDict,
     )
+    from .earntransfertoaddressparams import (
+        EarnTransferToAddressParams,
+        EarnTransferToAddressParamsAmount,
+        EarnTransferToAddressParamsAmountTypedDict,
+        EarnTransferToAddressParamsTypedDict,
+    )
     from .earntransfertoeoaparams import (
         EarnTransferToEOAParams,
         EarnTransferToEOAParamsAmount,
@@ -1837,6 +1843,10 @@ __all__ = [
     "EarnTransferResponseEip712",
     "EarnTransferResponseEip712TypedDict",
     "EarnTransferResponseTypedDict",
+    "EarnTransferToAddressParams",
+    "EarnTransferToAddressParamsAmount",
+    "EarnTransferToAddressParamsAmountTypedDict",
+    "EarnTransferToAddressParamsTypedDict",
     "EarnTransferToEOAParams",
     "EarnTransferToEOAParamsAmount",
     "EarnTransferToEOAParamsAmountTypedDict",
@@ -2907,6 +2917,10 @@ _dynamic_imports: dict[str, str] = {
     "EarnTransferResponseEip712": ".earntransferresponse",
     "EarnTransferResponseEip712TypedDict": ".earntransferresponse",
     "EarnTransferResponseTypedDict": ".earntransferresponse",
+    "EarnTransferToAddressParams": ".earntransfertoaddressparams",
+    "EarnTransferToAddressParamsAmount": ".earntransfertoaddressparams",
+    "EarnTransferToAddressParamsAmountTypedDict": ".earntransfertoaddressparams",
+    "EarnTransferToAddressParamsTypedDict": ".earntransfertoaddressparams",
     "EarnTransferToEOAParams": ".earntransfertoeoaparams",
     "EarnTransferToEOAParamsAmount": ".earntransfertoeoaparams",
     "EarnTransferToEOAParamsAmountTypedDict": ".earntransfertoeoaparams",

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/src/compass_api_sdk/models/earntransferrequest.py

@@ -49,6 +49,8 @@ class EarnTransferRequestTypedDict(TypedDict):
     r"""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."""
     spender: NotRequired[Nullable[str]]
     r"""The address that will call Permit2's permitTransferFrom to execute the transfer. When `action` is 'DEPOSIT' and `gas_sponsorship` is `true`: - If provided, the signature will authorize this address (typically a gas sponsor) to pull tokens. - If not provided, defaults to the Earn Account (Safe) address, allowing the transfer to be included in a bundle transaction where the Safe pulls the tokens itself."""
+    recipient: NotRequired[Nullable[str]]
+    r"""Optional recipient address for withdrawals. When `action` is 'WITHDRAW': - If provided, tokens will be sent to this address instead of the owner. - If not provided, defaults to the owner's address."""
 
 
 class EarnTransferRequest(BaseModel):
@@ -73,10 +75,13 @@ class EarnTransferRequest(BaseModel):
     spender: OptionalNullable[str] = UNSET
     r"""The address that will call Permit2's permitTransferFrom to execute the transfer. When `action` is 'DEPOSIT' and `gas_sponsorship` is `true`: - If provided, the signature will authorize this address (typically a gas sponsor) to pull tokens. - If not provided, defaults to the Earn Account (Safe) address, allowing the transfer to be included in a bundle transaction where the Safe pulls the tokens itself."""
 
+    recipient: OptionalNullable[str] = UNSET
+    r"""Optional recipient address for withdrawals. When `action` is 'WITHDRAW': - If provided, tokens will be sent to this address instead of the owner. - If not provided, defaults to the owner's address."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = set(["gas_sponsorship", "spender"])
-        nullable_fields = set(["spender"])
+        optional_fields = set(["gas_sponsorship", "spender", "recipient"])
+        nullable_fields = set(["spender", "recipient"])
         serialized = handler(self)
         m = {}
 

compass_api_sdk-2.2.26/src/compass_api_sdk/models/earntransfertoaddressparams.py

@@ -0,0 +1,93 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel, 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, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+EarnTransferToAddressParamsAmountTypedDict = TypeAliasType(
+    "EarnTransferToAddressParamsAmountTypedDict", Union[float, str]
+)
+r"""The amount of tokens to transfer (in token units, not wei)."""
+
+
+EarnTransferToAddressParamsAmount = TypeAliasType(
+    "EarnTransferToAddressParamsAmount", Union[float, str]
+)
+r"""The amount of tokens to transfer (in token units, not wei)."""
+
+
+class EarnTransferToAddressParamsTypedDict(TypedDict):
+    r"""Parameters for transferring tokens from product account to an arbitrary address.
+
+    Used by multicall/bundle endpoint to send ERC20 tokens from the product account
+    to any specified recipient address as part of an atomic bundle transaction.
+
+    No signature is required for this action since the product account already owns
+    the tokens and is executing the transfer as part of its own transaction.
+    """
+
+    token: str
+    r"""The ERC20 token to transfer from the product account."""
+    amount: EarnTransferToAddressParamsAmountTypedDict
+    r"""The amount of tokens to transfer (in token units, not wei)."""
+    recipient: str
+    r"""The destination address to receive the tokens."""
+    action_type: Literal["V2_TRANSFER_TO_ADDRESS"]
+    r"""Action type identifier for product-account-to-arbitrary-address transfer operations."""
+
+
+class EarnTransferToAddressParams(BaseModel):
+    r"""Parameters for transferring tokens from product account to an arbitrary address.
+
+    Used by multicall/bundle endpoint to send ERC20 tokens from the product account
+    to any specified recipient address as part of an atomic bundle transaction.
+
+    No signature is required for this action since the product account already owns
+    the tokens and is executing the transfer as part of its own transaction.
+    """
+
+    token: str
+    r"""The ERC20 token to transfer from the product account."""
+
+    amount: EarnTransferToAddressParamsAmount
+    r"""The amount of tokens to transfer (in token units, not wei)."""
+
+    recipient: str
+    r"""The destination address to receive the tokens."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["V2_TRANSFER_TO_ADDRESS"]],
+            AfterValidator(validate_const("V2_TRANSFER_TO_ADDRESS")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "V2_TRANSFER_TO_ADDRESS"
+    r"""Action type identifier for product-account-to-arbitrary-address transfer operations."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["action_type"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+try:
+    EarnTransferToAddressParams.model_rebuild()
+except NameError:
+    pass

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/src/compass_api_sdk/models/v2bundlerequest.py

@@ -14,14 +14,16 @@ class V2BundleRequestTypedDict(TypedDict):
 
     ## Supported Action Types
 
-    - **V2_TRANSFER_FROM_EOA**: Transfer tokens from the owner's EOA to the Earn Account
+    - **V2_TRANSFER_FROM_EOA**: Transfer tokens from the owner's EOA to the product account
     using Permit2. Requires a signed Permit2 message.
-    - **V2_TRANSFER_TO_EOA**: Transfer tokens from the Earn Account back to the owner's EOA.
-    No signature required (Safe owns the tokens).
-    - **V2_SWAP**: Swap tokens within the Earn Account using 1inch aggregator.
+    - **V2_TRANSFER_TO_EOA**: Transfer tokens from the product account back to the owner's EOA.
+    No signature required (product account owns the tokens).
+    - **V2_TRANSFER_TO_ADDRESS**: Transfer ERC20 tokens from the product account to any
+    specified recipient address. No signature required (product account owns the tokens).
+    - **V2_SWAP**: Swap tokens within the product account using 1inch aggregator.
     - **V2_MANAGE**: Deposit or withdraw from DeFi venues (Aave, Morpho, Vaults, etc.)
 
-    ## Using V2_TRANSFER_FROM_EOA (Deposit to Earn Account)
+    ## Using V2_TRANSFER_FROM_EOA (Deposit to Product Account)
 
     To include a transfer from EOA in your bundle, follow these steps:
 
@@ -31,7 +33,7 @@ class V2BundleRequestTypedDict(TypedDict):
     2. **Get Permit2 signature**: Call `POST /v2/earn/transfer` with:
     - `action`: \"DEPOSIT\"
     - `gas_sponsorship`: true
-    - `spender`: omit this field (defaults to Safe address for bundle use)
+    - `spender`: omit this field (defaults to product account address for bundle use)
 
     This returns EIP-712 typed data. Sign it with the owner's wallet.
 
@@ -42,9 +44,9 @@ class V2BundleRequestTypedDict(TypedDict):
 
     ## Using V2_TRANSFER_TO_EOA (Withdraw to EOA)
 
-    To transfer tokens from the Earn Account back to the owner's EOA, simply add
+    To transfer tokens from the product account back to the owner's EOA, simply add
     a V2_TRANSFER_TO_EOA action to your bundle. No signature is required since
-    the Safe already owns the tokens.
+    the product account already owns the tokens.
 
     Specify the exact token amount to transfer.
     """
@@ -64,14 +66,16 @@ class V2BundleRequest(BaseModel):
 
     ## Supported Action Types
 
-    - **V2_TRANSFER_FROM_EOA**: Transfer tokens from the owner's EOA to the Earn Account
+    - **V2_TRANSFER_FROM_EOA**: Transfer tokens from the owner's EOA to the product account
     using Permit2. Requires a signed Permit2 message.
-    - **V2_TRANSFER_TO_EOA**: Transfer tokens from the Earn Account back to the owner's EOA.
-    No signature required (Safe owns the tokens).
-    - **V2_SWAP**: Swap tokens within the Earn Account using 1inch aggregator.
+    - **V2_TRANSFER_TO_EOA**: Transfer tokens from the product account back to the owner's EOA.
+    No signature required (product account owns the tokens).
+    - **V2_TRANSFER_TO_ADDRESS**: Transfer ERC20 tokens from the product account to any
+    specified recipient address. No signature required (product account owns the tokens).
+    - **V2_SWAP**: Swap tokens within the product account using 1inch aggregator.
     - **V2_MANAGE**: Deposit or withdraw from DeFi venues (Aave, Morpho, Vaults, etc.)
 
-    ## Using V2_TRANSFER_FROM_EOA (Deposit to Earn Account)
+    ## Using V2_TRANSFER_FROM_EOA (Deposit to Product Account)
 
     To include a transfer from EOA in your bundle, follow these steps:
 
@@ -81,7 +85,7 @@ class V2BundleRequest(BaseModel):
     2. **Get Permit2 signature**: Call `POST /v2/earn/transfer` with:
     - `action`: \"DEPOSIT\"
     - `gas_sponsorship`: true
-    - `spender`: omit this field (defaults to Safe address for bundle use)
+    - `spender`: omit this field (defaults to product account address for bundle use)
 
     This returns EIP-712 typed data. Sign it with the owner's wallet.
 
@@ -92,9 +96,9 @@ class V2BundleRequest(BaseModel):
 
     ## Using V2_TRANSFER_TO_EOA (Withdraw to EOA)
 
-    To transfer tokens from the Earn Account back to the owner's EOA, simply add
+    To transfer tokens from the product account back to the owner's EOA, simply add
     a V2_TRANSFER_TO_EOA action to your bundle. No signature is required since
-    the Safe already owns the tokens.
+    the product account already owns the tokens.
 
     Specify the exact token amount to transfer.
     """

{compass_api_sdk-2.2.25 → compass_api_sdk-2.2.26}/src/compass_api_sdk/models/v2useroperation.py

@@ -7,6 +7,10 @@ from .earntransferfromeoaparams import (
     EarnTransferFromEOAParams,
     EarnTransferFromEOAParamsTypedDict,
 )
+from .earntransfertoaddressparams import (
+    EarnTransferToAddressParams,
+    EarnTransferToAddressParamsTypedDict,
+)
 from .earntransfertoeoaparams import (
     EarnTransferToEOAParams,
     EarnTransferToEOAParamsTypedDict,
@@ -22,6 +26,7 @@ V2UserOperationBodyTypedDict = TypeAliasType(
     "V2UserOperationBodyTypedDict",
     Union[
         EarnTransferToEOAParamsTypedDict,
+        EarnTransferToAddressParamsTypedDict,
         EarnSwapParamsTypedDict,
         EarnManageParamsTypedDict,
         EarnTransferFromEOAParamsTypedDict,
@@ -34,6 +39,7 @@ V2UserOperationBody = Annotated[
         Annotated[EarnManageParams, Tag("V2_MANAGE")],
         Annotated[EarnSwapParams, Tag("V2_SWAP")],
         Annotated[EarnTransferFromEOAParams, Tag("V2_TRANSFER_FROM_EOA")],
+        Annotated[EarnTransferToAddressParams, Tag("V2_TRANSFER_TO_ADDRESS")],
         Annotated[EarnTransferToEOAParams, Tag("V2_TRANSFER_TO_EOA")],
     ],
     Discriminator(lambda m: get_discriminator(m, "action_type", "action_type")),