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

package/docs/models/components/aavehistoricaltransactionsresponsetransaction.md

@@ -0,0 +1,148 @@
+# AaveHistoricalTransactionsResponseTransaction
+
+
+## Supported Types
+
+### `components.Borrow`
+
+```typescript
+const value: components.Borrow = {
+  id: "<id>",
+  timestamp: 132507,
+  txHash: "<value>",
+  amount: 5726.04,
+  borrowRateMode: 1,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 1060.46,
+  action: "Borrow",
+  block: 644384,
+};
+```
+
+### `components.LiquidationCall`
+
+```typescript
+const value: components.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,
+};
+```
+
+### `components.Withdraw`
+
+```typescript
+const value: components.Withdraw = {
+  id: "<id>",
+  timestamp: 147233,
+  txHash: "<value>",
+  amount: 4842.28,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 7585.27,
+  action: "Withdraw",
+  block: 237308,
+};
+```
+
+### `components.Repay`
+
+```typescript
+const value: components.Repay = {
+  id: "<id>",
+  timestamp: 529023,
+  txHash: "<value>",
+  amount: 9272.21,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 3951.28,
+  action: "Repay",
+  block: 361702,
+};
+```
+
+### `components.Supply`
+
+```typescript
+const value: components.Supply = {
+  id: "<id>",
+  timestamp: 177043,
+  txHash: "<value>",
+  amount: 5023.38,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 2731.57,
+  action: "Supply",
+  block: 626983,
+};
+```
+
+### `components.SwapBorrowRate`
+
+```typescript
+const value: components.SwapBorrowRate = {
+  id: "<id>",
+  timestamp: 661095,
+  txHash: "<value>",
+  borrowRateModeFrom: 740235,
+  borrowRateModeTo: 239047,
+  variableBorrowRate: 179223,
+  stableBorrowRate: 225369,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  action: "SwapBorrowRate",
+  block: 364832,
+};
+```
+
+### `components.UsageAsCollateral`
+
+```typescript
+const value: components.UsageAsCollateral = {
+  id: "<id>",
+  timestamp: 393669,
+  txHash: "<value>",
+  fromState: false,
+  toState: false,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  action: "UsageAsCollateral",
+  block: 936532,
+};
+```
+

package/docs/models/components/aaveliquiditychangeresponse.md

