@compass-labs/api-sdk 2.2.106 → 2.2.108-rc.0

package/docs/models/components/{riskyieldcollectrequest.md → creditswapresponse.md}

@@ -1,29 +1,25 @@
-# RiskYieldCollectRequest
+# CreditSwapResponse
 
-Sweep the fees a position has earned.
+The swap transaction to sign, plus which route priced it and how long
+that price holds.
 
 ## Example Usage
 
 ```typescript
-import { RiskYieldCollectRequest } from "@compass-labs/api-sdk/models/components";
+import { CreditSwapResponse } from "@compass-labs/api-sdk/models/components";
 
-let value: RiskYieldCollectRequest = {
-  owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
-  chain: "robinhood",
-  positionId: 1076416,
+let value: CreditSwapResponse = {
+  estimatedAmountOut: "<value>",
+  swapProvider: "market",
 };
 ```
 
 ## Fields
 
-| Field                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                     | Example                                                                                                                                                                                                                                         |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `owner`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | The wallet that owns the Risk Yield Account.                                                                                                                                                                                                    | 0x06A9aF046187895AcFc7258450B15397CAc67400                                                                                                                                                                                                      |
-| `chain`                                                                                                                                                                                                                                         | [components.RiskYieldCollectRequestChain](../../models/components/riskyieldcollectrequestchain.md)                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                              | Risk Yield is available on Robinhood Chain only.                                                                                                                                                                                                | robinhood                                                                                                                                                                                                                                       |
-| `gasSponsorship`                                                                                                                                                                                                                                | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Return EIP-712 typed data for the owner to sign instead of a transaction, so a sponsor can broadcast it.                                                                                                                                        | false                                                                                                                                                                                                                                           |
-| `preview`                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                              | Return the plan and its simulation without building a transaction. Nothing is signed and nothing can be broadcast.                                                                                                                              | false                                                                                                                                                                                                                                           |
-| `slippagePct`                                                                                                                                                                                                                                   | *components.RiskYieldCollectRequestSlippagePct*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                              | How far the executed amounts may fall short of the quote before the transaction reverts. Memecoin pools move between the quote and the block that includes the transaction.                                                                     | 0.5                                                                                                                                                                                                                                             |
-| `deadlineSeconds`                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | How long the transaction stays valid once built.                                                                                                                                                                                                | 300                                                                                                                                                                                                                                             |
-| `positionId`                                                                                                                                                                                                                                    | *number*                                                                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             | 1076416                                                                                                                                                                                                                                         |
-| `dexVersion`                                                                                                                                                                                                                                    | [components.DexVersion](../../models/components/dexversion.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                              | Which Uniswap deployment a pool belongs to.<br/><br/>v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a<br/>shared PoolManager and may route the fee through a hook, which is where the<br/>launchpad pools' zero LP yield comes from. |                                                                                                                                                                                                                                                 |
-| `recipient`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                 |
+| Field                                                                                                                                                                                                                                                                                                                                                         | Type                                                                                                                                                                                                                                                                                                                                                          | Required                                                                                                                                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                   | Example                                                                                                                                                                                                                                                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                                                                                                                                                                                                                                                                 | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Unsigned transaction for direct execution. Present when gas_sponsorship=false.                                                                                                                                                                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                               |
+| `eip712`                                                                                                                                                                                                                                                                                                                                                      | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                                                               |
+| `estimatedAmountOut`                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                            | Estimated amount of output token received from the swap. Exact on firm builds (a firm quote fills at this amount or reverts). On market builds it is a quote-time estimate, and `slippage` sets how far below it the transaction's enforced minimum output sits.                                                                                              |                                                                                                                                                                                                                                                                                                                                                               |
+| `swapProvider`                                                                                                                                                                                                                                                                                                                                                | [components.CreditSwapResponseSwapProvider](../../models/components/creditswapresponseswapprovider.md)                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Identifies which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present. This is the authoritative firm-vs-market signal and clients do need to read it: `pricing` is only what was REQUESTED, and under 'auto' a firm build can fall back to market transparently. | market                                                                                                                                                                                                                                                                                                                                                        |
+| `quoteExpiresAt`                                                                                                                                                                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                            | Deadline of the firm swap quote. Sign and broadcast before it or the transaction reverts on-chain; refresh by re-calling this endpoint (discard the previous payload). Null on market builds.                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                               |

package/docs/models/components/creditswapresponseswapprovider.md

@@ -0,0 +1,17 @@
+# CreditSwapResponseSwapProvider
+
+Identifies which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present. This is the authoritative firm-vs-market signal and clients do need to read it: `pricing` is only what was REQUESTED, and under 'auto' a firm build can fall back to market transparently.
+
+## Example Usage
+
+```typescript
+import { CreditSwapResponseSwapProvider } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditSwapResponseSwapProvider = "market";
+```
+
+## Values
+
+```typescript
+"market" | "firm"
+```

package/docs/models/components/earnswaprequest.md

@@ -1,8 +1,7 @@
 # EarnSwapRequest
 
-Request model for swap endpoint.
-
-Inherits swap params and adds context fields (owner, chain, gas_sponsorship).
+Swap one token held in the Earn Account for another, in a single atomic
+transaction.
 
 ## Example Usage
 

package/docs/models/operations/{v2earnvaultsminliquidityusd.md → minliquidityusd.md}

@@ -1,4 +1,4 @@
-# V2EarnVaultsMinLiquidityUsd
+# MinLiquidityUsd
 
 Minimum available liquidity in USD. Vaults below this are excluded.
 

package/docs/models/operations/v2earnvaultsrequest.md

@@ -24,5 +24,5 @@ let value: V2EarnVaultsRequest = {
 | `chain`                                                                                             | [components.Chain](../../models/components/chain.md)                                                | :heavy_minus_sign:                                                                                  | Optional chain filter. If not provided, returns vaults for all chains.                              |                                                                                                     |
 | `assetSymbol`                                                                                       | *string*                                                                                            | :heavy_minus_sign:                                                                                  | Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').                                    |                                                                                                     |
 | `minTvlUsd`                                                                                         | *operations.V2EarnVaultsMinTvlUsd*                                                                  | :heavy_minus_sign:                                                                                  | Minimum TVL in USD. Vaults with TVL below this value will be excluded.                              |                                                                                                     |
-| `minLiquidityUsd`                                                                                   | *operations.V2EarnVaultsMinLiquidityUsd*                                                            | :heavy_minus_sign:                                                                                  | Minimum available liquidity in USD. Vaults below this are excluded.                                 |                                                                                                     |
+| `minLiquidityUsd`                                                                                   | *operations.MinLiquidityUsd*                                                                        | :heavy_minus_sign:                                                                                  | Minimum available liquidity in USD. Vaults below this are excluded.                                 |                                                                                                     |
 | `minDepositCapUsd`                                                                                  | *operations.MinDepositCapUsd*                                                                       | :heavy_minus_sign:                                                                                  | Minimum deposit capacity in USD. Vaults below this are excluded. Set to 0 to exclude paused vaults. |                                                                                                     |

package/docs/sdks/credit/README.md

@@ -15,6 +15,7 @@
 * [creditUnloop](#creditunloop) - Unwind a leveraged loop
 * [creditRebalance](#creditrebalance) - Rebalance the leveraged credit book
 * [creditTransfer](#credittransfer) - Transfer tokens to/from Credit Account
+* [creditSwap](#creditswap) - Swap tokens
 * [creditRepay](#creditrepay) - Repay debt and withdraw collateral
 * [creditBundle](#creditbundle) - Execute multiple credit actions
 
@@ -1009,6 +1010,99 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## creditSwap
+
+Swap one token for another inside a Credit Account.
+
+Exchanges tokens the Credit Account already holds in a single atomic
+transaction, so idle or borrowed balances can be converted without moving
+funds out first. Returns an unsigned transaction to sign, the expected
+output amount, and which route priced the swap.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_credit_swap" method="post" path="/v2/credit/swap" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.credit.creditSwap({
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    amountIn: "0.01",
+    slippage: "0.5",
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    chain: "base",
+    gasSponsorship: false,
+    pricing: "auto",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { creditCreditSwap } from "@compass-labs/api-sdk/funcs/creditCreditSwap.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await creditCreditSwap(compassApiSDK, {
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    amountIn: "0.01",
+    slippage: "0.5",
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+    chain: "base",
+    gasSponsorship: false,
+    pricing: "auto",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("creditCreditSwap failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.CreditSwapRequest](../../models/components/creditswaprequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.CreditSwapResponse](../../models/components/creditswapresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## creditRepay
 
 Repay an Aave debt and withdraw collateral from a Credit Account.

package/docs/sdks/earn/README.md

@@ -14,7 +14,7 @@
 * [earnCreateAccount](#earncreateaccount) - Create earn account
 * [earnTransfer](#earntransfer) - Transfer tokens to/from account
 * [earnManage](#earnmanage) - Manage earn position
-* [earnSwap](#earnswap) - Swap tokens within Earn Account
+* [earnSwap](#earnswap) - Swap tokens
 * [earnBundle](#earnbundle) - Execute multiple earn actions
 
 ## earnPositions
@@ -899,13 +899,13 @@ run();
 
 ## earnSwap
 
-Swap tokens within an Earn Account.
+Swap one token for another inside an Earn Account.
 
-Use this endpoint to exchange one token for another without transferring funds out of the Earn Account.
-
-The swap executes atomically within the Earn Account and can be combined with other actions using the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions). For example, swap ETH to USDC, then deposit USDC into a vault—all in one transaction.
-
-Returns either an unsigned transaction (when `gas_sponsorship=false`) or EIP-712 typed data for off-chain signing (when `gas_sponsorship=true`). For gas-sponsored swaps, submit the signed typed data to `/gas_sponsorship/prepare`.
+Exchanges tokens the Earn Account already holds in a single atomic
+transaction, so funds never leave it, and can be chained with other actions
+through the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions)
+(for example, swap ETH to USDC and deposit the USDC into a vault at once).
+Returns an unsigned transaction to sign and the expected output amount.
 
 ### Example Usage