@compass-labs/api-sdk 2.1.10-rc.6 → 2.1.10-rc.8

package/src/models/components/depositforburnrequest.ts

@@ -58,22 +58,12 @@ export type DepositForBurnRequestTransferMode = ClosedEnum<
  *
  * @remarks
  *
- * 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
+ * Burns USDC from a Product Account to initiate a cross-chain transfer via Circle's
+ * CCTP.
  */
 export type DepositForBurnRequest = {
   /**
-   * The primary wallet address that owns and controls the Earn Account (Safe).
+   * The primary wallet address that owns and controls the Product Account.
    */
   owner: string;
   /**

package/src/models/components/mintpreparereadyresponse.ts

@@ -7,10 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  BatchedSafeOperationsResponseOutput,
-  BatchedSafeOperationsResponseOutput$inboundSchema,
-} from "./batchedsafeoperationsresponseoutput.js";
 import {
   UnsignedTransaction,
   UnsignedTransaction$inboundSchema,
@@ -21,10 +17,8 @@ import {
  *
  * @remarks
  *
- * Returned with 200 OK status code. Contains either an unsigned transaction for direct
- * submission or EIP-712 typed data for gas-sponsored transactions. The transaction
- * calls receiveMessage on the MessageTransmitter contract through the Earn Account
- * (Safe).
+ * Returned with 200 OK status code. Contains an unsigned transaction that calls
+ * receiveMessage on the MessageTransmitter contract.
  */
 export type MintPrepareReadyResponse = {
   /**
@@ -35,18 +29,7 @@ export type MintPrepareReadyResponse = {
    * The bridge identifier.
    */
   bridgeId: string;
-  /**
-   * Unsigned Safe execTransaction for the destination chain that calls receiveMessage on the MessageTransmitter contract. Sign and broadcast this to mint USDC to your Earn Account. Present when gas_sponsorship=False.
-   */
-  transaction?: UnsignedTransaction | null | undefined;
-  /**
-   * 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.
-   */
-  eip712?: BatchedSafeOperationsResponseOutput | null | undefined;
-  /**
-   * The CCTP message hash used to obtain the attestation.
-   */
-  messageHash: string;
+  transaction: UnsignedTransaction;
 };
 
 /** @internal */
@@ -57,15 +40,10 @@ export const MintPrepareReadyResponse$inboundSchema: z.ZodType<
 > = z.object({
   status: z.literal("ready").default("ready").optional(),
   bridge_id: z.string(),
-  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
-  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
-    .optional(),
-  message_hash: z.string(),
+  transaction: UnsignedTransaction$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "bridge_id": "bridgeId",
-    "eip_712": "eip712",
-    "message_hash": "messageHash",
   });
 });
 

package/src/models/components/mintpreparerequest.ts

@@ -6,16 +6,7 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 /**
- * Request model for preparing a CCTP mint transaction on an Earn Account.
- *
- * @remarks
- *
- * The mint/prepare endpoint uses the bridge_id and burn_tx_hash to:
- * 1. Look up the bridge session created during burn/prepare
- * 2. Find the DepositForBurn event using the burn transaction hash
- * 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 model for preparing a CCTP mint transaction.
  */
 export type MintPrepareRequest = {
   /**
@@ -27,21 +18,16 @@ export type MintPrepareRequest = {
    */
   burnTxHash: string;
   /**
-   * 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.
+   * The wallet address that will sign and send the mint transaction.
    */
-  owner: string;
-  /**
-   * 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`).
-   */
-  gasSponsorship?: boolean | undefined;
+  sender: string;
 };
 
 /** @internal */
 export type MintPrepareRequest$Outbound = {
   bridge_id: string;
   burn_tx_hash: string;
-  owner: string;
-  gas_sponsorship?: boolean | undefined;
+  sender: string;
 };
 
 /** @internal */
@@ -52,13 +38,11 @@ export const MintPrepareRequest$outboundSchema: z.ZodType<
 > = z.object({
   bridgeId: z.string(),
   burnTxHash: z.string(),
-  owner: z.string(),
-  gasSponsorship: z.boolean().optional(),
+  sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
     bridgeId: "bridge_id",
     burnTxHash: "burn_tx_hash",
-    gasSponsorship: "gas_sponsorship",
   });
 });
 

package/src/sdk/bridge.ts

@@ -14,7 +14,7 @@ export class Bridge extends ClientSDK {
    * Initiate USDC bridging
    *
    * @remarks
-   * Build a transaction to burn USDC from an Earn Account (Safe) on the source chain
+   * Build a transaction to burn USDC from any Product Account on the source chain
    * and initiate a cross-chain transfer via Circle's CCTP V2 (Cross-Chain Transfer Protocol).
    *
    * **Transfer modes:**
@@ -38,10 +38,8 @@ export class Bridge extends ClientSDK {
    * - Arbitrum (domain 3)
    * - Base (domain 6)
    *
-   * **Note:** The USDC must already be deposited in the Earn Account. If approval is needed
+   * **Note:** The USDC must already be deposited in the Product Account. If approval is needed
    * for the TokenMessengerV2 contract, it will be included in the transaction automatically.
-   *
-   * **Gas estimate:** ~200,000 gas units (includes Safe execTransaction overhead)
    */
   async cctpBurn(
     request: components.DepositForBurnRequest,
@@ -55,28 +53,25 @@ export class Bridge extends ClientSDK {
   }
 
   /**
-   * Confirm bridging
+   * Confirm USDC bridging
    *
    * @remarks
    * ***This endpoint is only needed to be called in rare cases when bridging was not confirmed automatically***
    *
-   * Prepare a receiveMessage transaction to mint USDC to an Earn Account (Safe) on the
+   * Prepare a receiveMessage transaction to mint USDC to any Product Account on the
    * destination chain.
    *
    * **How it works:**
    *
    * This endpoint uses the `bridge_id` from `/burn` to:
-   * 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
+   * 1. Look up the bridge session
+   * 2. Check if Circle's attestation is ready
+   * 3. Return the mint transaction
    *
    * **Request parameters:**
    *
    * - `bridge_id`: The bridge ID returned from `/burn`
-   * - `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
+   * - `burn_tx_hash`: The transaction hash of the burn transaction on the source chain
    *
    * **Response codes:**
    *
@@ -86,6 +81,8 @@ export class Bridge extends ClientSDK {
    *
    * **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
@@ -93,7 +90,7 @@ export class Bridge extends ClientSDK {
    * **After receiving 200:**
    *
    * Sign and broadcast the returned transaction on the destination chain to mint USDC
-   * to your Earn Account.
+   * to your Product Account.
    */
   async cctpMint(
     request: components.MintPrepareRequest,