compass_api_sdk 2.0.6__tar.gz → 2.0.6rc4__tar.gz

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.0.6
+Version: 2.0.6rc4
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2
@@ -240,10 +240,10 @@ with CompassAPI(
 * [aerodrome_slipstream_liquidity_provision_increase](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/aerodromeslipstream/README.md#aerodrome_slipstream_liquidity_provision_increase) - Increase an LP Position
 * [aerodrome_slipstream_liquidity_provision_withdraw](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/aerodromeslipstream/README.md#aerodrome_slipstream_liquidity_provision_withdraw) - Withdraw an LP Position
 
-### [bridge](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/bridge/README.md)
+### [cctp](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/cctp/README.md)
 
-* [cctp_burn](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/bridge/README.md#cctp_burn) - Initiate USDC bridging
-* [cctp_mint](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/bridge/README.md#cctp_mint) - Complete USDC bridging
+* [cctp_burn](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/cctp/README.md#cctp_burn) - Build depositForBurn transaction for Earn Account (CCTP V2)
+* [cctp_mint](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/cctp/README.md#cctp_mint) - Prepare mint transaction for Earn Account on destination chain
 
 ### [earn](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/earn/README.md)
 
@@ -449,7 +449,7 @@ with CompassAPI(
 * [`CompassAPIError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/compassapierror.py): The base class for HTTP error responses.
   * [`HTTPValidationError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/httpvalidationerror.py): Validation Error. Status code `422`.
 
-<details><summary>Less common errors (6)</summary>
+<details><summary>Less common errors (5)</summary>
 
 <br />
 
@@ -460,12 +460,9 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`MintPrepareNotFoundResponseError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 91 methods.*
 * [`ResponseValidationError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>
-
-\* Check [the method documentation](https://github.com/CompassLabs/mono/blob/master/python-sdk/#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/README-PYPI.md

@@ -222,10 +222,10 @@ with CompassAPI(
 * [aerodrome_slipstream_liquidity_provision_increase](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/aerodromeslipstream/README.md#aerodrome_slipstream_liquidity_provision_increase) - Increase an LP Position
 * [aerodrome_slipstream_liquidity_provision_withdraw](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/aerodromeslipstream/README.md#aerodrome_slipstream_liquidity_provision_withdraw) - Withdraw an LP Position
 
-### [bridge](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/bridge/README.md)
+### [cctp](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/cctp/README.md)
 
-* [cctp_burn](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/bridge/README.md#cctp_burn) - Initiate USDC bridging
-* [cctp_mint](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/bridge/README.md#cctp_mint) - Complete USDC bridging
+* [cctp_burn](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/cctp/README.md#cctp_burn) - Build depositForBurn transaction for Earn Account (CCTP V2)
+* [cctp_mint](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/cctp/README.md#cctp_mint) - Prepare mint transaction for Earn Account on destination chain
 
 ### [earn](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/earn/README.md)
 
@@ -431,7 +431,7 @@ with CompassAPI(
 * [`CompassAPIError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/compassapierror.py): The base class for HTTP error responses.
   * [`HTTPValidationError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/httpvalidationerror.py): Validation Error. Status code `422`.
 
-<details><summary>Less common errors (6)</summary>
+<details><summary>Less common errors (5)</summary>
 
 <br />
 
@@ -442,12 +442,9 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`MintPrepareNotFoundResponseError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 91 methods.*
 * [`ResponseValidationError`](https://github.com/CompassLabs/mono/blob/master/python-sdk/./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>
-
-\* Check [the method documentation](https://github.com/CompassLabs/mono/blob/master/python-sdk/#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/pyproject.toml

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

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/src/compass_api_sdk/_version.py

@@ -5,8 +5,8 @@ import importlib.metadata
 __title__: str = "compass_api_sdk"
 __version__: str = "2.0.0"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.768.0"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.768.0 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.767.2"
+__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.767.2 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

compass_api_sdk-2.0.6/src/compass_api_sdk/bridge.py → compass_api_sdk-2.0.6rc4/src/compass_api_sdk/cctp.py

@@ -8,7 +8,7 @@ from compass_api_sdk.utils.unmarshal_json_response import unmarshal_json_respons
 from typing import Any, Mapping, Optional, Union
 
 
-class Bridge(BaseSDK):
+class Cctp(BaseSDK):
     def cctp_burn(
         self,
         *,
@@ -26,9 +26,10 @@ class Bridge(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DepositForBurnResponse:
-        r"""Initiate USDC bridging
+        r"""Build depositForBurn transaction for Earn Account (CCTP V2)
 
-        Bridge USDC from any Product account to any chain using Circle's CCTP Protocol.
+        Build a transaction to burn USDC from an Earn Account (Safe) on the source chain
+        and initiate a cross-chain transfer via Circle's CCTP V2 (Cross-Chain Transfer Protocol).
 
         **Transfer modes:**
         - `standard` (default): ~15-19 minute transfers, **free** (no fee)
@@ -49,10 +50,12 @@ class Bridge(BaseSDK):
         - Arbitrum (domain 3)
         - Base (domain 6)
 
-        **Note:** The USDC must already be deposited in the Product Account. If approval is needed
+        **Note:** The USDC must already be deposited in the Earn Account. If approval is needed
         for the TokenMessengerV2 contract, it will be included in the transaction automatically.
 
-        :param owner: The primary wallet address that owns and controls the Product Account.
+        **Gas estimate:** ~200,000 gas units (includes Safe execTransaction overhead)
+
+        :param owner: The primary wallet address that owns and controls the Earn Account (Safe).
         :param chain: The source chain where USDC will be burned.
         :param amount: The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC).
         :param destination_chain: The destination chain where USDC will be minted.
@@ -157,9 +160,10 @@ class Bridge(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.DepositForBurnResponse:
-        r"""Initiate USDC bridging
+        r"""Build depositForBurn transaction for Earn Account (CCTP V2)
 
-        Bridge USDC from any Product account to any chain using Circle's CCTP Protocol.
+        Build a transaction to burn USDC from an Earn Account (Safe) on the source chain
+        and initiate a cross-chain transfer via Circle's CCTP V2 (Cross-Chain Transfer Protocol).
 
         **Transfer modes:**
         - `standard` (default): ~15-19 minute transfers, **free** (no fee)
@@ -180,10 +184,12 @@ class Bridge(BaseSDK):
         - Arbitrum (domain 3)
         - Base (domain 6)
 
-        **Note:** The USDC must already be deposited in the Product Account. If approval is needed
+        **Note:** The USDC must already be deposited in the Earn Account. If approval is needed
         for the TokenMessengerV2 contract, it will be included in the transaction automatically.
 
-        :param owner: The primary wallet address that owns and controls the Product Account.
+        **Gas estimate:** ~200,000 gas units (includes Safe execTransaction overhead)
+
+        :param owner: The primary wallet address that owns and controls the Earn Account (Safe).
         :param chain: The source chain where USDC will be burned.
         :param amount: The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC).
         :param destination_chain: The destination chain where USDC will be minted.
@@ -276,49 +282,54 @@ class Bridge(BaseSDK):
         *,
         bridge_id: str,
         burn_tx_hash: str,
-        sender: str,
+        owner: str,
+        gas_sponsorship: Optional[bool] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.V2CctpMintResponse:
-        r"""Complete USDC bridging
+        r"""Prepare mint transaction for Earn Account on destination chain
 
-        Prepare a receiveMessage transaction to mint USDC to any Product Account on the
+        Prepare a receiveMessage transaction to mint USDC to an Earn Account (Safe) on the
         destination chain.
 
         **How it works:**
 
         This endpoint uses the `bridge_id` from `/burn` to:
-        1. Look up the bridge session
-        2. Check if Circle's attestation is ready
-        3. Depending on the status of the attestation return the following:
-        - if attestation is still pending, return URLs for real-time updates
-        - if attestation is ready, return a transaction to complete the bridging process
-        - if the minting for a given `bridge_id` has been completed, informs with `completed` status
+        1. Look up the bridge session (no burn tx hash needed!)
+        2. Find the DepositForBurn event on the source chain using stored nonce
+        3. Extract the CCTP message and compute its hash
+        4. Check if Circle's attestation is ready
+        5. Return the mint transaction wrapped in Safe execTransaction
 
         **Request parameters:**
 
         - `bridge_id`: The bridge ID returned from `/burn`
-        - `burn_tx_hash`: The transaction hash of the burn transaction on the source chain
+        - `owner`: The wallet address that owns the Earn Account (Safe) on the destination chain
+        - `gas_sponsorship`: If true, returns EIP-712 typed data for gas-sponsored execution
 
         **Response codes:**
 
         - **200 OK**: Attestation is ready, mint transaction is included
         - **202 Accepted**: Attestation is pending, SSE URL for real-time updates is included
-        - **404 Not found**: Bridge not found
+        - **400 Bad Request**: Bridge not found, or burn event not found yet
 
         **After receiving 202:**
 
-        The SSE stream and status endpoint are in progress. Keep an eye on the updates from our team.
-
         Either:
         - Connect to the SSE stream at `sse_url` and wait for `attestation_ready` event
         - Poll this endpoint periodically until you get 200
 
+        **After receiving 200:**
+
+        Sign and broadcast the returned transaction on the destination chain to mint USDC
+        to your Earn Account.
+
         :param bridge_id: The bridge identifier returned from /burn endpoint. This is used to look up the bridge session.
         :param burn_tx_hash: The transaction hash of the burn transaction on the source chain. This is used to find the DepositForBurn event and extract the CCTP message.
-        :param sender: The wallet address that will sign and send the mint transaction.
+        :param owner: The primary wallet address that owns and controls the Earn Account (Safe) on the destination chain. This is used to determine the Safe address that will receive and execute the receiveMessage transaction.
+        :param gas_sponsorship: 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`).
         :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
@@ -337,7 +348,8 @@ class Bridge(BaseSDK):
         request = models.MintPrepareRequest(
             bridge_id=bridge_id,
             burn_tx_hash=burn_tx_hash,
-            sender=sender,
+            owner=owner,
+            gas_sponsorship=gas_sponsorship,
         )
 
         req = self._build_request(
@@ -377,20 +389,15 @@ class Bridge(BaseSDK):
                 security_source=self.sdk_configuration.security,
             ),
             request=req,
-            error_status_codes=["404", "422", "4XX", "5XX"],
+            error_status_codes=["422", "4XX", "5XX"],
             retry_config=retry_config,
         )
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.Response200V2CctpMint, http_res)
+            return unmarshal_json_response(models.MintPrepareReadyResponse, http_res)
         if utils.match_response(http_res, "202", "application/json"):
             return unmarshal_json_response(models.MintPreparePendingResponse, http_res)
-        if utils.match_response(http_res, "404", "application/json"):
-            response_data = unmarshal_json_response(
-                errors.MintPrepareNotFoundResponseErrorData, http_res
-            )
-            raise errors.MintPrepareNotFoundResponseError(response_data, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -410,49 +417,54 @@ class Bridge(BaseSDK):
         *,
         bridge_id: str,
         burn_tx_hash: str,
-        sender: str,
+        owner: str,
+        gas_sponsorship: Optional[bool] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.V2CctpMintResponse:
-        r"""Complete USDC bridging
+        r"""Prepare mint transaction for Earn Account on destination chain
 
-        Prepare a receiveMessage transaction to mint USDC to any Product Account on the
+        Prepare a receiveMessage transaction to mint USDC to an Earn Account (Safe) on the
         destination chain.
 
         **How it works:**
 
         This endpoint uses the `bridge_id` from `/burn` to:
-        1. Look up the bridge session
-        2. Check if Circle's attestation is ready
-        3. Depending on the status of the attestation return the following:
-        - if attestation is still pending, return URLs for real-time updates
-        - if attestation is ready, return a transaction to complete the bridging process
-        - if the minting for a given `bridge_id` has been completed, informs with `completed` status
+        1. Look up the bridge session (no burn tx hash needed!)
+        2. Find the DepositForBurn event on the source chain using stored nonce
+        3. Extract the CCTP message and compute its hash
+        4. Check if Circle's attestation is ready
+        5. Return the mint transaction wrapped in Safe execTransaction
 
         **Request parameters:**
 
         - `bridge_id`: The bridge ID returned from `/burn`
-        - `burn_tx_hash`: The transaction hash of the burn transaction on the source chain
+        - `owner`: The wallet address that owns the Earn Account (Safe) on the destination chain
+        - `gas_sponsorship`: If true, returns EIP-712 typed data for gas-sponsored execution
 
         **Response codes:**
 
         - **200 OK**: Attestation is ready, mint transaction is included
         - **202 Accepted**: Attestation is pending, SSE URL for real-time updates is included
-        - **404 Not found**: Bridge not found
+        - **400 Bad Request**: Bridge not found, or burn event not found yet
 
         **After receiving 202:**
 
-        The SSE stream and status endpoint are in progress. Keep an eye on the updates from our team.
-
         Either:
         - Connect to the SSE stream at `sse_url` and wait for `attestation_ready` event
         - Poll this endpoint periodically until you get 200
 
+        **After receiving 200:**
+
+        Sign and broadcast the returned transaction on the destination chain to mint USDC
+        to your Earn Account.
+
         :param bridge_id: The bridge identifier returned from /burn endpoint. This is used to look up the bridge session.
         :param burn_tx_hash: The transaction hash of the burn transaction on the source chain. This is used to find the DepositForBurn event and extract the CCTP message.
-        :param sender: The wallet address that will sign and send the mint transaction.
+        :param owner: The primary wallet address that owns and controls the Earn Account (Safe) on the destination chain. This is used to determine the Safe address that will receive and execute the receiveMessage transaction.
+        :param gas_sponsorship: 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`).
         :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
@@ -471,7 +483,8 @@ class Bridge(BaseSDK):
         request = models.MintPrepareRequest(
             bridge_id=bridge_id,
             burn_tx_hash=burn_tx_hash,
-            sender=sender,
+            owner=owner,
+            gas_sponsorship=gas_sponsorship,
         )
 
         req = self._build_request_async(
@@ -511,20 +524,15 @@ class Bridge(BaseSDK):
                 security_source=self.sdk_configuration.security,
             ),
             request=req,
-            error_status_codes=["404", "422", "4XX", "5XX"],
+            error_status_codes=["422", "4XX", "5XX"],
             retry_config=retry_config,
         )
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.Response200V2CctpMint, http_res)
+            return unmarshal_json_response(models.MintPrepareReadyResponse, http_res)
         if utils.match_response(http_res, "202", "application/json"):
             return unmarshal_json_response(models.MintPreparePendingResponse, http_res)
-        if utils.match_response(http_res, "404", "application/json"):
-            response_data = unmarshal_json_response(
-                errors.MintPrepareNotFoundResponseErrorData, http_res
-            )
-            raise errors.MintPrepareNotFoundResponseError(response_data, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/src/compass_api_sdk/errors/__init__.py

@@ -9,10 +9,6 @@ import sys
 if TYPE_CHECKING:
     from .apierror import APIError
     from .httpvalidationerror import HTTPValidationError, HTTPValidationErrorData
-    from .mintpreparenotfoundresponse_error import (
-        MintPrepareNotFoundResponseError,
-        MintPrepareNotFoundResponseErrorData,
-    )
     from .no_response_error import NoResponseError
     from .responsevalidationerror import ResponseValidationError
 
@@ -21,8 +17,6 @@ __all__ = [
     "CompassAPIError",
     "HTTPValidationError",
     "HTTPValidationErrorData",
-    "MintPrepareNotFoundResponseError",
-    "MintPrepareNotFoundResponseErrorData",
     "NoResponseError",
     "ResponseValidationError",
 ]
@@ -31,8 +25,6 @@ _dynamic_imports: dict[str, str] = {
     "APIError": ".apierror",
     "HTTPValidationError": ".httpvalidationerror",
     "HTTPValidationErrorData": ".httpvalidationerror",
-    "MintPrepareNotFoundResponseError": ".mintpreparenotfoundresponse_error",
-    "MintPrepareNotFoundResponseErrorData": ".mintpreparenotfoundresponse_error",
     "NoResponseError": ".no_response_error",
     "ResponseValidationError": ".responsevalidationerror",
 }

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/src/compass_api_sdk/models/__init__.py

@@ -477,10 +477,6 @@ if TYPE_CHECKING:
     from .marketposition import MarketPosition, MarketPositionTypedDict
     from .markettokens import MarketTokens, MarketTokensTypedDict
     from .maxsupplyapydata import MaxSupplyApyData, MaxSupplyApyDataTypedDict
-    from .mintpreparecompletedresponse import (
-        MintPrepareCompletedResponse,
-        MintPrepareCompletedResponseTypedDict,
-    )
     from .mintpreparependingresponse import (
         MintPreparePendingResponse,
         MintPreparePendingResponseTypedDict,
@@ -1190,12 +1186,7 @@ if TYPE_CHECKING:
         V1WildcatMarketRequest,
         V1WildcatMarketRequestTypedDict,
     )
-    from .v2_cctp_mintop import (
-        Response200V2CctpMint,
-        Response200V2CctpMintTypedDict,
-        V2CctpMintResponse,
-        V2CctpMintResponseTypedDict,
-    )
+    from .v2_cctp_mintop import V2CctpMintResponse, V2CctpMintResponseTypedDict
     from .v2_earn_aave_token_ratesop import (
         V2EarnAaveTokenRatesRequest,
         V2EarnAaveTokenRatesRequestTypedDict,
@@ -1605,8 +1596,6 @@ __all__ = [
     "MaxSlippagePercentTypedDict",
     "MaxSupplyApyData",
     "MaxSupplyApyDataTypedDict",
-    "MintPrepareCompletedResponse",
-    "MintPrepareCompletedResponseTypedDict",
     "MintPreparePendingResponse",
     "MintPreparePendingResponseTypedDict",
     "MintPrepareReadyResponse",
@@ -1778,8 +1767,6 @@ __all__ = [
     "RepayTypedDict",
     "Reserve",
     "ReserveTypedDict",
-    "Response200V2CctpMint",
-    "Response200V2CctpMintTypedDict",
     "ResponseV1TransactionBundlerAaveLoop",
     "ResponseV1TransactionBundlerAaveLoopTypedDict",
     "S",
@@ -2518,8 +2505,6 @@ _dynamic_imports: dict[str, str] = {
     "MarketTokensTypedDict": ".markettokens",
     "MaxSupplyApyData": ".maxsupplyapydata",
     "MaxSupplyApyDataTypedDict": ".maxsupplyapydata",
-    "MintPrepareCompletedResponse": ".mintpreparecompletedresponse",
-    "MintPrepareCompletedResponseTypedDict": ".mintpreparecompletedresponse",
     "MintPreparePendingResponse": ".mintpreparependingresponse",
     "MintPreparePendingResponseTypedDict": ".mintpreparependingresponse",
     "MintPrepareReadyResponse": ".mintpreparereadyresponse",
@@ -3023,8 +3008,6 @@ _dynamic_imports: dict[str, str] = {
     "V1WildcatMarketChain": ".v1_wildcat_marketop",
     "V1WildcatMarketRequest": ".v1_wildcat_marketop",
     "V1WildcatMarketRequestTypedDict": ".v1_wildcat_marketop",
-    "Response200V2CctpMint": ".v2_cctp_mintop",
-    "Response200V2CctpMintTypedDict": ".v2_cctp_mintop",
     "V2CctpMintResponse": ".v2_cctp_mintop",
     "V2CctpMintResponseTypedDict": ".v2_cctp_mintop",
     "V2EarnAaveTokenRatesRequest": ".v2_earn_aave_token_ratesop",

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/src/compass_api_sdk/models/depositforburnrequest.py

@@ -43,8 +43,24 @@ class DepositForBurnRequestTransferMode(str, Enum):
 
 
 class DepositForBurnRequestTypedDict(TypedDict):
+    r"""Request model for CCTP depositForBurn transaction from a smart account.
+
+    Burns USDC from an Earn Account (Safe) to initiate a cross-chain transfer
+    via Circle's CCTP. The transaction is executed through the Safe contract,
+    supporting both direct owner execution and gas-sponsored transactions.
+
+    Flow:
+    1. Owner calls this endpoint to get either:
+    - An unsigned transaction (gas_sponsorship=False)
+    - EIP-712 typed data for signing (gas_sponsorship=True)
+    2. Owner signs the transaction/typed data
+    3. Transaction is broadcast on source chain
+    4. Wait for Circle's attestation service
+    5. Call receiveMessage on destination chain to mint USDC
+    """
+
     owner: str
-    r"""The primary wallet address that owns and controls the Product Account."""
+    r"""The primary wallet address that owns and controls the Earn Account (Safe)."""
     chain: DepositForBurnRequestChain
     r"""The source chain where USDC will be burned."""
     amount: DepositForBurnRequestAmountTypedDict
@@ -58,8 +74,24 @@ class DepositForBurnRequestTypedDict(TypedDict):
 
 
 class DepositForBurnRequest(BaseModel):
+    r"""Request model for CCTP depositForBurn transaction from a smart account.
+
+    Burns USDC from an Earn Account (Safe) to initiate a cross-chain transfer
+    via Circle's CCTP. The transaction is executed through the Safe contract,
+    supporting both direct owner execution and gas-sponsored transactions.
+
+    Flow:
+    1. Owner calls this endpoint to get either:
+    - An unsigned transaction (gas_sponsorship=False)
+    - EIP-712 typed data for signing (gas_sponsorship=True)
+    2. Owner signs the transaction/typed data
+    3. Transaction is broadcast on source chain
+    4. Wait for Circle's attestation service
+    5. Call receiveMessage on destination chain to mint USDC
+    """
+
     owner: str
-    r"""The primary wallet address that owns and controls the Product Account."""
+    r"""The primary wallet address that owns and controls the Earn Account (Safe)."""
 
     chain: DepositForBurnRequestChain
     r"""The source chain where USDC will be burned."""

{compass_api_sdk-2.0.6 → compass_api_sdk-2.0.6rc4}/src/compass_api_sdk/models/depositforburnresponse.py

@@ -28,9 +28,23 @@ class DepositForBurnResponseTransferMode(str, Enum):
 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.
+    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.
+
+    Attributes:
+    bridge_id: Unique identifier for this bridge operation. Use this ID when
+    calling /mint/prepare to complete the cross-chain transfer. The API
+    tracks the bridge state and will automatically poll for Circle's
+    attestation.
+    transaction: Unsigned transaction for the owner to sign and submit directly.
+    Present when gas_sponsorship=False.
+    eip_712: EIP-712 typed data for off-chain signing. The owner signs this
+    data and submits it to /gas_sponsorship/prepare for a relayer to execute.
+    Present when gas_sponsorship=True.
+    transfer_mode: The transfer speed mode used for this bridge operation.
+    fee: Fee amount in USDC (only charged for fast mode, None for standard).
+    estimated_time_seconds: Estimated time to complete the bridge in seconds.
     """
 
     transaction: Nullable[UnsignedTransactionTypedDict]
@@ -48,9 +62,23 @@ class DepositForBurnResponseTypedDict(TypedDict):
 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.
+    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.
+
+    Attributes:
+    bridge_id: Unique identifier for this bridge operation. Use this ID when
+    calling /mint/prepare to complete the cross-chain transfer. The API
+    tracks the bridge state and will automatically poll for Circle's
+    attestation.
+    transaction: Unsigned transaction for the owner to sign and submit directly.
+    Present when gas_sponsorship=False.
+    eip_712: EIP-712 typed data for off-chain signing. The owner signs this
+    data and submits it to /gas_sponsorship/prepare for a relayer to execute.
+    Present when gas_sponsorship=True.
+    transfer_mode: The transfer speed mode used for this bridge operation.
+    fee: Fee amount in USDC (only charged for fast mode, None for standard).
+    estimated_time_seconds: Estimated time to complete the bridge in seconds.
     """
 
     transaction: Nullable[UnsignedTransaction]