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

package/src/funcs/cctpCCTPBurn.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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)
+ */
+export function cctpCCTPBurn(
+  client: CompassApiSDKCore,
+  request: components.DepositForBurnRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DepositForBurnResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.DepositForBurnRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DepositForBurnResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.DepositForBurnRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/cctp/burn")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_cctp_burn",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.DepositForBurnResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DepositForBurnResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/cctpCCTPMint.ts

@@ -0,0 +1,204 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function cctpCCTPMint(
+  client: CompassApiSDKCore,
+  request: components.MintPrepareRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.V2CctpMintResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.MintPrepareRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.V2CctpMintResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.MintPrepareRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/cctp/mint")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_cctp_mint",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.V2CctpMintResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.V2CctpMintResponse$inboundSchema),
+    M.json(202, operations.V2CctpMintResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -62,7 +62,7 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
   sdkVersion: "2.0.0",
-  genVersion: "2.763.3",
+  genVersion: "2.767.2",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.763.3 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.767.2 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/lib/encodings.ts

@@ -427,6 +427,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 type QueryEncoderOptions = {
   explode?: boolean;
   charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
 };
 
 type QueryEncoder = (
@@ -451,7 +452,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
       charEncoding: options?.charEncoding ?? "percent",
     };
 
+    const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
+
     const encoded = Object.entries(values).map(([key, value]) => {
+      if (allowEmptySet.has(key)) {
+        if (
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
+        ) {
+          return `${encodeURIComponent(key)}=`;
+        }
+      }
       return f(key, value, opts);
     });
     return queryJoin(...encoded);

package/src/models/components/depositforburnrequest.ts

@@ -0,0 +1,153 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The source chain where USDC will be burned.
+ */
+export const DepositForBurnRequestChain = {
+  Ethereum: "ethereum",
+  Arbitrum: "arbitrum",
+  Base: "base",
+} as const;
+/**
+ * The source chain where USDC will be burned.
+ */
+export type DepositForBurnRequestChain = ClosedEnum<
+  typeof DepositForBurnRequestChain
+>;
+
+/**
+ * The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC).
+ */
+export type DepositForBurnRequestAmount = number | string;
+
+/**
+ * The destination chain where USDC will be minted.
+ */
+export const DestinationChain = {
+  Ethereum: "ethereum",
+  Arbitrum: "arbitrum",
+  Base: "base",
+} as const;
+/**
+ * The destination chain where USDC will be minted.
+ */
+export type DestinationChain = ClosedEnum<typeof DestinationChain>;
+
+/**
+ * Request model for CCTP depositForBurn transaction from a smart account.
+ *
+ * @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
+ */
+export type DepositForBurnRequest = {
+  /**
+   * The primary wallet address that owns and controls the Earn Account (Safe).
+   */
+  owner: string;
+  /**
+   * The source chain where USDC will be burned.
+   */
+  chain: DepositForBurnRequestChain;
+  /**
+   * The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC).
+   */
+  amount: number | string;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const DepositForBurnRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof DepositForBurnRequestChain
+> = z.nativeEnum(DepositForBurnRequestChain);
+
+/** @internal */
+export type DepositForBurnRequestAmount$Outbound = number | string;
+
+/** @internal */
+export const DepositForBurnRequestAmount$outboundSchema: z.ZodType<
+  DepositForBurnRequestAmount$Outbound,
+  z.ZodTypeDef,
+  DepositForBurnRequestAmount
+> = z.union([z.number(), z.string()]);
+
+export function depositForBurnRequestAmountToJSON(
+  depositForBurnRequestAmount: DepositForBurnRequestAmount,
+): string {
+  return JSON.stringify(
+    DepositForBurnRequestAmount$outboundSchema.parse(
+      depositForBurnRequestAmount,
+    ),
+  );
+}
+
+/** @internal */
+export const DestinationChain$outboundSchema: z.ZodNativeEnum<
+  typeof DestinationChain
+> = z.nativeEnum(DestinationChain);
+
+/** @internal */
+export type DepositForBurnRequest$Outbound = {
+  owner: string;
+  chain: string;
+  amount: number | string;
+  destination_chain: string;
+  destination_address: string;
+  gas_sponsorship?: boolean | undefined;
+};
+
+/** @internal */
+export const DepositForBurnRequest$outboundSchema: z.ZodType<
+  DepositForBurnRequest$Outbound,
+  z.ZodTypeDef,
+  DepositForBurnRequest
+> = z.object({
+  owner: z.string(),
+  chain: DepositForBurnRequestChain$outboundSchema,
+  amount: z.union([z.number(), z.string()]),
+  destinationChain: DestinationChain$outboundSchema,
+  destinationAddress: z.string(),
+  gasSponsorship: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    destinationChain: "destination_chain",
+    destinationAddress: "destination_address",
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function depositForBurnRequestToJSON(
+  depositForBurnRequest: DepositForBurnRequest,
+): string {
+  return JSON.stringify(
+    DepositForBurnRequest$outboundSchema.parse(depositForBurnRequest),
+  );
+}

package/src/models/components/depositforburnresponse.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 model for CCTP depositForBurn transaction from a smart account.
+ *
+ * @remarks
+ *
+ * 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.
+ */
+export type DepositForBurnResponse = {
+  /**
+   * Unique bridge identifier for tracking this cross-chain transfer. Use this ID when calling /mint/prepare to complete the transfer. Only present when Redis is configured on the server.
+   */
+  bridgeId?: string | null | undefined;
+  transaction: UnsignedTransaction | null;
+  eip712: BatchedSafeOperationsResponseOutput | null;
+};
+
+/** @internal */
+export const DepositForBurnResponse$inboundSchema: z.ZodType<
+  DepositForBurnResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bridge_id: z.nullable(z.string()).optional(),
+  transaction: z.nullable(UnsignedTransaction$inboundSchema),
+  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "bridge_id": "bridgeId",
+    "eip_712": "eip712",
+  });
+});
+
+export function depositForBurnResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DepositForBurnResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DepositForBurnResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DepositForBurnResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -78,6 +78,8 @@ export * from "./compassapibackendv2modelssafetransactresponsebatchedsafeoperati
 export * from "./cooldownposition.js";
 export * from "./createaccountrequest.js";
 export * from "./createaccountresponse.js";
+export * from "./depositforburnrequest.js";
+export * from "./depositforburnresponse.js";
 export * from "./details.js";
 export * from "./earnmanagerequest.js";
 export * from "./earnmanageresponse.js";
@@ -108,6 +110,9 @@ export * from "./market.js";
 export * from "./marketposition.js";
 export * from "./markettokens.js";
 export * from "./maxsupplyapydata.js";
+export * from "./mintpreparependingresponse.js";
+export * from "./mintpreparereadyresponse.js";
+export * from "./mintpreparerequest.js";
 export * from "./morphoborrowparams.js";
 export * from "./morphoborrowrequest.js";
 export * from "./morphocheckmarketpositionresponse.js";