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

package/src/models/components/mintpreparependingresponse.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Response when attestation is not yet ready.
+ *
+ * @remarks
+ *
+ * Returned with 202 Accepted status code. The client should either:
+ * - Connect to the SSE stream for real-time updates
+ * - Poll the status endpoint periodically
+ * - Call /mint/prepare again after some time
+ */
+export type MintPreparePendingResponse = {
+  /**
+   * Indicates the attestation is still being awaited.
+   */
+  status?: "pending" | undefined;
+  /**
+   * The bridge identifier.
+   */
+  bridgeId: string;
+  /**
+   * The CCTP message hash being polled for attestation.
+   */
+  messageHash: string;
+  /**
+   * SSE endpoint URL for real-time attestation updates.
+   */
+  sseUrl: string;
+  /**
+   * HTTP endpoint URL for polling bridge status.
+   */
+  statusUrl: string;
+  /**
+   * Estimated wait time in seconds. Fast mode is typically ~30 seconds, standard mode is 15-19 minutes.
+   */
+  estimatedWaitSeconds: number;
+};
+
+/** @internal */
+export const MintPreparePendingResponse$inboundSchema: z.ZodType<
+  MintPreparePendingResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.literal("pending").default("pending").optional(),
+  bridge_id: z.string(),
+  message_hash: z.string(),
+  sse_url: z.string(),
+  status_url: z.string(),
+  estimated_wait_seconds: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "bridge_id": "bridgeId",
+    "message_hash": "messageHash",
+    "sse_url": "sseUrl",
+    "status_url": "statusUrl",
+    "estimated_wait_seconds": "estimatedWaitSeconds",
+  });
+});
+
+export function mintPreparePendingResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MintPreparePendingResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MintPreparePendingResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MintPreparePendingResponse' from JSON`,
+  );
+}

package/src/models/components/mintpreparereadyresponse.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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,
+} from "./unsignedtransaction.js";
+
+/**
+ * Response when attestation is ready and mint transaction can be built.
+ *
+ * @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).
+ */
+export type MintPrepareReadyResponse = {
+  /**
+   * Indicates the attestation is ready and mint transaction is available.
+   */
+  status?: "ready" | undefined;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const MintPrepareReadyResponse$inboundSchema: z.ZodType<
+  MintPrepareReadyResponse,
+  z.ZodTypeDef,
+  unknown
+> = 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(),
+}).transform((v) => {
+  return remap$(v, {
+    "bridge_id": "bridgeId",
+    "eip_712": "eip712",
+    "message_hash": "messageHash",
+  });
+});
+
+export function mintPrepareReadyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MintPrepareReadyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MintPrepareReadyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MintPrepareReadyResponse' from JSON`,
+  );
+}

