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

package/docs/models/components/uniswapwithdrawliquidityprovisionrequest.md

@@ -0,0 +1,25 @@
+# UniswapWithdrawLiquidityProvisionRequest
+
+## Example Usage
+
+```typescript
+import { UniswapWithdrawLiquidityProvisionRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: UniswapWithdrawLiquidityProvisionRequest = {
+  tokenId: 3432182,
+  percentageForWithdrawal: 1,
+  chain: "base",
+  sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                | Type                                                                                                                                 | Required                                                                                                                             | Description                                                                                                                          | Example                                                                                                                              |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `actionType`                                                                                                                         | *"UNISWAP_WITHDRAW_LIQUIDITY_PROVISION"*                                                                                             | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  | UNISWAP_WITHDRAW_LIQUIDITY_PROVISION                                                                                                 |
+| `tokenId`                                                                                                                            | *number*                                                                                                                             | :heavy_check_mark:                                                                                                                   | Token ID of the NFT representing the liquidity provisioned position.                                                                 |                                                                                                                                      |
+| `percentageForWithdrawal`                                                                                                            | *components.UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal*                                                         | :heavy_check_mark:                                                                                                                   | How much liquidity to take out in percentage.                                                                                        |                                                                                                                                      |
+| `chain`                                                                                                                              | [components.UniswapWithdrawLiquidityProvisionRequestChain](../../models/components/uniswapwithdrawliquidityprovisionrequestchain.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/uniswapwithdrawliquidityprovisionrequestchain.md

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

package/docs/models/components/uniswapwithdrawliquidityprovisionrequestpercentageforwithdrawal.md

@@ -0,0 +1,19 @@
+# UniswapWithdrawLiquidityProvisionRequestPercentageForWithdrawal
+
+How much liquidity to take out in percentage.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/unsignedmulticalltransaction.md

@@ -0,0 +1,35 @@
+# UnsignedMulticallTransaction
+
+## Example Usage
+
+```typescript
+import { UnsignedMulticallTransaction } from "@compass-labs/api-sdk/models/components";
+
+let value: UnsignedMulticallTransaction = {
+  chainId: "<id>",
+  data: "<value>",
+  from: "<value>",
+  gas: "<value>",
+  to: "<value>",
+  value: "<value>",
+  nonce: "<value>",
+  maxFeePerGas: "<value>",
+  maxPriorityFeePerGas: "<value>",
+  authorizationList: [],
+};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        | Example                                                                            |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `chainId`                                                                          | *string*                                                                           | :heavy_check_mark:                                                                 | The chain id of the transaction                                                    |                                                                                    |
+| `data`                                                                             | *string*                                                                           | :heavy_check_mark:                                                                 | The data of the transaction                                                        |                                                                                    |
+| `from`                                                                             | *string*                                                                           | :heavy_check_mark:                                                                 | The sender of the transaction                                                      |                                                                                    |
+| `gas`                                                                              | *string*                                                                           | :heavy_check_mark:                                                                 | The gas of the transaction                                                         |                                                                                    |
+| `to`                                                                               | *string*                                                                           | :heavy_check_mark:                                                                 | The recipient of the transaction                                                   |                                                                                    |
+| `value`                                                                            | *string*                                                                           | :heavy_check_mark:                                                                 | The value of the transaction                                                       |                                                                                    |
+| `nonce`                                                                            | *string*                                                                           | :heavy_check_mark:                                                                 | The nonce of the address                                                           |                                                                                    |
+| `maxFeePerGas`                                                                     | *string*                                                                           | :heavy_check_mark:                                                                 | The max fee per gas of the transaction                                             |                                                                                    |
+| `maxPriorityFeePerGas`                                                             | *string*                                                                           | :heavy_check_mark:                                                                 | The max priority fee per gas of the transaction                                    |                                                                                    |
+| `authorizationList`                                                                | [components.SignedAuthorization](../../models/components/signedauthorization.md)[] | :heavy_minus_sign:                                                                 | EIP-7702 authorization                                                             | []                                                                                 |

package/docs/models/components/unsignedtransaction.md

