@compass-labs/api-sdk 2.1.10-rc.9 → 2.1.10

package/dist/esm/models/errors/mintpreparenotfoundresponseerror.d.ts

@@ -0,0 +1,52 @@
+import * as z from "zod/v3";
+import { CompassAPISDKError } from "./compassapisdkerror.js";
+/**
+ * Response when the burn event has not been found yet.
+ *
+ * @remarks
+ *
+ * This means the burn transaction hasn't been confirmed on-chain yet, or the user
+ * hasn't broadcast the burn transaction.
+ */
+export type MintPrepareNotFoundResponseErrorData = {
+    /**
+     * Indicates the burn event was not found on the source chain.
+     */
+    status?: "burn_not_found" | undefined;
+    /**
+     * The bridge identifier.
+     */
+    bridgeId: string;
+    /**
+     * Human-readable message explaining the status.
+     */
+    message: string;
+};
+/**
+ * Response when the burn event has not been found yet.
+ *
+ * @remarks
+ *
+ * This means the burn transaction hasn't been confirmed on-chain yet, or the user
+ * hasn't broadcast the burn transaction.
+ */
+export declare class MintPrepareNotFoundResponseError extends CompassAPISDKError {
+    /**
+     * Indicates the burn event was not found on the source chain.
+     */
+    status?: "burn_not_found" | undefined;
+    /**
+     * The bridge identifier.
+     */
+    bridgeId: string;
+    /** The original data that was passed to this error instance. */
+    data$: MintPrepareNotFoundResponseErrorData;
+    constructor(err: MintPrepareNotFoundResponseErrorData, httpMeta: {
+        response: Response;
+        request: Request;
+        body: string;
+    });
+}
+/** @internal */
+export declare const MintPrepareNotFoundResponseError$inboundSchema: z.ZodType<MintPrepareNotFoundResponseError, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=mintpreparenotfoundresponseerror.d.ts.map

package/dist/esm/models/errors/mintpreparenotfoundresponseerror.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mintpreparenotfoundresponseerror.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/mintpreparenotfoundresponseerror.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,gCAAiC,SAAQ,kBAAkB;IACtE;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,gEAAgE;IAChE,KAAK,EAAE,oCAAoC,CAAC;gBAG1C,GAAG,EAAE,oCAAoC,EACzC,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED,gBAAgB;AAChB,eAAO,MAAM,8CAA8C,EAAE,CAAC,CAAC,OAAO,CACpE,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,OAAO,CAmBL,CAAC"}

package/dist/esm/models/errors/mintpreparenotfoundresponseerror.js

@@ -0,0 +1,45 @@
+/*
+ * 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 { CompassAPISDKError } from "./compassapisdkerror.js";
+/**
+ * Response when the burn event has not been found yet.
+ *
+ * @remarks
+ *
+ * This means the burn transaction hasn't been confirmed on-chain yet, or the user
+ * hasn't broadcast the burn transaction.
+ */
+export class MintPrepareNotFoundResponseError extends CompassAPISDKError {
+    constructor(err, httpMeta) {
+        const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+        super(message, httpMeta);
+        this.data$ = err;
+        if (err.status != null)
+            this.status = err.status;
+        this.bridgeId = err.bridgeId;
+        this.name = "MintPrepareNotFoundResponseError";
+    }
+}
+/** @internal */
+export const MintPrepareNotFoundResponseError$inboundSchema = z.object({
+    status: z.literal("burn_not_found").optional(),
+    bridge_id: z.string(),
+    message: z.string(),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+})
+    .transform((v) => {
+    const remapped = remap$(v, {
+        "bridge_id": "bridgeId",
+    });
+    return new MintPrepareNotFoundResponseError(remapped, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+    });
+});
+//# sourceMappingURL=mintpreparenotfoundresponseerror.js.map

