@compass-labs/api-sdk 2.2.105 → 2.2.107

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. package/README.md +6 -4
  2. package/codeSamples_typescript.yaml +7 -1
  3. package/dist/commonjs/funcs/creditCreditSwap.d.ts +23 -0
  4. package/dist/commonjs/funcs/creditCreditSwap.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/creditCreditSwap.js +124 -0
  6. package/dist/commonjs/funcs/creditCreditSwap.js.map +1 -0
  7. package/dist/commonjs/funcs/earnEarnSwap.d.ts +7 -7
  8. package/dist/commonjs/funcs/earnEarnSwap.js +7 -7
  9. package/dist/commonjs/lib/config.d.ts +2 -2
  10. package/dist/commonjs/lib/config.js +2 -2
  11. package/dist/commonjs/lib/config.js.map +1 -1
  12. package/dist/commonjs/models/components/chain.d.ts +1 -0
  13. package/dist/commonjs/models/components/chain.d.ts.map +1 -1
  14. package/dist/commonjs/models/components/chain.js +1 -0
  15. package/dist/commonjs/models/components/chain.js.map +1 -1
  16. package/dist/commonjs/models/components/creditswaprequest.d.ts +112 -0
  17. package/dist/commonjs/models/components/creditswaprequest.d.ts.map +1 -0
  18. package/dist/commonjs/models/components/creditswaprequest.js +101 -0
  19. package/dist/commonjs/models/components/creditswaprequest.js.map +1 -0
  20. package/dist/commonjs/models/components/creditswapresponse.d.ts +51 -0
  21. package/dist/commonjs/models/components/creditswapresponse.d.ts.map +1 -0
  22. package/dist/commonjs/models/components/creditswapresponse.js +74 -0
  23. package/dist/commonjs/models/components/creditswapresponse.js.map +1 -0
  24. package/dist/commonjs/models/components/earnswaprequest.d.ts +2 -3
  25. package/dist/commonjs/models/components/earnswaprequest.d.ts.map +1 -1
  26. package/dist/commonjs/models/components/earnswaprequest.js.map +1 -1
  27. package/dist/commonjs/models/components/eulermarket.d.ts +12 -0
  28. package/dist/commonjs/models/components/eulermarket.d.ts.map +1 -1
  29. package/dist/commonjs/models/components/eulermarket.js +6 -0
  30. package/dist/commonjs/models/components/eulermarket.js.map +1 -1
  31. package/dist/commonjs/models/components/eulermarketcollateral.d.ts +4 -0
  32. package/dist/commonjs/models/components/eulermarketcollateral.d.ts.map +1 -1
  33. package/dist/commonjs/models/components/eulermarketcollateral.js +2 -0
  34. package/dist/commonjs/models/components/eulermarketcollateral.js.map +1 -1
  35. package/dist/commonjs/models/components/index.d.ts +2 -0
  36. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  37. package/dist/commonjs/models/components/index.js +2 -0
  38. package/dist/commonjs/models/components/index.js.map +1 -1
  39. package/dist/commonjs/models/operations/v2earnswapquote.d.ts +1 -0
  40. package/dist/commonjs/models/operations/v2earnswapquote.d.ts.map +1 -1
  41. package/dist/commonjs/models/operations/v2earnswapquote.js +1 -0
  42. package/dist/commonjs/models/operations/v2earnswapquote.js.map +1 -1
  43. package/dist/commonjs/models/operations/v2tokenizedassetsbalances.d.ts +1 -0
  44. package/dist/commonjs/models/operations/v2tokenizedassetsbalances.d.ts.map +1 -1
  45. package/dist/commonjs/models/operations/v2tokenizedassetsbalances.js +1 -0
  46. package/dist/commonjs/models/operations/v2tokenizedassetsbalances.js.map +1 -1
  47. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts +1 -0
  48. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
  49. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js +1 -0
  50. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
  51. package/dist/commonjs/models/operations/v2tokenizedassetspositions.d.ts +1 -0
  52. package/dist/commonjs/models/operations/v2tokenizedassetspositions.d.ts.map +1 -1
  53. package/dist/commonjs/models/operations/v2tokenizedassetspositions.js +1 -0
  54. package/dist/commonjs/models/operations/v2tokenizedassetspositions.js.map +1 -1
  55. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts +1 -0
  56. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -1
  57. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js +1 -0
  58. package/dist/commonjs/models/operations/v2tokenizedassetsredemptions.js.map +1 -1
  59. package/dist/commonjs/sdk/credit.d.ts +12 -0
  60. package/dist/commonjs/sdk/credit.d.ts.map +1 -1
  61. package/dist/commonjs/sdk/credit.js +15 -0
  62. package/dist/commonjs/sdk/credit.js.map +1 -1
  63. package/dist/commonjs/sdk/earn.d.ts +7 -7
  64. package/dist/commonjs/sdk/earn.js +7 -7
  65. package/dist/esm/funcs/creditCreditSwap.d.ts +23 -0
  66. package/dist/esm/funcs/creditCreditSwap.d.ts.map +1 -0
  67. package/dist/esm/funcs/creditCreditSwap.js +88 -0
  68. package/dist/esm/funcs/creditCreditSwap.js.map +1 -0
  69. package/dist/esm/funcs/earnEarnSwap.d.ts +7 -7
  70. package/dist/esm/funcs/earnEarnSwap.js +7 -7
  71. package/dist/esm/lib/config.d.ts +2 -2
  72. package/dist/esm/lib/config.js +2 -2
  73. package/dist/esm/lib/config.js.map +1 -1
  74. package/dist/esm/models/components/chain.d.ts +1 -0
  75. package/dist/esm/models/components/chain.d.ts.map +1 -1
  76. package/dist/esm/models/components/chain.js +1 -0
  77. package/dist/esm/models/components/chain.js.map +1 -1
  78. package/dist/esm/models/components/creditswaprequest.d.ts +112 -0
  79. package/dist/esm/models/components/creditswaprequest.d.ts.map +1 -0
  80. package/dist/esm/models/components/creditswaprequest.js +62 -0
  81. package/dist/esm/models/components/creditswaprequest.js.map +1 -0
  82. package/dist/esm/models/components/creditswapresponse.d.ts +51 -0
  83. package/dist/esm/models/components/creditswapresponse.d.ts.map +1 -0
  84. package/dist/esm/models/components/creditswapresponse.js +37 -0
  85. package/dist/esm/models/components/creditswapresponse.js.map +1 -0
  86. package/dist/esm/models/components/earnswaprequest.d.ts +2 -3
  87. package/dist/esm/models/components/earnswaprequest.d.ts.map +1 -1
  88. package/dist/esm/models/components/earnswaprequest.js.map +1 -1
  89. package/dist/esm/models/components/eulermarket.d.ts +12 -0
  90. package/dist/esm/models/components/eulermarket.d.ts.map +1 -1
  91. package/dist/esm/models/components/eulermarket.js +6 -0
  92. package/dist/esm/models/components/eulermarket.js.map +1 -1
  93. package/dist/esm/models/components/eulermarketcollateral.d.ts +4 -0
  94. package/dist/esm/models/components/eulermarketcollateral.d.ts.map +1 -1
  95. package/dist/esm/models/components/eulermarketcollateral.js +2 -0
  96. package/dist/esm/models/components/eulermarketcollateral.js.map +1 -1
  97. package/dist/esm/models/components/index.d.ts +2 -0
  98. package/dist/esm/models/components/index.d.ts.map +1 -1
  99. package/dist/esm/models/components/index.js +2 -0
  100. package/dist/esm/models/components/index.js.map +1 -1
  101. package/dist/esm/models/operations/v2earnswapquote.d.ts +1 -0
  102. package/dist/esm/models/operations/v2earnswapquote.d.ts.map +1 -1
  103. package/dist/esm/models/operations/v2earnswapquote.js +1 -0
  104. package/dist/esm/models/operations/v2earnswapquote.js.map +1 -1
  105. package/dist/esm/models/operations/v2tokenizedassetsbalances.d.ts +1 -0
  106. package/dist/esm/models/operations/v2tokenizedassetsbalances.d.ts.map +1 -1
  107. package/dist/esm/models/operations/v2tokenizedassetsbalances.js +1 -0
  108. package/dist/esm/models/operations/v2tokenizedassetsbalances.js.map +1 -1
  109. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts +1 -0
  110. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
  111. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js +1 -0
  112. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
  113. package/dist/esm/models/operations/v2tokenizedassetspositions.d.ts +1 -0
  114. package/dist/esm/models/operations/v2tokenizedassetspositions.d.ts.map +1 -1
  115. package/dist/esm/models/operations/v2tokenizedassetspositions.js +1 -0
  116. package/dist/esm/models/operations/v2tokenizedassetspositions.js.map +1 -1
  117. package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts +1 -0
  118. package/dist/esm/models/operations/v2tokenizedassetsredemptions.d.ts.map +1 -1
  119. package/dist/esm/models/operations/v2tokenizedassetsredemptions.js +1 -0
  120. package/dist/esm/models/operations/v2tokenizedassetsredemptions.js.map +1 -1
  121. package/dist/esm/sdk/credit.d.ts +12 -0
  122. package/dist/esm/sdk/credit.d.ts.map +1 -1
  123. package/dist/esm/sdk/credit.js +15 -0
  124. package/dist/esm/sdk/credit.js.map +1 -1
  125. package/dist/esm/sdk/earn.d.ts +7 -7
  126. package/dist/esm/sdk/earn.js +7 -7
  127. package/docs/models/components/chain.md +1 -1
  128. package/docs/models/components/creditswaprequest.md +36 -0
  129. package/docs/models/components/creditswaprequestamountin.md +19 -0
  130. package/docs/models/components/creditswaprequestchain.md +17 -0
  131. package/docs/models/components/creditswaprequestpricing.md +17 -0
  132. package/docs/models/components/creditswaprequestslippage.md +19 -0
  133. package/docs/models/components/creditswapresponse.md +25 -0
  134. package/docs/models/components/creditswapresponseswapprovider.md +17 -0
  135. package/docs/models/components/earnswaprequest.md +2 -3
  136. package/docs/models/components/eulermarket.md +21 -18
  137. package/docs/models/components/eulermarketcollateral.md +11 -10
  138. package/docs/models/operations/v2earnswapquotechain.md +1 -1
  139. package/docs/models/operations/v2tokenizedassetsbalanceschain.md +2 -2
  140. package/docs/models/operations/v2tokenizedassetsmarketssymbolchain.md +2 -2
  141. package/docs/models/operations/v2tokenizedassetspositionschain.md +1 -1
  142. package/docs/models/operations/v2tokenizedassetsredemptionschain.md +1 -1
  143. package/docs/sdks/credit/README.md +94 -0
  144. package/docs/sdks/earn/README.md +7 -7
  145. package/docs/sdks/tokenizedassets/README.md +2 -2
  146. package/openapi_prepped_for_speakeasy.json +272 -3
  147. package/package.json +1 -1
  148. package/src/funcs/creditCreditSwap.ts +176 -0
  149. package/src/funcs/earnEarnSwap.ts +7 -7
  150. package/src/lib/config.ts +2 -2
  151. package/src/models/components/chain.ts +1 -0
  152. package/src/models/components/creditswaprequest.ts +186 -0
  153. package/src/models/components/creditswapresponse.ts +99 -0
  154. package/src/models/components/earnswaprequest.ts +2 -3
  155. package/src/models/components/eulermarket.ts +18 -0
  156. package/src/models/components/eulermarketcollateral.ts +6 -0
  157. package/src/models/components/index.ts +2 -0
  158. package/src/models/operations/v2earnswapquote.ts +1 -0
  159. package/src/models/operations/v2tokenizedassetsbalances.ts +1 -0
  160. package/src/models/operations/v2tokenizedassetsmarketssymbol.ts +1 -0
  161. package/src/models/operations/v2tokenizedassetspositions.ts +1 -0
  162. package/src/models/operations/v2tokenizedassetsredemptions.ts +1 -0
  163. package/src/sdk/credit.ts +23 -0
  164. package/src/sdk/earn.ts +7 -7