package/src/models/components/mintpreparerequest.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 to:
+ * 1. Look up the bridge session created during burn/prepare
+ * 2. Find the DepositForBurn event on the source chain
+ * 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.
+   */
+  bridgeId: 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.
+   */
+  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;
+};
+
+/** @internal */
+export type MintPrepareRequest$Outbound = {
+  bridge_id: string;
+  owner: string;
+  gas_sponsorship?: boolean | undefined;
+};
+
+/** @internal */
+export const MintPrepareRequest$outboundSchema: z.ZodType<
+  MintPrepareRequest$Outbound,
+  z.ZodTypeDef,
+  MintPrepareRequest
+> = z.object({
+  bridgeId: z.string(),
+  owner: z.string(),
+  gasSponsorship: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    bridgeId: "bridge_id",
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function mintPrepareRequestToJSON(
+  mintPrepareRequest: MintPrepareRequest,
+): string {
+  return JSON.stringify(
+    MintPrepareRequest$outboundSchema.parse(mintPrepareRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -40,6 +40,7 @@ export * from "./v1uniswapquotebuyexactly.js";
 export * from "./v1uniswapquotesellexactly.js";
 export * from "./v1vaultsvault.js";
 export * from "./v1wildcatmarket.js";
+export * from "./v2cctpmint.js";
 export * from "./v2earnaavetokenrates.js";
 export * from "./v2earnpositions.js";
 export * from "./v2earnpositionspositionid.js";

package/src/models/operations/v2cctpmint.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2CctpMintResponse =
+  | components.MintPreparePendingResponse
+  | components.MintPrepareReadyResponse;
+
+/** @internal */
+export const V2CctpMintResponse$inboundSchema: z.ZodType<
+  V2CctpMintResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.MintPreparePendingResponse$inboundSchema,
+  components.MintPrepareReadyResponse$inboundSchema,
+]);
+
+export function v2CctpMintResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<V2CctpMintResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2CctpMintResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2CctpMintResponse' from JSON`,
+  );
+}

package/src/sdk/cctp.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { cctpCCTPBurn } from "../funcs/cctpCCTPBurn.js";
+import { cctpCCTPMint } from "../funcs/cctpCCTPMint.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Cctp extends ClientSDK {
+  /**
+   * Build depositForBurn transaction for Earn Account
+   *
+   * @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).
+   *
+   * **Flow:**
+   * 1. Call this endpoint with `gas_sponsorship=false` to get an unsigned transaction,
+   *    or `gas_sponsorship=true` to get EIP-712 typed data for gas-sponsored execution
+   * 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
+   *
+   * **Supported chains:**
+   * - Ethereum (domain 0)
+   * - Arbitrum (domain 3)
+   * - 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.
+   *
+   * **Gas estimate:** ~200,000 gas units (includes Safe execTransaction overhead)
+   */
+  async cctpBurn(
+    request: components.DepositForBurnRequest,
+    options?: RequestOptions,
+  ): Promise<components.DepositForBurnResponse> {
+    return unwrapAsync(cctpCCTPBurn(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Prepare mint transaction for Earn Account on destination chain
+   *
+   * @remarks
+   * 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 (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`
+   * - `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
+   * - **400 Bad Request**: Bridge not found, or burn event not found yet
+   *
+   * **After receiving 202:**
+   *
+   * 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.
+   */
+  async cctpMint(
+    request: components.MintPrepareRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V2CctpMintResponse> {
+    return unwrapAsync(cctpCCTPMint(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -5,6 +5,7 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { AaveV3 } from "./aavev3.js";
 import { AerodromeSlipstream } from "./aerodromeslipstream.js";
+import { Cctp } from "./cctp.js";
 import { Earn } from "./earn.js";
 import { Erc4626Vaults } from "./erc4626vaults.js";
 import { Ethena } from "./ethena.js";
@@ -102,4 +103,9 @@ export class CompassApiSDK extends ClientSDK {
   get earn(): Earn {
     return (this._earn ??= new Earn(this._options));
   }
+
+  private _cctp?: Cctp;
+  get cctp(): Cctp {
+    return (this._cctp ??= new Cctp(this._options));
+  }
 }

package/src/types/unrecognized.ts

@@ -16,8 +16,16 @@ export function startCountingUnrecognized() {
   refCount++;
   const start = globalCount;
   return {
-    end: () => {
+    /**
+     * Ends counting and returns the delta.
+     * @param delta - If provided, only this amount is added to the parent counter
+     *   (used for nested unions where we only want to record the winning option's count).
+     *   If not provided, records all counts since start().
+     */
+    end: (delta?: number) => {
       const count = globalCount - start;
+      // Reset globalCount back to start, then add only the specified delta
+      globalCount = start + (delta ?? count);
       if (--refCount === 0) globalCount = 0;
       return count;
     },

package/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "compilerOptions": {
     "incremental": true,
-    "tsBuildInfoFile": ".tsbuildinfo",
     "target": "ES2020",
     "lib": ["ES2022", "DOM", "DOM.Iterable"],
     "jsx": "react-jsx",