package/dist/esm/models/errors/mintpreparenotfoundresponseerror.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mintpreparenotfoundresponseerror.js","sourceRoot":"","sources":["../../../../src/models/errors/mintpreparenotfoundresponseerror.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAyB7D;;;;;;;GAOG;AACH,MAAM,OAAO,gCAAiC,SAAQ,kBAAkB;IAatE,YACE,GAAyC,EACzC,QAAgE;QAEhE,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5E,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACjB,IAAI,GAAG,CAAC,MAAM,IAAI,IAAI;YAAE,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAE7B,IAAI,CAAC,IAAI,GAAG,kCAAkC,CAAC;IACjD,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,8CAA8C,GAIvD,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IAC9C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,EAAE;QACzB,WAAW,EAAE,UAAU;KACxB,CAAC,CAAC;IAEH,OAAO,IAAI,gCAAgC,CAAC,QAAQ,EAAE;QACpD,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,IAAI,EAAE,CAAC,CAAC,KAAK;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/models/operations/v2cctpmint.d.ts

@@ -2,7 +2,14 @@ import * as z from "zod/v3";
 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;
+/**
+ * Attestation ready with mint transaction, or bridge already completed
+ */
+export type Response200V2CctpMint = components.MintPrepareReadyResponse | components.MintPrepareCompletedResponse;
+export type V2CctpMintResponse = components.MintPreparePendingResponse | components.MintPrepareReadyResponse | components.MintPrepareCompletedResponse;
+/** @internal */
+export declare const Response200V2CctpMint$inboundSchema: z.ZodType<Response200V2CctpMint, z.ZodTypeDef, unknown>;
+export declare function response200V2CctpMintFromJSON(jsonString: string): SafeParseResult<Response200V2CctpMint, SDKValidationError>;
 /** @internal */
 export declare const V2CctpMintResponse$inboundSchema: z.ZodType<V2CctpMintResponse, z.ZodTypeDef, unknown>;
 export declare function v2CctpMintResponseFromJSON(jsonString: string): SafeParseResult<V2CctpMintResponse, SDKValidationError>;

