@compass-labs/api-sdk 2.2.93 → 2.2.95-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. package/codeSamples_typescript.yaml +1 -1
  2. package/dist/commonjs/models/components/createcreditaccountrequest.d.ts +1 -0
  3. package/dist/commonjs/models/components/createcreditaccountrequest.d.ts.map +1 -1
  4. package/dist/commonjs/models/components/createcreditaccountrequest.js +1 -0
  5. package/dist/commonjs/models/components/createcreditaccountrequest.js.map +1 -1
  6. package/dist/commonjs/models/components/creditborrowrequest.d.ts +20 -3
  7. package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
  8. package/dist/commonjs/models/components/creditborrowrequest.js +15 -3
  9. package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
  10. package/dist/commonjs/models/components/creditbundlerequest.d.ts +20 -3
  11. package/dist/commonjs/models/components/creditbundlerequest.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/creditbundlerequest.js +15 -3
  13. package/dist/commonjs/models/components/creditbundlerequest.js.map +1 -1
  14. package/dist/commonjs/models/components/creditlooppreview.d.ts +4 -0
  15. package/dist/commonjs/models/components/creditlooppreview.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/creditlooppreview.js +2 -0
  17. package/dist/commonjs/models/components/creditlooppreview.js.map +1 -1
  18. package/dist/commonjs/models/components/creditlooprequest.d.ts +20 -3
  19. package/dist/commonjs/models/components/creditlooprequest.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/creditlooprequest.js +15 -3
  21. package/dist/commonjs/models/components/creditlooprequest.js.map +1 -1
  22. package/dist/commonjs/models/components/creditrebalancerequest.d.ts +19 -3
  23. package/dist/commonjs/models/components/creditrebalancerequest.d.ts.map +1 -1
  24. package/dist/commonjs/models/components/creditrebalancerequest.js +14 -3
  25. package/dist/commonjs/models/components/creditrebalancerequest.js.map +1 -1
  26. package/dist/commonjs/models/components/creditrepayrequest.d.ts +20 -3
  27. package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
  28. package/dist/commonjs/models/components/creditrepayrequest.js +15 -3
  29. package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
  30. package/dist/commonjs/models/components/credittransferrequest.d.ts +19 -3
  31. package/dist/commonjs/models/components/credittransferrequest.d.ts.map +1 -1
  32. package/dist/commonjs/models/components/credittransferrequest.js +15 -3
  33. package/dist/commonjs/models/components/credittransferrequest.js.map +1 -1
  34. package/dist/commonjs/models/components/creditunlooprequest.d.ts +20 -3
  35. package/dist/commonjs/models/components/creditunlooprequest.d.ts.map +1 -1
  36. package/dist/commonjs/models/components/creditunlooprequest.js +15 -3
  37. package/dist/commonjs/models/components/creditunlooprequest.js.map +1 -1
  38. package/dist/commonjs/models/components/looplegpreview.d.ts +4 -0
  39. package/dist/commonjs/models/components/looplegpreview.d.ts.map +1 -1
  40. package/dist/commonjs/models/components/looplegpreview.js +2 -0
  41. package/dist/commonjs/models/components/looplegpreview.js.map +1 -1
  42. package/dist/commonjs/models/operations/v2creditbalances.d.ts +1 -0
  43. package/dist/commonjs/models/operations/v2creditbalances.d.ts.map +1 -1
  44. package/dist/commonjs/models/operations/v2creditbalances.js +1 -0
  45. package/dist/commonjs/models/operations/v2creditbalances.js.map +1 -1
  46. package/dist/commonjs/models/operations/v2crediteulermarkets.d.ts +1 -0
  47. package/dist/commonjs/models/operations/v2crediteulermarkets.d.ts.map +1 -1
  48. package/dist/commonjs/models/operations/v2crediteulermarkets.js +1 -0
  49. package/dist/commonjs/models/operations/v2crediteulermarkets.js.map +1 -1
  50. package/dist/commonjs/models/operations/v2creditloopedpositions.d.ts +1 -0
  51. package/dist/commonjs/models/operations/v2creditloopedpositions.d.ts.map +1 -1
  52. package/dist/commonjs/models/operations/v2creditloopedpositions.js +1 -0
  53. package/dist/commonjs/models/operations/v2creditloopedpositions.js.map +1 -1
  54. package/dist/commonjs/models/operations/v2creditmorphomarkets.d.ts +1 -0
  55. package/dist/commonjs/models/operations/v2creditmorphomarkets.d.ts.map +1 -1
  56. package/dist/commonjs/models/operations/v2creditmorphomarkets.js +1 -0
  57. package/dist/commonjs/models/operations/v2creditmorphomarkets.js.map +1 -1
  58. package/dist/commonjs/models/operations/v2creditpositions.d.ts +1 -0
  59. package/dist/commonjs/models/operations/v2creditpositions.d.ts.map +1 -1
  60. package/dist/commonjs/models/operations/v2creditpositions.js +1 -0
  61. package/dist/commonjs/models/operations/v2creditpositions.js.map +1 -1
  62. package/dist/esm/models/components/createcreditaccountrequest.d.ts +1 -0
  63. package/dist/esm/models/components/createcreditaccountrequest.d.ts.map +1 -1
  64. package/dist/esm/models/components/createcreditaccountrequest.js +1 -0
  65. package/dist/esm/models/components/createcreditaccountrequest.js.map +1 -1
  66. package/dist/esm/models/components/creditborrowrequest.d.ts +20 -3
  67. package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
  68. package/dist/esm/models/components/creditborrowrequest.js +14 -2
  69. package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
  70. package/dist/esm/models/components/creditbundlerequest.d.ts +20 -3
  71. package/dist/esm/models/components/creditbundlerequest.d.ts.map +1 -1
  72. package/dist/esm/models/components/creditbundlerequest.js +14 -2
  73. package/dist/esm/models/components/creditbundlerequest.js.map +1 -1
  74. package/dist/esm/models/components/creditlooppreview.d.ts +4 -0
  75. package/dist/esm/models/components/creditlooppreview.d.ts.map +1 -1
  76. package/dist/esm/models/components/creditlooppreview.js +2 -0
  77. package/dist/esm/models/components/creditlooppreview.js.map +1 -1
  78. package/dist/esm/models/components/creditlooprequest.d.ts +20 -3
  79. package/dist/esm/models/components/creditlooprequest.d.ts.map +1 -1
  80. package/dist/esm/models/components/creditlooprequest.js +14 -2
  81. package/dist/esm/models/components/creditlooprequest.js.map +1 -1
  82. package/dist/esm/models/components/creditrebalancerequest.d.ts +19 -3
  83. package/dist/esm/models/components/creditrebalancerequest.d.ts.map +1 -1
  84. package/dist/esm/models/components/creditrebalancerequest.js +13 -2
  85. package/dist/esm/models/components/creditrebalancerequest.js.map +1 -1
  86. package/dist/esm/models/components/creditrepayrequest.d.ts +20 -3
  87. package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
  88. package/dist/esm/models/components/creditrepayrequest.js +14 -2
  89. package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
  90. package/dist/esm/models/components/credittransferrequest.d.ts +19 -3
  91. package/dist/esm/models/components/credittransferrequest.d.ts.map +1 -1
  92. package/dist/esm/models/components/credittransferrequest.js +14 -2
  93. package/dist/esm/models/components/credittransferrequest.js.map +1 -1
  94. package/dist/esm/models/components/creditunlooprequest.d.ts +20 -3
  95. package/dist/esm/models/components/creditunlooprequest.d.ts.map +1 -1
  96. package/dist/esm/models/components/creditunlooprequest.js +14 -2
  97. package/dist/esm/models/components/creditunlooprequest.js.map +1 -1
  98. package/dist/esm/models/components/looplegpreview.d.ts +4 -0
  99. package/dist/esm/models/components/looplegpreview.d.ts.map +1 -1
  100. package/dist/esm/models/components/looplegpreview.js +2 -0
  101. package/dist/esm/models/components/looplegpreview.js.map +1 -1
  102. package/dist/esm/models/operations/v2creditbalances.d.ts +1 -0
  103. package/dist/esm/models/operations/v2creditbalances.d.ts.map +1 -1
  104. package/dist/esm/models/operations/v2creditbalances.js +1 -0
  105. package/dist/esm/models/operations/v2creditbalances.js.map +1 -1
  106. package/dist/esm/models/operations/v2crediteulermarkets.d.ts +1 -0
  107. package/dist/esm/models/operations/v2crediteulermarkets.d.ts.map +1 -1
  108. package/dist/esm/models/operations/v2crediteulermarkets.js +1 -0
  109. package/dist/esm/models/operations/v2crediteulermarkets.js.map +1 -1
  110. package/dist/esm/models/operations/v2creditloopedpositions.d.ts +1 -0
  111. package/dist/esm/models/operations/v2creditloopedpositions.d.ts.map +1 -1
  112. package/dist/esm/models/operations/v2creditloopedpositions.js +1 -0
  113. package/dist/esm/models/operations/v2creditloopedpositions.js.map +1 -1
  114. package/dist/esm/models/operations/v2creditmorphomarkets.d.ts +1 -0
  115. package/dist/esm/models/operations/v2creditmorphomarkets.d.ts.map +1 -1
  116. package/dist/esm/models/operations/v2creditmorphomarkets.js +1 -0
  117. package/dist/esm/models/operations/v2creditmorphomarkets.js.map +1 -1
  118. package/dist/esm/models/operations/v2creditpositions.d.ts +1 -0
  119. package/dist/esm/models/operations/v2creditpositions.d.ts.map +1 -1
  120. package/dist/esm/models/operations/v2creditpositions.js +1 -0
  121. package/dist/esm/models/operations/v2creditpositions.js.map +1 -1
  122. package/docs/models/components/createcreditaccountrequestchain.md +1 -1
  123. package/docs/models/components/creditborrowrequest.md +1 -1
  124. package/docs/models/components/creditborrowrequestchain.md +17 -0
  125. package/docs/models/components/creditbundlerequest.md +7 -7
  126. package/docs/models/components/creditbundlerequestchain.md +17 -0
  127. package/docs/models/components/creditlooppreview.md +12 -10
  128. package/docs/models/components/creditlooprequest.md +1 -1
  129. package/docs/models/components/creditlooprequestchain.md +17 -0
  130. package/docs/models/components/creditloopresponse.md +1 -0
  131. package/docs/models/components/creditrebalancerequest.md +1 -1
  132. package/docs/models/components/creditrebalancerequestchain.md +17 -0
  133. package/docs/models/components/creditrepayrequest.md +1 -1
  134. package/docs/models/components/creditrepayrequestchain.md +17 -0
  135. package/docs/models/components/credittransferrequest.md +1 -1
  136. package/docs/models/components/credittransferrequestchain.md +17 -0
  137. package/docs/models/components/creditunlooprequest.md +1 -1
  138. package/docs/models/components/creditunlooprequestchain.md +17 -0
  139. package/docs/models/components/looplegpreview.md +6 -5
  140. package/docs/models/operations/v2creditbalanceschain.md +1 -1
  141. package/docs/models/operations/v2crediteulermarketschain.md +1 -1
  142. package/docs/models/operations/v2creditloopedpositionschain.md +1 -1
  143. package/docs/models/operations/v2creditmorphomarketschain.md +1 -1
  144. package/docs/models/operations/v2creditpositionschain.md +1 -1
  145. package/docs/sdks/credit/README.md +2 -2
  146. package/openapi_prepped_for_speakeasy.json +95 -9
  147. package/package.json +1 -1
  148. package/src/models/components/createcreditaccountrequest.ts +1 -0
  149. package/src/models/components/creditborrowrequest.ts +27 -4
  150. package/src/models/components/creditbundlerequest.ts +27 -4
  151. package/src/models/components/creditlooppreview.ts +6 -0
  152. package/src/models/components/creditlooprequest.ts +25 -4
  153. package/src/models/components/creditrebalancerequest.ts +26 -4
  154. package/src/models/components/creditrepayrequest.ts +27 -4
  155. package/src/models/components/credittransferrequest.ts +26 -4
  156. package/src/models/components/creditunlooprequest.ts +27 -4
  157. package/src/models/components/looplegpreview.ts +6 -0
  158. package/src/models/operations/v2creditbalances.ts +1 -0
  159. package/src/models/operations/v2crediteulermarkets.ts +1 -0
  160. package/src/models/operations/v2creditloopedpositions.ts +1 -0
  161. package/src/models/operations/v2creditmorphomarkets.ts +1 -0
  162. package/src/models/operations/v2creditpositions.ts +1 -0
