@compass-labs/api-sdk 2.2.60 → 2.2.61-rc.0

package/docs/models/operations/v2earnswapquoterequest.md

@@ -0,0 +1,26 @@
+# V2EarnSwapQuoteRequest
+
+## Example Usage
+
+```typescript
+import { V2EarnSwapQuoteRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2EarnSwapQuoteRequest = {
+  chain: "base",
+  tokenIn: "WETH",
+  tokenOut: "USDC",
+  amountIn: "1",
+  slippage: "1.0",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                                                                                                                   | Required                                                                                                                                                                                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                            | Example                                                                                                                                                                                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                                                                                                                                                                                                                | [operations.V2EarnSwapQuoteChain](../../models/operations/v2earnswapquotechain.md)                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | Target blockchain network.                                                                                                                                                                                                                                                                                             | base                                                                                                                                                                                                                                                                                                                   |
+| `tokenIn`                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | Token to sell (input). A token symbol (e.g. 'WETH') or any token address.                                                                                                                                                                                                                                              | WETH                                                                                                                                                                                                                                                                                                                   |
+| `tokenOut`                                                                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | Token to buy (output). A token symbol (e.g. 'USDC') or any token address.                                                                                                                                                                                                                                              | USDC                                                                                                                                                                                                                                                                                                                   |
+| `syAddress`                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | Optional Pendle SY (Standardized Yield) address. When provided, `token_in` is overridden with the token the PT actually redeems into on withdrawal (the SY asset if it is a valid token-out, else the SY yield token) — use this to gauge a Pendle position's real exit liquidity rather than the reported underlying. |                                                                                                                                                                                                                                                                                                                        |
+| `amountIn`                                                                                                                                                                                                                                                                                                             | *operations.V2EarnSwapQuoteAmountIn*                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                     | Human-readable amount of `token_in` to quote (token units, not wei).                                                                                                                                                                                                                                                   | 1                                                                                                                                                                                                                                                                                                                      |
+| `slippage`                                                                                                                                                                                                                                                                                                             | *operations.Slippage*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                     | Maximum slippage tolerance as a percentage (e.g., 1 = 1%).                                                                                                                                                                                                                                                             | 1.0                                                                                                                                                                                                                                                                                                                    |

package/docs/sdks/earn/README.md

@@ -9,6 +9,7 @@
 * [earnVaults](#earnvaults) - List vaults
 * [earnAaveMarkets](#earnaavemarkets) - List aave markets
 * [earnPendleMarkets](#earnpendlemarkets) - List pendle markets
+* [earnSwapQuote](#earnswapquote) - Quote a swap (read-only)
 * [earnBalances](#earnbalances) - Get token balances
 * [earnCreateAccount](#earncreateaccount) - Create earn account
 * [earnTransfer](#earntransfer) - Transfer tokens to/from account
@@ -435,6 +436,96 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## earnSwapQuote
+
+Estimate the output of a swap without building a transaction.
+
+Returns the expected amount of `token_out` received for selling `amount_in`
+of `token_in`, routed via 1inch. This is read-only: it does not build a
+transaction, require an account, or check balances.
+
+Use it to gauge exit liquidity and price impact for a token before entering
+a position — for example, to warn when a market's underlying asset cannot be
+swapped back to a stablecoin without large slippage.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_earn_swap_quote" method="get" path="/v2/earn/swap_quote" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.earn.earnSwapQuote({
+    chain: "base",
+    tokenIn: "WETH",
+    tokenOut: "USDC",
+    amountIn: "1",
+    slippage: "1.0",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { earnEarnSwapQuote } from "@compass-labs/api-sdk/funcs/earnEarnSwapQuote.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 earnEarnSwapQuote(compassApiSDK, {
+    chain: "base",
+    tokenIn: "WETH",
+    tokenOut: "USDC",
+    amountIn: "1",
+    slippage: "1.0",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("earnEarnSwapQuote failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2EarnSwapQuoteRequest](../../models/operations/v2earnswapquoterequest.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.EarnSwapQuoteResponse](../../models/components/earnswapquoteresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## earnBalances
 
 Get token balances and transfer history for an earn account.

package/examples/node_modules/@types/node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v20.
 
 ### Additional Details
- * Last updated: Mon, 11 May 2026 22:25:21 GMT
+ * Last updated: Fri, 05 Jun 2026 22:33:07 GMT
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
 
 # Credits

package/examples/node_modules/@types/node/http2.d.ts

@@ -635,6 +635,7 @@ declare module "http2" {
         maxConcurrentStreams?: number | undefined;
         maxHeaderListSize?: number | undefined;
         enableConnectProtocol?: boolean | undefined;
+        customSettings?: { [key: number]: number };
     }
     export interface ClientSessionRequestOptions {
         endStream?: boolean | undefined;
@@ -1337,6 +1338,8 @@ declare module "http2" {
         Http2Request extends typeof Http2ServerRequest = typeof Http2ServerRequest,
         Http2Response extends typeof Http2ServerResponse<InstanceType<Http2Request>> = typeof Http2ServerResponse,
     > extends SessionOptions {
+        maxSessionRejectedStreams?: number | undefined;
+        maxSessionInvalidFrames?: number | undefined;
         Http1IncomingMessage?: Http1Request | undefined;
         Http1ServerResponse?: Http1Response | undefined;
         Http2ServerRequest?: Http2Request | undefined;

package/examples/node_modules/@types/node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "20.19.41",
+    "version": "20.19.42",
     "description": "TypeScript definitions for node",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -135,6 +135,6 @@
         "undici-types": "~6.21.0"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "d592be83b1be202f0510055f25eea821cdc1774bf8523cc07f1d22b5ddabd18c",
+    "typesPublisherContentHash": "ada232ae4b945d559a12c6e845140613a8d767a88147aafe0ab24b837048ff04",
     "typeScriptVersion": "5.3"
 }

package/examples/package-lock.json

@@ -478,9 +478,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.19.41",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.41.tgz",
-      "integrity": "sha512-ECymXOukMnOoVkC2bb1Vc/w/836DXncOg5m8Xj1RH7xSHZJWNYY6Zh7EH477vcnD5egKNNfy2RpNOmuChhFPgQ==",
+      "version": "20.19.42",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.42.tgz",
+      "integrity": "sha512-5L7SUaFC1RyDraj2yRhyBzHTobyXHmohD100CChNtyPyleoq37Mqab5Gn8XEKI04dfN/oqPdpHk38MgcQWHbZg==",
       "dev": true,
       "license": "MIT",
       "dependencies": {

package/openapi_prepped_for_speakeasy.json

@@ -5351,6 +5351,139 @@
         "x-speakeasy-name-override": "earn_pendle_markets"
       }
     },
+    "/v2/earn/swap_quote": {
+      "get": {
+        "tags": [
+          "Earn"
+        ],
+        "summary": "Quote a swap (read-only)",
+        "description": "Estimate the output of a swap without building a transaction.\n\nReturns the expected amount of `token_out` received for selling `amount_in`\nof `token_in`, routed via 1inch. This is read-only: it does not build a\ntransaction, require an account, or check balances.\n\nUse it to gauge exit liquidity and price impact for a token before entering\na position \u2014 for example, to warn when a market's underlying asset cannot be\nswapped back to a stablecoin without large slippage.",
+        "operationId": "v2_earn_swap_quote",
+        "parameters": [
+          {
+            "name": "chain",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "base",
+                "ethereum",
+                "arbitrum",
+                "hyperevm",
+                "tempo"
+              ],
+              "title": "Chain",
+              "description": "The chain to use.",
+              "example": "base"
+            },
+            "description": "Target blockchain network."
+          },
+          {
+            "name": "token_in",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "title": "Token In",
+              "example": "WETH"
+            },
+            "description": "Token to sell (input). A token symbol (e.g. 'WETH') or any token address."
+          },
+          {
+            "name": "token_out",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "title": "Token Out",
+              "example": "USDC"
+            },
+            "description": "Token to buy (output). A token symbol (e.g. 'USDC') or any token address."
+          },
+          {
+            "name": "sy_address",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "Sy Address"
+            },
+            "description": "Optional Pendle SY (Standardized Yield) address. When provided, `token_in` is overridden with the token the PT actually redeems into on withdrawal (the SY asset if it is a valid token-out, else the SY yield token) \u2014 use this to gauge a Pendle position's real exit liquidity rather than the reported underlying."
+          },
+          {
+            "name": "amount_in",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "number",
+                  "exclusiveMinimum": 0.0
+                },
+                {
+                  "type": "string",
+                  "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+                }
+              ],
+              "title": "Amount In",
+              "example": "1"
+            },
+            "description": "Human-readable amount of `token_in` to quote (token units, not wei)."
+          },
+          {
+            "name": "slippage",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "number",
+                  "minimum": 0.0
+                },
+                {
+                  "type": "string",
+                  "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+                }
+              ],
+              "title": "Slippage",
+              "example": "1.0"
+            },
+            "description": "Maximum slippage tolerance as a percentage (e.g., 1 = 1%)."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EarnSwapQuoteResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "earn_swap_quote"
+      }
+    },
     "/v2/earn/balances": {
       "get": {
         "tags": [
@@ -10683,7 +10816,7 @@
           "address": {
             "type": "string",
             "title": "Address",
-            "description": "Token contract address on this chain."
+            "description": "Underlying token (reserve) contract address on this chain. This is Aave's canonical per-reserve identifier."
           },
           "a_token_address": {
             "type": "string",
@@ -10724,6 +10857,15 @@
             "type": "string",
             "title": "Utilization Rate",
             "description": "Percentage of supplied tokens that are currently borrowed (e.g., 85.0 means 85%)."
+          },
+          "reserves": {
+            "items": {
+              "$ref": "#/components/schemas/ReserveInfo"
+            },
+            "type": "array",
+            "title": "Reserves",
+            "description": "Every Aave reserve for this token on this chain, ordered by liquidity (highest first). Identified by underlying `address`. For most tokens this has a single entry equal to the canonical reserve above; where a chain has multiple reserves for one symbol (e.g. Arbitrum native USDC and bridged USDC.e), all are listed with their individual rates.",
+            "example": []
           }
         },
         "type": "object",
@@ -10739,7 +10881,7 @@
           "utilization_rate"
         ],
         "title": "ChainMarketInfo",
-        "description": "Rate information for a token on a specific chain."
+        "description": "Rate information for a token on a specific chain.\n\nThe top-level fields describe the canonical (highest-liquidity) reserve for this\ntoken on this chain, preserving the original single-reserve shape. `reserves`\nlists every reserve for the token on this chain so clients can disambiguate\ncases like native USDC vs bridged USDC.e on Arbitrum."
       },
       "CollateralPosition": {
         "properties": {
@@ -12987,6 +13129,33 @@
         "title": "EarnSwapParams",
         "description": "Parameters for swap operations (without context like owner/chain).\n\nUsed by multicall/bundle endpoint to specify swap actions."
       },
+      "EarnSwapQuoteResponse": {
+        "properties": {
+          "amount_out": {
+            "type": "string",
+            "title": "Amount Out",
+            "description": "Estimated amount of `token_out` received, in human-readable units. Zero when no route / insufficient liquidity exists for the pair."
+          },
+          "token_in": {
+            "type": "string",
+            "title": "Token In",
+            "description": "The token address actually quoted as input. Usually the requested `token_in`; for Pendle (when `sy_address` is supplied) it is the resolved redeem token, which callers should use to value the input."
+          },
+          "token_out": {
+            "type": "string",
+            "title": "Token Out",
+            "description": "The token address quoted as output \u2014 what `amount_out` is denominated in (the resolved `token_out` from the request)."
+          }
+        },
+        "type": "object",
+        "required": [
+          "amount_out",
+          "token_in",
+          "token_out"
+        ],
+        "title": "EarnSwapQuoteResponse",
+        "description": "Estimated output of a read-only swap quote."
+      },
       "EarnSwapRequest": {
         "properties": {
           "action_type": {
@@ -19367,6 +19536,69 @@
         ],
         "title": "Reserve"
       },
+      "ReserveInfo": {
+        "properties": {
+          "address": {
+            "type": "string",
+            "title": "Address",
+            "description": "Underlying token (reserve) contract address on this chain. This is Aave's canonical per-reserve identifier."
+          },
+          "a_token_address": {
+            "type": "string",
+            "title": "A Token Address",
+            "description": "Aave aToken contract address on this chain. This is the interest-bearing token that represents the supply position."
+          },
+          "supply_apy": {
+            "type": "string",
+            "title": "Supply Apy",
+            "description": "Variable rate APY for deposits, in percentage (e.g., 4.5 means 4.5%)."
+          },
+          "borrow_apy": {
+            "type": "string",
+            "title": "Borrow Apy",
+            "description": "Variable rate APY for loans, in percentage (e.g., 6.2 means 6.2%)."
+          },
+          "supply_apy_avg": {
+            "type": "string",
+            "title": "Supply Apy Avg",
+            "description": "Variable rate APY for deposits averaged over the `days` window in the request (default 30 days), in percentage. Computed the same way as the v1 `/v1/aave/avg_rate` endpoint."
+          },
+          "borrow_apy_avg": {
+            "type": "string",
+            "title": "Borrow Apy Avg",
+            "description": "Variable rate APY for loans averaged over the `days` window in the request (default 30 days), in percentage. Computed the same way as the v1 `/v1/aave/avg_rate` endpoint."
+          },
+          "total_borrowed": {
+            "type": "string",
+            "title": "Total Borrowed",
+            "description": "Total amount currently borrowed from this market, in token units (e.g., 1234567.89 USDC)."
+          },
+          "available_liquidity": {
+            "type": "string",
+            "title": "Available Liquidity",
+            "description": "Amount of tokens available to borrow, in token units. Equals total supplied minus total borrowed."
+          },
+          "utilization_rate": {
+            "type": "string",
+            "title": "Utilization Rate",
+            "description": "Percentage of supplied tokens that are currently borrowed (e.g., 85.0 means 85%)."
+          }
+        },
+        "type": "object",
+        "required": [
+          "address",
+          "a_token_address",
+          "supply_apy",
+          "borrow_apy",
+          "supply_apy_avg",
+          "borrow_apy_avg",
+          "total_borrowed",
+          "available_liquidity",
+          "utilization_rate"
+        ],
+        "title": "ReserveInfo",
+        "description": "Rate and liquidity information for a single Aave reserve on a chain.\n\nA reserve is identified by its underlying token `address` \u2014 Aave's canonical\nreserve identifier. The same token symbol can map to more than one reserve on a\nchain (e.g. native USDC and bridged USDC.e on Arbitrum), each with its own rates\nand liquidity."
+      },
       "SafeMessageEip712Response": {
         "properties": {
           "domain": {

package/package.json

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