@compass-labs/api-sdk 2.2.75 → 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.
- package/README.md +5 -3
- package/codeSamples_typescript.yaml +6 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +30 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +136 -0
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -0
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +8 -6
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +3 -3
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +4 -2
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
- package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +2 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +2 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/marketdetail.d.ts +8 -6
- package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
- package/dist/commonjs/models/components/marketdetail.js +3 -3
- package/dist/commonjs/models/components/marketdetail.js.map +1 -1
- package/dist/commonjs/models/components/redemption.d.ts +52 -0
- package/dist/commonjs/models/components/redemption.d.ts.map +1 -0
- package/dist/commonjs/models/components/redemption.js +73 -0
- package/dist/commonjs/models/components/redemption.js.map +1 -0
- package/dist/commonjs/models/components/redemptionsresponse.d.ts +17 -0
- package/dist/commonjs/models/components/redemptionsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/redemptionsresponse.js +51 -0
- package/dist/commonjs/models/components/redemptionsresponse.js.map +1 -0
- package/dist/commonjs/models/components/tokenizedassetclass.d.ts +9 -4
- package/dist/commonjs/models/components/tokenizedassetclass.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetclass.js +5 -2
- package/dist/commonjs/models/components/tokenizedassetclass.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetprovider.d.ts +1 -0
- package/dist/commonjs/models/components/tokenizedassetprovider.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetprovider.js +1 -0
- package/dist/commonjs/models/components/tokenizedassetprovider.js.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts +22 -0
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.js +14 -1
- package/dist/commonjs/models/components/tokenizedassetstraderesponse.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +1 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +1 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts +43 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js +64 -0
- package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js.map +1 -0
- package/dist/commonjs/sdk/tokenizedassets.d.ts +18 -0
- package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/commonjs/sdk/tokenizedassets.js +21 -0
- package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +30 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +100 -0
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -0
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +8 -6
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +3 -3
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +4 -2
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
- package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +2 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +2 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/marketdetail.d.ts +8 -6
- package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
- package/dist/esm/models/components/marketdetail.js +3 -3
- package/dist/esm/models/components/marketdetail.js.map +1 -1
- package/dist/esm/models/components/redemption.d.ts +52 -0
- package/dist/esm/models/components/redemption.d.ts.map +1 -0
- package/dist/esm/models/components/redemption.js +36 -0
- package/dist/esm/models/components/redemption.js.map +1 -0
- package/dist/esm/models/components/redemptionsresponse.d.ts +17 -0
- package/dist/esm/models/components/redemptionsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/redemptionsresponse.js +14 -0
- package/dist/esm/models/components/redemptionsresponse.js.map +1 -0
- package/dist/esm/models/components/tokenizedassetclass.d.ts +9 -4
- package/dist/esm/models/components/tokenizedassetclass.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetclass.js +5 -2
- package/dist/esm/models/components/tokenizedassetclass.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetprovider.d.ts +1 -0
- package/dist/esm/models/components/tokenizedassetprovider.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetprovider.js +1 -0
- package/dist/esm/models/components/tokenizedassetprovider.js.map +1 -1
- package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts +22 -0
- package/dist/esm/models/components/tokenizedassetstraderesponse.d.ts.map +1 -1
- package/dist/esm/models/components/tokenizedassetstraderesponse.js +13 -0
- package/dist/esm/models/components/tokenizedassetstraderesponse.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +1 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +1 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts +43 -0
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -0
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.js +27 -0
- package/dist/esm/models/operations/v2tokenizedassetsredemptions.js.map +1 -0
- package/dist/esm/sdk/tokenizedassets.d.ts +18 -0
- package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/esm/sdk/tokenizedassets.js +21 -0
- package/dist/esm/sdk/tokenizedassets.js.map +1 -1
- package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +21 -18
- package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +15 -15
- package/docs/models/components/marketdetail.md +32 -29
- package/docs/models/components/redemption.md +27 -0
- package/docs/models/components/redemptionsresponse.md +19 -0
- package/docs/models/components/redemptionstatus.md +17 -0
- package/docs/models/components/settlement.md +17 -0
- package/docs/models/components/tokenizedassetclass.md +6 -4
- package/docs/models/components/tokenizedassetprovider.md +2 -2
- package/docs/models/components/tokenizedassetstraderesponse.md +9 -6
- package/docs/models/operations/v2tokenizedassetsredemptionschain.md +17 -0
- package/docs/models/operations/v2tokenizedassetsredemptionsrequest.md +21 -0
- package/docs/sdks/tokenizedassets/README.md +90 -0
- package/openapi_prepped_for_speakeasy.json +201 -19
- package/package.json +1 -1
- package/src/funcs/tokenizedAssetsTokenizedAssetsRedemptions.ts +192 -0
- package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +11 -9
- package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +4 -2
- package/src/models/components/index.ts +2 -0
- package/src/models/components/marketdetail.ts +11 -9
- package/src/models/components/redemption.ts +89 -0
- package/src/models/components/redemptionsresponse.ts +38 -0
- package/src/models/components/tokenizedassetclass.ts +9 -4
- package/src/models/components/tokenizedassetprovider.ts +1 -0
- package/src/models/components/tokenizedassetstraderesponse.ts +28 -0
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/v2tokenizedassetsredemptions.ts +72 -0
- package/src/sdk/tokenizedassets.ts +29 -0
|
@@ -21,18 +21,18 @@ let value:
|
|
|
21
21
|
|
|
22
22
|
## Fields
|
|
23
23
|
|
|
24
|
-
| Field
|
|
25
|
-
|
|
|
26
|
-
| `symbol`
|
|
27
|
-
| `underlyingTicker`
|
|
28
|
-
| `name`
|
|
29
|
-
| `contractAddress`
|
|
30
|
-
| `decimals`
|
|
31
|
-
| `balance`
|
|
32
|
-
| `currentPriceUsd`
|
|
33
|
-
| `balanceUsd`
|
|
34
|
-
| `provider`
|
|
35
|
-
| `assetClass`
|
|
36
|
-
| `chain`
|
|
37
|
-
| `pnl`
|
|
38
|
-
| `events`
|
|
24
|
+
| Field | Type | Required | Description | Example |
|
|
25
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `symbol` | *string* | :heavy_check_mark: | On-chain Ondo symbol (e.g. `TSLAon`). | |
|
|
27
|
+
| `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker. | |
|
|
28
|
+
| `name` | *string* | :heavy_check_mark: | Underlying equity name (or ticker fallback). | |
|
|
29
|
+
| `contractAddress` | *string* | :heavy_check_mark: | Ethereum mainnet ERC-20 address. | |
|
|
30
|
+
| `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals. | |
|
|
31
|
+
| `balance` | *string* | :heavy_check_mark: | Human-readable balance (already scaled by `decimals`). | |
|
|
32
|
+
| `currentPriceUsd` | *string* | :heavy_minus_sign: | USD spot price at read time (decimal string). | |
|
|
33
|
+
| `balanceUsd` | *string* | :heavy_minus_sign: | `balance * current_price_usd` when the price is available. | |
|
|
34
|
+
| `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_minus_sign: | Issuer/provider of a tokenized asset. | |
|
|
35
|
+
| `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_minus_sign: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`<br/>trade via the swap-based `transact/buy` and `transact/sell` endpoints.<br/>`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an<br/>*asynchronous* redemption request settled off-chain by the vault operator. | |
|
|
36
|
+
| `chain` | [components.Chain](../../models/components/chain.md) | :heavy_minus_sign: | The chain to use. | |
|
|
37
|
+
| `pnl` | [components.TokenizedAssetsPnl](../../models/components/tokenizedassetspnl.md) | :heavy_minus_sign: | Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis). | |
|
|
38
|
+
| `events` | [components.TokenizedAssetsActivityEvent](../../models/components/tokenizedassetsactivityevent.md)[] | :heavy_minus_sign: | Chronological activity for this position (buy / sell / transfer_in / transfer_out). Pure-USDC funding is excluded — it appears on the balances endpoint. | [] |
|
|
@@ -16,6 +16,9 @@ let value: MarketDetail = {
|
|
|
16
16
|
currentPriceUsd: "<value>",
|
|
17
17
|
sectors: [],
|
|
18
18
|
regionExposure: [],
|
|
19
|
+
provider: "ixs",
|
|
20
|
+
assetClass: "MANAGED_VAULT",
|
|
21
|
+
chain: "arbitrum",
|
|
19
22
|
priceHistory24h: [],
|
|
20
23
|
tradableSessions: [],
|
|
21
24
|
};
|
|
@@ -23,32 +26,32 @@ let value: MarketDetail = {
|
|
|
23
26
|
|
|
24
27
|
## Fields
|
|
25
28
|
|
|
26
|
-
| Field
|
|
27
|
-
|
|
|
28
|
-
| `symbol`
|
|
29
|
-
| `underlyingTicker`
|
|
30
|
-
| `name`
|
|
31
|
-
| `contractAddress`
|
|
32
|
-
| `decimals`
|
|
33
|
-
| `currentPriceUsd`
|
|
34
|
-
| `change24hUsd`
|
|
35
|
-
| `change24hPct`
|
|
36
|
-
| `sectors`
|
|
37
|
-
| `regionExposure`
|
|
38
|
-
| `provider`
|
|
39
|
-
| `assetClass`
|
|
40
|
-
| `chain`
|
|
41
|
-
| `apy7d`
|
|
42
|
-
| `apy30d`
|
|
43
|
-
| `tvlUsd`
|
|
44
|
-
| `priceHistory24h`
|
|
45
|
-
| `priceHigh52w`
|
|
46
|
-
| `priceLow52w`
|
|
47
|
-
| `volume24h`
|
|
48
|
-
| `averageVolume`
|
|
49
|
-
| `sharesOutstanding`
|
|
50
|
-
| `marketCap`
|
|
51
|
-
| `totalHolders`
|
|
52
|
-
| `tradableSessions`
|
|
53
|
-
| `sharesMultiplier`
|
|
54
|
-
| `candles`
|
|
29
|
+
| Field | Type | Required | Description | Example |
|
|
30
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
31
|
+
| `symbol` | *string* | :heavy_check_mark: | On-chain token symbol (e.g. 'TSLAon'). | |
|
|
32
|
+
| `underlyingTicker` | *string* | :heavy_check_mark: | Underlying equity ticker (e.g. 'TSLA'). | |
|
|
33
|
+
| `name` | *string* | :heavy_check_mark: | Underlying equity full name (e.g. 'Tesla, Inc. Common Stock'). | |
|
|
34
|
+
| `contractAddress` | *string* | :heavy_check_mark: | On-chain ERC-20 address for this token, on the network given by `chain`. | |
|
|
35
|
+
| `decimals` | *number* | :heavy_check_mark: | ERC-20 decimals for this token. | |
|
|
36
|
+
| `currentPriceUsd` | *string* | :heavy_check_mark: | Latest price in USD as a decimal string. | |
|
|
37
|
+
| `change24hUsd` | *string* | :heavy_minus_sign: | Absolute USD price change vs 24h ago (decimal string). | |
|
|
38
|
+
| `change24hPct` | *string* | :heavy_minus_sign: | Percent price change vs 24h ago (decimal string). | |
|
|
39
|
+
| `sectors` | *string*[] | :heavy_minus_sign: | Sector / industry tags from the issuer (e.g. ['Technology']). | [] |
|
|
40
|
+
| `regionExposure` | *string*[] | :heavy_minus_sign: | Regional market exposure tags (e.g. ['US']). | [] |
|
|
41
|
+
| `provider` | [components.TokenizedAssetProvider](../../models/components/tokenizedassetprovider.md) | :heavy_check_mark: | Issuer/provider of a tokenized asset. | |
|
|
42
|
+
| `assetClass` | [components.TokenizedAssetClass](../../models/components/tokenizedassetclass.md) | :heavy_check_mark: | Asset class of a tokenized asset.<br/><br/>`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA<br/>yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`<br/>trade via the swap-based `transact/buy` and `transact/sell` endpoints.<br/>`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an<br/>*asynchronous* redemption request settled off-chain by the vault operator. | |
|
|
43
|
+
| `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
|
|
44
|
+
| `apy7d` | *string* | :heavy_minus_sign: | Trailing 7-day annualized NAV growth (decimal fraction string, e.g. '0.0512' = 5.12%). RWA yield assets only; null until enough NAV history exists. | |
|
|
45
|
+
| `apy30d` | *string* | :heavy_minus_sign: | Trailing 30-day annualized NAV growth (decimal fraction string). RWA yield assets only; null until enough NAV history exists. | |
|
|
46
|
+
| `tvlUsd` | *string* | :heavy_minus_sign: | Total value locked in USD (RWA yield assets only). | |
|
|
47
|
+
| `priceHistory24h` | [components.PricePoint](../../models/components/pricepoint.md)[] | :heavy_minus_sign: | 24h price sparkline as `(timestamp, price)` samples in chronological order. | [] |
|
|
48
|
+
| `priceHigh52w` | *string* | :heavy_minus_sign: | 52-week high of the underlying equity (USD). | |
|
|
49
|
+
| `priceLow52w` | *string* | :heavy_minus_sign: | 52-week low of the underlying equity (USD). | |
|
|
50
|
+
| `volume24h` | *string* | :heavy_minus_sign: | 24h trading volume of the underlying equity. | |
|
|
51
|
+
| `averageVolume` | *string* | :heavy_minus_sign: | Average trading volume of the underlying equity. | |
|
|
52
|
+
| `sharesOutstanding` | *string* | :heavy_minus_sign: | Shares outstanding of the underlying equity. | |
|
|
53
|
+
| `marketCap` | *string* | :heavy_minus_sign: | Market cap of the underlying equity (USD). | |
|
|
54
|
+
| `totalHolders` | *number* | :heavy_minus_sign: | On-chain holder count for the tokenized equity. | |
|
|
55
|
+
| `tradableSessions` | *string*[] | :heavy_minus_sign: | Sessions in which the token can be traded (e.g. 'regular', 'premarket'). | [] |
|
|
56
|
+
| `sharesMultiplier` | *string* | :heavy_minus_sign: | Shares-multiplier ratio (= 1 if no recent split / corporate action). | |
|
|
57
|
+
| `candles` | [components.OhlcCandle](../../models/components/ohlccandle.md)[] | :heavy_minus_sign: | OHLC candles. Present only when both `interval` and `range` query params are provided and form a valid pair; omitted otherwise. | |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Redemption
|
|
2
|
+
|
|
3
|
+
One IXS vault redemption request, reconstructed on-chain.
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { Redemption } from "@compass-labs/api-sdk/models/components";
|
|
9
|
+
|
|
10
|
+
let value: Redemption = {
|
|
11
|
+
id: 125800,
|
|
12
|
+
status: "pending",
|
|
13
|
+
shares: "<value>",
|
|
14
|
+
requestedAt: 555089,
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Fields
|
|
19
|
+
|
|
20
|
+
| Field | Type | Required | Description |
|
|
21
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
+
| `id` | *number* | :heavy_check_mark: | On-chain redemption request id. |
|
|
23
|
+
| `status` | [components.RedemptionStatus](../../models/components/redemptionstatus.md) | :heavy_check_mark: | 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). |
|
|
24
|
+
| `shares` | *string* | :heavy_check_mark: | Vault shares in the request (human units). |
|
|
25
|
+
| `expectedNetAssets` | *string* | :heavy_minus_sign: | For a `pending` request, the estimated net assets (after the exit fee) it would settle for at the current NAV — a preview, not a guarantee (settlement depends on the operator and the vault's available assets). Null once finalized or rejected. |
|
|
26
|
+
| `requestedAt` | *number* | :heavy_check_mark: | Unix timestamp when the redemption was requested. |
|
|
27
|
+
| `processedAt` | *number* | :heavy_minus_sign: | Unix timestamp when finalized/rejected; null while pending. |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# RedemptionsResponse
|
|
2
|
+
|
|
3
|
+
An owner's IXS redemption requests for one vault.
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { RedemptionsResponse } from "@compass-labs/api-sdk/models/components";
|
|
9
|
+
|
|
10
|
+
let value: RedemptionsResponse = {
|
|
11
|
+
redemptions: [],
|
|
12
|
+
};
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Description | Example |
|
|
18
|
+
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
19
|
+
| `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. | [] |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# RedemptionStatus
|
|
2
|
+
|
|
3
|
+
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).
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { RedemptionStatus } from "@compass-labs/api-sdk/models/components";
|
|
9
|
+
|
|
10
|
+
let value: RedemptionStatus = "pending";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"pending" | "finalized" | "rejected" | "unknown"
|
|
17
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Settlement
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Example Usage
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { Settlement } from "@compass-labs/api-sdk/models/components";
|
|
9
|
+
|
|
10
|
+
let value: Settlement = "instant";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"instant" | "async"
|
|
17
|
+
```
|
|
@@ -3,19 +3,21 @@
|
|
|
3
3
|
Asset class of a tokenized asset.
|
|
4
4
|
|
|
5
5
|
`EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
|
|
6
|
-
yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`)
|
|
7
|
-
swap-based `transact/buy` and `transact/sell` endpoints.
|
|
6
|
+
yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
|
|
7
|
+
trade via the swap-based `transact/buy` and `transact/sell` endpoints.
|
|
8
|
+
`MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
|
|
9
|
+
*asynchronous* redemption request settled off-chain by the vault operator.
|
|
8
10
|
|
|
9
11
|
## Example Usage
|
|
10
12
|
|
|
11
13
|
```typescript
|
|
12
14
|
import { TokenizedAssetClass } from "@compass-labs/api-sdk/models/components";
|
|
13
15
|
|
|
14
|
-
let value: TokenizedAssetClass = "
|
|
16
|
+
let value: TokenizedAssetClass = "MANAGED_VAULT";
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
## Values
|
|
18
20
|
|
|
19
21
|
```typescript
|
|
20
|
-
"EQUITY" | "T_BILLS" | "BASIS_TRADE" | "BTC_YIELD"
|
|
22
|
+
"EQUITY" | "T_BILLS" | "BASIS_TRADE" | "BTC_YIELD" | "MANAGED_VAULT"
|
|
21
23
|
```
|
|
@@ -7,11 +7,11 @@ Issuer/provider of a tokenized asset.
|
|
|
7
7
|
```typescript
|
|
8
8
|
import { TokenizedAssetProvider } from "@compass-labs/api-sdk/models/components";
|
|
9
9
|
|
|
10
|
-
let value: TokenizedAssetProvider = "
|
|
10
|
+
let value: TokenizedAssetProvider = "midas";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Values
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
"ondo" | "midas"
|
|
16
|
+
"ondo" | "midas" | "ixs"
|
|
17
17
|
```
|