package/docs/models/components/creditlooprequest.md CHANGED
@@ -28,7 +28,7 @@ let value: CreditLoopRequest = {
28
28
  | Field | Type | Required | Description | Example |
29
29
  | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30
30
  | `owner` | *string* | :heavy_check_mark: | The address that owns the Credit Account. | 0x5e5b00ed886A6879C2B934612D2312975427fcAf |
31
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
31
+ | `chain` | [components.CreditLoopRequestChain](../../models/components/creditlooprequestchain.md) | :heavy_check_mark: | Blockchain network. | ethereum |
32
32
  | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``MORPHO`` identifies Morpho<br/>Blue lending markets by their bytes32 ``market_id``. ``EULER`` identifies Euler<br/>V2 markets by their EVK ``collateral_vault`` + ``borrow_vault`` addresses and<br/>supports isolated per-sub-account positions (``sub_account_id``). All three<br/>support the loop/unloop leverage endpoints. | |
33
33
  | `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. | |
34
34
  | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault address collateral is supplied to (from /v2/credit/euler_markets). Required when protocol=EULER. | |
package/docs/models/components/creditlooprequestchain.md ADDED
@@ -0,0 +1,17 @@
1
+ # CreditLoopRequestChain
2
+
3
+ Blockchain network.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditLoopRequestChain } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditLoopRequestChain = "ethereum";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
17
+ ```
package/docs/models/components/creditloopresponse.md CHANGED
@@ -16,6 +16,7 @@ let value: CreditLoopResponse = {
16
16
  projectedLtv: "<value>",
17
17
  projectedHealthFactor: "<value>",
18
18
  estimatedMaxDust: "<value>",
19
+ estimatedSwapCost: "<value>",
19
20
  legs: [],
20
21
  },
21
22
  };