@@ -0,0 +1,36 @@
1
+ # CreditSwapRequest
2
+
3
+ Swap one token held in the Credit Account for another, in a single
4
+ atomic transaction, at a firm quote where one covers the pair and at market
5
+ rate otherwise.
6
+
7
+ ## Example Usage
8
+
9
+ ```typescript
10
+ import { CreditSwapRequest } from "@compass-labs/api-sdk/models/components";
11
+
12
+ let value: CreditSwapRequest = {
13
+ tokenIn: "USDC",
14
+ tokenOut: "USDT",
15
+ amountIn: "0.01",
16
+ slippage: "0.5",
17
+ owner: "0x06A9aF046187895AcFc7258450B15397CAc67400",
18
+ chain: "base",
19
+ gasSponsorship: false,
20
+ pricing: "auto",
21
+ };
22
+ ```
23
+
24
+ ## Fields
25
+
26
+ | Field | Type | Required | Description | Example |
27
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
+ | `actionType` | *"V2_SWAP"* | :heavy_minus_sign: | Action type identifier for swap operations. | V2_SWAP |
29
+ | `tokenIn` | *string* | :heavy_check_mark: | Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address. | USDC |
30
+ | `tokenOut` | *string* | :heavy_check_mark: | Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address. | USDT |
31
+ | `amountIn` | *components.CreditSwapRequestAmountIn* | :heavy_check_mark: | Human-readable amount of `token_in` to swap (token units, not wei). | 0.01 |
32
+ | `slippage` | *components.CreditSwapRequestSlippage* | :heavy_minus_sign: | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Bounds the market route only; a firm quote fills exactly and ignores it. | 0.5 |
33
+ | `owner` | *string* | :heavy_check_mark: | The owner's wallet address. Their Credit Account must already exist (create it with `/v2/credit/create_account`) and hold `token_in` (deposit with `/v2/credit/transfer`). | 0x06A9aF046187895AcFc7258450B15397CAc67400 |
34
+ | `chain` | [components.CreditSwapRequestChain](../../models/components/creditswaprequestchain.md) | :heavy_check_mark: | Target blockchain network where the swap will execute. | base |
35
+ | `gasSponsorship` | *boolean* | :heavy_minus_sign: | Optionally request gas sponsorship. If `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Gas-sponsored builds always execute at market rate. | false |
36
+ | `pricing` | [components.CreditSwapRequestPricing](../../models/components/creditswaprequestpricing.md) | :heavy_minus_sign: | Swap routing policy. 'auto': a firm zero-slippage quote when a firm venue covers the pair, transparent fallback to the market aggregator otherwise. 'firm': never price on the market route; an uncovered pair fails with a typed error instead of silently substituting market pricing. 'market': never route through the firm venue; the swap is priced by the aggregator and bounded by `slippage` (which firm fills ignore). 'firm' is incompatible with gas_sponsorship (sponsored swaps force market routing). | auto |
@@ -0,0 +1,19 @@
1
+ # CreditSwapRequestAmountIn
2
+
3
+ Human-readable amount of `token_in` to swap (token units, not wei).
4
+
5
+
6
+ ## Supported Types
7
+
8
+ ### `number`
9
+
10
+ ```typescript
11
+ const value: number = 1284.03;
12
+ ```
13
+
14
+ ### `string`
15
+
16
+ ```typescript
17
+ const value: string = "0.01";
18
+ ```
19
+
@@ -0,0 +1,17 @@
1
+ # CreditSwapRequestChain
2
+
3
+ Target blockchain network where the swap will execute.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditSwapRequestChain } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditSwapRequestChain = "base";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
17
+ ```
@@ -0,0 +1,17 @@
1
+ # CreditSwapRequestPricing
2
+
3
+ Swap routing policy. 'auto': a firm zero-slippage quote when a firm venue covers the pair, transparent fallback to the market aggregator otherwise. 'firm': never price on the market route; an uncovered pair fails with a typed error instead of silently substituting market pricing. 'market': never route through the firm venue; the swap is priced by the aggregator and bounded by `slippage` (which firm fills ignore). 'firm' is incompatible with gas_sponsorship (sponsored swaps force market routing).
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditSwapRequestPricing } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditSwapRequestPricing = "auto";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "auto" | "firm" | "market"
17
+ ```
@@ -0,0 +1,19 @@
1
+ # CreditSwapRequestSlippage
2
+
3
+ Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Bounds the market route only; a firm quote fills exactly and ignores it.
4
+
5
+
6
+ ## Supported Types
7
+
8
+ ### `number`
9
+
10
+ ```typescript
11
+ const value: number = 1284.03;
12
+ ```
13
+
14
+ ### `string`
15
+
16
+ ```typescript
17
+ const value: string = "0.5";
18
+ ```
19
+
@@ -0,0 +1,25 @@
1
+ # CreditSwapResponse
2
+
3
+ The swap transaction to sign, plus which route priced it and how long
4
+ that price holds.
5
+
6
+ ## Example Usage
7
+
8
+ ```typescript
9
+ import { CreditSwapResponse } from "@compass-labs/api-sdk/models/components";
10
+
11
+ let value: CreditSwapResponse = {
12
+ estimatedAmountOut: "<value>",
13
+ swapProvider: "market",
14
+ };
15
+ ```
16
+
17
+ ## Fields
18
+
19
+ | Field | Type | Required | Description | Example |
20
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | `transaction` | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_minus_sign: | Unsigned transaction for direct execution. Present when gas_sponsorship=false. | |
22
+ | `eip712` | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_minus_sign: | EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true. | |
23
+ | `estimatedAmountOut` | *string* | :heavy_check_mark: | Estimated amount of output token received from the swap. Exact on firm builds (a firm quote fills at this amount or reverts). On market builds it is a quote-time estimate, and `slippage` sets how far below it the transaction's enforced minimum output sits. | |
24
+ | `swapProvider` | [components.CreditSwapResponseSwapProvider](../../models/components/creditswapresponseswapprovider.md) | :heavy_minus_sign: | Identifies which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present. This is the authoritative firm-vs-market signal and clients do need to read it: `pricing` is only what was REQUESTED, and under 'auto' a firm build can fall back to market transparently. | market |
25
+ | `quoteExpiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Deadline of the firm swap quote. Sign and broadcast before it or the transaction reverts on-chain; refresh by re-calling this endpoint (discard the previous payload). Null on market builds. | |
@@ -0,0 +1,17 @@
1
+ # CreditSwapResponseSwapProvider
2
+
3
+ Identifies which route priced the swap. 'market': a DEX aggregator, slippage-bounded. 'firm': a zero-slippage quote that fills exactly or reverts. Always present. This is the authoritative firm-vs-market signal and clients do need to read it: `pricing` is only what was REQUESTED, and under 'auto' a firm build can fall back to market transparently.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditSwapResponseSwapProvider } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditSwapResponseSwapProvider = "market";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "market" | "firm"
17
+ ```
@@ -1,8 +1,7 @@
1
1
  # EarnSwapRequest
2
2
 
3
- Request model for swap endpoint.
4
-
5
- Inherits swap params and adds context fields (owner, chain, gas_sponsorship).
3
+ Swap one token held in the Earn Account for another, in a single atomic
4
+ transaction.
6
5
 
7
6
  ## Example Usage
8
7
 
@@ -23,21 +23,24 @@ let value: EulerMarket = {
23
23
 
24
24
  ## Fields
25
25
 
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. | [] |
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
+ | `intrinsicApy` | *string* | :heavy_minus_sign: | What the borrowable asset earns inside its own price, in percentage, trailing 7 days. Debt owed in such a token grows by this on top of borrow_apy a borrower's true cost is their sum. Null means unmeasured, NOT zero. | |
38
+ | `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. | |
39
+ | `totalSupplyAssets` | *string* | :heavy_check_mark: | Total asset supplied to this market, in token units. | |
40
+ | `totalBorrowAssets` | *string* | :heavy_check_mark: | Total asset borrowed from this market, in token units. | |
41
+ | `utilization` | *string* | :heavy_check_mark: | Borrowed share of supplied assets, in percentage 0-100. | |
42
+ | `tvlUsd` | *string* | :heavy_minus_sign: | Total asset supplied to this market in USD (total_supply_assets priced by the shared request-time feed). Null when the price feed can't quote the asset size in token units instead. | |
43
+ | `liquidityUsd` | *string* | :heavy_minus_sign: | Asset available to borrow right now in USD (available_liquidity priced by the shared request-time feed; vault cash equals supplied minus borrowed). Null when the price feed can't quote the asset. | |
44
+ | `supplyCap` | *string* | :heavy_minus_sign: | Maximum total supply allowed, in token units. Null when the market is uncapped. | |
45
+ | `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. | |
46
+ | `collaterals` | [components.EulerMarketCollateral](../../models/components/eulermarketcollateral.md)[] | :heavy_minus_sign: | Collateral vaults this market accepts (those currently borrowable, LTV > 0), each with its LTVs. | [] |
@@ -19,13 +19,14 @@ let value: EulerMarketCollateral = {
19
19
 
20
20
  ## Fields
21
21
 
22
- | Field | Type | Required | Description |
23
- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
24
- | `vault` | *string* | :heavy_check_mark: | EVK collateral vault to supply into (pass as collateral_vault when borrowing). |
25
- | `asset` | *string* | :heavy_check_mark: | Underlying asset of the collateral vault. |
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). |
29
- | `borrowLtv` | *string* | :heavy_check_mark: | Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%). |
30
- | `liquidationLtv` | *string* | :heavy_check_mark: | Loan-to-value at which this collateral is liquidated, in percentage (e.g. 96 means 96%). |
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. |
22
+ | Field | Type | Required | Description |
23
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | `vault` | *string* | :heavy_check_mark: | EVK collateral vault to supply into (pass as collateral_vault when borrowing). |
25
+ | `asset` | *string* | :heavy_check_mark: | Underlying asset of the collateral vault. |
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). |
29
+ | `borrowLtv` | *string* | :heavy_check_mark: | Maximum loan-to-value when borrowing against this collateral, in percentage (e.g. 94 means 94%). |
30
+ | `liquidationLtv` | *string* | :heavy_check_mark: | Loan-to-value at which this collateral is liquidated, in percentage (e.g. 96 means 96%). |
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. |
32
+ | `intrinsicApy` | *string* | :heavy_minus_sign: | What the collateral token earns inside its own price, in percentage: an ERC-4626 share's vault yield, a staking token's rewards, or an RWA token's NAV accrual, trailing 7 days. Earned on top of supply_apy — the collateral leg's whole yield is their sum. Null means unmeasured, NOT zero: a plain token (USDC, cbBTC) earns nothing and a yield-bearing one may simply not be indexed yet. |
@@ -13,5 +13,5 @@ let value: V2EarnSwapQuoteChain = "base";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
17
17
  ```
