@compass-labs/api-sdk 2.2.76-rc.3 → 2.2.76
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 +3 -7
- package/codeSamples_typescript.yaml +0 -12
- package/dist/commonjs/models/components/aavelooprequest.d.ts +16 -16
- package/dist/commonjs/models/components/aavelooprequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/aavelooprequest.js +17 -17
- package/dist/commonjs/models/components/aavelooprequest.js.map +1 -1
- package/dist/commonjs/models/components/accountsummary.d.ts +0 -4
- package/dist/commonjs/models/components/accountsummary.d.ts.map +1 -1
- package/dist/commonjs/models/components/accountsummary.js.map +1 -1
- package/dist/commonjs/models/components/collateralposition.d.ts +0 -12
- package/dist/commonjs/models/components/collateralposition.d.ts.map +1 -1
- package/dist/commonjs/models/components/collateralposition.js +0 -4
- package/dist/commonjs/models/components/collateralposition.js.map +1 -1
- package/dist/commonjs/models/components/creditborrowparams.d.ts +0 -9
- package/dist/commonjs/models/components/creditborrowparams.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditborrowparams.js +0 -2
- package/dist/commonjs/models/components/creditborrowparams.js.map +1 -1
- package/dist/commonjs/models/components/creditborrowrequest.d.ts +0 -9
- package/dist/commonjs/models/components/creditborrowrequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditborrowrequest.js +0 -2
- package/dist/commonjs/models/components/creditborrowrequest.js.map +1 -1
- package/dist/commonjs/models/components/creditenablecollateralparams.d.ts +0 -4
- package/dist/commonjs/models/components/creditenablecollateralparams.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditenablecollateralparams.js.map +1 -1
- package/dist/commonjs/models/components/creditprotocol.d.ts +0 -9
- package/dist/commonjs/models/components/creditprotocol.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditprotocol.js +0 -5
- package/dist/commonjs/models/components/creditprotocol.js.map +1 -1
- package/dist/commonjs/models/components/creditrepayparams.d.ts +0 -9
- package/dist/commonjs/models/components/creditrepayparams.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditrepayparams.js +0 -2
- package/dist/commonjs/models/components/creditrepayparams.js.map +1 -1
- package/dist/commonjs/models/components/creditrepayrequest.d.ts +0 -9
- package/dist/commonjs/models/components/creditrepayrequest.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditrepayrequest.js +0 -2
- package/dist/commonjs/models/components/creditrepayrequest.js.map +1 -1
- package/dist/commonjs/models/components/creditsupplyparams.d.ts +0 -9
- package/dist/commonjs/models/components/creditsupplyparams.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditsupplyparams.js +0 -2
- package/dist/commonjs/models/components/creditsupplyparams.js.map +1 -1
- package/dist/commonjs/models/components/creditwithdrawparams.d.ts +0 -9
- package/dist/commonjs/models/components/creditwithdrawparams.d.ts.map +1 -1
- package/dist/commonjs/models/components/creditwithdrawparams.js +0 -2
- package/dist/commonjs/models/components/creditwithdrawparams.js.map +1 -1
- package/dist/commonjs/models/components/debtposition.d.ts +0 -12
- package/dist/commonjs/models/components/debtposition.d.ts.map +1 -1
- package/dist/commonjs/models/components/debtposition.js +0 -4
- package/dist/commonjs/models/components/debtposition.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +0 -6
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +0 -6
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +0 -1
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -1
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/sdk/credit.d.ts +0 -32
- package/dist/commonjs/sdk/credit.d.ts.map +1 -1
- package/dist/commonjs/sdk/credit.js +0 -38
- package/dist/commonjs/sdk/credit.js.map +1 -1
- package/dist/esm/models/components/aavelooprequest.d.ts +16 -16
- package/dist/esm/models/components/aavelooprequest.d.ts.map +1 -1
- package/dist/esm/models/components/aavelooprequest.js +12 -12
- package/dist/esm/models/components/aavelooprequest.js.map +1 -1
- package/dist/esm/models/components/accountsummary.d.ts +0 -4
- package/dist/esm/models/components/accountsummary.d.ts.map +1 -1
- package/dist/esm/models/components/accountsummary.js.map +1 -1
- package/dist/esm/models/components/collateralposition.d.ts +0 -12
- package/dist/esm/models/components/collateralposition.d.ts.map +1 -1
- package/dist/esm/models/components/collateralposition.js +0 -4
- package/dist/esm/models/components/collateralposition.js.map +1 -1
- package/dist/esm/models/components/creditborrowparams.d.ts +0 -9
- package/dist/esm/models/components/creditborrowparams.d.ts.map +1 -1
- package/dist/esm/models/components/creditborrowparams.js +0 -2
- package/dist/esm/models/components/creditborrowparams.js.map +1 -1
- package/dist/esm/models/components/creditborrowrequest.d.ts +0 -9
- package/dist/esm/models/components/creditborrowrequest.d.ts.map +1 -1
- package/dist/esm/models/components/creditborrowrequest.js +0 -2
- package/dist/esm/models/components/creditborrowrequest.js.map +1 -1
- package/dist/esm/models/components/creditenablecollateralparams.d.ts +0 -4
- package/dist/esm/models/components/creditenablecollateralparams.d.ts.map +1 -1
- package/dist/esm/models/components/creditenablecollateralparams.js.map +1 -1
- package/dist/esm/models/components/creditprotocol.d.ts +0 -9
- package/dist/esm/models/components/creditprotocol.d.ts.map +1 -1
- package/dist/esm/models/components/creditprotocol.js +0 -5
- package/dist/esm/models/components/creditprotocol.js.map +1 -1
- package/dist/esm/models/components/creditrepayparams.d.ts +0 -9
- package/dist/esm/models/components/creditrepayparams.d.ts.map +1 -1
- package/dist/esm/models/components/creditrepayparams.js +0 -2
- package/dist/esm/models/components/creditrepayparams.js.map +1 -1
- package/dist/esm/models/components/creditrepayrequest.d.ts +0 -9
- package/dist/esm/models/components/creditrepayrequest.d.ts.map +1 -1
- package/dist/esm/models/components/creditrepayrequest.js +0 -2
- package/dist/esm/models/components/creditrepayrequest.js.map +1 -1
- package/dist/esm/models/components/creditsupplyparams.d.ts +0 -9
- package/dist/esm/models/components/creditsupplyparams.d.ts.map +1 -1
- package/dist/esm/models/components/creditsupplyparams.js +0 -2
- package/dist/esm/models/components/creditsupplyparams.js.map +1 -1
- package/dist/esm/models/components/creditwithdrawparams.d.ts +0 -9
- package/dist/esm/models/components/creditwithdrawparams.d.ts.map +1 -1
- package/dist/esm/models/components/creditwithdrawparams.js +0 -2
- package/dist/esm/models/components/creditwithdrawparams.js.map +1 -1
- package/dist/esm/models/components/debtposition.d.ts +0 -12
- package/dist/esm/models/components/debtposition.d.ts.map +1 -1
- package/dist/esm/models/components/debtposition.js +0 -4
- package/dist/esm/models/components/debtposition.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +0 -6
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +0 -6
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +0 -1
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -1
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/sdk/credit.d.ts +0 -32
- package/dist/esm/sdk/credit.d.ts.map +1 -1
- package/dist/esm/sdk/credit.js +0 -38
- package/dist/esm/sdk/credit.js.map +1 -1
- package/docs/models/components/aavelooprequest.md +4 -4
- package/docs/models/components/accountsummary.md +10 -10
- package/docs/models/components/collateralposition.md +14 -16
- package/docs/models/components/creditborrowparams.md +9 -10
- package/docs/models/components/creditborrowrequest.md +19 -20
- package/docs/models/components/creditenablecollateralparams.md +6 -6
- package/docs/models/components/creditprotocol.md +1 -5
- package/docs/models/components/creditrepayparams.md +8 -9
- package/docs/models/components/creditrepayrequest.md +18 -19
- package/docs/models/components/creditsupplyparams.md +7 -8
- package/docs/models/components/creditwithdrawparams.md +7 -8
- package/docs/models/components/debtposition.md +13 -15
- package/docs/models/components/{aavelooprequestinitialcollateralamount.md → initialcollateralamount.md} +1 -1
- package/docs/models/components/{aavelooprequestloantovalue.md → loantovalue.md} +1 -1
- package/docs/models/components/{aavelooprequestmaxslippagepercent.md → maxslippagepercent.md} +1 -1
- package/docs/models/components/{aavelooprequestmultiplier.md → multiplier.md} +1 -1
- package/docs/sdks/credit/README.md +0 -186
- package/examples/node_modules/tsx/dist/cli.cjs +1 -1
- package/examples/node_modules/tsx/dist/cli.mjs +1 -1
- package/examples/node_modules/tsx/dist/esm/api/index.cjs +1 -1
- package/examples/node_modules/tsx/dist/esm/api/index.mjs +1 -1
- package/examples/node_modules/tsx/dist/esm/index.cjs +1 -1
- package/examples/node_modules/tsx/dist/esm/index.mjs +1 -1
- package/examples/node_modules/tsx/dist/loader.cjs +1 -1
- package/examples/node_modules/tsx/dist/loader.mjs +1 -1
- package/examples/node_modules/tsx/dist/package-BhsaYzSJ.cjs +1 -0
- package/examples/node_modules/tsx/dist/package-REq4Oepp.mjs +1 -0
- package/examples/node_modules/tsx/dist/register-BBZNEaBg.cjs +2 -0
- package/examples/node_modules/tsx/dist/register-tkXbOgAS.mjs +2 -0
- package/examples/node_modules/tsx/dist/repl.cjs +1 -1
- package/examples/node_modules/tsx/dist/repl.mjs +1 -1
- package/examples/node_modules/tsx/package.json +1 -1
- package/examples/package-lock.json +3 -3
- package/openapi_prepped_for_speakeasy.json +2 -658
- package/package.json +1 -1
- package/src/models/components/aavelooprequest.ts +30 -43
- package/src/models/components/accountsummary.ts +0 -4
- package/src/models/components/collateralposition.ts +0 -16
- package/src/models/components/creditborrowparams.ts +0 -11
- package/src/models/components/creditborrowrequest.ts +0 -11
- package/src/models/components/creditenablecollateralparams.ts +0 -4
- package/src/models/components/creditprotocol.ts +0 -9
- package/src/models/components/creditrepayparams.ts +0 -11
- package/src/models/components/creditrepayrequest.ts +0 -11
- package/src/models/components/creditsupplyparams.ts +0 -11
- package/src/models/components/creditwithdrawparams.ts +0 -11
- package/src/models/components/debtposition.ts +0 -16
- package/src/models/components/index.ts +0 -6
- package/src/models/operations/index.ts +0 -1
- package/src/sdk/credit.ts +0 -54
- package/dist/commonjs/funcs/creditCreditLoop.d.ts +0 -31
- package/dist/commonjs/funcs/creditCreditLoop.d.ts.map +0 -1
- package/dist/commonjs/funcs/creditCreditLoop.js +0 -132
- package/dist/commonjs/funcs/creditCreditLoop.js.map +0 -1
- package/dist/commonjs/funcs/creditCreditMorphoMarkets.d.ts +0 -24
- package/dist/commonjs/funcs/creditCreditMorphoMarkets.d.ts.map +0 -1
- package/dist/commonjs/funcs/creditCreditMorphoMarkets.js +0 -128
- package/dist/commonjs/funcs/creditCreditMorphoMarkets.js.map +0 -1
- package/dist/commonjs/models/components/creditlooppreview.d.ts +0 -45
- package/dist/commonjs/models/components/creditlooppreview.d.ts.map +0 -1
- package/dist/commonjs/models/components/creditlooppreview.js +0 -68
- package/dist/commonjs/models/components/creditlooppreview.js.map +0 -1
- package/dist/commonjs/models/components/creditlooprequest.d.ts +0 -125
- package/dist/commonjs/models/components/creditlooprequest.d.ts.map +0 -1
- package/dist/commonjs/models/components/creditlooprequest.js +0 -98
- package/dist/commonjs/models/components/creditlooprequest.js.map +0 -1
- package/dist/commonjs/models/components/creditloopresponse.d.ts +0 -27
- package/dist/commonjs/models/components/creditloopresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/creditloopresponse.js +0 -61
- package/dist/commonjs/models/components/creditloopresponse.js.map +0 -1
- package/dist/commonjs/models/components/looplegpreview.d.ts +0 -24
- package/dist/commonjs/models/components/looplegpreview.d.ts.map +0 -1
- package/dist/commonjs/models/components/looplegpreview.js +0 -59
- package/dist/commonjs/models/components/looplegpreview.js.map +0 -1
- package/dist/commonjs/models/components/morpholendingmarket.d.ts +0 -80
- package/dist/commonjs/models/components/morpholendingmarket.d.ts.map +0 -1
- package/dist/commonjs/models/components/morpholendingmarket.js +0 -82
- package/dist/commonjs/models/components/morpholendingmarket.js.map +0 -1
- package/dist/commonjs/models/components/morphomarketsresponse.d.ts +0 -21
- package/dist/commonjs/models/components/morphomarketsresponse.d.ts.map +0 -1
- package/dist/commonjs/models/components/morphomarketsresponse.js +0 -52
- package/dist/commonjs/models/components/morphomarketsresponse.js.map +0 -1
- package/dist/commonjs/models/operations/v2creditmorphomarkets.d.ts +0 -22
- package/dist/commonjs/models/operations/v2creditmorphomarkets.d.ts.map +0 -1
- package/dist/commonjs/models/operations/v2creditmorphomarkets.js +0 -57
- package/dist/commonjs/models/operations/v2creditmorphomarkets.js.map +0 -1
- package/dist/esm/funcs/creditCreditLoop.d.ts +0 -31
- package/dist/esm/funcs/creditCreditLoop.d.ts.map +0 -1
- package/dist/esm/funcs/creditCreditLoop.js +0 -96
- package/dist/esm/funcs/creditCreditLoop.js.map +0 -1
- package/dist/esm/funcs/creditCreditMorphoMarkets.d.ts +0 -24
- package/dist/esm/funcs/creditCreditMorphoMarkets.d.ts.map +0 -1
- package/dist/esm/funcs/creditCreditMorphoMarkets.js +0 -92
- package/dist/esm/funcs/creditCreditMorphoMarkets.js.map +0 -1
- package/dist/esm/models/components/creditlooppreview.d.ts +0 -45
- package/dist/esm/models/components/creditlooppreview.d.ts.map +0 -1
- package/dist/esm/models/components/creditlooppreview.js +0 -31
- package/dist/esm/models/components/creditlooppreview.js.map +0 -1
- package/dist/esm/models/components/creditlooprequest.d.ts +0 -125
- package/dist/esm/models/components/creditlooprequest.d.ts.map +0 -1
- package/dist/esm/models/components/creditlooprequest.js +0 -57
- package/dist/esm/models/components/creditlooprequest.js.map +0 -1
- package/dist/esm/models/components/creditloopresponse.d.ts +0 -27
- package/dist/esm/models/components/creditloopresponse.d.ts.map +0 -1
- package/dist/esm/models/components/creditloopresponse.js +0 -24
- package/dist/esm/models/components/creditloopresponse.js.map +0 -1
- package/dist/esm/models/components/looplegpreview.d.ts +0 -24
- package/dist/esm/models/components/looplegpreview.d.ts.map +0 -1
- package/dist/esm/models/components/looplegpreview.js +0 -22
- package/dist/esm/models/components/looplegpreview.js.map +0 -1
- package/dist/esm/models/components/morpholendingmarket.d.ts +0 -80
- package/dist/esm/models/components/morpholendingmarket.d.ts.map +0 -1
- package/dist/esm/models/components/morpholendingmarket.js +0 -45
- package/dist/esm/models/components/morpholendingmarket.js.map +0 -1
- package/dist/esm/models/components/morphomarketsresponse.d.ts +0 -21
- package/dist/esm/models/components/morphomarketsresponse.d.ts.map +0 -1
- package/dist/esm/models/components/morphomarketsresponse.js +0 -15
- package/dist/esm/models/components/morphomarketsresponse.js.map +0 -1
- package/dist/esm/models/operations/v2creditmorphomarkets.d.ts +0 -22
- package/dist/esm/models/operations/v2creditmorphomarkets.d.ts.map +0 -1
- package/dist/esm/models/operations/v2creditmorphomarkets.js +0 -20
- package/dist/esm/models/operations/v2creditmorphomarkets.js.map +0 -1
- package/docs/models/components/creditlooppreview.md +0 -33
- package/docs/models/components/creditlooprequest.md +0 -41
- package/docs/models/components/creditlooprequestinitialcollateralamount.md +0 -19
- package/docs/models/components/creditlooprequestloantovalue.md +0 -19
- package/docs/models/components/creditlooprequestmaxslippagepercent.md +0 -19
- package/docs/models/components/creditlooprequestmultiplier.md +0 -19
- package/docs/models/components/creditloopresponse.md +0 -30
- package/docs/models/components/looplegpreview.md +0 -21
- package/docs/models/components/morpholendingmarket.md +0 -49
- package/docs/models/components/morphomarketsresponse.md +0 -21
- package/docs/models/operations/v2creditmorphomarketschain.md +0 -15
- package/docs/models/operations/v2creditmorphomarketsrequest.md +0 -17
- package/examples/node_modules/tsx/dist/package-Bj47PlGH.mjs +0 -1
- package/examples/node_modules/tsx/dist/package-DMqO70yR.cjs +0 -1
- package/examples/node_modules/tsx/dist/register-CKju0f8h.cjs +0 -2
- package/examples/node_modules/tsx/dist/register-CqMfTiWi.mjs +0 -2
- package/src/funcs/creditCreditLoop.ts +0 -184
- package/src/funcs/creditCreditMorphoMarkets.ts +0 -182
- package/src/models/components/creditlooppreview.ts +0 -86
- package/src/models/components/creditlooprequest.ts +0 -235
- package/src/models/components/creditloopresponse.ts +0 -65
- package/src/models/components/looplegpreview.ts +0 -54
- package/src/models/components/morpholendingmarket.ts +0 -133
- package/src/models/components/morphomarketsresponse.ts +0 -46
- package/src/models/operations/v2creditmorphomarkets.ts +0 -49
|
@@ -23,13 +23,13 @@ let value: AccountSummary = {
|
|
|
23
23
|
|
|
24
24
|
## Fields
|
|
25
25
|
|
|
26
|
-
| Field
|
|
27
|
-
|
|
|
28
|
-
| `protocol`
|
|
29
|
-
| `healthFactor`
|
|
30
|
-
| `totalCollateralUsd`
|
|
31
|
-
| `totalDebtUsd`
|
|
32
|
-
| `availableBorrowsUsd`
|
|
33
|
-
| `ltv`
|
|
34
|
-
| `emodeCategoryId`
|
|
35
|
-
| `emodeLabel`
|
|
26
|
+
| Field | Type | Required | Description | Example |
|
|
27
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
+
| `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. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
|
|
29
|
+
| `healthFactor` | *string* | :heavy_check_mark: | Health factor. Above 1 is safe; below 1 risks liquidation. | |
|
|
30
|
+
| `totalCollateralUsd` | *string* | :heavy_check_mark: | Total collateral value in USD. | |
|
|
31
|
+
| `totalDebtUsd` | *string* | :heavy_check_mark: | Total debt value in USD. | |
|
|
32
|
+
| `availableBorrowsUsd` | *string* | :heavy_check_mark: | Available borrow capacity in USD. | |
|
|
33
|
+
| `ltv` | *string* | :heavy_check_mark: | Current loan-to-value ratio. | |
|
|
34
|
+
| `emodeCategoryId` | *number* | :heavy_minus_sign: | E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative). | 0 |
|
|
35
|
+
| `emodeLabel` | *string* | :heavy_minus_sign: | Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0). | |
|
|
@@ -17,19 +17,17 @@ let value: CollateralPosition = {
|
|
|
17
17
|
|
|
18
18
|
## Fields
|
|
19
19
|
|
|
20
|
-
| Field
|
|
21
|
-
|
|
|
22
|
-
| `token`
|
|
23
|
-
| `symbol`
|
|
24
|
-
| `protocol`
|
|
25
|
-
| `vault`
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `maxLtv` | *string* | :heavy_minus_sign: | Maximum loan-to-value ratio for this collateral in percentage (e.g. 80 means 80%). | |
|
|
35
|
-
| `events` | [components.CreditEvent](../../models/components/creditevent.md)[] | :heavy_minus_sign: | All historical events for this collateral reserve. | [] |
|
|
20
|
+
| Field | Type | Required | Description | Example |
|
|
21
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
+
| `token` | *string* | :heavy_check_mark: | Address of the collateral token. | |
|
|
23
|
+
| `symbol` | *string* | :heavy_check_mark: | Symbol of the collateral token (e.g. USDC). | |
|
|
24
|
+
| `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. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
|
|
25
|
+
| `vault` | *string* | :heavy_minus_sign: | Euler only: the EVK collateral vault holding this position. | |
|
|
26
|
+
| `amountSupplied` | *string* | :heavy_check_mark: | Current on-chain collateral balance (the vault's underlying asset for Euler). | |
|
|
27
|
+
| `usdValue` | *string* | :heavy_minus_sign: | Collateral value in USD. | |
|
|
28
|
+
| `supplyApy` | *string* | :heavy_minus_sign: | Current supply APY in percentage (e.g. 4.5 means 4.5%). | |
|
|
29
|
+
| `totalDeposited` | *string* | :heavy_minus_sign: | Total collateral deposited over all time. | |
|
|
30
|
+
| `totalWithdrawn` | *string* | :heavy_minus_sign: | Total collateral withdrawn over all time. | |
|
|
31
|
+
| `interestEarned` | *string* | :heavy_minus_sign: | Interest earned on collateral: on_chain_balance + total_withdrawn - total_deposited. | |
|
|
32
|
+
| `maxLtv` | *string* | :heavy_minus_sign: | Maximum loan-to-value ratio for this collateral in percentage (e.g. 80 means 80%). | |
|
|
33
|
+
| `events` | [components.CreditEvent](../../models/components/creditevent.md)[] | :heavy_minus_sign: | All historical events for this collateral reserve. | [] |
|
|
@@ -21,13 +21,12 @@ let value: CreditBorrowParams = {
|
|
|
21
21
|
|
|
22
22
|
## Fields
|
|
23
23
|
|
|
24
|
-
| Field
|
|
25
|
-
|
|
|
26
|
-
| `actionType`
|
|
27
|
-
| `token`
|
|
28
|
-
| `amount`
|
|
29
|
-
| `interestRateMode`
|
|
30
|
-
| `fee`
|
|
31
|
-
| `protocol`
|
|
32
|
-
| `borrowVault`
|
|
33
|
-
| `marketId` | *string* | :heavy_minus_sign: | Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. | |
|
|
24
|
+
| Field | Type | Required | Description | Example |
|
|
25
|
+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `actionType` | *"CREDIT_BORROW"* | :heavy_check_mark: | N/A | CREDIT_BORROW |
|
|
27
|
+
| `token` | *string* | :heavy_check_mark: | Token to borrow from Aave. | |
|
|
28
|
+
| `amount` | *components.CreditBorrowParamsAmount* | :heavy_check_mark: | Amount in token units to borrow. | |
|
|
29
|
+
| `interestRateMode` | [components.InterestRateMode](../../models/components/interestratemode.md) | :heavy_minus_sign: | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. | |
|
|
30
|
+
| `fee` | [components.CreditFee](../../models/components/creditfee.md) | :heavy_minus_sign: | Optional fee on the borrowed amount. | |
|
|
31
|
+
| `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. ``EULER`` opts in to the<br/>Euler V2 path, where the market is identified by EVK vault address(es). | |
|
|
32
|
+
| `borrowVault` | *string* | :heavy_minus_sign: | Euler only: the EVK vault to borrow from. Required when protocol=EULER. | |
|