package/docs/models/components/creditrebalancerequest.md CHANGED
@@ -31,7 +31,7 @@ let value: CreditRebalanceRequest = {
31
31
  | Field | Type | Required | Description | Example |
32
32
  | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
33
33
  | `owner` | *string* | :heavy_check_mark: | The address that owns the Credit Account. | 0x4D3c07d1db7E4A9E44285fae9810d6549655bc74 |
34
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
34
+ | `chain` | [components.CreditRebalanceRequestChain](../../models/components/creditrebalancerequestchain.md) | :heavy_check_mark: | Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there. | ethereum |
35
35
  | `targets` | [components.RebalanceTarget](../../models/components/rebalancetarget.md)[] | :heavy_check_mark: | The positions to change. Scoped: only positions named here are touched; any position not listed is left untouched. | [<br/>{<br/>"borrow_token": "USDC",<br/>"collateral_token": "WETH",<br/>"protocol": "AAVE",<br/>"target_multiplier": 2<br/>}<br/>] |
36
36
  | `maxSlippagePercent` | *components.CreditRebalanceRequestMaxSlippagePercent* | :heavy_minus_sign: | Request-level per-swap slippage tolerance in percent (including routing swaps). A per-target max_slippage_percent overrides it where set. | 0.5 |
37
37
  | `gasSponsorship` | *boolean* | :heavy_minus_sign: | If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction. | false |
package/docs/models/components/creditrebalancerequestchain.md ADDED
@@ -0,0 +1,17 @@
1
+ # CreditRebalanceRequestChain
2
+
3
+ Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditRebalanceRequestChain } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditRebalanceRequestChain = "ethereum";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "arbitrum" | "base" | "bsc" | "ethereum" | "tempo"
17
+ ```
package/docs/models/components/creditrepayrequest.md CHANGED
@@ -23,7 +23,7 @@ let value: CreditRepayRequest = {
23
23
  | Field | Type | Required | Description | Example |
24
24
  | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
25
  | `owner` | *string* | :heavy_check_mark: | The address that owns the Credit Account. | 0x831Ad0C52C77708DA5D49dc8278C966dfdD4ddA1 |
26
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
26
+ | `chain` | [components.CreditRepayRequestChain](../../models/components/creditrepayrequestchain.md) | :heavy_check_mark: | Blockchain network. | base |
27
27
  | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``MORPHO`` identifies Morpho<br/>Blue lending markets by their bytes32 ``market_id``. ``EULER`` identifies Euler<br/>V2 markets by their EVK ``collateral_vault`` + ``borrow_vault`` addresses and<br/>supports isolated per-sub-account positions (``sub_account_id``). All three<br/>support the loop/unloop leverage endpoints. | |
28
28
  | `borrowVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault the debt is owed to (repay target). Required when protocol=EULER. | |
