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

package/docs/models/components/redemptionsresponse.md

@@ -0,0 +1,19 @@
+# RedemptionsResponse
+
+An owner's IXS redemption requests for one vault.
+
+## Example Usage
+
+```typescript
+import { RedemptionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: RedemptionsResponse = {
+  redemptions: [],
+};
+```
+
+## Fields
+
+| Field                                                                                                                         | Type                                                                                                                          | Required                                                                                                                      | Description                                                                                                                   | Example                                                                                                                       |
+| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `redemptions`                                                                                                                 | [components.Redemption](../../models/components/redemption.md)[]                                                              | :heavy_minus_sign:                                                                                                            | The owner's non-empty redemption requests for the vault, in ascending id order. Empty when the owner has never requested one. | []                                                                                                                            |

package/docs/models/components/redemptionstatus.md

@@ -0,0 +1,17 @@
+# RedemptionStatus
+
+Lifecycle state: `pending` (awaiting operator settlement), `finalized` (settled — assets paid to the product account), `rejected` (operator declined; shares returned to the account), or `unknown` (an unrecognized on-chain status code — should not occur for the current contract, surfaced defensively instead of erroring).
+
+## Example Usage
+
+```typescript
+import { RedemptionStatus } from "@compass-labs/api-sdk/models/components";
+
+let value: RedemptionStatus = "pending";
+```
+
+## Values
+
+```typescript
+"pending" | "finalized" | "rejected" | "unknown"
+```

package/docs/models/components/settlement.md

@@ -0,0 +1,17 @@
+# Settlement
+
+How the trade settles. `instant`: the signed transaction completes the trade (Midas/Ondo swaps and IXS deposits). `async`: the transaction only *requests* an IXS redemption, which the vault operator settles off-chain later — poll `poll_endpoint` for status.
+
+## Example Usage
+
+```typescript
+import { Settlement } from "@compass-labs/api-sdk/models/components";
+
+let value: Settlement = "instant";
+```
+
+## Values
+
+```typescript
+"instant" | "async"
+```

package/docs/models/components/tokenizedassetclass.md

@@ -3,19 +3,21 @@
 Asset class of a tokenized asset.
 
 `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
-yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) trade via the
-swap-based `transact/buy` and `transact/sell` endpoints.
+yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
+trade via the swap-based `transact/buy` and `transact/sell` endpoints.
+`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
+*asynchronous* redemption request settled off-chain by the vault operator.
 
 ## Example Usage
 
 ```typescript
 import { TokenizedAssetClass } from "@compass-labs/api-sdk/models/components";
 
-let value: TokenizedAssetClass = "BTC_YIELD";
+let value: TokenizedAssetClass = "MANAGED_VAULT";
 ```
 
 ## Values
 
 ```typescript
-"EQUITY" | "T_BILLS" | "BASIS_TRADE" | "BTC_YIELD"
+"EQUITY" | "T_BILLS" | "BASIS_TRADE" | "BTC_YIELD" | "MANAGED_VAULT"
 ```

package/docs/models/components/tokenizedassetprovider.md

@@ -7,11 +7,11 @@ Issuer/provider of a tokenized asset.
 ```typescript
 import { TokenizedAssetProvider } from "@compass-labs/api-sdk/models/components";
 
-let value: TokenizedAssetProvider = "ondo";
+let value: TokenizedAssetProvider = "midas";
 ```
 
 ## Values
 
 ```typescript
-"ondo" | "midas"
+"ondo" | "midas" | "ixs"
 ```

package/docs/models/components/tokenizedassetstraderesponse.md