@@ -0,0 +1,21 @@
+# AaveLiquidityChangeResponse
+
+## Example Usage
+
+```typescript
+import { AaveLiquidityChangeResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveLiquidityChangeResponse = {
+  liquidityChange: "<value>",
+  startTime: new Date("2023-12-20T02:39:56.491Z"),
+  endTime: new Date("2023-08-18T07:37:51.082Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `liquidityChange`                                                                             | *string*                                                                                      | :heavy_check_mark:                                                                            | The change in the liquidity index between the two times, expressed as a percentage.           |
+| `startTime`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | Dateime of starting block                                                                     |
+| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | Datetime of ending block                                                                      |

package/docs/models/components/aavelooprequest.md

@@ -0,0 +1,46 @@
+# AaveLoopRequest
+
+Request model for executing an Aave loop strategy.
+
+## Example Usage
+
+```typescript
+import { AaveLoopRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveLoopRequest = {
+  chain: "arbitrum",
+  sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  estimateGas: true,
+  signedAuthorization: {
+    nonce: 1000,
+    address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    chainId: 42161,
+    r: "0x5f9f3f3226ac91bc01a72dd117141f6c6de1ed30d3af9f95c3423316dc21d615",
+    s: "0x78f7982ede9dabc53d7153974c5692fda8a21fc73bdafc42aaf135505e22817c",
+    yParity: 0,
+  },
+  collateralToken: "USDC",
+  borrowToken: "WETH",
+  initialCollateralAmount: "1000",
+  multiplier: "2.5",
+  maxSlippagePercent: "0.5",
+  loanToValue: "60",
+  isAccountAbstraction: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                      | [components.AaveLoopRequestChain](../../models/components/aavelooprequestchain.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                                                                                                                         |
+| `signedAuthorization`                                                                                                        | [components.SignedAuthorization](../../models/components/signedauthorization.md)                                             | :heavy_minus_sign:                                                                                                           | EIP-7702 authorization. Required when `is_account_abstraction` is False.                                                     |                                                                                                                              |
+| `collateralToken`                                                                                                            | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | Symbol or address of token to supply to Aave..                                                                               |                                                                                                                              |
+| `borrowToken`                                                                                                                | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | Symbol or address of token to borrow from Aave..                                                                             |                                                                                                                              |
+| `initialCollateralAmount`                                                                                                    | *components.InitialCollateralAmount*                                                                                         | :heavy_check_mark:                                                                                                           | Amount of collateral token to supply to Aave                                                                                 |                                                                                                                              |
+| `multiplier`                                                                                                                 | *components.Multiplier*                                                                                                      | :heavy_check_mark:                                                                                                           | Leverage multiplier. Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount`                  |                                                                                                                              |
+| `maxSlippagePercent`                                                                                                         | *components.MaxSlippagePercent*                                                                                              | :heavy_check_mark:                                                                                                           | Maximum allowed slippage for token swaps in percentage                                                                       |                                                                                                                              |
+| `loanToValue`                                                                                                                | *components.LoanToValue*                                                                                                     | :heavy_check_mark:                                                                                                           | Loan To Value percentage of the loop                                                                                         |                                                                                                                              |
+| `isAccountAbstraction`                                                                                                       | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Whether to use account abstraction for the transaction.                                                                      | false                                                                                                                        |

package/docs/models/components/aavelooprequestchain.md

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

package/docs/models/components/aaveposition.md

@@ -0,0 +1,25 @@
+# AavePosition
+
+## Example Usage
+
+```typescript
+import { AavePosition } from "@compass-labs/api-sdk/models/components";
+
+let value: AavePosition = {
+  type: "AAVE",
+  id: "<id>",
+  amountInUnderlyingToken: "<value>",
+  tokenName: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  | Example                                                      |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `type`                                                       | *"AAVE"*                                                     | :heavy_check_mark:                                           | The market type discriminator.                               |                                                              |
+| `id`                                                         | *string*                                                     | :heavy_check_mark:                                           | Base64-encoded position identifier.                          |                                                              |
+| `vaultAddress`                                               | *"None"*                                                     | :heavy_minus_sign:                                           | N/A                                                          | None                                                         |
+| `amountInUnderlyingToken`                                    | *string*                                                     | :heavy_check_mark:                                           | The user's position value denominated in the supplied asset. |                                                              |
+| `tokenName`                                                  | *string*                                                     | :heavy_check_mark:                                           | Symbol of the Aave reserve asset (e.g., USDC).               |                                                              |
+| `vaultName`                                                  | *"None"*                                                     | :heavy_minus_sign:                                           | N/A                                                          | None                                                         |

package/docs/models/components/aaverateresponse.md

@@ -0,0 +1,27 @@
+# AaveRateResponse
+
+## Example Usage
+
+```typescript
+import { AaveRateResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveRateResponse = {
+  supplyApyVariableRate: "<value>",
+  supplyAprVariableRate: "<value>",
+  borrowApyVariableRate: "<value>",
+  borrowAprVariableRate: "<value>",
+  borrowApyFixedRate: "<value>",
+  borrowAprFixedRate: "<value>",
+};
+```
+
+## Fields
+
+| Field                           | Type                            | Required                        | Description                     |
+| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
+| `supplyApyVariableRate`         | *string*                        | :heavy_check_mark:              | Variable rate APY for deposits. |
+| `supplyAprVariableRate`         | *string*                        | :heavy_check_mark:              | Variable rate APR for deposits. |
+| `borrowApyVariableRate`         | *string*                        | :heavy_check_mark:              | Variable rate APY for loans.    |
+| `borrowAprVariableRate`         | *string*                        | :heavy_check_mark:              | Variable rate APR for loans.    |
+| `borrowApyFixedRate`            | *string*                        | :heavy_check_mark:              | Fixed rate APY for loans.       |
+| `borrowAprFixedRate`            | *string*                        | :heavy_check_mark:              | Fixed rate APR for loans.       |

package/docs/models/components/aaverepayparams.md

@@ -0,0 +1,24 @@
+# AaveRepayParams
+
+## Example Usage
+
+```typescript
+import { AaveRepayParams } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveRepayParams = {
+  actionType: "AAVE_REPAY",
+  token: "<value>",
+  amount: 734.27,
+  interestRateMode: "stable",
+};
+```
+
+## Fields
+
+| Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              | Example                                                                                                  |
+| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                             | *"AAVE_REPAY"*                                                                                           | :heavy_check_mark:                                                                                       | N/A                                                                                                      | AAVE_REPAY                                                                                               |
+| `token`                                                                                                  | *string*                                                                                                 | :heavy_check_mark:                                                                                       | The symbol of the underlying asset to repay..                                                            |                                                                                                          |
+| `amount`                                                                                                 | *components.AaveRepayParamsAmount*                                                                       | :heavy_check_mark:                                                                                       | The amount of the asset to repay                                                                         |                                                                                                          |
+| `interestRateMode`                                                                                       | [components.InterestRateMode](../../models/components/interestratemode.md)                               | :heavy_check_mark:                                                                                       | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. |                                                                                                          |
+| `onBehalfOf`                                                                                             | *string*                                                                                                 | :heavy_minus_sign:                                                                                       | The address on behalf of whom the supply is made                                                         |                                                                                                          |

package/docs/models/components/aaverepayparamsamount.md

@@ -0,0 +1,19 @@
+# AaveRepayParamsAmount
+
+The amount of the asset to repay
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aaverepayrequest.md

@@ -0,0 +1,29 @@
+# AaveRepayRequest
+
+## Example Usage
+
+```typescript
+import { AaveRepayRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveRepayRequest = {
+  token: "USDC",
+  amount: "0.2",
+  interestRateMode: "variable",
+  onBehalfOf: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
+  chain: "base",
+  sender: "0x3254f3b1918637ba924e3F18968Cb74219974b63",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"AAVE_REPAY"*                                                                                                               | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | AAVE_REPAY                                                                                                                   |
+| `token`                                                                                                                      | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The symbol of the underlying asset to repay..                                                                                |                                                                                                                              |
+| `amount`                                                                                                                     | *components.AaveRepayRequestAmount*                                                                                          | :heavy_check_mark:                                                                                                           | The amount of the asset to repay                                                                                             |                                                                                                                              |
+| `interestRateMode`                                                                                                           | [components.InterestRateMode](../../models/components/interestratemode.md)                                                   | :heavy_check_mark:                                                                                                           | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate.             |                                                                                                                              |
+| `onBehalfOf`                                                                                                                 | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address on behalf of whom the supply is made                                                                             |                                                                                                                              |
+| `chain`                                                                                                                      | [components.AaveRepayRequestChain](../../models/components/aaverepayrequestchain.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/aaverepayrequestamount.md

@@ -0,0 +1,19 @@
+# AaveRepayRequestAmount
+
+The amount of the asset to repay
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aaverepayrequestchain.md

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

package/docs/models/components/aavereserveoverviewresponse.md

@@ -0,0 +1,21 @@
+# AaveReserveOverviewResponse
+
+## Example Usage
+
+```typescript
+import { AaveReserveOverviewResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveReserveOverviewResponse = {
+  tvl: 4647.39,
+  totalBorrowed: 658.65,
+  utilizationRatio: 3833.45,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                     | Type                                                                                                                                      | Required                                                                                                                                  | Description                                                                                                                               |
+| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| `tvl`                                                                                                                                     | *number*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Total tokens supplied in an Aave Reserve in USD. E.G. How much WBTC has been supplied on Aave in USD.                                     |
+| `totalBorrowed`                                                                                                                           | *number*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Total tokens borrowed in an Aave Reserve converted to USD. E.G. How much WBTC has been supplied on Aave (in USD).                         |
+| `utilizationRatio`                                                                                                                        | *number*                                                                                                                                  | :heavy_check_mark:                                                                                                                        | Total borrowed divided by total supplied in an Aave Reserve. E.G. How much WBTC has been borrowed on Aaave divided by the amount supplied |

package/docs/models/components/aavestdrateresponse.md

@@ -0,0 +1,27 @@
+# AaveSTDRateResponse
+
+## Example Usage
+
+```typescript
+import { AaveSTDRateResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveSTDRateResponse = {
+  supplyApyVariableRate: 4033.88,
+  supplyAprVariableRate: 9826.18,
+  borrowApyVariableRate: 9255.45,
+  borrowAprVariableRate: 6487.1,
+  borrowApyFixedRate: 585.35,
+  borrowAprFixedRate: 1220.65,
+};
+```
+
+## Fields
+
+| Field                                                     | Type                                                      | Required                                                  | Description                                               |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `supplyApyVariableRate`                                   | *number*                                                  | :heavy_check_mark:                                        | Standard deviation of the variable rate APY for deposits. |
+| `supplyAprVariableRate`                                   | *number*                                                  | :heavy_check_mark:                                        | Standard deviation of the variable rate APR for deposits. |
+| `borrowApyVariableRate`                                   | *number*                                                  | :heavy_check_mark:                                        | Standard deviation of the variable rate APY for loans.    |
+| `borrowAprVariableRate`                                   | *number*                                                  | :heavy_check_mark:                                        | Standard deviation of the variable rate APR for loans.    |
+| `borrowApyFixedRate`                                      | *number*                                                  | :heavy_check_mark:                                        | Standard deviation of the fixed rate APY for loans.       |
+| `borrowAprFixedRate`                                      | *number*                                                  | :heavy_check_mark:                                        | Standard deviation of the fixed rate APR for loans.       |

package/docs/models/components/aavesupplyparams.md

@@ -0,0 +1,22 @@
+# AaveSupplyParams
+
+## Example Usage
+
+```typescript
+import { AaveSupplyParams } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveSupplyParams = {
+  actionType: "AAVE_SUPPLY",
+  token: "<value>",
+  amount: 4486.99,
+};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        | Example                                                                                            |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                       | *"AAVE_SUPPLY"*                                                                                    | :heavy_check_mark:                                                                                 | N/A                                                                                                | AAVE_SUPPLY                                                                                        |
+| `token`                                                                                            | *string*                                                                                           | :heavy_check_mark:                                                                                 | The symbol or address of the underlying asset to supply as collateral. You can borrow against it.. |                                                                                                    |
+| `amount`                                                                                           | *components.AaveSupplyParamsAmount*                                                                | :heavy_check_mark:                                                                                 | The amount of the asset to supply                                                                  |                                                                                                    |
+| `onBehalfOf`                                                                                       | *string*                                                                                           | :heavy_minus_sign:                                                                                 | The address on behalf of whom the supply is made. Defaults to the transaction sender.              |                                                                                                    |

package/docs/models/components/aavesupplyparamsamount.md

@@ -0,0 +1,19 @@
+# AaveSupplyParamsAmount
+
+The amount of the asset to supply
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aavesupplyrequest.md

@@ -0,0 +1,26 @@
+# AaveSupplyRequest
+
+## Example Usage
+
+```typescript
+import { AaveSupplyRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveSupplyRequest = {
+  token: "USDC",
+  amount: "0.5",
+  chain: "base",
+  sender: "0x466C298e40c57e1DfD364443B364DFB2717BF882",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"AAVE_SUPPLY"*                                                                                                              | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | AAVE_SUPPLY                                                                                                                  |
+| `token`                                                                                                                      | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The symbol or address of the underlying asset to supply as collateral. You can borrow against it..                           |                                                                                                                              |
+| `amount`                                                                                                                     | *components.AaveSupplyRequestAmount*                                                                                         | :heavy_check_mark:                                                                                                           | The amount of the asset to supply                                                                                            |                                                                                                                              |
+| `onBehalfOf`                                                                                                                 | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address on behalf of whom the supply is made. Defaults to the transaction sender.                                        |                                                                                                                              |
+| `chain`                                                                                                                      | [components.AaveSupplyRequestChain](../../models/components/aavesupplyrequestchain.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/aavesupplyrequestamount.md

@@ -0,0 +1,19 @@
+# AaveSupplyRequestAmount
+
+The amount of the asset to supply
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/aavesupplyrequestchain.md

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

package/docs/models/components/aavesupportedtokenmetadata.md

@@ -0,0 +1,23 @@
+# AaveSupportedTokenMetadata
+
+## Example Usage
+
+```typescript
+import { AaveSupportedTokenMetadata } from "@compass-labs/api-sdk/models/components";
+
+let value: AaveSupportedTokenMetadata = {
+  symbol: "<value>",
+  address: "234 Devonshire Road",
+  supplyingEnabled: true,
+  borrowingEnabled: true,
+};
+```
+
+## Fields
+
+| Field                                        | Type                                         | Required                                     | Description                                  |
+| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
+| `symbol`                                     | *string*                                     | :heavy_check_mark:                           | Token symbol (e.g., 'WETH', 'DAI').          |
+| `address`                                    | *string*                                     | :heavy_check_mark:                           | Token contract address.                      |
+| `supplyingEnabled`                           | *boolean*                                    | :heavy_check_mark:                           | Whether the token can be used as collateral. |
+| `borrowingEnabled`                           | *boolean*                                    | :heavy_check_mark:                           | Whether the token can be borrowed.           |