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

package/openapi_prepped_for_speakeasy.json

@@ -6195,6 +6195,49 @@
         "x-speakeasy-name-override": "credit_borrow"
       }
     },
+    "/v2/credit/loop": {
+      "post": {
+        "tags": [
+          "Credit"
+        ],
+        "summary": "Open a leveraged loop",
+        "description": "Open a leveraged loop into an Aave or Morpho market in ONE atomic transaction.\n\nRepeatedly supplies collateral, borrows at the requested loan-to-value, and\nswaps the borrow back to collateral. Each iteration's supply uses the swap's\nGUARANTEED minimum output (enforced on-chain), so a fill anywhere within the\nslippage tolerance can never break a later step; any positive surplus stays\nin the Credit Account (the preview reports the bound as estimated_max_dust).\nVery large loops relative to pool depth can still exceed the slippage\ntolerance through their own cumulative price impact \u2014 size accordingly or\nraise max_slippage_percent.\n\nThe Credit Account must already hold initial_collateral_amount of\ncollateral_token. For protocol=MORPHO pass a market_id from\n/v2/credit/morpho_markets.",
+        "operationId": "v2_credit_loop",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreditLoopRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreditLoopResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "credit_loop"
+      }
+    },
     "/v2/credit/transfer": {
       "post": {
         "tags": [
@@ -12190,6 +12233,18 @@
             ],
             "title": "Borrow Vault",
             "description": "Euler only: the EVK vault to borrow from. Required when protocol=EULER."
+          },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
           }
         },
         "type": "object",
@@ -12242,6 +12297,18 @@
             "title": "Borrow Vault",
             "description": "Euler only: the EVK vault to borrow from. Required when protocol=EULER."
           },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
+          },
           "token_in": {
             "anyOf": [
               {
@@ -12670,6 +12737,252 @@
         "title": "CreditFee",
         "description": "Fee configuration for credit-product actions.\n\nSame shape as `Fee`, but narrows `denomination` to the values supported by\ncredit borrows. PERFORMANCE is not supported because realized-profit fees\nare not meaningful for debt positions."
       },
+      "CreditLoopPreview": {
+        "properties": {
+          "iterations": {
+            "type": "integer",
+            "title": "Iterations",
+            "description": "Number of loop iterations bundled."
+          },
+          "total_collateral_supplied": {
+            "type": "string",
+            "title": "Total Collateral Supplied",
+            "description": "Guaranteed minimum total collateral supplied (token units); actual can only be higher (swap fills above the floor become dust)."
+          },
+          "total_borrowed": {
+            "type": "string",
+            "title": "Total Borrowed",
+            "description": "Total loan tokens borrowed across iterations."
+          },
+          "achieved_multiplier": {
+            "type": "string",
+            "title": "Achieved Multiplier",
+            "description": "Guaranteed leverage floor: total_collateral_supplied / initial_collateral_amount."
+          },
+          "projected_ltv": {
+            "type": "string",
+            "title": "Projected Ltv",
+            "description": "Projected end loan-to-value in percent, at the sizing oracle prices."
+          },
+          "projected_health_factor": {
+            "type": "string",
+            "title": "Projected Health Factor",
+            "description": "Projected health factor (liquidation threshold / projected LTV). Below 1 would be liquidatable \u2014 the request is rejected long before that."
+          },
+          "estimated_max_dust": {
+            "type": "string",
+            "title": "Estimated Max Dust",
+            "description": "Upper bound of collateral-token surplus the swaps can leave in the Credit Account (sum of quote \u2212 guaranteed floor per swap). It is bounded by max_slippage_percent per iteration, stays in the account, and is never lost."
+          },
+          "legs": {
+            "items": {
+              "$ref": "#/components/schemas/LoopLegPreview"
+            },
+            "type": "array",
+            "title": "Legs",
+            "description": "Per-iteration breakdown.",
+            "example": []
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "iterations",
+          "total_collateral_supplied",
+          "total_borrowed",
+          "achieved_multiplier",
+          "projected_ltv",
+          "projected_health_factor",
+          "estimated_max_dust"
+        ],
+        "title": "CreditLoopPreview",
+        "description": "Projected end state of the loop, computed on GUARANTEED swap floors."
+      },
+      "CreditLoopRequest": {
+        "properties": {
+          "owner": {
+            "type": "string",
+            "title": "Owner",
+            "description": "The address that owns the Credit Account.",
+            "example": "0x5e5b00ed886A6879C2B934612D2312975427fcAf"
+          },
+          "chain": {
+            "$ref": "#/components/schemas/Chain",
+            "description": "Blockchain network.",
+            "example": "ethereum"
+          },
+          "protocol": {
+            "$ref": "#/components/schemas/CreditProtocol",
+            "description": "Lending protocol to loop into: AAVE or MORPHO. EULER looping is not available yet.",
+            "example": "AAVE"
+          },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
+          },
+          "collateral_token": {
+            "type": "string",
+            "title": "Token",
+            "description": "Token supplied as collateral each iteration. Must already be in the Credit Account for the initial amount. For MORPHO it must be the market's collateral token.",
+            "example": "WETH"
+          },
+          "borrow_token": {
+            "type": "string",
+            "title": "Token",
+            "description": "Token borrowed each iteration and swapped back to the collateral token. For MORPHO it must be the market's loan token.",
+            "example": "USDC"
+          },
+          "initial_collateral_amount": {
+            "anyOf": [
+              {
+                "type": "number",
+                "exclusiveMinimum": 0.0
+              },
+              {
+                "type": "string",
+                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+              }
+            ],
+            "title": "Initial Collateral Amount",
+            "description": "Collateral (in token units) already held in the Credit Account to seed the loop.",
+            "example": 1
+          },
+          "multiplier": {
+            "anyOf": [
+              {
+                "type": "number",
+                "exclusiveMinimum": 1.0
+              },
+              {
+                "type": "string",
+                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+              }
+            ],
+            "title": "Multiplier",
+            "description": "Target leverage: total collateral exposure = multiplier \u00d7 initial_collateral_amount. Must be achievable at the requested loan_to_value (max \u2248 0.9 / (1 \u2212 LTV)).",
+            "example": 2
+          },
+          "loan_to_value": {
+            "anyOf": [
+              {
+                "type": "number",
+                "maximum": 100.0,
+                "exclusiveMinimum": 0.0
+              },
+              {
+                "type": "string",
+                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+              }
+            ],
+            "title": "Loan To Value",
+            "description": "Per-iteration borrow LTV in percent. Must not exceed the protocol's maximum for the market (Aave reserve/e-mode LTV; Morpho LLTV with a safety margin); borrows are sized slightly inside the requested value so no leg sits on the protocol's revert boundary.",
+            "example": 70
+          },
+          "max_slippage_percent": {
+            "anyOf": [
+              {
+                "type": "number",
+                "maximum": 10.0,
+                "exclusiveMinimum": 0.0
+              },
+              {
+                "type": "string",
+                "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+              }
+            ],
+            "title": "Max Slippage Percent",
+            "description": "Per-swap slippage tolerance in percent. Loop dust is bounded by this per iteration, so tighter slippage means less dust.",
+            "example": "0.5"
+          },
+          "emode_category": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "minimum": 0.0
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Emode Category",
+            "description": "Aave only: e-mode category to enable before looping (higher LTV for correlated pairs, e.g. ETH-correlated)."
+          },
+          "gas_sponsorship": {
+            "type": "boolean",
+            "title": "Gas Sponsorship",
+            "description": "If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.",
+            "example": false
+          }
+        },
+        "type": "object",
+        "required": [
+          "owner",
+          "chain",
+          "collateral_token",
+          "borrow_token",
+          "initial_collateral_amount",
+          "multiplier",
+          "loan_to_value"
+        ],
+        "title": "CreditLoopRequest",
+        "description": "Open a leveraged loop: repeatedly supply collateral, borrow, and swap the\nborrow back to collateral \u2014 all in ONE atomic transaction from the Credit\nAccount.",
+        "example": {
+          "owner": "0x5e5b00ed886A6879C2B934612D2312975427fcAf",
+          "chain": "ethereum",
+          "protocol": "AAVE",
+          "collateral_token": "WETH",
+          "borrow_token": "USDC",
+          "initial_collateral_amount": 1,
+          "multiplier": 2,
+          "loan_to_value": 70,
+          "max_slippage_percent": 0.5,
+          "gas_sponsorship": false
+        }
+      },
+      "CreditLoopResponse": {
+        "properties": {
+          "transaction": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/UnsignedTransaction"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Unsigned transaction for direct execution by the owner. 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."
+          },
+          "preview": {
+            "$ref": "#/components/schemas/CreditLoopPreview",
+            "description": "Projected end state, computed on guaranteed swap floors."
+          }
+        },
+        "type": "object",
+        "required": [
+          "preview"
+        ],
+        "title": "CreditLoopResponse",
+        "description": "The atomic loop transaction plus its guaranteed-floor preview."
+      },
       "CreditPositionsResponse": {
         "properties": {
           "collateral_positions": {
@@ -12801,6 +13114,18 @@
             ],
             "title": "Borrow Vault",
             "description": "Euler only: the EVK vault the debt is owed to. Required when protocol=EULER."
+          },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
           }
         },
         "type": "object",
