@compass-labs/api-sdk 2.1.11 → 2.1.12-rc.0

package/docs/models/components/ethenaunstakeparams.md

@@ -0,0 +1,18 @@
+# EthenaUnstakeParams
+
+## Example Usage
+
+```typescript
+import { EthenaUnstakeParams } from "@compass-labs/api-sdk/models/components";
+
+let value: EthenaUnstakeParams = {
+  actionType: "ETHENA_UNSTAKE",
+};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               | Example                                                                   |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `actionType`                                                              | *"ETHENA_UNSTAKE"*                                                        | :heavy_check_mark:                                                        | N/A                                                                       | ETHENA_UNSTAKE                                                            |
+| `receiver`                                                                | *string*                                                                  | :heavy_minus_sign:                                                        | The address which will receive the unstaked USDe. Defaults to the sender. |                                                                           |

package/docs/models/components/ethenaunstakerequest.md

@@ -0,0 +1,22 @@
+# EthenaUnstakeRequest
+
+## Example Usage
+
+```typescript
+import { EthenaUnstakeRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: EthenaUnstakeRequest = {
+  chain: "ethereum",
+  sender: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"ETHENA_UNSTAKE"*                                                                                                           | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | ETHENA_UNSTAKE                                                                                                               |
+| `receiver`                                                                                                                   | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address which will receive the unstaked USDe. Defaults to the sender.                                                    |                                                                                                                              |
+| `chain`                                                                                                                      | [components.EthenaUnstakeRequestChain](../../models/components/ethenaunstakerequestchain.md)                                 | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          |                                                                                                                              |
+| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       |                                                                                                                              |
+| `estimateGas`                                                                                                                | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true                                                                                                                         |

package/docs/models/components/ethenaunstakerequestchain.md

@@ -0,0 +1,15 @@
+# EthenaUnstakeRequestChain
+
+## Example Usage
+
+```typescript
+import { EthenaUnstakeRequestChain } from "@compass-labs/api-sdk/models/components";
+
+let value: EthenaUnstakeRequestChain = "ethereum";
+```
+
+## Values
+
+```typescript
+"ethereum"
+```

package/docs/models/components/fee.md

@@ -0,0 +1,21 @@
+# Fee
+
+## Example Usage
+
+```typescript
+import { Fee } from "@compass-labs/api-sdk/models/components";
+
+let value: Fee = {
+  recipient: "<value>",
+  amount: 4618.16,
+  denomination: "PERCENTAGE",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                   | Type                                                                                                                                                                                                                    | Required                                                                                                                                                                                                                | Description                                                                                                                                                                                                             | Example                                                                                                                                                                                                                 |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `recipient`                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                      | The wallet address that will receive the fee.                                                                                                                                                                           |                                                                                                                                                                                                                         |
+| `amount`                                                                                                                                                                                                                | *components.FeeAmount*                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                      | The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). |                                                                                                                                                                                                                         |
+| `denomination`                                                                                                                                                                                                          | [components.Denomination](../../models/components/denomination.md)                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                      | The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).                        | PERCENTAGE                                                                                                                                                                                                              |

package/docs/models/components/feeamount.md

@@ -0,0 +1,19 @@
+# FeeAmount
+
+The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens).
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/feeenum.md

@@ -0,0 +1,19 @@
+# FeeEnum
+
+The transaction fee of a Uniswap pool in bips.
+
+Uniswap supports 4 different fee levels.
+
+## Example Usage
+
+```typescript
+import { FeeEnum } from "@compass-labs/api-sdk/models/components";
+
+let value: FeeEnum = "1.0";
+```
+
+## Values
+
+```typescript
+"0.01" | "0.05" | "0.3" | "1.0"
+```

package/docs/models/components/initialcollateralamount.md

@@ -0,0 +1,19 @@
+# InitialCollateralAmount
+
+Amount of collateral token to supply to Aave
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/interestratemode.md

@@ -0,0 +1,19 @@
+# InterestRateMode
+
+On AAVE there are 2 different interest modes.
+
+A stable (but typically higher rate), or a variable rate.
+
+## Example Usage
+
+```typescript
+import { InterestRateMode } from "@compass-labs/api-sdk/models/components";
+
+let value: InterestRateMode = "variable";
+```
+
+## Values
+
+```typescript
+"stable" | "variable"
+```

package/docs/models/components/liquidationcall.md

@@ -0,0 +1,45 @@
+# LiquidationCall
+
+## Example Usage
+
+```typescript
+import { LiquidationCall } from "@compass-labs/api-sdk/models/components";
+
+let value: LiquidationCall = {
+  id: "<id>",
+  timestamp: 906796,
+  txHash: "<value>",
+  collateralAmount: 3903,
+  collateralReserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  principalAmount: 1013.27,
+  principalReserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  collateralAssetPriceUSD: 1927.57,
+  borrowAssetPriceUSD: 3105.83,
+  action: "LiquidationCall",
+  block: 548176,
+};
+```
+
+## Fields
+
+| Field                                                                  | Type                                                                   | Required                                                               | Description                                                            |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| `id`                                                                   | *string*                                                               | :heavy_check_mark:                                                     | The id of a historical transaction on aave                             |
+| `timestamp`                                                            | *number*                                                               | :heavy_check_mark:                                                     | Timestamp in unix time                                                 |
+| `txHash`                                                               | *string*                                                               | :heavy_check_mark:                                                     | Transaction hash. You can paste these into the search bar on etherscan |
+| `collateralAmount`                                                     | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `collateralReserve`                                                    | [components.Reserve](../../models/components/reserve.md)               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `principalAmount`                                                      | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `principalReserve`                                                     | [components.Reserve](../../models/components/reserve.md)               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `collateralAssetPriceUSD`                                              | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `borrowAssetPriceUSD`                                                  | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `action`                                                               | *"LiquidationCall"*                                                    | :heavy_check_mark:                                                     | N/A                                                                    |
+| `block`                                                                | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |

package/docs/models/components/loantovalue.md

@@ -0,0 +1,19 @@
+# LoanToValue
+
+Loan To Value percentage of the loop
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/loc.md

@@ -0,0 +1,17 @@
+# Loc
+
+
+## Supported Types
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+
+### `number`
+
+```typescript
+const value: number = 128403;
+```
+

package/docs/models/components/lpbalance.md

@@ -0,0 +1,21 @@
+# LpBalance
+
+## Example Usage
+
+```typescript
+import { LpBalance } from "@compass-labs/api-sdk/models/components";
+
+let value: LpBalance = {
+  valuation: 2244.37,
+  balance: "<value>",
+  activeBalance: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `valuation`        | *number*           | :heavy_check_mark: | N/A                |
+| `balance`          | *string*           | :heavy_check_mark: | N/A                |
+| `activeBalance`    | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/market.md

@@ -0,0 +1,17 @@
+# Market
+
+## Example Usage
+
+```typescript
+import { Market } from "@compass-labs/api-sdk/models/components";
+
+let value: Market = {
+  uniqueKey: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `uniqueKey`        | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/marketposition.md

@@ -0,0 +1,35 @@
+# MarketPosition
+
+## Example Usage
+
+```typescript
+import { MarketPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: MarketPosition = {
+  market: {
+    uniqueKey: "<value>",
+  },
+  healthFactor: "<value>",
+  priceVariationToLiquidationPrice: "<value>",
+  state: {
+    pnlUsd: "<value>",
+    borrowAssets: "<value>",
+    borrowShares: "<value>",
+    borrowAssetsUsd: "<value>",
+    collateral: "<value>",
+    collateralUsd: "<value>",
+    supplyAssets: "<value>",
+    supplyShares: "<value>",
+    supplyAssetsUsd: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                    | Type                                                                                                                                                                                     | Required                                                                                                                                                                                 | Description                                                                                                                                                                              |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `market`                                                                                                                                                                                 | [components.Market](../../models/components/market.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                       | N/A                                                                                                                                                                                      |
+| `healthFactor`                                                                                                                                                                           | *string*                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                       | N/A                                                                                                                                                                                      |
+| `priceVariationToLiquidationPrice`                                                                                                                                                       | *string*                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                       | N/A                                                                                                                                                                                      |
+| `state`                                                                                                                                                                                  | [components.CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionMarketState](../../models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionmarketstate.md) | :heavy_check_mark:                                                                                                                                                                       | N/A                                                                                                                                                                                      |

package/docs/models/components/markettokens.md

@@ -0,0 +1,50 @@
+# MarketTokens
+
+## Example Usage
+
+```typescript
+import { MarketTokens } from "@compass-labs/api-sdk/models/components";
+
+let value: MarketTokens = {
+  underlyingToken: {
+    address: "46793 Schneider Mount",
+    symbol: "<value>",
+    name: "<value>",
+    decimals: 348593,
+  },
+  sy: {
+    address: "15508 Walnut Close",
+    symbol: "<value>",
+    name: "<value>",
+    decimals: 149197,
+  },
+  pt: {
+    address: "7177 Kirlin Motorway",
+    symbol: "<value>",
+    name: "<value>",
+    decimals: 845477,
+  },
+  yt: {
+    address: "8060 Reilly Underpass",
+    symbol: "<value>",
+    name: "<value>",
+    decimals: 36127,
+  },
+  accountingAsset: {
+    address: "191 Kling Lights",
+    symbol: "<value>",
+    name: "<value>",
+    decimals: 507596,
+  },
+};
+```
+
+## Fields
+
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `underlyingToken`                                            | [components.Erc20Data](../../models/components/erc20data.md) | :heavy_check_mark:                                           | N/A                                                          |
+| `sy`                                                         | [components.Erc20Data](../../models/components/erc20data.md) | :heavy_check_mark:                                           | N/A                                                          |
+| `pt`                                                         | [components.Erc20Data](../../models/components/erc20data.md) | :heavy_check_mark:                                           | N/A                                                          |
+| `yt`                                                         | [components.Erc20Data](../../models/components/erc20data.md) | :heavy_check_mark:                                           | N/A                                                          |
+| `accountingAsset`                                            | [components.Erc20Data](../../models/components/erc20data.md) | :heavy_check_mark:                                           | N/A                                                          |

package/docs/models/components/maxslippagepercent.md

@@ -0,0 +1,19 @@
+# MaxSlippagePercent
+
+Maximum allowed slippage for token swaps in percentage
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/maxsupplyapydata.md

@@ -0,0 +1,24 @@
+# MaxSupplyApyData
+
+Data for the chain with the highest supply APY.
+
+## Example Usage
+
+```typescript
+import { MaxSupplyApyData } from "@compass-labs/api-sdk/models/components";
+
+let value: MaxSupplyApyData = {
+  chain: "<value>",
+  rates: {
+    supplyApyVariableRate: "<value>",
+    borrowApyVariableRate: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `chain`                                                                      | *string*                                                                     | :heavy_check_mark:                                                           | Name of the chain with the highest supply APY (ethereum, base, or arbitrum). |
+| `rates`                                                                      | [components.ChainRateData](../../models/components/chainratedata.md)         | :heavy_check_mark:                                                           | Rate data for a specific chain.                                              |

package/docs/models/components/mintpreparecompletedresponse.md

@@ -0,0 +1,27 @@
+# MintPrepareCompletedResponse
+
+Response when the bridge has already been completed (minted).
+
+This means someone has already called receiveMessage on the destination chain to
+mint the USDC. No further action is required.
+
+## Example Usage
+
+```typescript
+import { MintPrepareCompletedResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: MintPrepareCompletedResponse = {
+  status: "completed",
+  bridgeId: "<id>",
+  message:
+    "Bridge has already been completed. USDC has been minted on the destination chain.",
+};
+```
+
+## Fields
+
+| Field                                                                             | Type                                                                              | Required                                                                          | Description                                                                       | Example                                                                           |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `status`                                                                          | *"completed"*                                                                     | :heavy_check_mark:                                                                | Indicates the bridge has already been completed and USDC minted.                  | completed                                                                         |
+| `bridgeId`                                                                        | *string*                                                                          | :heavy_check_mark:                                                                | The bridge identifier.                                                            |                                                                                   |
+| `message`                                                                         | *string*                                                                          | :heavy_minus_sign:                                                                | Human-readable message explaining the status.                                     | Bridge has already been completed. USDC has been minted on the destination chain. |

package/docs/models/components/mintpreparependingresponse.md

@@ -0,0 +1,33 @@
+# MintPreparePendingResponse
+
+Response when attestation is not yet ready.
+
+Returned with 202 Accepted status code. The client should either:
+- Connect to the SSE stream for real-time updates
+- Poll the status endpoint periodically
+- Call /mint/prepare again after some time
+
+## Example Usage
+
+```typescript
+import { MintPreparePendingResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: MintPreparePendingResponse = {
+  bridgeId: "<id>",
+  messageHash: "<value>",
+  sseUrl: "https://flowery-yogurt.name/",
+  statusUrl: "https://breakable-pupil.info",
+  estimatedWaitSeconds: 35977,
+};
+```
+
+## Fields
+
+| Field                                                                                               | Type                                                                                                | Required                                                                                            | Description                                                                                         | Example                                                                                             |
+| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| `status`                                                                                            | *"pending"*                                                                                         | :heavy_minus_sign:                                                                                  | Indicates the attestation is still being awaited.                                                   | pending                                                                                             |
+| `bridgeId`                                                                                          | *string*                                                                                            | :heavy_check_mark:                                                                                  | The bridge identifier.                                                                              |                                                                                                     |
+| `messageHash`                                                                                       | *string*                                                                                            | :heavy_check_mark:                                                                                  | The CCTP message hash being polled for attestation.                                                 |                                                                                                     |
+| `sseUrl`                                                                                            | *string*                                                                                            | :heavy_check_mark:                                                                                  | SSE endpoint URL for real-time attestation updates.                                                 |                                                                                                     |
+| `statusUrl`                                                                                         | *string*                                                                                            | :heavy_check_mark:                                                                                  | HTTP endpoint URL for polling bridge status.                                                        |                                                                                                     |
+| `estimatedWaitSeconds`                                                                              | *number*                                                                                            | :heavy_check_mark:                                                                                  | Estimated wait time in seconds. Fast mode is typically ~30 seconds, standard mode is 15-19 minutes. |                                                                                                     |

package/docs/models/components/mintpreparereadyresponse.md

@@ -0,0 +1,36 @@
+# MintPrepareReadyResponse
+
+Response when attestation is ready and mint transaction can be built.
+
+Returned with 200 OK status code. Contains an unsigned transaction that calls
+receiveMessage on the MessageTransmitter contract.
+
+## Example Usage
+
+```typescript
+import { MintPrepareReadyResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: MintPrepareReadyResponse = {
+  status: "ready",
+  bridgeId: "<id>",
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      | Example                                                                          |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `status`                                                                         | *"ready"*                                                                        | :heavy_check_mark:                                                               | Indicates the attestation is ready and mint transaction is available.            | ready                                                                            |
+| `bridgeId`                                                                       | *string*                                                                         | :heavy_check_mark:                                                               | The bridge identifier.                                                           |                                                                                  |
+| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark:                                                               | N/A                                                                              |                                                                                  |

package/docs/models/components/mintpreparerequest.md

@@ -0,0 +1,22 @@
+# MintPrepareRequest
+
+## Example Usage
+
+```typescript
+import { MintPrepareRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: MintPrepareRequest = {
+  bridgeId: "br_cae305798062",
+  burnTxHash:
+    "0x42c914b870eacc2c1734420f6ab183f95a5b0e0fdbb1c82247183848b76fc8ad",
+  sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                      | Type                                                                                                                                                       | Required                                                                                                                                                   | Description                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bridgeId`                                                                                                                                                 | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | The bridge identifier returned from /burn endpoint. This is used to look up the bridge session.                                                            |
+| `burnTxHash`                                                                                                                                               | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | The transaction hash of the burn transaction on the source chain. This is used to find the DepositForBurn event and extract the CCTP message.              |
+| `sender`                                                                                                                                                   | *string*                                                                                                                                                   | :heavy_check_mark:                                                                                                                                         | The wallet address that will sign and send the mint transaction. This can be any wallet, the receiver of the minted USDC is not determined by this sender. |

package/docs/models/components/morphoborrowparams.md

@@ -0,0 +1,23 @@
+# MorphoBorrowParams
+
+## Example Usage
+
+```typescript
+import { MorphoBorrowParams } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoBorrowParams = {
+  actionType: "MORPHO_BORROW",
+  amount: 2478.69,
+  uniqueMarketKey: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      | Example                                                                                          |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `actionType`                                                                                     | *"MORPHO_BORROW"*                                                                                | :heavy_check_mark:                                                                               | N/A                                                                                              | MORPHO_BORROW                                                                                    |
+| `amount`                                                                                         | *components.MorphoBorrowParamsAmount*                                                            | :heavy_check_mark:                                                                               | Amount of the token to borrow from the market.                                                   |                                                                                                  |
+| `uniqueMarketKey`                                                                                | *string*                                                                                         | :heavy_check_mark:                                                                               | The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint. |                                                                                                  |
+| `onBehalfOf`                                                                                     | *string*                                                                                         | :heavy_minus_sign:                                                                               | The address where the collateral is borrowed against. Defaults to sender.                        |                                                                                                  |
+| `receiver`                                                                                       | *string*                                                                                         | :heavy_minus_sign:                                                                               | The address of the receiver of the tokens borrowed. Defaults to the transaction sender.          |                                                                                                  |

package/docs/models/components/morphoborrowparamsamount.md

@@ -0,0 +1,19 @@
+# MorphoBorrowParamsAmount
+
+Amount of the token to borrow from the market.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+