@compass-labs/api-sdk 2.1.10-rc.2 → 2.1.10-rc.4

package/src/funcs/cctpCCTPBurn.ts

@@ -26,11 +26,17 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Build depositForBurn transaction for Earn Account
+ * Build depositForBurn transaction for Earn Account (CCTP V2)
  *
  * @remarks
  * 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 (Cross-Chain Transfer Protocol).
+ * 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)
+ * - `fast`: ~30 second transfers, requires a small fee (typically ~0.01%)
+ *
+ * The fee for fast mode is automatically calculated based on Circle's current rates.
  *
  * **Flow:**
  * 1. Call this endpoint with `gas_sponsorship=false` to get an unsigned transaction,
@@ -38,7 +44,7 @@ import { Result } from "../types/fp.js";
  * 2. Owner signs the transaction or typed data
  * 3. Broadcast the transaction on the source chain (or submit to `/gas_sponsorship/prepare`)
  * 4. Wait for Circle's attestation service to attest the burn
- * 5. Call the mint endpoint (when available) to receive USDC on the destination chain
+ * 5. Call the mint endpoint to receive USDC on the destination chain
  *
  * **Supported chains:**
  * - Ethereum (domain 0)
@@ -46,7 +52,7 @@ import { Result } from "../types/fp.js";
  * - Base (domain 6)
  *
  * **Note:** The USDC must already be deposited in the Earn Account. If approval is needed
- * for the TokenMessenger contract, it will be included in the transaction automatically.
+ * for the TokenMessengerV2 contract, it will be included in the transaction automatically.
  *
  * **Gas estimate:** ~200,000 gas units (includes Safe execTransaction overhead)
  */

package/src/models/components/depositforburnrequest.ts

@@ -39,6 +39,20 @@ export const DestinationChain = {
  */
 export type DestinationChain = ClosedEnum<typeof DestinationChain>;
 
+/**
+ * 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'.
+ */
+export const DepositForBurnRequestTransferMode = {
+  Fast: "fast",
+  Standard: "standard",
+} as const;
+/**
+ * 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'.
+ */
+export type DepositForBurnRequestTransferMode = ClosedEnum<
+  typeof DepositForBurnRequestTransferMode
+>;
+
 /**
  * Request model for CCTP depositForBurn transaction from a smart account.
  *
@@ -74,14 +88,14 @@ export type DepositForBurnRequest = {
    * The destination chain where USDC will be minted.
    */
   destinationChain: DestinationChain;
-  /**
-   * The recipient address on the destination chain.
-   */
-  destinationAddress: 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;
+  /**
+   * 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'.
+   */
+  transferMode?: DepositForBurnRequestTransferMode | undefined;
 };
 
 /** @internal */
@@ -114,14 +128,19 @@ export const DestinationChain$outboundSchema: z.ZodNativeEnum<
   typeof DestinationChain
 > = z.nativeEnum(DestinationChain);
 
+/** @internal */
+export const DepositForBurnRequestTransferMode$outboundSchema: z.ZodNativeEnum<
+  typeof DepositForBurnRequestTransferMode
+> = z.nativeEnum(DepositForBurnRequestTransferMode);
+
 /** @internal */
 export type DepositForBurnRequest$Outbound = {
   owner: string;
   chain: string;
   amount: number | string;
   destination_chain: string;
-  destination_address: string;
   gas_sponsorship?: boolean | undefined;
+  transfer_mode?: string | undefined;
 };
 
 /** @internal */
@@ -134,13 +153,13 @@ export const DepositForBurnRequest$outboundSchema: z.ZodType<
   chain: DepositForBurnRequestChain$outboundSchema,
   amount: z.union([z.number(), z.string()]),
   destinationChain: DestinationChain$outboundSchema,
-  destinationAddress: z.string(),
   gasSponsorship: z.boolean().optional(),
+  transferMode: DepositForBurnRequestTransferMode$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     destinationChain: "destination_chain",
-    destinationAddress: "destination_address",
     gasSponsorship: "gas_sponsorship",
+    transferMode: "transfer_mode",
   });
 });
 

package/src/models/components/depositforburnresponse.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -16,6 +17,20 @@ import {
   UnsignedTransaction$inboundSchema,
 } from "./unsignedtransaction.js";
 
+/**
+ * The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min).
+ */
+export const DepositForBurnResponseTransferMode = {
+  Fast: "fast",
+  Standard: "standard",
+} as const;
+/**
+ * The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min).
+ */
+export type DepositForBurnResponseTransferMode = ClosedEnum<
+  typeof DepositForBurnResponseTransferMode
+>;
+
 /**
  * Response model for CCTP depositForBurn transaction from a smart account.
  *
@@ -35,6 +50,9 @@ import {
  *     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.
  */
 export type DepositForBurnResponse = {
   /**
@@ -43,8 +61,25 @@ export type DepositForBurnResponse = {
   bridgeId?: string | null | undefined;
   transaction: UnsignedTransaction | null;
   eip712: BatchedSafeOperationsResponseOutput | null;
+  /**
+   * The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min).
+   */
+  transferMode: DepositForBurnResponseTransferMode;
+  /**
+   * Fee amount in USDC charged for this transfer. Only present for fast mode. Standard mode transfers are free (fee is None or 0).
+   */
+  fee?: string | null | undefined;
+  /**
+   * Estimated time to complete the bridge in seconds.
+   */
+  estimatedTimeSeconds: number;
 };
 
