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

package/src/models/components/vaultdepositparams.ts

@@ -11,7 +11,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 export type VaultDepositParamsAmount = number | string;
 
 export type VaultDepositParams = {
-  actionType?: "VAULT_DEPOSIT" | undefined;
+  actionType: "VAULT_DEPOSIT";
   /**
    * The vault address you are depositing to.
    */

package/src/models/components/vaultdepositrequest.ts

@@ -70,7 +70,7 @@ export const VaultDepositRequestChain$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type VaultDepositRequest$Outbound = {
-  action_type: "VAULT_DEPOSIT";
+  action_type?: "VAULT_DEPOSIT" | undefined;
   vault_address: string;
   amount: number | string;
   receiver?: string | null | undefined;
@@ -85,7 +85,7 @@ export const VaultDepositRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   VaultDepositRequest
 > = z.object({
-  actionType: z.literal("VAULT_DEPOSIT"),
+  actionType: z.literal("VAULT_DEPOSIT").optional(),
   vaultAddress: z.string(),
   amount: z.union([z.number(), z.string()]),
   receiver: z.nullable(z.string()).optional(),

package/src/models/components/vaultvenue.ts

@@ -9,7 +9,7 @@ export type VaultVenue = {
   /**
    * The venue type discriminator.
    */
-  type?: "VAULT" | undefined;
+  type: "VAULT";
   /**
    * The vault address you are interacting with for this action.
    */

package/src/models/components/vaultwithdrawparams.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type VaultWithdrawParams = {
-  actionType?: "VAULT_WITHDRAW" | undefined;
+  actionType: "VAULT_WITHDRAW";
   /**
    * The vault address you are withdrawing from.
    */

package/src/models/components/vaultwithdrawrequest.ts

@@ -47,7 +47,7 @@ export const VaultWithdrawRequestChain$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type VaultWithdrawRequest$Outbound = {
-  action_type: "VAULT_WITHDRAW";
+  action_type?: "VAULT_WITHDRAW" | undefined;
   vault_address: string;
   amount?: any | undefined;
   receiver?: string | null | undefined;
@@ -62,7 +62,7 @@ export const VaultWithdrawRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   VaultWithdrawRequest
 > = z.object({
-  actionType: z.literal("VAULT_WITHDRAW"),
+  actionType: z.literal("VAULT_WITHDRAW").optional(),
   vaultAddress: z.string(),
   amount: z.any().optional(),
   receiver: z.nullable(z.string()).optional(),

package/src/models/components/withdraw.ts

@@ -33,7 +33,7 @@ export type Withdraw = {
   /**
    * The type of transaction
    */
-  action: string;
+  action: "Withdraw";
   block: number;
 };
 
@@ -49,7 +49,7 @@ export const Withdraw$inboundSchema: z.ZodType<
   amount: z.number(),
   reserve: Reserve$inboundSchema,
   assetPriceUSD: z.number(),
-  action: z.string(),
+  action: z.literal("Withdraw"),
   block: z.number().int(),
 });
 

package/src/models/components/wrapethparams.ts

@@ -14,7 +14,7 @@ export type WrapEthParamsAmount = number | string;
  * Parameters model for wrapping ETH into WETH.
  */
 export type WrapEthParams = {
-  actionType?: "WRAP_ETH" | undefined;
+  actionType: "WRAP_ETH";
   /**
    * The amount of ETH to wrap.
    */

package/src/models/components/wrapethrequest.ts

@@ -63,7 +63,7 @@ export const WrapEthRequestChain$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type WrapEthRequest$Outbound = {
-  action_type: "WRAP_ETH";
+  action_type?: "WRAP_ETH" | undefined;
   amount: number | string;
   chain: string;
   sender: string;
@@ -76,7 +76,7 @@ export const WrapEthRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   WrapEthRequest
 > = z.object({
-  actionType: z.literal("WRAP_ETH"),
+  actionType: z.literal("WRAP_ETH").optional(),
   amount: z.union([z.number(), z.string()]),
   chain: WrapEthRequestChain$outboundSchema,
   sender: z.string(),

package/src/models/errors/index.ts

@@ -6,5 +6,6 @@ export * from "./apierror.js";
 export * from "./compassapisdkerror.js";
 export * from "./httpclienterrors.js";
 export * from "./httpvalidationerror.js";
+export * from "./mintpreparenotfoundresponseerror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";

package/src/models/errors/mintpreparenotfoundresponseerror.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 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 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 },
+  ) {
+    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.ZodType<
+  MintPrepareNotFoundResponseError,
+  z.ZodTypeDef,
+  unknown
+> = 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$,
+    });
+  });

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,64 @@
+/*
+ * 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";
+
+/**
+ * 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 const Response200V2CctpMint$inboundSchema: z.ZodType<
+  Response200V2CctpMint,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.MintPrepareReadyResponse$inboundSchema,
+  components.MintPrepareCompletedResponse$inboundSchema,
+]);
+
+export function response200V2CctpMintFromJSON(
+  jsonString: string,
+): SafeParseResult<Response200V2CctpMint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Response200V2CctpMint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Response200V2CctpMint' from JSON`,
+  );
+}
+
+/** @internal */
+export const V2CctpMintResponse$inboundSchema: z.ZodType<
+  V2CctpMintResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.MintPreparePendingResponse$inboundSchema,
+  z.union([
+    components.MintPrepareReadyResponse$inboundSchema,
+    components.MintPrepareCompletedResponse$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/bridge.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { bridgeCctpBurn } from "../funcs/bridgeCctpBurn.js";
+import { bridgeCctpMint } from "../funcs/bridgeCctpMint.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 Bridge extends ClientSDK {
+  /**
+   * Initiate USDC bridging
+   *
+   * @remarks
+   * 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)
+   * - `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,
+   *    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 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 Product Account. If approval is needed
+   * for the TokenMessengerV2 contract, it will be included in the transaction automatically.
+   */
+  async cctpBurn(
+    request: components.DepositForBurnRequest,
+    options?: RequestOptions,
+  ): Promise<components.DepositForBurnResponse> {
+    return unwrapAsync(bridgeCctpBurn(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Complete USDC bridging
+   *
+   * @remarks
+   * 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
+   * 2. Check if Circle's attestation is ready
+   * 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:**
+   *
+   * - `bridge_id`: The bridge ID returned from `/burn`
+   * - `burn_tx_hash`: The transaction hash of the burn transaction on the source chain
+   *
+   * **Response codes:**
+   *
+   * - **200 OK**: Attestation is ready, mint transaction is included
+   * - **202 Accepted**: Attestation is pending, SSE URL for real-time updates is included
+   * - **404 Not found**: Bridge not found
+   *
+   * **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
+   */
+  async cctpMint(
+    request: components.MintPrepareRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V2CctpMintResponse> {
+    return unwrapAsync(bridgeCctpMint(
+      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 { Bridge } from "./bridge.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 _bridge?: Bridge;
+  get bridge(): Bridge {
+    return (this._bridge ??= new Bridge(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",

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

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