package/dist/esm/models/operations/v2cctpmint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"v2cctpmint.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/v2cctpmint.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAC1B,UAAU,CAAC,0BAA0B,GACrC,UAAU,CAAC,wBAAwB,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}
+{"version":3,"file":"v2cctpmint.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/v2cctpmint.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,UAAU,CAAC,wBAAwB,GACnC,UAAU,CAAC,4BAA4B,CAAC;AAE5C,MAAM,MAAM,kBAAkB,GAC1B,UAAU,CAAC,0BAA0B,GACrC,UAAU,CAAC,wBAAwB,GACnC,UAAU,CAAC,4BAA4B,CAAC;AAE5C,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D;AAED,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}

package/dist/esm/models/operations/v2cctpmint.js

@@ -5,9 +5,20 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import * as components from "../components/index.js";
 /** @internal */
+export const Response200V2CctpMint$inboundSchema = z.union([
+    components.MintPrepareReadyResponse$inboundSchema,
+    components.MintPrepareCompletedResponse$inboundSchema,
+]);
+export function response200V2CctpMintFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Response200V2CctpMint$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Response200V2CctpMint' from JSON`);
+}
+/** @internal */
 export const V2CctpMintResponse$inboundSchema = z.union([
     components.MintPreparePendingResponse$inboundSchema,
-    components.MintPrepareReadyResponse$inboundSchema,
+    z.union([
+        components.MintPrepareReadyResponse$inboundSchema,
+        components.MintPrepareCompletedResponse$inboundSchema,
+    ]),
 ]);
 export function v2CctpMintResponseFromJSON(jsonString) {
     return safeParse(jsonString, (x) => V2CctpMintResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'V2CctpMintResponse' from JSON`);

package/dist/esm/models/operations/v2cctpmint.js.map

@@ -1 +1 @@
-{"version":3,"file":"v2cctpmint.js","sourceRoot":"","sources":["../../../../src/models/operations/v2cctpmint.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAOrD,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,KAAK,CAAC;IACV,UAAU,CAAC,wCAAwC;IACnD,UAAU,CAAC,sCAAsC;CAClD,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"v2cctpmint.js","sourceRoot":"","sources":["../../../../src/models/operations/v2cctpmint.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAerD,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,KAAK,CAAC;IACV,UAAU,CAAC,sCAAsC;IACjD,UAAU,CAAC,0CAA0C;CACtD,CAAC,CAAC;AAEH,MAAM,UAAU,6BAA6B,CAC3C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/D,mDAAmD,CACpD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,KAAK,CAAC;IACV,UAAU,CAAC,wCAAwC;IACnD,CAAC,CAAC,KAAK,CAAC;QACN,UAAU,CAAC,sCAAsC;QACjD,UAAU,CAAC,0CAA0C;KACtD,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/bridge.d.ts

@@ -6,8 +6,7 @@ export declare class Bridge extends ClientSDK {
      * Initiate USDC bridging
      *
      * @remarks
-     * 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).
+     * Bridge USDC from any Product account to any chain using Circle's CCTP Protocol.
      *
      * **Transfer modes:**
      * - `standard` (default): ~15-19 minute transfers, **free** (no fee)
@@ -23,8 +22,6 @@ export declare class Bridge extends ClientSDK {
      * 4. Wait for Circle's attestation service to attest the burn
      * 5. Call the mint endpoint to receive USDC on the destination chain
      *
-     * Step 5 is only required as a fail safe mechanism to mint USDC on a destination chain when bridging has not been confirmed up automatically.
-     *
      * **Supported chains:**
      * - Ethereum (domain 0)
      * - Arbitrum (domain 3)
@@ -35,11 +32,9 @@ export declare class Bridge extends ClientSDK {
      */
     cctpBurn(request: components.DepositForBurnRequest, options?: RequestOptions): Promise<components.DepositForBurnResponse>;
     /**
-     * Confirm USDC bridging
+     * Complete 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 any Product Account on the
      * destination chain.
      *
@@ -48,7 +43,10 @@ export declare class Bridge extends ClientSDK {
      * This endpoint uses the `bridge_id` from `/burn` to:
      * 1. Look up the bridge session
      * 2. Check if Circle's attestation is ready
-     * 3. Return the mint transaction
+     * 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
      *
      * **Request parameters:**
      *
@@ -59,7 +57,7 @@ export declare class Bridge extends ClientSDK {
      *
      * - **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
+     * - **404 Not found**: Bridge not found
      *
      * **After receiving 202:**
      *
@@ -68,11 +66,6 @@ export declare class Bridge extends ClientSDK {
      * 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 Product Account.
      */
     cctpMint(request: components.MintPrepareRequest, options?: RequestOptions): Promise<operations.V2CctpMintResponse>;
 }

package/dist/esm/sdk/bridge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../../../src/sdk/bridge.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAO1C"}
+{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../../../src/sdk/bridge.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAO1C"}

package/dist/esm/sdk/bridge.js

@@ -10,8 +10,7 @@ export class Bridge extends ClientSDK {
      * Initiate USDC bridging
      *
      * @remarks
-     * 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).
+     * Bridge USDC from any Product account to any chain using Circle's CCTP Protocol.
      *
      * **Transfer modes:**
      * - `standard` (default): ~15-19 minute transfers, **free** (no fee)
@@ -27,8 +26,6 @@ export class Bridge extends ClientSDK {
      * 4. Wait for Circle's attestation service to attest the burn
      * 5. Call the mint endpoint to receive USDC on the destination chain
      *
-     * Step 5 is only required as a fail safe mechanism to mint USDC on a destination chain when bridging has not been confirmed up automatically.
-     *
      * **Supported chains:**
      * - Ethereum (domain 0)
      * - Arbitrum (domain 3)
@@ -41,11 +38,9 @@ export class Bridge extends ClientSDK {
         return unwrapAsync(bridgeCctpBurn(this, request, options));
     }
     /**
-     * Confirm USDC bridging
+     * Complete 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 any Product Account on the
      * destination chain.
      *
@@ -54,7 +49,10 @@ export class Bridge extends ClientSDK {
      * This endpoint uses the `bridge_id` from `/burn` to:
      * 1. Look up the bridge session
      * 2. Check if Circle's attestation is ready
-     * 3. Return the mint transaction
+     * 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
      *
      * **Request parameters:**
      *
@@ -65,7 +63,7 @@ export class Bridge extends ClientSDK {
      *
      * - **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
+     * - **404 Not found**: Bridge not found
      *
      * **After receiving 202:**
      *
@@ -74,11 +72,6 @@ export class Bridge extends ClientSDK {
      * 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 Product Account.
      */
     async cctpMint(request, options) {
         return unwrapAsync(bridgeCctpMint(this, request, options));

package/dist/esm/sdk/bridge.js.map

@@ -1 +1 @@
-{"version":3,"file":"bridge.js","sourceRoot":"","sources":["../../../src/sdk/bridge.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"bridge.js","sourceRoot":"","sources":["../../../src/sdk/bridge.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.1.10-rc.9",
+  "version": "2.1.10",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/funcs/bridgeCctpBurn.ts

@@ -29,8 +29,7 @@ import { Result } from "../types/fp.js";
  * Initiate USDC bridging
  *
  * @remarks
- * 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).
+ * Bridge USDC from any Product account to any chain using Circle's CCTP Protocol.
  *
  * **Transfer modes:**
  * - `standard` (default): ~15-19 minute transfers, **free** (no fee)
@@ -46,8 +45,6 @@ import { Result } from "../types/fp.js";
  * 4. Wait for Circle's attestation service to attest the burn
  * 5. Call the mint endpoint to receive USDC on the destination chain
  *
- * Step 5 is only required as a fail safe mechanism to mint USDC on a destination chain when bridging has not been confirmed up automatically.
- *
  * **Supported chains:**
  * - Ethereum (domain 0)
  * - Arbitrum (domain 3)

package/src/funcs/bridgeCctpMint.ts

@@ -27,11 +27,9 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Confirm USDC bridging
+ * Complete 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 any Product Account on the
  * destination chain.
  *
@@ -40,7 +38,10 @@ import { Result } from "../types/fp.js";
  * This endpoint uses the `bridge_id` from `/burn` to:
  * 1. Look up the bridge session
  * 2. Check if Circle's attestation is ready
- * 3. Return the mint transaction
+ * 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
  *
  * **Request parameters:**
  *
@@ -51,7 +52,7 @@ import { Result } from "../types/fp.js";
  *
  * - **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
+ * - **404 Not found**: Bridge not found
  *
  * **After receiving 202:**
  *
@@ -60,11 +61,6 @@ import { Result } from "../types/fp.js";
  * 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 Product Account.
  */
 export function bridgeCctpMint(
   client: CompassApiSDKCore,
@@ -73,6 +69,7 @@ export function bridgeCctpMint(
 ): APIPromise<
   Result<
     operations.V2CctpMintResponse,
+    | errors.MintPrepareNotFoundResponseError
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -99,6 +96,7 @@ async function $do(
   [
     Result<
       operations.V2CctpMintResponse,
+      | errors.MintPrepareNotFoundResponseError
       | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
@@ -166,7 +164,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["422", "4XX", "5XX"],
+    errorCodes: ["404", "422", "4XX", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -181,6 +179,7 @@ async function $do(
 
   const [result] = await M.match<
     operations.V2CctpMintResponse,
+    | errors.MintPrepareNotFoundResponseError
     | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
@@ -193,6 +192,7 @@ async function $do(
   >(
     M.json(200, operations.V2CctpMintResponse$inboundSchema),
     M.json(202, operations.V2CctpMintResponse$inboundSchema),
+    M.jsonErr(404, errors.MintPrepareNotFoundResponseError$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

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.767.2",
+  genVersion: "2.768.0",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.767.2 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.768.0 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/aaveborrowparams.ts

@@ -15,7 +15,7 @@ import {
 export type AaveBorrowParamsAmount = number | string;
 
 export type AaveBorrowParams = {
-  actionType?: "AAVE_BORROW" | undefined;
+  actionType: "AAVE_BORROW";
   /**
    * The symbol or address of the underlying asset to borrow..
    */

package/src/models/components/aaveborrowrequest.ts

@@ -80,7 +80,7 @@ export const AaveBorrowRequestChain$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type AaveBorrowRequest$Outbound = {
-  action_type: "AAVE_BORROW";
+  action_type?: "AAVE_BORROW" | undefined;
   token: string;
   amount: number | string;
   interest_rate_mode: string;
@@ -96,7 +96,7 @@ export const AaveBorrowRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AaveBorrowRequest
 > = z.object({
-  actionType: z.literal("AAVE_BORROW"),
+  actionType: z.literal("AAVE_BORROW").optional(),
   token: z.string(),
   amount: z.union([z.number(), z.string()]),
   interestRateMode: InterestRateMode$outboundSchema,

package/src/models/components/aavehistoricaltransactionsresponse.ts

@@ -24,13 +24,13 @@ import {
 import { Withdraw, Withdraw$inboundSchema } from "./withdraw.js";
 
 export type AaveHistoricalTransactionsResponseTransaction =
-  | (LiquidationCall & { action: "LiquidationCall" })
-  | (SwapBorrowRate & { action: "SwapBorrowRate" })
-  | (Borrow & { action: "Borrow" })
-  | (Withdraw & { action: "Withdraw" })
-  | (Repay & { action: "Repay" })
-  | (Supply & { action: "Supply" })
-  | (UsageAsCollateral & { action: "UsageAsCollateral" });
+  | Borrow
+  | LiquidationCall
+  | Withdraw
+  | Repay
+  | Supply
+  | SwapBorrowRate
+  | UsageAsCollateral;
 
 /**
  * Response model for getting Aave historical transactions.
@@ -45,13 +45,13 @@ export type AaveHistoricalTransactionsResponse = {
    */
   limit: number;
   transactions: Array<
-    | (LiquidationCall & { action: "LiquidationCall" })
-    | (SwapBorrowRate & { action: "SwapBorrowRate" })
-    | (Borrow & { action: "Borrow" })
-    | (Withdraw & { action: "Withdraw" })
-    | (Repay & { action: "Repay" })
-    | (Supply & { action: "Supply" })
-    | (UsageAsCollateral & { action: "UsageAsCollateral" })
+    | Borrow
+    | LiquidationCall
+    | Withdraw
+    | Repay
+    | Supply
+    | SwapBorrowRate
+    | UsageAsCollateral
   >;
 };
 
@@ -62,19 +62,13 @@ export const AaveHistoricalTransactionsResponseTransaction$inboundSchema:
     z.ZodTypeDef,
     unknown
   > = z.union([
-    LiquidationCall$inboundSchema.and(
-      z.object({ action: z.literal("LiquidationCall") }),
-    ),
-    SwapBorrowRate$inboundSchema.and(
-      z.object({ action: z.literal("SwapBorrowRate") }),
-    ),
-    Borrow$inboundSchema.and(z.object({ action: z.literal("Borrow") })),
-    Withdraw$inboundSchema.and(z.object({ action: z.literal("Withdraw") })),
-    Repay$inboundSchema.and(z.object({ action: z.literal("Repay") })),
-    Supply$inboundSchema.and(z.object({ action: z.literal("Supply") })),
-    UsageAsCollateral$inboundSchema.and(
-      z.object({ action: z.literal("UsageAsCollateral") }),
-    ),
+    Borrow$inboundSchema,
+    LiquidationCall$inboundSchema,
+    Withdraw$inboundSchema,
+    Repay$inboundSchema,
+    Supply$inboundSchema,
+    SwapBorrowRate$inboundSchema,
+    UsageAsCollateral$inboundSchema,
   ]);
 
 export function aaveHistoricalTransactionsResponseTransactionFromJSON(
@@ -103,19 +97,13 @@ export const AaveHistoricalTransactionsResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   transactions: z.array(
     z.union([
-      LiquidationCall$inboundSchema.and(
-        z.object({ action: z.literal("LiquidationCall") }),
-      ),
-      SwapBorrowRate$inboundSchema.and(
-        z.object({ action: z.literal("SwapBorrowRate") }),
-      ),
-      Borrow$inboundSchema.and(z.object({ action: z.literal("Borrow") })),
-      Withdraw$inboundSchema.and(z.object({ action: z.literal("Withdraw") })),
-      Repay$inboundSchema.and(z.object({ action: z.literal("Repay") })),
-      Supply$inboundSchema.and(z.object({ action: z.literal("Supply") })),
-      UsageAsCollateral$inboundSchema.and(
-        z.object({ action: z.literal("UsageAsCollateral") }),
-      ),
+      Borrow$inboundSchema,
+      LiquidationCall$inboundSchema,
+      Withdraw$inboundSchema,
+      Repay$inboundSchema,
+      Supply$inboundSchema,
+      SwapBorrowRate$inboundSchema,
+      UsageAsCollateral$inboundSchema,
     ]),
   ),
 });

package/src/models/components/aaveposition.ts

@@ -12,7 +12,7 @@ export type AavePosition = {
   /**
    * The market type discriminator.
    */
-  type?: "AAVE" | undefined;
+  type: "AAVE";
   /**
    * Base64-encoded position identifier.
    */
@@ -35,12 +35,12 @@ export const AavePosition$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: z.literal("AAVE").default("AAVE").optional(),
+  type: z.literal("AAVE"),
   id: z.string(),
-  vault_address: z.literal("None").default("None").optional(),
+  vault_address: z.literal("None").optional(),
   amount_in_underlying_token: z.string(),
   token_name: z.string(),
-  vault_name: z.literal("None").default("None").optional(),
+  vault_name: z.literal("None").optional(),
 }).transform((v) => {
   return remap$(v, {
     "vault_address": "vaultAddress",

package/src/models/components/aaverepayparams.ts

@@ -15,7 +15,7 @@ import {
 export type AaveRepayParamsAmount = number | string;
 
 export type AaveRepayParams = {
-  actionType?: "AAVE_REPAY" | undefined;
+  actionType: "AAVE_REPAY";
   /**
    * The symbol of the underlying asset to repay..
    */

package/src/models/components/aaverepayrequest.ts

@@ -80,7 +80,7 @@ export const AaveRepayRequestChain$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type AaveRepayRequest$Outbound = {
-  action_type: "AAVE_REPAY";
+  action_type?: "AAVE_REPAY" | undefined;
   token: string;
   amount: number | string;
   interest_rate_mode: string;
@@ -96,7 +96,7 @@ export const AaveRepayRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AaveRepayRequest
 > = z.object({
-  actionType: z.literal("AAVE_REPAY"),
+  actionType: z.literal("AAVE_REPAY").optional(),
   token: z.string(),
   amount: z.union([z.number(), z.string()]),
   interestRateMode: InterestRateMode$outboundSchema,

package/src/models/components/aavesupplyparams.ts

@@ -11,7 +11,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 export type AaveSupplyParamsAmount = number | string;
 
 export type AaveSupplyParams = {
-  actionType?: "AAVE_SUPPLY" | undefined;
+  actionType: "AAVE_SUPPLY";
   /**
    * The symbol or address of the underlying asset to supply as collateral. You can borrow against it..
    */

package/src/models/components/aavesupplyrequest.ts

@@ -68,7 +68,7 @@ export const AaveSupplyRequestChain$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type AaveSupplyRequest$Outbound = {
-  action_type: "AAVE_SUPPLY";
+  action_type?: "AAVE_SUPPLY" | undefined;
   token: string;
   amount: number | string;
   on_behalf_of?: string | null | undefined;
@@ -83,7 +83,7 @@ export const AaveSupplyRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AaveSupplyRequest
 > = z.object({
-  actionType: z.literal("AAVE_SUPPLY"),
+  actionType: z.literal("AAVE_SUPPLY").optional(),
   token: z.string(),
   amount: z.union([z.number(), z.string()]),
   onBehalfOf: z.nullable(z.string()).optional(),

package/src/models/components/aavevenue.ts

@@ -8,7 +8,7 @@ export type AaveVenue = {
   /**
    * The venue type discriminator.
    */
-  type?: "AAVE" | undefined;
+  type: "AAVE";
   /**
    * The reserve token for the Aave pool you are interacting with.
    */