@compass-labs/api-sdk 2.2.105 → 2.2.107

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
 

package/docs/sdks/tokenizedassets/README.md

@@ -1265,7 +1265,7 @@ async function run() {
     amountIn: 8512.47,
     slippage: "0.5",
     owner: "<value>",
-    chain: "arbitrum",
+    chain: "hyperevm",
     gasSponsorship: false,
     fee: {
       recipient: "<value>",
@@ -1301,7 +1301,7 @@ async function run() {
     amountIn: 8512.47,
     slippage: "0.5",
     owner: "<value>",
-    chain: "arbitrum",
+    chain: "hyperevm",
     gasSponsorship: false,
     fee: {
       recipient: "<value>",

package/openapi_prepped_for_speakeasy.json

@@ -5374,6 +5374,7 @@
                 "hyperevm",
                 "tempo",
                 "bsc",
+                "robinhood",
                 "ethereum_sepolia"
               ],
               "title": "Chain",
@@ -5684,8 +5685,8 @@
         "tags": [
           "Earn"
         ],
-        "summary": "Swap tokens within Earn Account",
-        "description": "Swap tokens within an Earn Account.\n\nUse this endpoint to exchange one token for another without transferring funds out of the Earn Account.\n\nThe 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\u2014all in one transaction.\n\nReturns 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`.",
+        "summary": "Swap tokens",
+        "description": "Swap one token for another inside an Earn Account.\n\nExchanges tokens the Earn Account already holds in a single atomic\ntransaction, so funds never leave it, and can be chained with other actions\nthrough the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions)\n(for example, swap ETH to USDC and deposit the USDC into a vault at once).\nReturns an unsigned transaction to sign and the expected output amount.",
         "operationId": "v2_earn_swap",
         "requestBody": {
           "content": {
@@ -6498,6 +6499,49 @@
         "x-speakeasy-name-override": "credit_transfer"
       }
     },
+    "/v2/credit/swap": {
+      "post": {
+        "tags": [
+          "Credit"
+        ],
+        "summary": "Swap tokens",
+        "description": "Swap one token for another inside a Credit Account.\n\nExchanges tokens the Credit Account already holds in a single atomic\ntransaction, so idle or borrowed balances can be converted without moving\nfunds out first. Returns an unsigned transaction to sign, the expected\noutput amount, and which route priced the swap.",
+        "operationId": "v2_credit_swap",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreditSwapRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreditSwapResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "credit_swap"
+      }
+    },
     "/v2/credit/repay": {
       "post": {
         "tags": [
@@ -7588,6 +7632,7 @@
                 "hyperevm",
                 "tempo",
                 "bsc",
+                "robinhood",
                 "ethereum_sepolia"
               ],
               "title": "Chain",
@@ -7718,6 +7763,7 @@
                 "hyperevm",
                 "tempo",
                 "bsc",
+                "robinhood",
                 "ethereum_sepolia"
               ],
               "title": "Chain",
@@ -7804,6 +7850,7 @@
                 "hyperevm",
                 "tempo",
                 "bsc",
+                "robinhood",
                 "ethereum_sepolia"
               ],
               "title": "Chain",
@@ -7944,6 +7991,7 @@
                 "hyperevm",
                 "tempo",
                 "bsc",
+                "robinhood",
                 "ethereum_sepolia"
               ],
               "title": "Chain",
@@ -11656,6 +11704,7 @@
           "hyperevm",
           "tempo",
           "bsc",
+          "robinhood",
           "ethereum_sepolia"
         ],
         "title": "Chain",
@@ -13914,6 +13963,178 @@
         "title": "CreditSupplyParams",
         "description": "Supply collateral to Aave via Credit Account."
       },