@@ -12,14 +12,17 @@ import { TokenizedAssetsTradeResponse } from "@compass-labs/api-sdk/models/compo
 
 let value: TokenizedAssetsTradeResponse = {
   estimatedAmountOut: "<value>",
+  settlement: "instant",
 };
 ```
 
 ## Fields
 
-| Field                                                                                                            | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
-| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
-| `transaction`                                                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                 | :heavy_minus_sign:                                                                                               | Unsigned transaction executing the trade in the product account.                                                 |
-| `eip712`                                                                                                         | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign:                                                                                               | EIP-712 payload for gas-sponsored execution.                                                                     |
-| `estimatedAmountOut`                                                                                             | *string*                                                                                                         | :heavy_check_mark:                                                                                               | Estimated amount of `token_out` received (human-readable units).                                                 |
-| `feeAmount`                                                                                                      | *string*                                                                                                         | :heavy_minus_sign:                                                                                               | Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied.                             |
+| Field                                                                                                                                                                                                                                                             | Type                                                                                                                                                                                                                                                              | Required                                                                                                                                                                                                                                                          | Description                                                                                                                                                                                                                                                       | Example                                                                                                                                                                                                                                                           |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                                                                                                                                                                     | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                | Unsigned transaction executing the trade in the product account.                                                                                                                                                                                                  |                                                                                                                                                                                                                                                                   |
+| `eip712`                                                                                                                                                                                                                                                          | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                | EIP-712 payload for gas-sponsored execution.                                                                                                                                                                                                                      |                                                                                                                                                                                                                                                                   |
+| `estimatedAmountOut`                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                                                                                                                | Estimated amount of `token_out` received (human-readable units).                                                                                                                                                                                                  |                                                                                                                                                                                                                                                                   |
+| `feeAmount`                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                | Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied.                                                                                                                                                                              |                                                                                                                                                                                                                                                                   |
+| `settlement`                                                                                                                                                                                                                                                      | [components.Settlement](../../models/components/settlement.md)                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                | How the trade settles. `instant`: the signed transaction completes the trade (Midas/Ondo swaps and IXS deposits). `async`: the transaction only *requests* an IXS redemption, which the vault operator settles off-chain later — poll `poll_endpoint` for status. | instant                                                                                                                                                                                                                                                           |
+| `pollEndpoint`                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                | For `async` settlements, the endpoint to poll for redemption status (`GET /v2/tokenized_assets/redemptions`). Null for instant trades.                                                                                                                            |                                                                                                                                                                                                                                                                   |

package/docs/models/operations/v2creditmorphomarketschain.md

@@ -0,0 +1,15 @@
+# V2CreditMorphoMarketsChain
+
+## Example Usage
+
+```typescript
+import { V2CreditMorphoMarketsChain } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2CreditMorphoMarketsChain = "ethereum";
+```
+
+## Values
+
+```typescript
+"arbitrum" | "base" | "ethereum" | "tempo"
+```

package/docs/models/operations/v2creditmorphomarketsrequest.md

@@ -0,0 +1,17 @@
+# V2CreditMorphoMarketsRequest
+
+## Example Usage
+
+```typescript
+import { V2CreditMorphoMarketsRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2CreditMorphoMarketsRequest = {
+  chain: "ethereum",
+};
+```
+
+## Fields
+
+| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    | Example                                                                                        |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `chain`                                                                                        | [operations.V2CreditMorphoMarketsChain](../../models/operations/v2creditmorphomarketschain.md) | :heavy_check_mark:                                                                             | N/A                                                                                            | ethereum                                                                                       |

package/docs/models/operations/v2tokenizedassetsredemptionschain.md

@@ -0,0 +1,17 @@
+# V2TokenizedAssetsRedemptionsChain
+
+The chain to use.
+
+## Example Usage
+
+```typescript
+import { V2TokenizedAssetsRedemptionsChain } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2TokenizedAssetsRedemptionsChain = "bsc";
+```
+
+## Values
+
+```typescript
+"base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc"
+```

package/docs/models/operations/v2tokenizedassetsredemptionsrequest.md

@@ -0,0 +1,21 @@
+# V2TokenizedAssetsRedemptionsRequest
+
+## Example Usage
+
+```typescript
+import { V2TokenizedAssetsRedemptionsRequest } from "@compass-labs/api-sdk/models/operations";
+
+let value: V2TokenizedAssetsRedemptionsRequest = {
+  owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  chain: "bsc",
+  vault: "ixv1",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                         | Type                                                                                                                                                                          | Required                                                                                                                                                                      | Description                                                                                                                                                                   | Example                                                                                                                                                                       |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                       | *string*                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                            | The owner of the Tokenized Assets Account whose IXS redemption requests to read. Requests are reconstructed on-chain from the derived product account (the request receiver). | 0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B                                                                                                                                    |
+| `chain`                                                                                                                                                                       | [operations.V2TokenizedAssetsRedemptionsChain](../../models/operations/v2tokenizedassetsredemptionschain.md)                                                                  | :heavy_minus_sign:                                                                                                                                                            | Network the IXS vault lives on (IXS managed vaults are on BNB Smart Chain).                                                                                                   | bsc                                                                                                                                                                           |
+| `vault`                                                                                                                                                                       | *string*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                            | The IXS vault handle to read redemptions for (e.g. 'ixv1').                                                                                                                   | ixv1                                                                                                                                                                          |

package/docs/sdks/credit/README.md

@@ -7,6 +7,7 @@
 * [creditPositions](#creditpositions) - List credit positions
 * [creditBalances](#creditbalances) - Get credit account token balances
 * [creditEulerMarkets](#crediteulermarkets) - List curated Euler markets
+* [creditMorphoMarkets](#creditmorphomarkets) - List curated Morpho markets
 * [creditCreateAccount](#creditcreateaccount) - Create credit account
 * [creditBorrow](#creditborrow) - Borrow against collateral
 * [creditTransfer](#credittransfer) - Transfer tokens to/from Credit Account
@@ -250,6 +251,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.

package/docs/sdks/tokenizedassets/README.md

@@ -9,6 +9,7 @@
 * [tokenizedAssetsPositions](#tokenizedassetspositions) - Get tokenized-asset positions for an owner
 * [tokenizedAssetsBalances](#tokenizedassetsbalances) - Get account balances
 * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get tokenized-equity order status (Ondo)
+* [tokenizedAssetsRedemptions](#tokenizedassetsredemptions) - Get IXS vault redemption requests for an owner
 * [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create a Tokenized Assets Account
 * [tokenizedAssetsTransfer](#tokenizedassetstransfer) - Deposit to / withdraw from a Tokenized Assets Account
 * [tokenizedAssetsQuote](#tokenizedassetsquote) - Preview a tokenized-equity buy/sell quote (Ondo)
@@ -447,6 +448,95 @@ run();
 | errors.TokenizedAssetsErrorResponse | 502                                 | application/json                    |
 | errors.APIError                     | 4XX, 5XX                            | \*/\*                               |
 
+## tokenizedAssetsRedemptions
+
+Get an owner's IXS vault redemption requests (async redemption status).
+
+IXS managed-vault **sells** are asynchronous: `/transact/sell` returns a
+`requestRedeem` transaction, and the vault operator settles it off-chain
+later. This endpoint reconstructs the owner's requests directly from the
+vault on every call (Compass persists no async state) — each entry carries
+its `status` (`pending` | `finalized` | `rejected`), the `shares` requested,
+and, while `pending`, the `expected_net_assets` it would settle for at the
+current NAV (a preview, not a guarantee).
+
+IXS vaults live on BNB Smart Chain — pass `chain=bsc` (the default) and the
+`vault` handle (default `ixv1`).
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_redemptions" method="get" path="/v2/tokenized_assets/redemptions" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.tokenizedAssets.tokenizedAssetsRedemptions({
+    owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "bsc",
+    vault: "ixv1",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { tokenizedAssetsTokenizedAssetsRedemptions } from "@compass-labs/api-sdk/funcs/tokenizedAssetsTokenizedAssetsRedemptions.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 tokenizedAssetsTokenizedAssetsRedemptions(compassApiSDK, {
+    owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "bsc",
+    vault: "ixv1",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tokenizedAssetsTokenizedAssetsRedemptions failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V2TokenizedAssetsRedemptionsRequest](../../models/operations/v2tokenizedassetsredemptionsrequest.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.RedemptionsResponse](../../models/components/redemptionsresponse.md)\>**
+
+### Errors
+
+| Error Type                          | Status Code                         | Content Type                        |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| errors.TokenizedAssetsErrorResponse | 422                                 | application/json                    |
+| errors.APIError                     | 4XX, 5XX                            | \*/\*                               |
+
 ## tokenizedAssetsCreateAccount
 
 Create a Tokenized Assets Account for a wallet address.