29
29
  | `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. | |
package/docs/models/components/creditrepayrequestchain.md ADDED
@@ -0,0 +1,17 @@
1
+ # CreditRepayRequestChain
2
+
3
+ Blockchain network.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditRepayRequestChain } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditRepayRequestChain = "base";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
17
+ ```
package/docs/models/components/credittransferrequest.md CHANGED
@@ -19,7 +19,7 @@ let value: CreditTransferRequest = {
19
19
  | Field | Type | Required | Description | Example |
20
20
  | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
21
  | `owner` | *string* | :heavy_check_mark: | The owner's wallet address (EOA). | 0x4A83fec8c6A9A25Be28f3242a16dBaD0ab00f3a6 |
22
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
22
+ | `chain` | [components.CreditTransferRequestChain](../../models/components/credittransferrequestchain.md) | :heavy_check_mark: | Blockchain network. | base |
23
23
  | `token` | *string* | :heavy_check_mark: | The token to transfer. | USDC |
24
24
  | `amount` | *components.CreditTransferRequestAmount* | :heavy_check_mark: | The amount of tokens to transfer (in token units, not wei). | 100 |
25
25
  | `action` | [components.CreditTransferRequestAction](../../models/components/credittransferrequestaction.md) | :heavy_check_mark: | Whether you are depositing to or withdrawing from your credit account. | DEPOSIT |
package/docs/models/components/credittransferrequestchain.md ADDED
@@ -0,0 +1,17 @@
1
+ # CreditTransferRequestChain
2
+
3
+ Blockchain network.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditTransferRequestChain } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditTransferRequestChain = "base";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
17
+ ```
package/docs/models/components/creditunlooprequest.md CHANGED
@@ -26,7 +26,7 @@ let value: CreditUnloopRequest = {
26
26
  | Field | Type | Required | Description | Example |
27
27
  | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
28
  | `owner` | *string* | :heavy_check_mark: | The address that owns the Credit Account. | 0x0E407CdeBD8e078E6966ef6740540d25F5897082 |
29
- | `chain` | [components.Chain](../../models/components/chain.md) | :heavy_check_mark: | The chain to use. | |
29
+ | `chain` | [components.CreditUnloopRequestChain](../../models/components/creditunlooprequestchain.md) | :heavy_check_mark: | Blockchain network. | ethereum |
30
30
  | `protocol` | [components.CreditProtocol](../../models/components/creditprotocol.md) | :heavy_minus_sign: | Which lending protocol a credit action targets.<br/><br/>``AAVE`` is the default so existing callers (which never send a ``protocol``<br/>field) keep hitting the unchanged Aave code path. ``MORPHO`` identifies Morpho<br/>Blue lending markets by their bytes32 ``market_id``. ``EULER`` identifies Euler<br/>V2 markets by their EVK ``collateral_vault`` + ``borrow_vault`` addresses and<br/>supports isolated per-sub-account positions (``sub_account_id``). All three<br/>support the loop/unloop leverage endpoints. | |
31
31
  | `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. | |
