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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/README.md +5 -3
  2. package/codeSamples_typescript.yaml +6 -0
  3. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +30 -0
  4. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +136 -0
  6. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -0
  7. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +8 -6
  8. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  9. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +3 -3
  10. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  11. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +4 -2
  12. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  13. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  14. package/dist/commonjs/models/components/index.d.ts +2 -0
  15. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/index.js +2 -0
  17. package/dist/commonjs/models/components/index.js.map +1 -1
  18. package/dist/commonjs/models/components/marketdetail.d.ts +8 -6
  19. package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/marketdetail.js +3 -3
  21. package/dist/commonjs/models/components/marketdetail.js.map +1 -1
  22. package/dist/commonjs/models/components/redemption.d.ts +52 -0
  23. package/dist/commonjs/models/components/redemption.d.ts.map +1 -0
  24. package/dist/commonjs/models/components/redemption.js +73 -0
  25. package/dist/commonjs/models/components/redemption.js.map +1 -0
  26. package/dist/commonjs/models/components/redemptionsresponse.d.ts +17 -0
  27. package/dist/commonjs/models/components/redemptionsresponse.d.ts.map +1 -0
  28. package/dist/commonjs/models/components/redemptionsresponse.js +51 -0
  29. package/dist/commonjs/models/components/redemptionsresponse.js.map +1 -0
  30. package/dist/commonjs/models/components/tokenizedassetclass.d.ts +9 -4
  31. package/dist/commonjs/models/components/tokenizedassetclass.d.ts.map +1 -1
  32. package/dist/commonjs/models/components/tokenizedassetclass.js +5 -2
  33. package/dist/commonjs/models/components/tokenizedassetclass.js.map +1 -1
  34. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts +1 -0
  35. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts.map +1 -1
  36. package/dist/commonjs/models/components/tokenizedassetprovider.js +1 -0
  37. package/dist/commonjs/models/components/tokenizedassetprovider.js.map +1 -1
  38. package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts +22 -0
  39. package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
  40. package/dist/commonjs/models/components/tokenizedassetstraderesponse.js +14 -1
  41. package/dist/commonjs/models/components/tokenizedassetstraderesponse.js.map +1 -1
  42. package/dist/commonjs/models/operations/index.d.ts +1 -0
  43. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  44. package/dist/commonjs/models/operations/index.js +1 -0
  45. package/dist/commonjs/models/operations/index.js.map +1 -1
  46. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts +43 -0
  47. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -0
  48. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js +64 -0
  49. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js.map +1 -0
  50. package/dist/commonjs/sdk/tokenizedassets.d.ts +18 -0
  51. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  52. package/dist/commonjs/sdk/tokenizedassets.js +21 -0
  53. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  54. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +30 -0
  55. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -0
  56. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +100 -0
  57. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -0
  58. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +8 -6
  59. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  60. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +3 -3
  61. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  62. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +4 -2
  63. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  64. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  65. package/dist/esm/models/components/index.d.ts +2 -0
  66. package/dist/esm/models/components/index.d.ts.map +1 -1
  67. package/dist/esm/models/components/index.js +2 -0
  68. package/dist/esm/models/components/index.js.map +1 -1
  69. package/dist/esm/models/components/marketdetail.d.ts +8 -6
  70. package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
  71. package/dist/esm/models/components/marketdetail.js +3 -3
  72. package/dist/esm/models/components/marketdetail.js.map +1 -1
  73. package/dist/esm/models/components/redemption.d.ts +52 -0
  74. package/dist/esm/models/components/redemption.d.ts.map +1 -0
  75. package/dist/esm/models/components/redemption.js +36 -0
  76. package/dist/esm/models/components/redemption.js.map +1 -0
  77. package/dist/esm/models/components/redemptionsresponse.d.ts +17 -0
  78. package/dist/esm/models/components/redemptionsresponse.d.ts.map +1 -0
  79. package/dist/esm/models/components/redemptionsresponse.js +14 -0
  80. package/dist/esm/models/components/redemptionsresponse.js.map +1 -0
  81. package/dist/esm/models/components/tokenizedassetclass.d.ts +9 -4
  82. package/dist/esm/models/components/tokenizedassetclass.d.ts.map +1 -1
  83. package/dist/esm/models/components/tokenizedassetclass.js +5 -2
  84. package/dist/esm/models/components/tokenizedassetclass.js.map +1 -1
  85. package/dist/esm/models/components/tokenizedassetprovider.d.ts +1 -0
  86. package/dist/esm/models/components/tokenizedassetprovider.d.ts.map +1 -1
  87. package/dist/esm/models/components/tokenizedassetprovider.js +1 -0
  88. package/dist/esm/models/components/tokenizedassetprovider.js.map +1 -1
  89. package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts +22 -0
  90. package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
  91. package/dist/esm/models/components/tokenizedassetstraderesponse.js +13 -0
  92. package/dist/esm/models/components/tokenizedassetstraderesponse.js.map +1 -1
  93. package/dist/esm/models/operations/index.d.ts +1 -0
  94. package/dist/esm/models/operations/index.d.ts.map +1 -1
  95. package/dist/esm/models/operations/index.js +1 -0
  96. package/dist/esm/models/operations/index.js.map +1 -1
  97. package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts +43 -0
  98. package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -0
  99. package/dist/esm/models/operations/v2tokenizedassetsredemptions.js +27 -0
  100. package/dist/esm/models/operations/v2tokenizedassetsredemptions.js.map +1 -0
  101. package/dist/esm/sdk/tokenizedassets.d.ts +18 -0
  102. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  103. package/dist/esm/sdk/tokenizedassets.js +21 -0
  104. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  105. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +21 -18
  106. package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +15 -15
  107. package/docs/models/components/marketdetail.md +32 -29
  108. package/docs/models/components/redemption.md +27 -0
  109. package/docs/models/components/redemptionsresponse.md +19 -0
  110. package/docs/models/components/redemptionstatus.md +17 -0
  111. package/docs/models/components/settlement.md +17 -0
  112. package/docs/models/components/tokenizedassetclass.md +6 -4
  113. package/docs/models/components/tokenizedassetprovider.md +2 -2
  114. package/docs/models/components/tokenizedassetstraderesponse.md +9 -6
  115. package/docs/models/operations/v2tokenizedassetsredemptionschain.md +17 -0
  116. package/docs/models/operations/v2tokenizedassetsredemptionsrequest.md +21 -0
  117. package/docs/sdks/tokenizedassets/README.md +90 -0
  118. package/openapi_prepped_for_speakeasy.json +201 -19
  119. package/package.json +1 -1
  120. package/src/funcs/tokenizedAssetsTokenizedAssetsRedemptions.ts +192 -0
  121. package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +11 -9
  122. package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +4 -2
  123. package/src/models/components/index.ts +2 -0
  124. package/src/models/components/marketdetail.ts +11 -9
  125. package/src/models/components/redemption.ts +89 -0
  126. package/src/models/components/redemptionsresponse.ts +38 -0
  127. package/src/models/components/tokenizedassetclass.ts +9 -4
  128. package/src/models/components/tokenizedassetprovider.ts +1 -0
  129. package/src/models/components/tokenizedassetstraderesponse.ts +28 -0
  130. package/src/models/operations/index.ts +1 -0
  131. package/src/models/operations/v2tokenizedassetsredemptions.ts +72 -0
  132. package/src/sdk/tokenizedassets.ts +29 -0
