@compass-labs/api-sdk 2.2.76 → 2.2.77-rc.1

package/docs/sdks/credit/README.md

@@ -6,9 +6,12 @@
 
 * [creditPositions](#creditpositions) - List credit positions
 * [creditBalances](#creditbalances) - Get credit account token balances
+* [creditLoopedPositions](#creditloopedpositions) - List looped (leveraged) credit positions
 * [creditEulerMarkets](#crediteulermarkets) - List curated Euler markets
+* [creditMorphoMarkets](#creditmorphomarkets) - List curated Morpho markets
 * [creditCreateAccount](#creditcreateaccount) - Create credit account
 * [creditBorrow](#creditborrow) - Borrow against collateral
+* [creditLoop](#creditloop) - Open a leveraged loop
 * [creditTransfer](#credittransfer) - Transfer tokens to/from Credit Account
 * [creditRepay](#creditrepay) - Repay debt and withdraw collateral
 * [creditBundle](#creditbundle) - Execute multiple credit actions
@@ -171,6 +174,89 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## creditLoopedPositions
+
+List looped (leveraged) positions for a credit account owner.
+
+Detects loops from the account's on-chain history: a transaction containing
+lending + borrowing + swap legs is a loop transaction. Returns one position
+per Morpho market / Aave collateral+debt reserve pair, each with its complete
+per-transaction history, lifetime totals, and live on-chain state (health
+factor, USD values, leverage) for open positions. Covers Aave V3 and Morpho
+Blue.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_credit_looped_positions" method="get" path="/v2/credit/looped_positions" -->
+```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.creditLoopedPositions({
+    chain: "base",
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { creditCreditLoopedPositions } from "@compass-labs/api-sdk/funcs/creditCreditLoopedPositions.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 creditCreditLoopedPositions(compassApiSDK, {
+    chain: "base",
+    owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("creditCreditLoopedPositions failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2CreditLoopedPositionsRequest](../../models/operations/v2creditloopedpositionsrequest.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.CreditLoopedPositionsResponse](../../models/components/creditloopedpositionsresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## creditEulerMarkets
 
 List curated Euler V2 credit markets for a chain.
@@ -250,6 +336,85 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## creditMorphoMarkets
+
+List curated Morpho Blue lending markets for a chain.
+
+Morpho Blue is permissionless, so credit actions identify a market by its
+bytes32 market id. This returns the curated market set with live LLTV,
+supply/borrow APY, utilization, and available liquidity -- read on-chain per
+request -- so callers know which market_id to use and what it currently costs.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_credit_morpho_markets" method="get" path="/v2/credit/morpho_markets" -->
+```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.creditMorphoMarkets({
+    chain: "ethereum",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { creditCreditMorphoMarkets } from "@compass-labs/api-sdk/funcs/creditCreditMorphoMarkets.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 creditCreditMorphoMarkets(compassApiSDK, {
+    chain: "ethereum",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("creditCreditMorphoMarkets failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2CreditMorphoMarketsRequest](../../models/operations/v2creditmorphomarketsrequest.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.MorphoMarketsResponse](../../models/components/morphomarketsresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## creditCreateAccount
 
 Create a Credit Account for a wallet address.
@@ -435,6 +600,111 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## creditLoop
+
+Open a leveraged loop into an Aave or Morpho market in ONE atomic transaction.
+
+Repeatedly supplies collateral, borrows at the requested loan-to-value, and
+swaps the borrow back to collateral. Each iteration's supply uses the swap's
+GUARANTEED minimum output (enforced on-chain), so a fill anywhere within the
+slippage tolerance can never break a later step; any positive surplus stays
+in the Credit Account (the preview reports the bound as estimated_max_dust).
+Very large loops relative to pool depth can still exceed the slippage
+tolerance through their own cumulative price impact — size accordingly or
+raise max_slippage_percent.
+
+The Credit Account must already hold initial_collateral_amount of
+collateral_token. For protocol=MORPHO pass a market_id from
+/v2/credit/morpho_markets.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_credit_loop" method="post" path="/v2/credit/loop" -->
+```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.creditLoop({
+    owner: "0x5e5b00ed886A6879C2B934612D2312975427fcAf",
+    chain: "ethereum",
+    protocol: "AAVE",
+    collateralToken: "WETH",
+    borrowToken: "USDC",
+    initialCollateralAmount: 1,
+    multiplier: 2,
+    loanToValue: 70,
+    maxSlippagePercent: 0.5,
+    gasSponsorship: false,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { creditCreditLoop } from "@compass-labs/api-sdk/funcs/creditCreditLoop.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 creditCreditLoop(compassApiSDK, {
+    owner: "0x5e5b00ed886A6879C2B934612D2312975427fcAf",
+    chain: "ethereum",
+    protocol: "AAVE",
+    collateralToken: "WETH",
+    borrowToken: "USDC",
+    initialCollateralAmount: 1,
+    multiplier: 2,
+    loanToValue: 70,
+    maxSlippagePercent: 0.5,
+    gasSponsorship: false,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("creditCreditLoop failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.CreditLoopRequest](../../models/components/creditlooprequest.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.CreditLoopResponse](../../models/components/creditloopresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## creditTransfer
 
 Transfer tokens between the owner's EOA and their Credit Account.