@@ -0,0 +1,33 @@
+# UnsignedTransaction
+
+## Example Usage
+
+```typescript
+import { UnsignedTransaction } from "@compass-labs/api-sdk/models/components";
+
+let value: UnsignedTransaction = {
+  chainId: "<id>",
+  data: "<value>",
+  from: "<value>",
+  gas: null,
+  to: "<value>",
+  value: "<value>",
+  nonce: "<value>",
+  maxFeePerGas: "<value>",
+  maxPriorityFeePerGas: "<value>",
+};
+```
+
+## Fields
+
+| Field                                           | Type                                            | Required                                        | Description                                     |
+| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
+| `chainId`                                       | *string*                                        | :heavy_check_mark:                              | The chain id of the transaction                 |
+| `data`                                          | *string*                                        | :heavy_check_mark:                              | The data of the transaction                     |
+| `from`                                          | *string*                                        | :heavy_check_mark:                              | The sender of the transaction                   |
+| `gas`                                           | *string*                                        | :heavy_check_mark:                              | The gas of the transaction                      |
+| `to`                                            | *string*                                        | :heavy_check_mark:                              | The recipient of the transaction                |
+| `value`                                         | *string*                                        | :heavy_check_mark:                              | The value of the transaction                    |
+| `nonce`                                         | *string*                                        | :heavy_check_mark:                              | The nonce of the address                        |
+| `maxFeePerGas`                                  | *string*                                        | :heavy_check_mark:                              | The max fee per gas of the transaction          |
+| `maxPriorityFeePerGas`                          | *string*                                        | :heavy_check_mark:                              | The max priority fee per gas of the transaction |

package/docs/models/components/unwrapwethparams.md

@@ -0,0 +1,21 @@
+# UnwrapWethParams
+
+Parameters model for unwrapping WETH back to native ETH.
+
+## Example Usage
+
+```typescript
+import { UnwrapWethParams } from "@compass-labs/api-sdk/models/components";
+
+let value: UnwrapWethParams = {
+  actionType: "UNWRAP_WETH",
+  amount: 1365.33,
+};
+```
+
+## Fields
+
+| Field                               | Type                                | Required                            | Description                         | Example                             |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| `actionType`                        | *"UNWRAP_WETH"*                     | :heavy_check_mark:                  | N/A                                 | UNWRAP_WETH                         |
+| `amount`                            | *components.UnwrapWethParamsAmount* | :heavy_check_mark:                  | The amount of WETH to unwrap.       |                                     |

package/docs/models/components/unwrapwethparamsamount.md

@@ -0,0 +1,19 @@
+# UnwrapWethParamsAmount
+
+The amount of WETH to unwrap.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/unwrapwethrequest.md