+      "CreditSwapRequest": {
+        "properties": {
+          "action_type": {
+            "type": "string",
+            "const": "V2_SWAP",
+            "title": "Action Type",
+            "description": "Action type identifier for swap operations.",
+            "example": "V2_SWAP"
+          },
+          "token_in": {
+            "type": "string",
+            "title": "Token",
+            "description": "Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address.",
+            "example": "USDC"
+          },
+          "token_out": {
+            "type": "string",
+            "title": "Token",
+            "description": "Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address.",
+            "example": "USDT"
+          },
+          "amount_in": {
+            "anyOf": [
+              {
+                "type": "number",
+                "exclusiveMinimum": 0.0
+              },
+              {
+                "type": "string",
+                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+              }
+            ],
+            "title": "Amount In",
+            "description": "Human-readable amount of `token_in` to swap (token units, not wei).",
+            "example": "0.01"
+          },
+          "slippage": {
+            "anyOf": [
+              {
+                "type": "number",
+                "maximum": 10.0,
+                "minimum": 0.0
+              },
+              {
+                "type": "string",
+                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+              }
+            ],
+            "title": "Slippage",
+            "description": "Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Bounds the market route only; a firm quote fills exactly and ignores it.",
+            "example": "0.5"
+          },
+          "owner": {
+            "type": "string",
+            "title": "Owner",
+            "description": "The owner's wallet address. Their Credit Account must already exist (create it with `/v2/credit/create_account`) and hold `token_in` (deposit with `/v2/credit/transfer`).",
+            "example": "0x06A9aF046187895AcFc7258450B15397CAc67400"
+          },
+          "chain": {
+            "type": "string",
+            "enum": [
+              "arbitrum",
+              "base",
+              "bsc",
+              "ethereum",
+              "hyperevm",
+              "tempo"
+            ],
+            "title": "Chain",
+            "description": "Target blockchain network where the swap will execute.",
+            "example": "base"
+          },
+          "gas_sponsorship": {
+            "type": "boolean",
+            "title": "Gas Sponsorship",
+            "description": "Optionally request gas sponsorship. If `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`). Gas-sponsored builds always execute at market rate.",
+            "example": false
+          },
+          "pricing": {
+            "type": "string",
+            "enum": [
+              "auto",
+              "firm",
+              "market"
+            ],
+            "title": "Pricing",
+            "description": "Swap routing policy. 'auto': a firm zero-slippage quote when a firm venue covers the pair, transparent fallback to the market aggregator otherwise. 'firm': never price on the market route; an uncovered pair fails with a typed error instead of silently substituting market pricing. 'market': never route through the firm venue; the swap is priced by the aggregator and bounded by `slippage` (which firm fills ignore). 'firm' is incompatible with gas_sponsorship (sponsored swaps force market routing).",
+            "example": "auto"
+          }
+        },
+        "type": "object",
+        "required": [
+          "token_in",
+          "token_out",
+          "amount_in",
+          "owner",
+          "chain"
+        ],
+        "title": "CreditSwapRequest",
+        "description": "Swap one token held in the Credit Account for another, in a single\natomic transaction, at a firm quote where one covers the pair and at market\nrate otherwise.",
+        "example": {
+          "owner": "0x06A9aF046187895AcFc7258450B15397CAc67400",
+          "chain": "base",
+          "token_in": "USDC",
+          "token_out": "USDT",
+          "amount_in": "0.01",
+          "slippage": "0.5",
+          "gas_sponsorship": false,
+          "pricing": "auto"
+        }
+      },
+      "CreditSwapResponse": {
+        "properties": {
+          "transaction": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/UnsignedTransaction"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Unsigned transaction for direct execution. Present when gas_sponsorship=false."
+          },
+          "eip_712": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/BatchedSafeOperationsResponse-Output"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true."
+          },
+          "estimated_amount_out": {
+            "type": "string",
+            "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
+            "title": "Estimated Amount Out",
+            "description": "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."
+          },
+          "swap_provider": {
+            "type": "string",
+            "enum": [
+              "market",
+              "firm"
+            ],
+            "title": "Swap Provider",
+            "description": "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": "market"
+          },
+          "quote_expires_at": {
+            "anyOf": [
+              {
+                "type": "string",
+                "format": "date-time"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Quote Expires At",
+            "description": "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."
+          }
+        },
+        "type": "object",
+        "required": [
+          "estimated_amount_out"
+        ],
+        "title": "CreditSwapResponse",
+        "description": "The swap transaction to sign, plus which route priced it and how long\nthat price holds."
+      },
       "CreditTransferRequest": {
         "properties": {
           "owner": {
@@ -15479,7 +15700,7 @@
           "chain"
         ],
         "title": "EarnSwapRequest",
-        "description": "Request model for swap endpoint.\n\nInherits swap params and adds context fields (owner, chain, gas_sponsorship).",
+        "description": "Swap one token held in the Earn Account for another, in a single atomic\ntransaction.",
         "example": {
           "owner": "0x06A9aF046187895AcFc7258450B15397CAc67400",
           "chain": "base",
@@ -16307,6 +16528,18 @@
             "title": "Supply Apy",
             "description": "Current supply APY for this market (yield for supplying the asset), in percentage (e.g. 3.45 means 3.45%). Null if the rate is unavailable."
           },
+          "intrinsic_apy": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Intrinsic Apy",
+            "description": "What the borrowable asset earns inside its own price, in percentage, trailing 7 days. Debt owed in such a token grows by this on top of borrow_apy \u2014 a borrower's true cost is their sum. Null means unmeasured, NOT zero."
+          },
           "available_liquidity": {
             "type": "string",
             "title": "Available Liquidity",
@@ -16327,6 +16560,30 @@
             "title": "Utilization",
             "description": "Borrowed share of supplied assets, in percentage 0-100."
           },
+          "tvl_usd": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Tvl Usd",
+            "description": "Total asset supplied to this market in USD (total_supply_assets priced by the shared request-time feed). Null when the price feed can't quote the asset \u2014 size in token units instead."
+          },
+          "liquidity_usd": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Liquidity Usd",
+            "description": "Asset available to borrow right now in USD (available_liquidity priced by the shared request-time feed; vault cash equals supplied minus borrowed). Null when the price feed can't quote the asset."
+          },
           "supply_cap": {
             "anyOf": [
               {
@@ -16432,6 +16689,18 @@
             ],
             "title": "Supply Apy",
             "description": "Current supply APY earned on this collateral while it backs a loan, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable."
+          },
+          "intrinsic_apy": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Intrinsic Apy",
+            "description": "What the collateral token earns inside its own price, in percentage: an ERC-4626 share's vault yield, a staking token's rewards, or an RWA token's NAV accrual, trailing 7 days. Earned on top of supply_apy \u2014 the collateral leg's whole yield is their sum. Null means unmeasured, NOT zero: a plain token (USDC, cbBTC) earns nothing and a yield-bearing one may simply not be indexed yet."
           }
         },
         "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.105",
+  "version": "2.2.107",
   "author": "royalnine",
   "type": "module",
   "tshy": {