@@ -7,11 +7,11 @@ The chain to use.
7
7
  ```typescript
8
8
  import { V2TokenizedAssetsBalancesChain } from "@compass-labs/api-sdk/models/operations";
9
9
 
10
- let value: V2TokenizedAssetsBalancesChain = "ethereum";
10
+ let value: V2TokenizedAssetsBalancesChain = "arbitrum";
11
11
  ```
12
12
 
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
17
17
  ```
@@ -7,11 +7,11 @@ The chain to use.
7
7
  ```typescript
8
8
  import { V2TokenizedAssetsMarketsSymbolChain } from "@compass-labs/api-sdk/models/operations";
9
9
 
10
- let value: V2TokenizedAssetsMarketsSymbolChain = "hyperevm";
10
+ let value: V2TokenizedAssetsMarketsSymbolChain = "tempo";
11
11
  ```
12
12
 
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
17
17
  ```
@@ -13,5 +13,5 @@ let value: V2TokenizedAssetsPositionsChain = "hyperevm";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
17
17
  ```
@@ -13,5 +13,5 @@ let value: V2TokenizedAssetsRedemptionsChain = "bsc";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "ethereum_sepolia"
16
+ "base" | "ethereum" | "arbitrum" | "hyperevm" | "tempo" | "bsc" | "robinhood" | "ethereum_sepolia"
17
17
  ```