32
32
  | `collateralVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault the loop's collateral is in. Required when protocol=EULER. | |
package/docs/models/components/creditunlooprequestchain.md ADDED
@@ -0,0 +1,17 @@
1
+ # CreditUnloopRequestChain
2
+
3
+ Blockchain network.
4
+
5
+ ## Example Usage
6
+
7
+ ```typescript
8
+ import { CreditUnloopRequestChain } from "@compass-labs/api-sdk/models/components";
9
+
10
+ let value: CreditUnloopRequestChain = "ethereum";
11
+ ```
12
+
13
+ ## Values
14
+
15
+ ```typescript
16
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
17
+ ```
package/docs/models/components/looplegpreview.md CHANGED
@@ -14,8 +14,9 @@ let value: LoopLegPreview = {
14
14
 
15
15
  ## Fields
16
16
 
17
- | Field | Type | Required | Description |
18
- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
19
- | `supplyAmount` | *string* | :heavy_check_mark: | Collateral supplied this iteration (token units). |
20
- | `borrowAmount` | *string* | :heavy_minus_sign: | Loan borrowed this iteration; null on the final supply-only iteration. |
21
- | `minSwapOut` | *string* | :heavy_minus_sign: | Guaranteed swap output (collateral units) — the next iteration's supply. Enforced on-chain by the swap's minimum-return. |
17
+ | Field | Type | Required | Description |
18
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
19
+ | `supplyAmount` | *string* | :heavy_check_mark: | Collateral supplied this iteration (token units). |
20
+ | `borrowAmount` | *string* | :heavy_minus_sign: | Loan borrowed this iteration; null on the final supply-only iteration. |
21
+ | `minSwapOut` | *string* | :heavy_minus_sign: | Guaranteed swap output (collateral units) — the next iteration's supply. Enforced on-chain by the swap's minimum-return. |
22
+ | `expectedSwapOut` | *string* | :heavy_minus_sign: | Quoted swap output (collateral units) before the slippage floor is applied. Only min_swap_out is guaranteed on-chain; the gap between the two is the adverse-slippage tolerance, bounded by max_slippage_percent, not a surplus that is certain to arrive. Whatever the fill actually delivers above min_swap_out stays in the account, and estimated_max_dust is the upper bound on that. |
package/docs/models/operations/v2creditbalanceschain.md CHANGED
@@ -11,5 +11,5 @@ let value: V2CreditBalancesChain = "base";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "arbitrum" | "base" | "bsc" | "ethereum" | "tempo"
14
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
15
15
  ```