@@ -12841,6 +13166,18 @@
             "title": "Borrow Vault",
             "description": "Euler only: the EVK vault the debt is owed to (repay target). Required when protocol=EULER."
           },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
+          },
           "collateral_vault": {
             "anyOf": [
               {
@@ -13091,6 +13428,18 @@
             ],
             "title": "Collateral Vault",
             "description": "Euler only: the EVK collateral vault to supply into. Required when protocol=EULER."
+          },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
           }
         },
         "type": "object",
@@ -13351,6 +13700,18 @@
             ],
             "title": "Collateral Vault",
             "description": "Euler only: the EVK collateral vault to withdraw from. Required when protocol=EULER."
+          },
+          "market_id": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Market Id",
+            "description": "Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO."
           }
         },
         "type": "object",
@@ -16637,6 +16998,53 @@
         "title": "ListAaveMarketsResponse",
         "description": "Response containing Aave market rates organized by token symbol."
       },
+      "LoopLegPreview": {
+        "properties": {
+          "supply_amount": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Supply Amount",
+            "description": "Collateral supplied this iteration (token units)."
+          },
+          "borrow_amount": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Borrow Amount",
+            "description": "Loan borrowed this iteration; null on the final supply-only iteration."
+          },
+          "min_swap_out": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Min Swap Out",
+            "description": "Guaranteed swap output (collateral units) \u2014 the next iteration's supply. Enforced on-chain by the swap's minimum-return."
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "supply_amount"
+        ],
+        "title": "LoopLegPreview",
+        "description": "One planned loop iteration."
+      },
       "LpBalance": {
         "properties": {
           "valuation": {

package/package.json

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

package/src/funcs/creditCreditLoop.ts

@@ -0,0 +1,184 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Open a leveraged loop
+ *
+ * @remarks
+ * 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.
+ */
+export function creditCreditLoop(
+  client: CompassApiSDKCore,
+  request: components.CreditLoopRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.CreditLoopResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.CreditLoopRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.CreditLoopResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.CreditLoopRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/credit/loop")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_credit_loop",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.CreditLoopResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.CreditLoopResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}