@@ -0,0 +1,25 @@
+# UnwrapWethRequest
+
+Request model for unwrapping WETH back to native ETH.
+
+## Example Usage
+
+```typescript
+import { UnwrapWethRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: UnwrapWethRequest = {
+  amount: "0.00004",
+  chain: "base",
+  sender: "0x0E9E8986823aF26F6b18702C31AfF6a10C1e9E7A",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"UNWRAP_WETH"*                                                                                                              | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | UNWRAP_WETH                                                                                                                  |
+| `amount`                                                                                                                     | *components.UnwrapWethRequestAmount*                                                                                         | :heavy_check_mark:                                                                                                           | The amount of WETH to unwrap.                                                                                                |                                                                                                                              |
+| `chain`                                                                                                                      | [components.UnwrapWethRequestChain](../../models/components/unwrapwethrequestchain.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/unwrapwethrequestamount.md

@@ -0,0 +1,19 @@
+# UnwrapWethRequestAmount
+
+The amount of WETH to unwrap.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/unwrapwethrequestchain.md

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

package/docs/models/components/usageascollateral.md

@@ -0,0 +1,35 @@
+# UsageAsCollateral
+
+## Example Usage
+
+```typescript
+import { UsageAsCollateral } from "@compass-labs/api-sdk/models/components";
+
+let value: UsageAsCollateral = {
+  id: "<id>",
+  timestamp: 393669,
+  txHash: "<value>",
+  fromState: false,
+  toState: false,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  action: "UsageAsCollateral",
+  block: 936532,
+};
+```
+
+## 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 |
+| `fromState`                                                            | *boolean*                                                              | :heavy_check_mark:                                                     | N/A                                                                    |
+| `toState`                                                              | *boolean*                                                              | :heavy_check_mark:                                                     | N/A                                                                    |
+| `reserve`                                                              | [components.Reserve](../../models/components/reserve.md)               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `action`                                                               | *"UsageAsCollateral"*                                                  | :heavy_check_mark:                                                     | The type of transaction                                                |
+| `block`                                                                | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |

package/docs/models/components/useroperation.md

@@ -0,0 +1,21 @@
+# UserOperation
+
+## Example Usage
+
+```typescript
+import { UserOperation } from "@compass-labs/api-sdk/models/components";
+
+let value: UserOperation = {
+  body: {
+    actionType: "MORPHO_DEPOSIT",
+    vaultAddress: "<value>",
+    amount: 4096.99,
+  },
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `body`             | *components.Body*  | :heavy_check_mark: | N/A                |

package/docs/models/components/useroperationresponse.md

@@ -0,0 +1,21 @@
+# UserOperationResponse
+
+## Example Usage
+
+```typescript
+import { UserOperationResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: UserOperationResponse = {
+  to: "<value>",
+  data: "<value>",
+  value: "<value>",
+};
+```
+
+## Fields
+
+| Field                                         | Type                                          | Required                                      | Description                                   |
+| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
+| `to`                                          | *string*                                      | :heavy_check_mark:                            | The target contract address for the operation |
+| `data`                                        | *string*                                      | :heavy_check_mark:                            | The calldata for the operation                |
+| `value`                                       | *string*                                      | :heavy_check_mark:                            | The ETH value to send with the operation      |

package/docs/models/components/userposition.md

@@ -0,0 +1,30 @@
+# UserPosition
+
+
+## Supported Types
+
+### `components.AavePosition`
+
+```typescript
+const value: components.AavePosition = {
+  type: "AAVE",
+  id: "<id>",
+  amountInUnderlyingToken: "<value>",
+  tokenName: "<value>",
+};
+```
+
+### `components.CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition`
+
+```typescript
+const value:
+  components.CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition = {
+    type: "VAULT",
+    id: "<id>",
+    vaultAddress: "<value>",
+    amountInUnderlyingToken: "<value>",
+    tokenName: "<value>",
+    vaultName: "<value>",
+  };
+```
+

package/docs/models/components/userstate.md

@@ -0,0 +1,27 @@
+# UserState
+
+## Example Usage
+
+```typescript
+import { UserState } from "@compass-labs/api-sdk/models/components";
+
+let value: UserState = {
+  vaultsPnlUsd: "<value>",
+  vaultsAssetsUsd: "<value>",
+  marketsPnlUsd: "<value>",
+  marketsBorrowAssetsUsd: "<value>",
+  marketsCollateralUsd: "<value>",
+  marketsSupplyAssetsUsd: "<value>",
+};
+```
+
+## Fields
+
+| Field                    | Type                     | Required                 | Description              |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+| `vaultsPnlUsd`           | *string*                 | :heavy_check_mark:       | N/A                      |
+| `vaultsAssetsUsd`        | *string*                 | :heavy_check_mark:       | N/A                      |
+| `marketsPnlUsd`          | *string*                 | :heavy_check_mark:       | N/A                      |
+| `marketsBorrowAssetsUsd` | *string*                 | :heavy_check_mark:       | N/A                      |
+| `marketsCollateralUsd`   | *string*                 | :heavy_check_mark:       | N/A                      |
+| `marketsSupplyAssetsUsd` | *string*                 | :heavy_check_mark:       | N/A                      |

package/docs/models/components/validationerror.md

@@ -0,0 +1,23 @@
+# ValidationError
+
+## Example Usage
+
+```typescript
+import { ValidationError } from "@compass-labs/api-sdk/models/components";
+
+let value: ValidationError = {
+  loc: [
+    929957,
+  ],
+  msg: "<value>",
+  type: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `loc`              | *components.Loc*[] | :heavy_check_mark: | N/A                |
+| `msg`              | *string*           | :heavy_check_mark: | N/A                |
+| `type`             | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/vault.md

@@ -0,0 +1,47 @@
+# Vault
+
+## Example Usage
+
+```typescript
+import { Vault } from "@compass-labs/api-sdk/models/components";
+
+let value: Vault = {
+  address: "777 Legros Union",
+  name: "<value>",
+  symbol: "<value>",
+  whitelisted: false,
+  asset: {
+    name: "<value>",
+    symbol: "<value>",
+    address: "47326 Grange Avenue",
+    decimals: 871956,
+    priceUsd: "<value>",
+    logoURI: "https://favorable-morbidity.net",
+  },
+  dailyApys: {
+    apy: "<value>",
+    netApy: "<value>",
+  },
+  weeklyApys: {
+    apy: "<value>",
+    netApy: "<value>",
+  },
+  monthlyApys: {
+    apy: "<value>",
+    netApy: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                            | Type                                                                                                                                                                             | Required                                                                                                                                                                         | Description                                                                                                                                                                      |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `address`                                                                                                                                                                        | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `name`                                                                                                                                                                           | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `symbol`                                                                                                                                                                         | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `whitelisted`                                                                                                                                                                    | *boolean*                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `asset`                                                                                                                                                                          | [components.CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionAsset](../../models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionasset.md)     | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `dailyApys`                                                                                                                                                                      | [components.CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionApyData](../../models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionapydata.md) | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `weeklyApys`                                                                                                                                                                     | [components.CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionApyData](../../models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionapydata.md) | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `monthlyApys`                                                                                                                                                                    | [components.CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionApyData](../../models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionapydata.md) | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |

package/docs/models/components/vaultdepositparams.md

@@ -0,0 +1,22 @@
+# VaultDepositParams
+
+## Example Usage
+
+```typescript
+import { VaultDepositParams } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultDepositParams = {
+  actionType: "VAULT_DEPOSIT",
+  vaultAddress: "<value>",
+  amount: 5966,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                             | Type                                                                                                                                              | Required                                                                                                                                          | Description                                                                                                                                       | Example                                                                                                                                           |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                                      | *"VAULT_DEPOSIT"*                                                                                                                                 | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               | VAULT_DEPOSIT                                                                                                                                     |
+| `vaultAddress`                                                                                                                                    | *string*                                                                                                                                          | :heavy_check_mark:                                                                                                                                | The vault address you are depositing to.                                                                                                          |                                                                                                                                                   |
+| `amount`                                                                                                                                          | *components.VaultDepositParamsAmount*                                                                                                             | :heavy_check_mark:                                                                                                                                | The amount of tokens to deposit into the vault.                                                                                                   |                                                                                                                                                   |
+| `receiver`                                                                                                                                        | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender. |                                                                                                                                                   |

package/docs/models/components/vaultdepositparamsamount.md

@@ -0,0 +1,19 @@
+# VaultDepositParamsAmount
+
+The amount of tokens to deposit into the vault.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/vaultdepositrequest.md

@@ -0,0 +1,26 @@
+# VaultDepositRequest
+
+## Example Usage
+
+```typescript
+import { VaultDepositRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultDepositRequest = {
+  vaultAddress: "0xfdB431E661372fA1146efB70bf120ECDed944a78",
+  amount: 0.5,
+  chain: "base",
+  sender: "0x38EBf6c7D836f476cEE7DD093Ca43Bbc08e4Cc91",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                             | Type                                                                                                                                              | Required                                                                                                                                          | Description                                                                                                                                       | Example                                                                                                                                           |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                                      | *"VAULT_DEPOSIT"*                                                                                                                                 | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               | VAULT_DEPOSIT                                                                                                                                     |
+| `vaultAddress`                                                                                                                                    | *string*                                                                                                                                          | :heavy_check_mark:                                                                                                                                | The vault address you are depositing to.                                                                                                          |                                                                                                                                                   |
+| `amount`                                                                                                                                          | *components.VaultDepositRequestAmount*                                                                                                            | :heavy_check_mark:                                                                                                                                | The amount of tokens to deposit into the vault.                                                                                                   |                                                                                                                                                   |
+| `receiver`                                                                                                                                        | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender. |                                                                                                                                                   |
+| `chain`                                                                                                                                           | [components.VaultDepositRequestChain](../../models/components/vaultdepositrequestchain.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/vaultdepositrequestamount.md

@@ -0,0 +1,19 @@
+# VaultDepositRequestAmount
+
+The amount of tokens to deposit into the vault.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/vaultdepositrequestchain.md

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