package/docs/models/operations/v2crediteulermarketschain.md CHANGED
@@ -11,5 +11,5 @@ let value: V2CreditEulerMarketsChain = "ethereum";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "arbitrum" | "base" | "bsc" | "ethereum" | "tempo"
14
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
15
15
  ```
package/docs/models/operations/v2creditloopedpositionschain.md CHANGED
@@ -11,5 +11,5 @@ let value: V2CreditLoopedPositionsChain = "base";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "arbitrum" | "base" | "bsc" | "ethereum" | "tempo"
14
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
15
15
  ```
package/docs/models/operations/v2creditmorphomarketschain.md CHANGED
@@ -11,5 +11,5 @@ let value: V2CreditMorphoMarketsChain = "ethereum";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "arbitrum" | "base" | "bsc" | "ethereum" | "tempo"
14
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
15
15
  ```
package/docs/models/operations/v2creditpositionschain.md CHANGED
@@ -11,5 +11,5 @@ let value: V2CreditPositionsChain = "base";
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "arbitrum" | "base" | "bsc" | "ethereum" | "tempo"
14
+ "arbitrum" | "base" | "bsc" | "ethereum" | "hyperevm" | "tempo"
15
15
  ```
package/docs/sdks/credit/README.md CHANGED
@@ -1194,7 +1194,7 @@ const compassApiSDK = new CompassApiSDK({
1194
1194
  async function run() {
1195
1195
  const result = await compassApiSDK.credit.creditBundle({
1196
1196
  owner: "<value>",
1197
- chain: "tempo",
1197
+ chain: "hyperevm",
1198
1198
  actions: [
1199
1199
  {
1200
1200
  body: {
@@ -1233,7 +1233,7 @@ const compassApiSDK = new CompassApiSDKCore({
1233
1233
  async function run() {
1234
1234
  const res = await creditCreditBundle(compassApiSDK, {
1235
1235
  owner: "<value>",
1236
- chain: "tempo",
1236
+ chain: "hyperevm",
1237
1237
  actions: [
1238
1238
  {
1239
1239
  body: {