+/** @internal */
+export const DepositForBurnResponseTransferMode$inboundSchema: z.ZodNativeEnum<
+  typeof DepositForBurnResponseTransferMode
+> = z.nativeEnum(DepositForBurnResponseTransferMode);
+
 /** @internal */
 export const DepositForBurnResponse$inboundSchema: z.ZodType<
   DepositForBurnResponse,
@@ -54,10 +89,15 @@ export const DepositForBurnResponse$inboundSchema: z.ZodType<
   bridge_id: z.nullable(z.string()).optional(),
   transaction: z.nullable(UnsignedTransaction$inboundSchema),
   eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema),
+  transfer_mode: DepositForBurnResponseTransferMode$inboundSchema,
+  fee: z.nullable(z.string()).optional(),
+  estimated_time_seconds: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
     "bridge_id": "bridgeId",
     "eip_712": "eip712",
+    "transfer_mode": "transferMode",
+    "estimated_time_seconds": "estimatedTimeSeconds",
   });
 });
 

package/src/models/components/mintpreparerequest.ts

@@ -10,20 +10,22 @@ import { remap as remap$ } from "../../lib/primitives.js";
  *
  * @remarks
  *
- * The mint/prepare endpoint uses the bridge_id to:
+ * 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 on the source chain
+ * 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
- *
- * This eliminates the need for users to provide the burn transaction hash.
  */
 export type MintPrepareRequest = {
   /**
-   * The bridge identifier returned from /burn endpoint. This is used to look up the bridge session and find the burn event.
+   * The bridge identifier returned from /burn endpoint. This is used to look up the bridge session.
    */
   bridgeId: string;
+  /**
+   * The transaction hash of the burn transaction on the source chain. This is used to find the DepositForBurn event and extract the CCTP message.
+   */
+  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.
    */
@@ -37,6 +39,7 @@ export type MintPrepareRequest = {
 /** @internal */
 export type MintPrepareRequest$Outbound = {
   bridge_id: string;
+  burn_tx_hash: string;
   owner: string;
   gas_sponsorship?: boolean | undefined;
 };
@@ -48,11 +51,13 @@ export const MintPrepareRequest$outboundSchema: z.ZodType<
   MintPrepareRequest
 > = z.object({
   bridgeId: z.string(),
+  burnTxHash: z.string(),
   owner: z.string(),
   gasSponsorship: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     bridgeId: "bridge_id",
+    burnTxHash: "burn_tx_hash",
     gasSponsorship: "gas_sponsorship",
   });
 });

package/src/sdk/cctp.ts

@@ -11,11 +11,17 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Cctp extends ClientSDK {
   /**
-   * Build depositForBurn transaction for Earn Account
+   * Build depositForBurn transaction for Earn Account (CCTP V2)
    *
    * @remarks
    * 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 (Cross-Chain Transfer Protocol).
+   * 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)
+   * - `fast`: ~30 second transfers, requires a small fee (typically ~0.01%)
+   *
+   * The fee for fast mode is automatically calculated based on Circle's current rates.
    *
    * **Flow:**
    * 1. Call this endpoint with `gas_sponsorship=false` to get an unsigned transaction,
@@ -23,7 +29,7 @@ export class Cctp extends ClientSDK {
    * 2. Owner signs the transaction or typed data
    * 3. Broadcast the transaction on the source chain (or submit to `/gas_sponsorship/prepare`)
    * 4. Wait for Circle's attestation service to attest the burn
-   * 5. Call the mint endpoint (when available) to receive USDC on the destination chain
+   * 5. Call the mint endpoint to receive USDC on the destination chain
    *
    * **Supported chains:**
    * - Ethereum (domain 0)
@@ -31,7 +37,7 @@ export class Cctp extends ClientSDK {
    * - Base (domain 6)
    *
    * **Note:** The USDC must already be deposited in the Earn Account. If approval is needed
-   * for the TokenMessenger contract, it will be included in the transaction automatically.
+   * for the TokenMessengerV2 contract, it will be included in the transaction automatically.
    *
    * **Gas estimate:** ~200,000 gas units (includes Safe execTransaction overhead)
    */

package/examples/node_modules/tsx/dist/package-DqlROeDy.mjs

@@ -1 +0,0 @@
-var r="4.20.6";export{r as v};