@compass-labs/api-sdk 2.2.84 → 2.2.85-rc.1
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 +32 -32
- package/dist/commonjs/funcs/earnEarnSwapQuote.d.ts +1 -1
- package/dist/commonjs/funcs/earnEarnSwapQuote.js +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +6 -4
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js +6 -4
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +7 -15
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +7 -15
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +7 -12
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +7 -12
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +8 -18
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +8 -18
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +9 -24
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js +9 -24
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +5 -13
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +5 -13
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +5 -11
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +5 -11
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +6 -8
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +6 -8
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +5 -11
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +5 -11
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +7 -13
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js +7 -13
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts +5 -23
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.js +5 -23
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsQuote.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +7 -12
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +7 -12
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts +9 -11
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js +9 -11
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts +10 -8
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js +10 -8
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts +6 -17
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts.map +1 -1
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.js +6 -17
- package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsTransfer.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/lib/http.d.ts +1 -1
- package/dist/commonjs/lib/http.d.ts.map +1 -1
- package/dist/commonjs/lib/http.js +1 -1
- package/dist/commonjs/lib/http.js.map +1 -1
- package/dist/commonjs/lib/security.d.ts +5 -4
- package/dist/commonjs/lib/security.d.ts.map +1 -1
- package/dist/commonjs/lib/security.js +6 -7
- package/dist/commonjs/lib/security.js.map +1 -1
- package/dist/commonjs/models/components/eulermarket.d.ts +32 -0
- package/dist/commonjs/models/components/eulermarket.d.ts.map +1 -1
- package/dist/commonjs/models/components/eulermarket.js +15 -0
- package/dist/commonjs/models/components/eulermarket.js.map +1 -1
- package/dist/commonjs/models/components/eulermarketcollateral.d.ts +8 -0
- package/dist/commonjs/models/components/eulermarketcollateral.d.ts.map +1 -1
- package/dist/commonjs/models/components/eulermarketcollateral.js +4 -0
- package/dist/commonjs/models/components/eulermarketcollateral.js.map +1 -1
- package/dist/commonjs/sdk/earn.d.ts +1 -1
- package/dist/commonjs/sdk/earn.js +1 -1
- package/dist/commonjs/sdk/tokenizedassets.d.ts +110 -208
- package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/commonjs/sdk/tokenizedassets.js +110 -208
- package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
- package/dist/esm/funcs/earnEarnSwapQuote.d.ts +1 -1
- package/dist/esm/funcs/earnEarnSwapQuote.js +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts +6 -4
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js +6 -4
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsBalances.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +7 -15
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +7 -15
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +7 -12
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +7 -12
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +8 -18
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +8 -18
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +9 -24
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js +9 -24
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +5 -13
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +5 -13
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +5 -11
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +5 -11
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts +6 -8
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js +6 -8
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +5 -11
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +5 -11
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +7 -13
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js +7 -13
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts +5 -23
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.js +5 -23
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsQuote.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts +7 -12
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js +7 -12
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsRedemptions.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts +9 -11
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js +9 -11
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts +10 -8
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js +10 -8
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransactSell.js.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts +6 -17
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.d.ts.map +1 -1
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.js +6 -17
- package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsTransfer.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/lib/http.d.ts +1 -1
- package/dist/esm/lib/http.d.ts.map +1 -1
- package/dist/esm/lib/http.js +1 -1
- package/dist/esm/lib/http.js.map +1 -1
- package/dist/esm/lib/security.d.ts +5 -4
- package/dist/esm/lib/security.d.ts.map +1 -1
- package/dist/esm/lib/security.js +4 -5
- package/dist/esm/lib/security.js.map +1 -1
- package/dist/esm/models/components/eulermarket.d.ts +32 -0
- package/dist/esm/models/components/eulermarket.d.ts.map +1 -1
- package/dist/esm/models/components/eulermarket.js +15 -0
- package/dist/esm/models/components/eulermarket.js.map +1 -1
- package/dist/esm/models/components/eulermarketcollateral.d.ts +8 -0
- package/dist/esm/models/components/eulermarketcollateral.d.ts.map +1 -1
- package/dist/esm/models/components/eulermarketcollateral.js +4 -0
- package/dist/esm/models/components/eulermarketcollateral.js.map +1 -1
- package/dist/esm/sdk/earn.d.ts +1 -1
- package/dist/esm/sdk/earn.js +1 -1
- package/dist/esm/sdk/tokenizedassets.d.ts +110 -208
- package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
- package/dist/esm/sdk/tokenizedassets.js +110 -208
- package/dist/esm/sdk/tokenizedassets.js.map +1 -1
- package/docs/models/components/eulermarket.md +22 -10
- package/docs/models/components/eulermarketcollateral.md +3 -0
- package/docs/sdks/earn/README.md +1 -1
- package/docs/sdks/tokenizedassets/README.md +102 -200
- package/openapi_prepped_for_speakeasy.json +122 -32
- package/package.json +1 -1
- package/src/funcs/earnEarnSwapQuote.ts +1 -1
- package/src/funcs/tokenizedAssetsTokenizedAssetsBalances.ts +6 -4
- package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts +7 -15
- package/src/funcs/tokenizedAssetsTokenizedAssetsMarkets.ts +7 -12
- package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts +8 -18
- package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts +9 -24
- package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts +5 -13
- package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts +5 -11
- package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee.ts +6 -8
- package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts +5 -11
- package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts +7 -13
- package/src/funcs/tokenizedAssetsTokenizedAssetsQuote.ts +5 -23
- package/src/funcs/tokenizedAssetsTokenizedAssetsRedemptions.ts +7 -12
- package/src/funcs/tokenizedAssetsTokenizedAssetsTransactBuy.ts +9 -11
- package/src/funcs/tokenizedAssetsTokenizedAssetsTransactSell.ts +10 -8
- package/src/funcs/tokenizedAssetsTokenizedAssetsTransfer.ts +6 -17
- package/src/lib/config.ts +2 -2
- package/src/lib/http.ts +3 -1
- package/src/lib/security.ts +10 -5
- package/src/models/components/eulermarket.ts +47 -0
- package/src/models/components/eulermarketcollateral.ts +12 -0
- package/src/sdk/earn.ts +1 -1
- package/src/sdk/tokenizedassets.ts +110 -208
|
@@ -27,20 +27,14 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Submit a signed
|
|
30
|
+
* Submit a signed order
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Submit a signed order for settlement.
|
|
33
|
+
* Submit a signed equity order to the market-maker network for settlement.
|
|
34
34
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* struct is the Tokenized Assets Account, not the owner's wallet —
|
|
39
|
-
* pass `signed_order` back unchanged.
|
|
40
|
-
*
|
|
41
|
-
* Returns the order hash and a server-side ISO 8601 timestamp.
|
|
42
|
-
* Subsequent calls to `GET /order/{order_hash}` track the lifecycle
|
|
43
|
-
* (`pending` → `filled` / `expired` / `cancelled`).
|
|
35
|
+
* Relays the payload from `/order` plus the owner's signature, and returns the
|
|
36
|
+
* order hash. Poll `GET /order/{order_hash}` to track its lifecycle (`pending` →
|
|
37
|
+
* `filled` / `expired` / `cancelled`).
|
|
44
38
|
*/
|
|
45
39
|
export function tokenizedAssetsTokenizedAssetsOrderSubmit(
|
|
46
40
|
client: CompassApiSDKCore,
|
|
@@ -28,22 +28,16 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
28
28
|
import { Result } from "../types/fp.js";
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* List positions
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
|
-
* Get
|
|
34
|
+
* Get an owner's tokenized-asset holdings, priced and aggregated.
|
|
35
35
|
*
|
|
36
|
-
*
|
|
37
|
-
* Midas RWA yield tokens
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* RWA positions are valued at the latest indexed NAV. Pass `chain=base` for
|
|
42
|
-
* Base holdings (equities are Ethereum-only). Zero balances are omitted, and
|
|
43
|
-
* a `total_usd` aggregate is returned across all priced positions.
|
|
44
|
-
*
|
|
45
|
-
* Returns 400 `ACCOUNT_NOT_DEPLOYED` if the owner has no Tokenized Assets
|
|
46
|
-
* Account deployed yet — create one via `/create_account` first.
|
|
36
|
+
* Returns positions across every asset family the account holds — Ondo equities,
|
|
37
|
+
* Midas RWA yield tokens, and IXS managed vaults — each valued in USD (equities
|
|
38
|
+
* from the Ondo feed, RWA at the latest indexed NAV) with a `total_usd` total.
|
|
39
|
+
* The account is derived from `owner`; pass `chain` for Base (Midas) or BNB Smart
|
|
40
|
+
* Chain (IXS) holdings.
|
|
47
41
|
*/
|
|
48
42
|
export function tokenizedAssetsTokenizedAssetsPositions(
|
|
49
43
|
client: CompassApiSDKCore,
|
|
@@ -27,33 +27,15 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Quote an order
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
33
|
* Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).
|
|
34
34
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* Returns the input/output amounts, fees, and slippage tolerance for an order.
|
|
40
|
-
*
|
|
41
|
-
* Read-only: previews the quote without consuming a ``quote_id`` or
|
|
42
|
-
* committing an order. Pair with `POST /order`:
|
|
43
|
-
* surface this preview to the user, and on confirm pass the body plus
|
|
44
|
-
* ``recommended_slippage_bps`` to `/order`.
|
|
45
|
-
*
|
|
46
|
-
* The response carries:
|
|
47
|
-
*
|
|
48
|
-
* - **`quote`** — input/output token amounts, fees, and an
|
|
49
|
-
* ``est_fill_seconds`` upper bound.
|
|
50
|
-
* - **`recommended_slippage_bps`** — system-derived slippage tolerance
|
|
51
|
-
* that clears the current auction floor; pass back as
|
|
52
|
-
* ``slippage_bps`` on `/order` so the build call validates against the
|
|
53
|
-
* same floor the user was shown.
|
|
54
|
-
* - **`auction_range_bps`** — worst-case bps gap between the auction
|
|
55
|
-
* end amount and the reference quote amount. Use to surface a
|
|
56
|
-
* thin-liquidity warning to the user.
|
|
35
|
+
* Read-only price preview: returns the expected input/output amounts and a
|
|
36
|
+
* system-recommended slippage tolerance to carry into `/order`. Equities only —
|
|
37
|
+
* RWA yield tokens (Midas) have no quote step and are rejected with `422 Wrong
|
|
38
|
+
* trade flow`; trade them via `/transact/buy` and `/transact/sell`.
|
|
57
39
|
*/
|
|
58
40
|
export function tokenizedAssetsTokenizedAssetsQuote(
|
|
59
41
|
client: CompassApiSDKCore,
|
|
@@ -28,21 +28,16 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
28
28
|
import { Result } from "../types/fp.js";
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* List redemption requests
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
|
-
* Get an owner's IXS vault redemption requests
|
|
34
|
+
* Get an owner's IXS managed-vault redemption requests and their status.
|
|
35
35
|
*
|
|
36
|
-
* IXS
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* and, while `pending`, the `expected_net_assets` it would settle for at the
|
|
42
|
-
* current NAV (a preview, not a guarantee).
|
|
43
|
-
*
|
|
44
|
-
* IXS vaults live on BNB Smart Chain — pass `chain=bsc` (the default) and the
|
|
45
|
-
* `vault` handle (default `ixv1`).
|
|
36
|
+
* IXS vault sells are asynchronous — `/transact/sell` files a `requestRedeem`
|
|
37
|
+
* that the vault operator settles off-chain later. This reconstructs the owner's
|
|
38
|
+
* requests live from the vault (Compass stores no async state), reporting each as
|
|
39
|
+
* `pending`, `finalized`, or `rejected`. IXS vaults live on BNB Smart Chain
|
|
40
|
+
* (`chain=bsc`, vault `ixv1`).
|
|
46
41
|
*/
|
|
47
42
|
export function tokenizedAssetsTokenizedAssetsRedemptions(
|
|
48
43
|
client: CompassApiSDKCore,
|
|
@@ -27,20 +27,18 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Buy an RWA yield token
|
|
30
|
+
* Buy an RWA yield token
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Buy
|
|
33
|
+
* Buy an RWA yield token, or deposit into an IXS managed vault, with a stablecoin
|
|
34
|
+
* in one transaction.
|
|
34
35
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* `token_out` must be a Midas RWA asset; equities trade via the order
|
|
43
|
-
* endpoints (`/quote`, `/order`, `/order/submit`).
|
|
36
|
+
* Set `token_out` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
|
|
37
|
+
* **vault address** (its shares aren't a registered symbol). The account spends
|
|
38
|
+
* a stablecoin it already holds (fund it with a plain transfer first) and
|
|
39
|
+
* settles inside the product account — an unsigned transaction the owner signs,
|
|
40
|
+
* or EIP-712 with `gas_sponsorship`. Both paths are instant. Equities use the
|
|
41
|
+
* order flow (`/quote`, `/order`).
|
|
44
42
|
*/
|
|
45
43
|
export function tokenizedAssetsTokenizedAssetsTransactBuy(
|
|
46
44
|
client: CompassApiSDKCore,
|
|
@@ -27,17 +27,19 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Sell an RWA yield token
|
|
30
|
+
* Sell an RWA yield token
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Sell
|
|
33
|
+
* Sell an RWA yield token, or redeem from an IXS managed vault, back to a
|
|
34
|
+
* stablecoin.
|
|
34
35
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
36
|
+
* Set `token_in` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
|
|
37
|
+
* **vault address**. A Midas redemption is instant and settles in the same
|
|
38
|
+
* transaction; an IXS redemption is **asynchronous** — it files a
|
|
39
|
+
* `requestRedeem` (`settlement: async`) the vault operator settles off-chain
|
|
40
|
+
* later, so poll `GET /v2/tokenized_assets/redemptions` for status. The
|
|
41
|
+
* transaction executes inside the product account (owner signs, or EIP-712 with
|
|
42
|
+
* `gas_sponsorship`).
|
|
41
43
|
*/
|
|
42
44
|
export function tokenizedAssetsTokenizedAssetsTransactSell(
|
|
43
45
|
client: CompassApiSDKCore,
|
|
@@ -27,27 +27,16 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Transfer tokens to/from account
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
33
|
* Move tokens between the owner's wallet and their Tokenized Assets Account.
|
|
34
34
|
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* signs off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the
|
|
41
|
-
* sponsor broadcasts and pays the gas:
|
|
42
|
-
*
|
|
43
|
-
* - **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first
|
|
44
|
-
* grant a one-time token->Permit2 allowance (gaslessly via
|
|
45
|
-
* `POST /v2/gas_sponsorship/approve_transfer`).
|
|
46
|
-
* - **WITHDRAW** returns a Safe transaction the account executes.
|
|
47
|
-
*
|
|
48
|
-
* With `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer
|
|
49
|
-
* the owner broadcasts directly, and a WITHDRAW returns an unsigned Safe
|
|
50
|
-
* `execTransaction` the owner signs and broadcasts.
|
|
35
|
+
* `DEPOSIT` funds the account from the owner's wallet; `WITHDRAW` sends tokens
|
|
36
|
+
* back. Supports gas sponsorship: with `gas_sponsorship=true` the owner signs
|
|
37
|
+
* EIP-712 typed data (a Permit2 permit on deposit, a product-account transaction
|
|
38
|
+
* on withdrawal) and a sponsor broadcasts; otherwise the owner broadcasts the
|
|
39
|
+
* transaction directly.
|
|
51
40
|
*/
|
|
52
41
|
export function tokenizedAssetsTokenizedAssetsTransfer(
|
|
53
42
|
client: CompassApiSDKCore,
|
package/src/lib/config.ts
CHANGED
|
@@ -62,7 +62,7 @@ export const SDK_METADATA = {
|
|
|
62
62
|
language: "typescript",
|
|
63
63
|
openapiDocVersion: "0.0.1",
|
|
64
64
|
sdkVersion: "2.0.0",
|
|
65
|
-
genVersion: "2.916.
|
|
65
|
+
genVersion: "2.916.4",
|
|
66
66
|
userAgent:
|
|
67
|
-
"speakeasy-sdk/typescript 2.0.0 2.916.
|
|
67
|
+
"speakeasy-sdk/typescript 2.0.0 2.916.4 0.0.1 @compass-labs/api-sdk",
|
|
68
68
|
} as const;
|
package/src/lib/http.ts
CHANGED
|
@@ -45,8 +45,10 @@ export class HTTPClient {
|
|
|
45
45
|
private requestHooks: BeforeRequestHook[] = [];
|
|
46
46
|
private requestErrorHooks: RequestErrorHook[] = [];
|
|
47
47
|
private responseHooks: ResponseHook[] = [];
|
|
48
|
+
private options: HTTPClientOptions;
|
|
48
49
|
|
|
49
|
-
constructor(
|
|
50
|
+
constructor(options: HTTPClientOptions = {}) {
|
|
51
|
+
this.options = options;
|
|
50
52
|
this.fetcher = options.fetcher || DEFAULT_FETCHER;
|
|
51
53
|
}
|
|
52
54
|
|
package/src/lib/security.ts
CHANGED
|
@@ -12,17 +12,22 @@ type OAuth2PasswordFlow = {
|
|
|
12
12
|
tokenURL: string;
|
|
13
13
|
};
|
|
14
14
|
|
|
15
|
-
export
|
|
16
|
-
Incomplete
|
|
17
|
-
UnrecognisedSecurityType
|
|
18
|
-
}
|
|
15
|
+
export const SecurityErrorCode = {
|
|
16
|
+
Incomplete: "incomplete",
|
|
17
|
+
UnrecognisedSecurityType: "unrecognized_security_type",
|
|
18
|
+
} as const;
|
|
19
|
+
export type SecurityErrorCode =
|
|
20
|
+
(typeof SecurityErrorCode)[keyof typeof SecurityErrorCode];
|
|
19
21
|
|
|
20
22
|
export class SecurityError extends Error {
|
|
23
|
+
public code: SecurityErrorCode;
|
|
24
|
+
|
|
21
25
|
constructor(
|
|
22
|
-
|
|
26
|
+
code: SecurityErrorCode,
|
|
23
27
|
message: string,
|
|
24
28
|
) {
|
|
25
29
|
super(message);
|
|
30
|
+
this.code = code;
|
|
26
31
|
this.name = "SecurityError";
|
|
27
32
|
}
|
|
28
33
|
|
|
@@ -36,6 +36,14 @@ export type EulerMarket = {
|
|
|
36
36
|
* Decimals of the borrowable asset.
|
|
37
37
|
*/
|
|
38
38
|
assetDecimals: number;
|
|
39
|
+
/**
|
|
40
|
+
* USD price of one whole unit of the borrowable asset. Use it to convert USD borrow capacity into token units. Null if the price feed can't quote it.
|
|
41
|
+
*/
|
|
42
|
+
assetPriceUsd?: string | null | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* Symbol of the market's native unit of account (usually USD). The market's own risk engine denominates collateral and debt in this unit.
|
|
45
|
+
*/
|
|
46
|
+
unitOfAccountSymbol?: string | null | undefined;
|
|
39
47
|
/**
|
|
40
48
|
* Current borrow APY for this market (cost to borrow the asset), in percentage (e.g. 5.25 means 5.25%). Null if the rate is unavailable.
|
|
41
49
|
*/
|
|
@@ -44,6 +52,30 @@ export type EulerMarket = {
|
|
|
44
52
|
* Current supply APY for this market (yield for supplying the asset), in percentage (e.g. 3.45 means 3.45%). Null if the rate is unavailable.
|
|
45
53
|
*/
|
|
46
54
|
supplyApy?: string | null | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Asset available to borrow right now (vault cash), in token units. A borrow larger than this reverts even if the account is healthy.
|
|
57
|
+
*/
|
|
58
|
+
availableLiquidity: string;
|
|
59
|
+
/**
|
|
60
|
+
* Total asset supplied to this market, in token units.
|
|
61
|
+
*/
|
|
62
|
+
totalSupplyAssets: string;
|
|
63
|
+
/**
|
|
64
|
+
* Total asset borrowed from this market, in token units.
|
|
65
|
+
*/
|
|
66
|
+
totalBorrowAssets: string;
|
|
67
|
+
/**
|
|
68
|
+
* Borrowed share of supplied assets, in percentage 0-100.
|
|
69
|
+
*/
|
|
70
|
+
utilization: string;
|
|
71
|
+
/**
|
|
72
|
+
* Maximum total supply allowed, in token units. Null when the market is uncapped.
|
|
73
|
+
*/
|
|
74
|
+
supplyCap?: string | null | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* Maximum total borrow allowed, in token units. A borrow that would breach this reverts even when cash exists. Null when uncapped.
|
|
77
|
+
*/
|
|
78
|
+
borrowCap?: string | null | undefined;
|
|
47
79
|
/**
|
|
48
80
|
* Collateral vaults this market accepts (those currently borrowable, LTV > 0), each with its LTVs.
|
|
49
81
|
*/
|
|
@@ -61,16 +93,31 @@ export const EulerMarket$inboundSchema: z.ZodType<
|
|
|
61
93
|
asset: z.string(),
|
|
62
94
|
asset_symbol: z.string(),
|
|
63
95
|
asset_decimals: z.number().int(),
|
|
96
|
+
asset_price_usd: z.nullable(z.string()).optional(),
|
|
97
|
+
unit_of_account_symbol: z.nullable(z.string()).optional(),
|
|
64
98
|
borrow_apy: z.nullable(z.string()).optional(),
|
|
65
99
|
supply_apy: z.nullable(z.string()).optional(),
|
|
100
|
+
available_liquidity: z.string(),
|
|
101
|
+
total_supply_assets: z.string(),
|
|
102
|
+
total_borrow_assets: z.string(),
|
|
103
|
+
utilization: z.string(),
|
|
104
|
+
supply_cap: z.nullable(z.string()).optional(),
|
|
105
|
+
borrow_cap: z.nullable(z.string()).optional(),
|
|
66
106
|
collaterals: z.array(EulerMarketCollateral$inboundSchema).optional(),
|
|
67
107
|
}).transform((v) => {
|
|
68
108
|
return remap$(v, {
|
|
69
109
|
"vault_symbol": "vaultSymbol",
|
|
70
110
|
"asset_symbol": "assetSymbol",
|
|
71
111
|
"asset_decimals": "assetDecimals",
|
|
112
|
+
"asset_price_usd": "assetPriceUsd",
|
|
113
|
+
"unit_of_account_symbol": "unitOfAccountSymbol",
|
|
72
114
|
"borrow_apy": "borrowApy",
|
|
73
115
|
"supply_apy": "supplyApy",
|
|
116
|
+
"available_liquidity": "availableLiquidity",
|
|
117
|
+
"total_supply_assets": "totalSupplyAssets",
|
|
118
|
+
"total_borrow_assets": "totalBorrowAssets",
|
|
119
|
+
"supply_cap": "supplyCap",
|
|
120
|
+
"borrow_cap": "borrowCap",
|
|
74
121
|
});
|
|
75
122
|
});
|
|
76
123
|
|
|
@@ -24,6 +24,14 @@ export type EulerMarketCollateral = {
|
|
|
24
24
|
* Symbol of the collateral's underlying asset (e.g. USDC).
|
|
25
25
|
*/
|
|
26
26
|
assetSymbol: string;
|
|
27
|
+
/**
|
|
28
|
+
* Decimals of the collateral's underlying asset.
|
|
29
|
+
*/
|
|
30
|
+
assetDecimals: number;
|
|
31
|
+
/**
|
|
32
|
+
* USD price of one whole unit of the collateral asset. Null if the price feed can't quote it (size the supply in token units instead).
|
|
33
|
+
*/
|
|
34
|
+
assetPriceUsd?: string | null | undefined;
|
|
27
35
|
/**
|
|
28
36
|
* Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%).
|
|
29
37
|
*/
|
|
@@ -47,12 +55,16 @@ export const EulerMarketCollateral$inboundSchema: z.ZodType<
|
|
|
47
55
|
vault: z.string(),
|
|
48
56
|
asset: z.string(),
|
|
49
57
|
asset_symbol: z.string(),
|
|
58
|
+
asset_decimals: z.number().int(),
|
|
59
|
+
asset_price_usd: z.nullable(z.string()).optional(),
|
|
50
60
|
borrow_ltv: z.string(),
|
|
51
61
|
liquidation_ltv: z.string(),
|
|
52
62
|
supply_apy: z.nullable(z.string()).optional(),
|
|
53
63
|
}).transform((v) => {
|
|
54
64
|
return remap$(v, {
|
|
55
65
|
"asset_symbol": "assetSymbol",
|
|
66
|
+
"asset_decimals": "assetDecimals",
|
|
67
|
+
"asset_price_usd": "assetPriceUsd",
|
|
56
68
|
"borrow_ltv": "borrowLtv",
|
|
57
69
|
"liquidation_ltv": "liquidationLtv",
|
|
58
70
|
"supply_apy": "supplyApy",
|