@@ -12,14 +12,17 @@ import { TokenizedAssetsTradeResponse } from "@compass-labs/api-sdk/models/compo
12
12
 
13
13
  let value: TokenizedAssetsTradeResponse = {
14
14
  estimatedAmountOut: "<value>",
15
+ settlement: "instant",
15
16
  };
16
17
  ```
17
18
 
18
19
  ## Fields
19
20
 
20
- | Field | Type | Required | Description |
21
- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
22
- | `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_minus_sign: | Unsigned transaction executing the trade in the product account. |
23
- | `eip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 payload for gas-sponsored execution. |
24
- | `estimatedAmountOut` | *string* | :heavy_check_mark: | Estimated amount of `token_out` received (human-readable units). |
25
- | `feeAmount` | *string* | :heavy_minus_sign: | Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied. |
21
+ | Field | Type | Required | Description | Example |
22
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23
+ | `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_minus_sign: | Unsigned transaction executing the trade in the product account. | |
24
+ | `eip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 payload for gas-sponsored execution. | |
25
+ | `estimatedAmountOut` | *string* | :heavy_check_mark: | Estimated amount of `token_out` received (human-readable units). | |
26
+ | `feeAmount` | *string* | :heavy_minus_sign: | Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied. | |
27
+ | `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 |
28
+ | `pollEndpoint` | *string* | :heavy_minus_sign: | For `async` settlements, the endpoint to poll for redemption status (`GET /v2/tokenized_assets/redemptions`). Null for instant trades. | |
@@ -0,0 +1,17 @@
1
+ # V2TokenizedAssetsRedemptionsChain
2
+
3
+ The chain to use.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { V2TokenizedAssetsRedemptionsChain } from "@compass-labs/api-sdk/models/operations";
9
+
10
+ let value: V2TokenizedAssetsRedemptionsChain = "bsc";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc"
17
+ ```
@@ -0,0 +1,21 @@
1
+ # V2TokenizedAssetsRedemptionsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { V2TokenizedAssetsRedemptionsRequest } from "@compass-labs/api-sdk/models/operations";
7
+
8
+ let value: V2TokenizedAssetsRedemptionsRequest = {
9
+ owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
10
+ chain: "bsc",
11
+ vault: "ixv1",
12
+ };
13
+ ```
14
+
15
+ ## Fields
16
+
17
+ | Field | Type | Required | Description | Example |
18
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
+ | `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 |
20
+ | `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 |
21
+ | `vault` | *string* | :heavy_minus_sign: | The IXS vault handle to read redemptions for (e.g. 'ixv1'). | ixv1 |
@@ -9,6 +9,7 @@
9
9
  * [tokenizedAssetsPositions](#tokenizedassetspositions) - Get tokenized-asset positions for an owner
10
10
  * [tokenizedAssetsBalances](#tokenizedassetsbalances) - Get account balances
11
11
  * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get tokenized-equity order status (Ondo)
12
+ * [tokenizedAssetsRedemptions](#tokenizedassetsredemptions) - Get IXS vault redemption requests for an owner
12
13
  * [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create a Tokenized Assets Account
13
14
  * [tokenizedAssetsTransfer](#tokenizedassetstransfer) - Deposit to / withdraw from a Tokenized Assets Account
14
15
  * [tokenizedAssetsQuote](#tokenizedassetsquote) - Preview a tokenized-equity buy/sell quote (Ondo)
@@ -447,6 +448,95 @@ run();
447
448
  | errors.TokenizedAssetsErrorResponse | 502 | application/json |
448
449
  | errors.APIError | 4XX, 5XX | \*/\* |
449
450
 
451
+ ## tokenizedAssetsRedemptions
452
+
453
+ Get an owner's IXS vault redemption requests (async redemption status).
454
+
455
+ IXS managed-vault **sells** are asynchronous: `/transact/sell` returns a
456
+ `requestRedeem` transaction, and the vault operator settles it off-chain
457
+ later. This endpoint reconstructs the owner's requests directly from the
458
+ vault on every call (Compass persists no async state) — each entry carries
459
+ its `status` (`pending` | `finalized` | `rejected`), the `shares` requested,
460
+ and, while `pending`, the `expected_net_assets` it would settle for at the
461
+ current NAV (a preview, not a guarantee).
462
+
463
+ IXS vaults live on BNB Smart Chain — pass `chain=bsc` (the default) and the
464
+ `vault` handle (default `ixv1`).
465
+
466
+ ### Example Usage
467
+
468
+ <!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_redemptions" method="get" path="/v2/tokenized_assets/redemptions" -->
469
+ ```typescript
470
+ import { CompassApiSDK } from "@compass-labs/api-sdk";
471
+
472
+ const compassApiSDK = new CompassApiSDK({
473
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
474
+ });
475
+
476
+ async function run() {
477
+ const result = await compassApiSDK.tokenizedAssets.tokenizedAssetsRedemptions({
478
+ owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
479
+ chain: "bsc",
480
+ vault: "ixv1",
481
+ });
482
+
483
+ console.log(result);
484
+ }
485
+
486
+ run();
487
+ ```
488
+
489
+ ### Standalone function
490
+
491
+ The standalone function version of this method:
492
+
493
+ ```typescript
494
+ import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
495
+ import { tokenizedAssetsTokenizedAssetsRedemptions } from "@compass-labs/api-sdk/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js";
496
+
497
+ // Use `CompassApiSDKCore` for best tree-shaking performance.
498
+ // You can create one instance of it to use across an application.
499
+ const compassApiSDK = new CompassApiSDKCore({
500
+ apiKeyAuth: "<YOUR_API_KEY_HERE>",
501
+ });
502
+
503
+ async function run() {
504
+ const res = await tokenizedAssetsTokenizedAssetsRedemptions(compassApiSDK, {
505
+ owner: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
506
+ chain: "bsc",
507
+ vault: "ixv1",
508
+ });
509
+ if (res.ok) {
510
+ const { value: result } = res;
511
+ console.log(result);
512
+ } else {
513
+ console.log("tokenizedAssetsTokenizedAssetsRedemptions failed:", res.error);
514
+ }
515
+ }
516
+
517
+ run();
518
+ ```
519
+
520
+ ### Parameters
521
+
522
+ | Parameter | Type | Required | Description |
523
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
524
+ | `request` | [operations.V2TokenizedAssetsRedemptionsRequest](../../models/operations/v2tokenizedassetsredemptionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
525
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
526
+ | `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. |
527
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
528
+
529
+ ### Response
530
+
531
+ **Promise\<[components.RedemptionsResponse](../../models/components/redemptionsresponse.md)\>**
532
+
533
+ ### Errors
534
+
535
+ | Error Type | Status Code | Content Type |
536
+ | ----------------------------------- | ----------------------------------- | ----------------------------------- |
537
+ | errors.TokenizedAssetsErrorResponse | 422 | application/json |
538
+ | errors.APIError | 4XX, 5XX | \*/\* |
539
+
450
540
  ## tokenizedAssetsCreateAccount
451
541
 
452
542
  Create a Tokenized Assets Account for a wallet address.
@@ -7597,6 +7597,83 @@
7597
7597
  "x-speakeasy-name-override": "tokenized_assets_order_{order_hash}"
7598
7598
  }
7599
7599
  },
7600
+ "/v2/tokenized_assets/redemptions": {
7601
+ "get": {
7602
+ "tags": [
7603
+ "Tokenized Assets"
7604
+ ],
7605
+ "summary": "Get IXS vault redemption requests for an owner",
7606
+ "description": "Get an owner's IXS vault redemption requests (async redemption status).\n\nIXS managed-vault **sells** are asynchronous: `/transact/sell` returns a\n`requestRedeem` transaction, and the vault operator settles it off-chain\nlater. This endpoint reconstructs the owner's requests directly from the\nvault on every call (Compass persists no async state) \u2014 each entry carries\nits `status` (`pending` | `finalized` | `rejected`), the `shares` requested,\nand, while `pending`, the `expected_net_assets` it would settle for at the\ncurrent NAV (a preview, not a guarantee).\n\nIXS vaults live on BNB Smart Chain \u2014 pass `chain=bsc` (the default) and the\n`vault` handle (default `ixv1`).",
7607
+ "operationId": "v2_tokenized_assets_redemptions",
7608
+ "parameters": [
7609
+ {
7610
+ "name": "owner",
7611
+ "in": "query",
7612
+ "required": true,
7613
+ "schema": {
7614
+ "type": "string",
7615
+ "title": "Owner",
7616
+ "example": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
7617
+ },
7618
+ "description": "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)."
7619
+ },
7620
+ {
7621
+ "name": "chain",
7622
+ "in": "query",
7623
+ "required": false,
7624
+ "schema": {
7625
+ "type": "string",
7626
+ "enum": [
7627
+ "base",
7628
+ "ethereum",
7629
+ "arbitrum",
7630
+ "hyperevm",
7631
+ "tempo",
7632
+ "bsc"
7633
+ ],
7634
+ "title": "Chain",
7635
+ "description": "The chain to use.",
7636
+ "example": "bsc"
7637
+ },
7638
+ "description": "Network the IXS vault lives on (IXS managed vaults are on BNB Smart Chain)."
7639
+ },
7640
+ {
7641
+ "name": "vault",
7642
+ "in": "query",
7643
+ "required": false,
7644
+ "schema": {
7645
+ "type": "string",
7646
+ "title": "Vault",
7647
+ "example": "ixv1"
7648
+ },
7649
+ "description": "The IXS vault handle to read redemptions for (e.g. 'ixv1')."
7650
+ }
7651
+ ],
7652
+ "responses": {
7653
+ "200": {
7654
+ "description": "Successful Response",
7655
+ "content": {
7656
+ "application/json": {
7657
+ "schema": {
7658
+ "$ref": "#/components/schemas/RedemptionsResponse"
7659
+ }
7660
+ }
7661
+ }
7662
+ },
7663
+ "422": {
7664
+ "description": "`NOT_AN_IXS_VAULT` \u2014 no IXS vault with the given `vault` handle is registered on the requested `chain`.",
7665
+ "content": {
7666
+ "application/json": {
7667
+ "schema": {
7668
+ "$ref": "#/components/schemas/TokenizedAssetsErrorResponse"
7669
+ }
7670
+ }
7671
+ }
7672
+ }
7673
+ },
7674
+ "x-speakeasy-name-override": "tokenized_assets_redemptions"
7675
+ }
7676
+ },
7600
7677
  "/v2/tokenized_assets/create_account": {
7601
7678
  "post": {
7602
7679
  "tags": [
@@ -16597,7 +16674,7 @@
16597
16674
  "contract_address": {
16598
16675
  "type": "string",
16599
16676
  "title": "Contract Address",
16600
- "description": "Ethereum mainnet ERC-20 address for this token."
16677
+ "description": "On-chain ERC-20 address for this token, on the network given by `chain`."
16601
16678
  },
16602
16679
  "decimals": {
16603
16680
  "type": "integer",
@@ -16653,18 +16730,15 @@
16653
16730
  },
16654
16731
  "provider": {
16655
16732
  "$ref": "#/components/schemas/TokenizedAssetProvider",
16656
- "description": "Issuer of this tokenized asset ('ondo' equities, 'midas' RWA yield).",
16657
- "example": "ondo"
16733
+ "description": "Issuer of this tokenized asset ('ondo' equities, 'midas' RWA yield, 'ixs' managed vaults)."
16658
16734
  },
16659
16735
  "asset_class": {
16660
16736
  "$ref": "#/components/schemas/TokenizedAssetClass",
16661
- "description": "Asset class. EQUITY trades via the order endpoints; RWA yield classes trade via transact/buy and transact/sell.",
16662
- "example": "EQUITY"
16737
+ "description": "Asset class. EQUITY trades via the order endpoints; the RWA yield classes and MANAGED_VAULT trade via transact/buy and transact/sell."
16663
16738
  },
16664
16739
  "chain": {
16665
16740
  "$ref": "#/components/schemas/Chain",
16666
- "description": "Network the `contract_address` lives on ('ethereum' or 'base').",
16667
- "example": "ethereum"
16741
+ "description": "Network the `contract_address` lives on (e.g. 'ethereum', 'base', 'bsc')."
16668
16742
  },
16669
16743
  "apy_7d": {
16670
16744
  "anyOf": [
@@ -16839,7 +16913,10 @@
16839
16913
  "name",
16840
16914
  "contract_address",
16841
16915
  "decimals",
16842
- "current_price_usd"
16916
+ "current_price_usd",
16917
+ "provider",
16918
+ "asset_class",
16919
+ "chain"
16843
16920
  ],
16844
16921
  "title": "MarketDetail",
16845
16922
  "description": "Extended market view returned when fetching a single market."
@@ -20948,6 +21025,87 @@
20948
21025
  ],
20949
21026
  "title": "Withdraw"
20950
21027
  },
21028
+ "Redemption": {
21029
+ "properties": {
21030
+ "id": {
21031
+ "type": "integer",
21032
+ "title": "Id",
21033
+ "description": "On-chain redemption request id."
21034
+ },
21035
+ "status": {
21036
+ "type": "string",
21037
+ "enum": [
21038
+ "pending",
21039
+ "finalized",
21040
+ "rejected",
21041
+ "unknown"
21042
+ ],
21043
+ "title": "Status",
21044
+ "description": "Lifecycle state: `pending` (awaiting operator settlement), `finalized` (settled \u2014 assets paid to the product account), `rejected` (operator declined; shares returned to the account), or `unknown` (an unrecognized on-chain status code \u2014 should not occur for the current contract, surfaced defensively instead of erroring)."
21045
+ },
21046
+ "shares": {
21047
+ "type": "string",
21048
+ "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
21049
+ "title": "Shares",
21050
+ "description": "Vault shares in the request (human units)."
21051
+ },
21052
+ "expected_net_assets": {
21053
+ "anyOf": [
21054
+ {
21055
+ "type": "string",
21056
+ "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
21057
+ },
21058
+ {
21059
+ "type": "null"
21060
+ }
21061
+ ],
21062
+ "title": "Expected Net Assets",
21063
+ "description": "For a `pending` request, the estimated net assets (after the exit fee) it would settle for at the current NAV \u2014 a preview, not a guarantee (settlement depends on the operator and the vault's available assets). Null once finalized or rejected."
21064
+ },
21065
+ "requested_at": {
21066
+ "type": "integer",
21067
+ "title": "Requested At",
21068
+ "description": "Unix timestamp when the redemption was requested."
21069
+ },
21070
+ "processed_at": {
21071
+ "anyOf": [
21072
+ {
21073
+ "type": "integer"
21074
+ },
21075
+ {
21076
+ "type": "null"
21077
+ }
21078
+ ],
21079
+ "title": "Processed At",
21080
+ "description": "Unix timestamp when finalized/rejected; null while pending."
21081
+ }
21082
+ },
21083
+ "type": "object",
21084
+ "required": [
21085
+ "id",
21086
+ "status",
21087
+ "shares",
21088
+ "requested_at"
21089
+ ],
21090
+ "title": "Redemption",
21091
+ "description": "One IXS vault redemption request, reconstructed on-chain."
21092
+ },
21093
+ "RedemptionsResponse": {
21094
+ "properties": {
21095
+ "redemptions": {
21096
+ "items": {
21097
+ "$ref": "#/components/schemas/Redemption"
21098
+ },
21099
+ "type": "array",
21100
+ "title": "Redemptions",
21101
+ "description": "The owner's non-empty redemption requests for the vault, in ascending id order. Empty when the owner has never requested one.",
21102
+ "example": []
21103
+ }
21104
+ },
21105
+ "type": "object",
21106
+ "title": "RedemptionsResponse",
21107
+ "description": "An owner's IXS redemption requests for one vault."
21108
+ },
20951
21109
  "Repay": {
20952
21110
  "properties": {
20953
21111
  "id": {
@@ -22793,16 +22951,18 @@
22793
22951
  "EQUITY",
22794
22952
  "T_BILLS",
22795
22953
  "BASIS_TRADE",
22796
- "BTC_YIELD"
22954
+ "BTC_YIELD",
22955
+ "MANAGED_VAULT"
22797
22956
  ],
22798
22957
  "title": "TokenizedAssetClass",
22799
- "description": "Asset class of a tokenized asset.\n\n`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA\nyield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) trade via the\nswap-based `transact/buy` and `transact/sell` endpoints."
22958
+ "description": "Asset class of a tokenized asset.\n\n`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA\nyield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`\ntrade via the swap-based `transact/buy` and `transact/sell` endpoints.\n`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an\n*asynchronous* redemption request settled off-chain by the vault operator."
22800
22959
  },
22801
22960
  "TokenizedAssetProvider": {
22802
22961
  "type": "string",
22803
22962
  "enum": [
22804
22963
  "ondo",
22805
- "midas"
22964
+ "midas",
22965
+ "ixs"
22806
22966
  ],
22807
22967
  "title": "TokenizedAssetProvider",
22808
22968
  "description": "Issuer/provider of a tokenized asset."
@@ -23560,6 +23720,28 @@
23560
23720
  ],
23561
23721
  "title": "Fee Amount",
23562
23722
  "description": "Fee charged on the sell, in payout-token (USDC) units. Null when no fee was applied."
23723
+ },
23724
+ "settlement": {
23725
+ "type": "string",
23726
+ "enum": [
23727
+ "instant",
23728
+ "async"
23729
+ ],
23730
+ "title": "Settlement",
23731
+ "description": "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 \u2014 poll `poll_endpoint` for status.",
23732
+ "example": "instant"
23733
+ },
23734
+ "poll_endpoint": {
23735
+ "anyOf": [
23736
+ {
23737
+ "type": "string"
23738
+ },
23739
+ {
23740
+ "type": "null"
23741
+ }
23742
+ ],
23743
+ "title": "Poll Endpoint",
23744
+ "description": "For `async` settlements, the endpoint to poll for redemption status (`GET /v2/tokenized_assets/redemptions`). Null for instant trades."
23563
23745
  }
23564
23746
  },
23565
23747
  "type": "object",
@@ -27775,7 +27957,7 @@
27775
27957
  "contract_address": {
27776
27958
  "type": "string",
27777
27959
  "title": "Contract Address",
27778
- "description": "Ethereum mainnet ERC-20 address for this token."
27960
+ "description": "On-chain ERC-20 address for this token, on the network given by `chain`."
27779
27961
  },
27780
27962
  "decimals": {
27781
27963
  "type": "integer",
@@ -27831,18 +28013,15 @@
27831
28013
  },
27832
28014
  "provider": {
27833
28015
  "$ref": "#/components/schemas/TokenizedAssetProvider",
27834
- "description": "Issuer of this tokenized asset ('ondo' equities, 'midas' RWA yield).",
27835
- "example": "ondo"
28016
+ "description": "Issuer of this tokenized asset ('ondo' equities, 'midas' RWA yield, 'ixs' managed vaults)."
27836
28017
  },
27837
28018
  "asset_class": {
27838
28019
  "$ref": "#/components/schemas/TokenizedAssetClass",
27839
- "description": "Asset class. EQUITY trades via the order endpoints; RWA yield classes trade via transact/buy and transact/sell.",
27840
- "example": "EQUITY"
28020
+ "description": "Asset class. EQUITY trades via the order endpoints; the RWA yield classes and MANAGED_VAULT trade via transact/buy and transact/sell."
27841
28021
  },
27842
28022
  "chain": {
27843
28023
  "$ref": "#/components/schemas/Chain",
27844
- "description": "Network the `contract_address` lives on ('ethereum' or 'base').",
27845
- "example": "ethereum"
28024
+ "description": "Network the `contract_address` lives on (e.g. 'ethereum', 'base', 'bsc')."
27846
28025
  },
27847
28026
  "apy_7d": {
27848
28027
  "anyOf": [
@@ -27888,7 +28067,10 @@
27888
28067
  "name",
27889
28068
  "contract_address",
27890
28069
  "decimals",
27891
- "current_price_usd"
28070
+ "current_price_usd",
28071
+ "provider",
28072
+ "asset_class",
28073
+ "chain"
27892
28074
  ],
27893
28075
  "title": "Market",
27894
28076
  "description": "Compact market entry returned in list responses."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.75-rc.0",
3
+ "version": "2.2.76-rc.0",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {