@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
|
@@ -20,328 +20,230 @@ import { ClientSDK } from "../lib/sdks.js";
|
|
|
20
20
|
import { unwrapAsync } from "../types/fp.js";
|
|
21
21
|
export class TokenizedAssets extends ClientSDK {
|
|
22
22
|
/**
|
|
23
|
-
* List
|
|
23
|
+
* List markets
|
|
24
24
|
*
|
|
25
25
|
* @remarks
|
|
26
|
-
* List tokenized
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* (substring match against symbol, ticker, or name).
|
|
34
|
-
*
|
|
35
|
-
* Equities are Ethereum-only; RWA yield tokens also list on Base — pass
|
|
36
|
-
* `chain=base` to see them. How to trade each: `asset_class=EQUITY` →
|
|
37
|
-
* `/quote` + `/order`; the RWA classes → `/transact/buy` + `/transact/sell`.
|
|
26
|
+
* List the tradable tokenized-asset catalog.
|
|
27
|
+
*
|
|
28
|
+
* Aggregates all three providers — Ondo (tokenized US equities), Midas (RWA
|
|
29
|
+
* yield tokens), and IXS (managed vaults) — into a single list with live USD
|
|
30
|
+
* pricing, plus APY and TVL for yield assets. Filter by provider, asset class,
|
|
31
|
+
* or chain, and narrow the results with a sector `category` or free-text
|
|
32
|
+
* `search`.
|
|
38
33
|
*/
|
|
39
34
|
async tokenizedAssetsMarkets(request, options) {
|
|
40
35
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsMarkets(this, request, options));
|
|
41
36
|
}
|
|
42
37
|
/**
|
|
43
|
-
* Get a
|
|
38
|
+
* Get a market
|
|
44
39
|
*
|
|
45
40
|
* @remarks
|
|
46
|
-
* Get extended detail for a single
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* `
|
|
53
|
-
*
|
|
54
|
-
* **OHLC candles are an equities-only feature** — opt in by passing both
|
|
55
|
-
* `interval` and `range` query params to include a `candles` array. They
|
|
56
|
-
* must be provided together and must form one of the supported pairs:
|
|
57
|
-
*
|
|
58
|
-
* - `1min` / `5min` / `15min` with `range=1day`
|
|
59
|
-
* - `1hour` / `4hour` with `range=1month`
|
|
60
|
-
* - `12hour` with `range=3month`
|
|
61
|
-
* - `1day` with `range=3month` / `6month` / `1year` / `all`
|
|
62
|
-
*
|
|
63
|
-
* Omitting both returns the market detail without `candles`.
|
|
41
|
+
* Get extended detail for a single market — an Ondo **equity** (e.g. `TSLAon`), a
|
|
42
|
+
* Midas **RWA yield token** (e.g. `mTBILL`), or an IXS **managed vault** (e.g.
|
|
43
|
+
* `ixv1`).
|
|
44
|
+
*
|
|
45
|
+
* Adds richer market data on top of the `/markets` listing, plus an optional
|
|
46
|
+
* OHLC candle series: pass matching `interval` and `range` query params to
|
|
47
|
+
* include `candles` (available for equities, Midas tokens except `mBTC`, and IXS
|
|
48
|
+
* vaults; omit both for detail without candles).
|
|
64
49
|
*/
|
|
65
50
|
async tokenizedAssetsMarketsSymbol(request, options) {
|
|
66
51
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsMarketsSymbol(this, request, options));
|
|
67
52
|
}
|
|
68
53
|
/**
|
|
69
|
-
*
|
|
54
|
+
* List positions
|
|
70
55
|
*
|
|
71
56
|
* @remarks
|
|
72
|
-
* Get
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
* Midas RWA yield tokens
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
* RWA positions are valued at the latest indexed NAV. Pass `chain=base` for
|
|
80
|
-
* Base holdings (equities are Ethereum-only). Zero balances are omitted, and
|
|
81
|
-
* a `total_usd` aggregate is returned across all priced positions.
|
|
82
|
-
*
|
|
83
|
-
* Returns 400 `ACCOUNT_NOT_DEPLOYED` if the owner has no Tokenized Assets
|
|
84
|
-
* Account deployed yet — create one via `/create_account` first.
|
|
57
|
+
* Get an owner's tokenized-asset holdings, priced and aggregated.
|
|
58
|
+
*
|
|
59
|
+
* Returns positions across every asset family the account holds — Ondo equities,
|
|
60
|
+
* Midas RWA yield tokens, and IXS managed vaults — each valued in USD (equities
|
|
61
|
+
* from the Ondo feed, RWA at the latest indexed NAV) with a `total_usd` total.
|
|
62
|
+
* The account is derived from `owner`; pass `chain` for Base (Midas) or BNB Smart
|
|
63
|
+
* Chain (IXS) holdings.
|
|
85
64
|
*/
|
|
86
65
|
async tokenizedAssetsPositions(request, options) {
|
|
87
66
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsPositions(this, request, options));
|
|
88
67
|
}
|
|
89
68
|
/**
|
|
90
|
-
* Get
|
|
69
|
+
* Get token balances
|
|
91
70
|
*
|
|
92
71
|
* @remarks
|
|
93
|
-
* Get
|
|
72
|
+
* Get a Tokenized Assets Account's full token ledger.
|
|
94
73
|
*
|
|
95
|
-
* Returns
|
|
96
|
-
* and
|
|
74
|
+
* Returns every token the account has held — including zero balances from fully-exited
|
|
75
|
+
* positions and USDC funding — each with its USD value and transfer history (a
|
|
76
|
+
* superset of `/positions`). Pass `chain=base` or `chain=bsc` for Base or BNB Smart
|
|
77
|
+
* Chain holdings.
|
|
97
78
|
*/
|
|
98
79
|
async tokenizedAssetsBalances(request, options) {
|
|
99
80
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsBalances(this, request, options));
|
|
100
81
|
}
|
|
101
82
|
/**
|
|
102
|
-
* Get
|
|
83
|
+
* Get order status
|
|
103
84
|
*
|
|
104
85
|
* @remarks
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
* Equity-order flow only: RWA-yield trades (`/transact/buy`, `/transact/sell`)
|
|
108
|
-
* are plain swaps that settle in a single transaction and have no order
|
|
109
|
-
* lifecycle to poll.
|
|
86
|
+
* Poll the lifecycle state of a submitted equity order (Ondo).
|
|
110
87
|
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* is also returned.
|
|
115
|
-
*
|
|
116
|
-
* Upstream protocol states beyond these four (e.g. `partially-filled`,
|
|
117
|
-
* `refunded`) are mapped onto this set.
|
|
88
|
+
* Reports `pending`, `filled`, `expired`, or `cancelled`, with fill details as
|
|
89
|
+
* they arrive. Equity orders only — RWA yield swaps settle in one transaction and
|
|
90
|
+
* have no lifecycle to poll.
|
|
118
91
|
*/
|
|
119
92
|
async tokenizedAssetsOrderOrderHash(request, options) {
|
|
120
93
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderOrderHash(this, request, options));
|
|
121
94
|
}
|
|
122
95
|
/**
|
|
123
|
-
*
|
|
96
|
+
* List redemption requests
|
|
124
97
|
*
|
|
125
98
|
* @remarks
|
|
126
|
-
* Get an owner's IXS vault redemption requests
|
|
127
|
-
*
|
|
128
|
-
* IXS
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
* and, while `pending`, the `expected_net_assets` it would settle for at the
|
|
134
|
-
* current NAV (a preview, not a guarantee).
|
|
135
|
-
*
|
|
136
|
-
* IXS vaults live on BNB Smart Chain — pass `chain=bsc` (the default) and the
|
|
137
|
-
* `vault` handle (default `ixv1`).
|
|
99
|
+
* Get an owner's IXS managed-vault redemption requests and their status.
|
|
100
|
+
*
|
|
101
|
+
* IXS vault sells are asynchronous — `/transact/sell` files a `requestRedeem`
|
|
102
|
+
* that the vault operator settles off-chain later. This reconstructs the owner's
|
|
103
|
+
* requests live from the vault (Compass stores no async state), reporting each as
|
|
104
|
+
* `pending`, `finalized`, or `rejected`. IXS vaults live on BNB Smart Chain
|
|
105
|
+
* (`chain=bsc`, vault `ixv1`).
|
|
138
106
|
*/
|
|
139
107
|
async tokenizedAssetsRedemptions(request, options) {
|
|
140
108
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsRedemptions(this, request, options));
|
|
141
109
|
}
|
|
142
110
|
/**
|
|
143
|
-
* Create
|
|
111
|
+
* Create account
|
|
144
112
|
*
|
|
145
113
|
* @remarks
|
|
146
114
|
* Create a Tokenized Assets Account for a wallet address.
|
|
147
115
|
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
* `/transact/buy` + `/transact/sell`) both settle into this one account.
|
|
151
|
-
*
|
|
152
|
-
* Each wallet address has one Tokenized Assets Account, isolated from the
|
|
153
|
-
* owner's Earn, Credit, and other product accounts.
|
|
116
|
+
* Before trading tokenized assets, the owner must create a Tokenized Assets
|
|
117
|
+
* Account. Each wallet address has one Tokenized Assets Account per chain.
|
|
154
118
|
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
* building orders.
|
|
158
|
-
*
|
|
159
|
-
* Returns an unsigned transaction to create the account. The `sender`
|
|
160
|
-
* signs and broadcasts this transaction.
|
|
119
|
+
* Returns an unsigned transaction to create the account. The `sender` signs
|
|
120
|
+
* and broadcasts this transaction.
|
|
161
121
|
*
|
|
162
122
|
* **If owner pays gas:** Set `sender` to the owner's address.
|
|
163
123
|
*
|
|
164
|
-
* **If someone else pays gas:** Set `sender` to the wallet that will
|
|
165
|
-
*
|
|
124
|
+
* **If someone else pays gas:** Set `sender` to the wallet that will sign and
|
|
125
|
+
* broadcast the transaction on behalf of the owner.
|
|
166
126
|
*/
|
|
167
127
|
async tokenizedAssetsCreateAccount(request, options) {
|
|
168
128
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsCreateAccount(this, request, options));
|
|
169
129
|
}
|
|
170
130
|
/**
|
|
171
|
-
*
|
|
131
|
+
* Transfer tokens to/from account
|
|
172
132
|
*
|
|
173
133
|
* @remarks
|
|
174
134
|
* Move tokens between the owner's wallet and their Tokenized Assets Account.
|
|
175
135
|
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
* signs off-chain, then submits to `POST /v2/gas_sponsorship/prepare` so the
|
|
182
|
-
* sponsor broadcasts and pays the gas:
|
|
183
|
-
*
|
|
184
|
-
* - **DEPOSIT** returns a Permit2 `PermitTransferFrom`. The owner must first
|
|
185
|
-
* grant a one-time token->Permit2 allowance (gaslessly via
|
|
186
|
-
* `POST /v2/gas_sponsorship/approve_transfer`).
|
|
187
|
-
* - **WITHDRAW** returns a Safe transaction the account executes.
|
|
188
|
-
*
|
|
189
|
-
* With `gas_sponsorship=false` a DEPOSIT returns an unsigned ERC-20 transfer
|
|
190
|
-
* the owner broadcasts directly, and a WITHDRAW returns an unsigned Safe
|
|
191
|
-
* `execTransaction` the owner signs and broadcasts.
|
|
136
|
+
* `DEPOSIT` funds the account from the owner's wallet; `WITHDRAW` sends tokens
|
|
137
|
+
* back. Supports gas sponsorship: with `gas_sponsorship=true` the owner signs
|
|
138
|
+
* EIP-712 typed data (a Permit2 permit on deposit, a product-account transaction
|
|
139
|
+
* on withdrawal) and a sponsor broadcasts; otherwise the owner broadcasts the
|
|
140
|
+
* transaction directly.
|
|
192
141
|
*/
|
|
193
142
|
async tokenizedAssetsTransfer(request, options) {
|
|
194
143
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsTransfer(this, request, options));
|
|
195
144
|
}
|
|
196
145
|
/**
|
|
197
|
-
*
|
|
146
|
+
* Quote an order
|
|
198
147
|
*
|
|
199
148
|
* @remarks
|
|
200
149
|
* Preview a buy/sell quote for a tokenized **equity** (Ondo, e.g. `TSLAon`).
|
|
201
150
|
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
* Returns the input/output amounts, fees, and slippage tolerance for an order.
|
|
207
|
-
*
|
|
208
|
-
* Read-only: previews the quote without consuming a ``quote_id`` or
|
|
209
|
-
* committing an order. Pair with `POST /order`:
|
|
210
|
-
* surface this preview to the user, and on confirm pass the body plus
|
|
211
|
-
* ``recommended_slippage_bps`` to `/order`.
|
|
212
|
-
*
|
|
213
|
-
* The response carries:
|
|
214
|
-
*
|
|
215
|
-
* - **`quote`** — input/output token amounts, fees, and an
|
|
216
|
-
* ``est_fill_seconds`` upper bound.
|
|
217
|
-
* - **`recommended_slippage_bps`** — system-derived slippage tolerance
|
|
218
|
-
* that clears the current auction floor; pass back as
|
|
219
|
-
* ``slippage_bps`` on `/order` so the build call validates against the
|
|
220
|
-
* same floor the user was shown.
|
|
221
|
-
* - **`auction_range_bps`** — worst-case bps gap between the auction
|
|
222
|
-
* end amount and the reference quote amount. Use to surface a
|
|
223
|
-
* thin-liquidity warning to the user.
|
|
151
|
+
* Read-only price preview: returns the expected input/output amounts and a
|
|
152
|
+
* system-recommended slippage tolerance to carry into `/order`. Equities only —
|
|
153
|
+
* RWA yield tokens (Midas) have no quote step and are rejected with `422 Wrong
|
|
154
|
+
* trade flow`; trade them via `/transact/buy` and `/transact/sell`.
|
|
224
155
|
*/
|
|
225
156
|
async tokenizedAssetsQuote(request, options) {
|
|
226
157
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsQuote(this, request, options));
|
|
227
158
|
}
|
|
228
159
|
/**
|
|
229
|
-
* Build
|
|
160
|
+
* Build an order
|
|
230
161
|
*
|
|
231
162
|
* @remarks
|
|
232
|
-
* Build a tokenized-**equity** (Ondo) buy/sell order;
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
* - **`quote`** — preview of the input/output amounts and fees.
|
|
242
|
-
* - **`approval_safe_tx_eip712`** — only present when the account's
|
|
243
|
-
* allowance to the settlement contract is below `amount`. The owner
|
|
244
|
-
* signs this EIP-712 payload, then it is broadcast via
|
|
245
|
-
* `POST /v2/gas_sponsorship/prepare` (or the owner can broadcast
|
|
246
|
-
* directly) to set the on-chain allowance. Wait for that transaction
|
|
247
|
-
* to confirm before signing the order.
|
|
248
|
-
* - **`order`** — the order metadata (`order_hash`, `extension`,
|
|
249
|
-
* `quote_id`, `order_message`) plus `safe_message_eip712`, an EIP-712
|
|
250
|
-
* payload the owner signs off-chain to authorize the order. The
|
|
251
|
-
* signature is submitted to `/order/submit` and is **never** broadcast
|
|
252
|
-
* on-chain.
|
|
253
|
-
*
|
|
254
|
-
* The owner never broadcasts the order itself — only the (one-time)
|
|
255
|
-
* approval transaction ever hits the chain.
|
|
163
|
+
* Build a tokenized-**equity** (Ondo) buy/sell order; the product account is the
|
|
164
|
+
* maker.
|
|
165
|
+
*
|
|
166
|
+
* Returns everything needed to place the order in one round-trip: a price quote,
|
|
167
|
+
* a one-time token approval to sign (only until the settlement contract is
|
|
168
|
+
* approved), and the order payload the owner signs off-chain. Only the approval
|
|
169
|
+
* ever touches the chain — the signed order is relayed to market makers, never
|
|
170
|
+
* broadcast. Equities only; RWA yield tokens use `/transact/buy` and
|
|
171
|
+
* `/transact/sell`.
|
|
256
172
|
*/
|
|
257
173
|
async tokenizedAssetsOrder(request, options) {
|
|
258
174
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsOrder(this, request, options));
|
|
259
175
|
}
|
|
260
176
|
/**
|
|
261
|
-
* Submit a signed
|
|
177
|
+
* Submit a signed order
|
|
262
178
|
*
|
|
263
179
|
* @remarks
|
|
264
|
-
* Submit a signed order for settlement.
|
|
265
|
-
*
|
|
266
|
-
* The body echoes the `order` fields from `/order` (`signed_order`,
|
|
267
|
-
* `extension`, `quote_id`, optionally `order_hash`) plus the owner's
|
|
268
|
-
* signature over `order.safe_message_eip712`. The maker on the order
|
|
269
|
-
* struct is the Tokenized Assets Account, not the owner's wallet —
|
|
270
|
-
* pass `signed_order` back unchanged.
|
|
180
|
+
* Submit a signed equity order to the market-maker network for settlement.
|
|
271
181
|
*
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
182
|
+
* Relays the payload from `/order` plus the owner's signature, and returns the
|
|
183
|
+
* order hash. Poll `GET /order/{order_hash}` to track its lifecycle (`pending` →
|
|
184
|
+
* `filled` / `expired` / `cancelled`).
|
|
275
185
|
*/
|
|
276
186
|
async tokenizedAssetsOrderSubmit(request, options) {
|
|
277
187
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderSubmit(this, request, options));
|
|
278
188
|
}
|
|
279
189
|
/**
|
|
280
|
-
* Cancel an
|
|
190
|
+
* Cancel an order
|
|
281
191
|
*
|
|
282
192
|
* @remarks
|
|
283
|
-
*
|
|
193
|
+
* Cancel an unfilled equity order on-chain.
|
|
284
194
|
*
|
|
285
|
-
* Returns
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* ``POST /v2/gas_sponsorship/prepare`` so the sponsor broadcasts the
|
|
289
|
-
* cancellation on the product account. The owner can also broadcast
|
|
290
|
-
* the resulting transaction directly without using gas sponsorship.
|
|
291
|
-
*
|
|
292
|
-
* Cancellation works on `pending` and `expired` orders only. Only the
|
|
293
|
-
* Tokenized Assets Account that placed the order can cancel it.
|
|
195
|
+
* Returns an EIP-712 payload the owner signs; a sponsor relays it, or the owner
|
|
196
|
+
* broadcasts it directly. Works only on `pending` or `expired` orders, and only
|
|
197
|
+
* the account that placed the order can cancel it.
|
|
294
198
|
*/
|
|
295
199
|
async tokenizedAssetsOrderOrderHashCancel(request, options) {
|
|
296
200
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderOrderHashCancel(this, request, options));
|
|
297
201
|
}
|
|
298
202
|
/**
|
|
299
|
-
* Charge a partner fee
|
|
203
|
+
* Charge a partner fee
|
|
300
204
|
*
|
|
301
205
|
* @remarks
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
* Equity orders
|
|
305
|
-
*
|
|
306
|
-
*
|
|
307
|
-
*
|
|
308
|
-
* product account — an unsigned transaction the owner signs, or an EIP-712
|
|
309
|
-
* payload when `gas_sponsorship` is true.
|
|
206
|
+
* Charge a partner fee on a filled equity sell order's USDC proceeds.
|
|
207
|
+
*
|
|
208
|
+
* Equity orders settle off-chain, so fees can't be bundled into the trade — call
|
|
209
|
+
* this after a sell fills and it builds a USDC transfer of your `fee` from the
|
|
210
|
+
* actual proceeds, executed by the product account (owner signs, or EIP-712 with
|
|
211
|
+
* `gas_sponsorship`).
|
|
310
212
|
*/
|
|
311
213
|
async tokenizedAssetsOrderOrderHashChargeFee(request, options) {
|
|
312
214
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsOrderOrderHashChargeFee(this, request, options));
|
|
313
215
|
}
|
|
314
216
|
/**
|
|
315
|
-
* Buy an RWA yield token
|
|
217
|
+
* Buy an RWA yield token
|
|
316
218
|
*
|
|
317
219
|
* @remarks
|
|
318
|
-
* Buy
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
* an unsigned transaction
|
|
325
|
-
* `gas_sponsorship
|
|
326
|
-
*
|
|
327
|
-
* `token_out` must be a Midas RWA asset; equities trade via the order
|
|
328
|
-
* endpoints (`/quote`, `/order`, `/order/submit`).
|
|
220
|
+
* Buy an RWA yield token, or deposit into an IXS managed vault, with a stablecoin
|
|
221
|
+
* in one transaction.
|
|
222
|
+
*
|
|
223
|
+
* Set `token_out` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
|
|
224
|
+
* **vault address** (its shares aren't a registered symbol). The account spends
|
|
225
|
+
* a stablecoin it already holds (fund it with a plain transfer first) and
|
|
226
|
+
* settles inside the product account — an unsigned transaction the owner signs,
|
|
227
|
+
* or EIP-712 with `gas_sponsorship`. Both paths are instant. Equities use the
|
|
228
|
+
* order flow (`/quote`, `/order`).
|
|
329
229
|
*/
|
|
330
230
|
async tokenizedAssetsTransactBuy(request, options) {
|
|
331
231
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsTransactBuy(this, request, options));
|
|
332
232
|
}
|
|
333
233
|
/**
|
|
334
|
-
* Sell an RWA yield token
|
|
234
|
+
* Sell an RWA yield token
|
|
335
235
|
*
|
|
336
236
|
* @remarks
|
|
337
|
-
* Sell
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
237
|
+
* Sell an RWA yield token, or redeem from an IXS managed vault, back to a
|
|
238
|
+
* stablecoin.
|
|
239
|
+
*
|
|
240
|
+
* Set `token_in` to a Midas symbol (`mTBILL`, `mBASIS`, `mBTC`) or to an IXS
|
|
241
|
+
* **vault address**. A Midas redemption is instant and settles in the same
|
|
242
|
+
* transaction; an IXS redemption is **asynchronous** — it files a
|
|
243
|
+
* `requestRedeem` (`settlement: async`) the vault operator settles off-chain
|
|
244
|
+
* later, so poll `GET /v2/tokenized_assets/redemptions` for status. The
|
|
245
|
+
* transaction executes inside the product account (owner signs, or EIP-712 with
|
|
246
|
+
* `gas_sponsorship`).
|
|
345
247
|
*/
|
|
346
248
|
async tokenizedAssetsTransactSell(request, options) {
|
|
347
249
|
return unwrapAsync(tokenizedAssetsTokenizedAssetsTransactSell(this, request, options));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tokenizedassets.js","sourceRoot":"","sources":["../../../src/sdk/tokenizedassets.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sCAAsC,EAAE,MAAM,oDAAoD,CAAC;AAC5G,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,qCAAqC,EAAE,MAAM,mDAAmD,CAAC;AAC1G,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,kDAAkD,EAAE,MAAM,gEAAgE,CAAC;AACpI,OAAO,EAAE,qDAAqD,EAAE,MAAM,mEAAmE,CAAC;AAC1I,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,0CAA0C,EAAE,MAAM,wDAAwD,CAAC;AACpH,OAAO,EAAE,sCAAsC,EAAE,MAAM,oDAAoD,CAAC;AAC5G,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C
|
|
1
|
+
{"version":3,"file":"tokenizedassets.js","sourceRoot":"","sources":["../../../src/sdk/tokenizedassets.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sCAAsC,EAAE,MAAM,oDAAoD,CAAC;AAC5G,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,qCAAqC,EAAE,MAAM,mDAAmD,CAAC;AAC1G,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,4CAA4C,EAAE,MAAM,0DAA0D,CAAC;AACxH,OAAO,EAAE,kDAAkD,EAAE,MAAM,gEAAgE,CAAC;AACpI,OAAO,EAAE,qDAAqD,EAAE,MAAM,mEAAmE,CAAC;AAC1I,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,uCAAuC,EAAE,MAAM,qDAAqD,CAAC;AAC9G,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAClH,OAAO,EAAE,0CAA0C,EAAE,MAAM,wDAAwD,CAAC;AACpH,OAAO,EAAE,sCAAsC,EAAE,MAAM,oDAAoD,CAAC;AAC5G,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,qCAAqC,CACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,uCAAuC,CACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,sCAAsC,CACvD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAA0D,EAC1D,OAAwB;QAExB,OAAO,WAAW,CAAC,4CAA4C,CAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,yCAAyC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,sCAAsC,CACvD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAoD,EACpD,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,yCAAyC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,mCAAmC,CACvC,OAAgE,EAChE,OAAwB;QAExB,OAAO,WAAW,CAAC,kDAAkD,CACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,sCAAsC,CAC1C,OAAmE,EACnE,OAAwB;QAExB,OAAO,WAAW,CAAC,qDAAqD,CACtE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,yCAAyC,CAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,0CAA0C,CAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -13,19 +13,31 @@ let value: EulerMarket = {
|
|
|
13
13
|
asset: "<value>",
|
|
14
14
|
assetSymbol: "<value>",
|
|
15
15
|
assetDecimals: 48252,
|
|
16
|
+
availableLiquidity: "<value>",
|
|
17
|
+
totalSupplyAssets: "<value>",
|
|
18
|
+
totalBorrowAssets: "<value>",
|
|
19
|
+
utilization: "<value>",
|
|
16
20
|
collaterals: [],
|
|
17
21
|
};
|
|
18
22
|
```
|
|
19
23
|
|
|
20
24
|
## Fields
|
|
21
25
|
|
|
22
|
-
| Field
|
|
23
|
-
|
|
|
24
|
-
| `vault`
|
|
25
|
-
| `vaultSymbol`
|
|
26
|
-
| `asset`
|
|
27
|
-
| `assetSymbol`
|
|
28
|
-
| `assetDecimals`
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
26
|
+
| Field | Type | Required | Description | Example |
|
|
27
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
+
| `vault` | *string* | :heavy_check_mark: | EVK vault to borrow from (pass as borrow_vault when borrowing). | |
|
|
29
|
+
| `vaultSymbol` | *string* | :heavy_check_mark: | Symbol of the EVK vault (e.g. eUSDT-2). | |
|
|
30
|
+
| `asset` | *string* | :heavy_check_mark: | Underlying asset this market lends and borrows. | |
|
|
31
|
+
| `assetSymbol` | *string* | :heavy_check_mark: | Symbol of the borrowable asset (e.g. USDT). | |
|
|
32
|
+
| `assetDecimals` | *number* | :heavy_check_mark: | Decimals of the borrowable asset. | |
|
|
33
|
+
| `assetPriceUsd` | *string* | :heavy_minus_sign: | 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. | |
|
|
34
|
+
| `unitOfAccountSymbol` | *string* | :heavy_minus_sign: | Symbol of the market's native unit of account (usually USD). The market's own risk engine denominates collateral and debt in this unit. | |
|
|
35
|
+
| `borrowApy` | *string* | :heavy_minus_sign: | 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. | |
|
|
36
|
+
| `supplyApy` | *string* | :heavy_minus_sign: | 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. | |
|
|
37
|
+
| `availableLiquidity` | *string* | :heavy_check_mark: | Asset available to borrow right now (vault cash), in token units. A borrow larger than this reverts even if the account is healthy. | |
|
|
38
|
+
| `totalSupplyAssets` | *string* | :heavy_check_mark: | Total asset supplied to this market, in token units. | |
|
|
39
|
+
| `totalBorrowAssets` | *string* | :heavy_check_mark: | Total asset borrowed from this market, in token units. | |
|
|
40
|
+
| `utilization` | *string* | :heavy_check_mark: | Borrowed share of supplied assets, in percentage 0-100. | |
|
|
41
|
+
| `supplyCap` | *string* | :heavy_minus_sign: | Maximum total supply allowed, in token units. Null when the market is uncapped. | |
|
|
42
|
+
| `borrowCap` | *string* | :heavy_minus_sign: | Maximum total borrow allowed, in token units. A borrow that would breach this reverts even when cash exists. Null when uncapped. | |
|
|
43
|
+
| `collaterals` | [components.EulerMarketCollateral](../../models/components/eulermarketcollateral.md)[] | :heavy_minus_sign: | Collateral vaults this market accepts (those currently borrowable, LTV > 0), each with its LTVs. | [] |
|
|
@@ -11,6 +11,7 @@ let value: EulerMarketCollateral = {
|
|
|
11
11
|
vault: "<value>",
|
|
12
12
|
asset: "<value>",
|
|
13
13
|
assetSymbol: "<value>",
|
|
14
|
+
assetDecimals: 656712,
|
|
14
15
|
borrowLtv: "<value>",
|
|
15
16
|
liquidationLtv: "<value>",
|
|
16
17
|
};
|
|
@@ -23,6 +24,8 @@ let value: EulerMarketCollateral = {
|
|
|
23
24
|
| `vault` | *string* | :heavy_check_mark: | EVK collateral vault to supply into (pass as collateral_vault when borrowing). |
|
|
24
25
|
| `asset` | *string* | :heavy_check_mark: | Underlying asset of the collateral vault. |
|
|
25
26
|
| `assetSymbol` | *string* | :heavy_check_mark: | Symbol of the collateral's underlying asset (e.g. USDC). |
|
|
27
|
+
| `assetDecimals` | *number* | :heavy_check_mark: | Decimals of the collateral's underlying asset. |
|
|
28
|
+
| `assetPriceUsd` | *string* | :heavy_minus_sign: | 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). |
|
|
26
29
|
| `borrowLtv` | *string* | :heavy_check_mark: | Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%). |
|
|
27
30
|
| `liquidationLtv` | *string* | :heavy_check_mark: | Loan-to-value at which this collateral is liquidated, in percentage (e.g. 96 means 96%). |
|
|
28
31
|
| `supplyApy` | *string* | :heavy_minus_sign: | Current supply APY earned on this collateral while it backs a loan, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable. |
|
package/docs/sdks/earn/README.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* [earnVaults](#earnvaults) - List vaults
|
|
10
10
|
* [earnAaveMarkets](#earnaavemarkets) - List aave markets
|
|
11
11
|
* [earnPendleMarkets](#earnpendlemarkets) - List pendle markets
|
|
12
|
-
* [earnSwapQuote](#earnswapquote) - Quote a swap
|
|
12
|
+
* [earnSwapQuote](#earnswapquote) - Quote a swap
|
|
13
13
|
* [earnBalances](#earnbalances) - Get token balances
|
|
14
14
|
* [earnCreateAccount](#earncreateaccount) - Create earn account
|
|
15
15
|
* [earnTransfer](#earntransfer) - Transfer tokens to/from account
|