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

package/docs/models/components/vaultgetvaultresponse.md

@@ -0,0 +1,42 @@
+# VaultGetVaultResponse
+
+## Example Usage
+
+```typescript
+import { VaultGetVaultResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultGetVaultResponse = {
+  name: "<value>",
+  symbol: "<value>",
+  decimals: 345654,
+  totalAssets: "<value>",
+  totalSupply: "<value>",
+  sharePrice: "<value>",
+  underlyingToken: {
+    address: "90228 Bosco Shoals",
+    name: "<value>",
+    symbol: "<value>",
+    decimals: 84128,
+  },
+  apy: {
+    current: "<value>",
+    apy1Day: "<value>",
+    apy7Day: "<value>",
+    apy30Day: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                              | Type                                                                                                                                                               | Required                                                                                                                                                           | Description                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `name`                                                                                                                                                             | *string*                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                 | Name of the vault.                                                                                                                                                 |
+| `symbol`                                                                                                                                                           | *string*                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                 | Symbol of the vault.                                                                                                                                               |
+| `decimals`                                                                                                                                                         | *number*                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                 | Number of decimals used for the vault's share precision.                                                                                                           |
+| `totalAssets`                                                                                                                                                      | *string*                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                 | Total amount of assets deposited in the vault.                                                                                                                     |
+| `totalSupply`                                                                                                                                                      | *string*                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                 | Total amount of shares issued from the vault.                                                                                                                      |
+| `sharePrice`                                                                                                                                                       | *string*                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                 | The price of one vault share in terms of the underlying asset.                                                                                                     |
+| `underlyingToken`                                                                                                                                                  | [components.UnderlyingToken](../../models/components/underlyingtoken.md)                                                                                           | :heavy_check_mark:                                                                                                                                                 | N/A                                                                                                                                                                |
+| `apy`                                                                                                                                                              | [components.Apy](../../models/components/apy.md)                                                                                                                   | :heavy_check_mark:                                                                                                                                                 | N/A                                                                                                                                                                |
+| `userPosition`                                                                                                                                                     | [components.CompassApiBackendV1ModelsVaultsReadResponseVaultUserPosition](../../models/components/compassapibackendv1modelsvaultsreadresponsevaultuserposition.md) | :heavy_minus_sign:                                                                                                                                                 | The user's position in the vault.                                                                                                                                  |

package/docs/models/components/vaultinfo.md

@@ -0,0 +1,57 @@
+# VaultInfo
+
+Information about a single DeFi vault.
+
+## Example Usage
+
+```typescript
+import { VaultInfo } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultInfo = {
+  name: "<value>",
+  address: "83955 Gerlach Mount",
+  protocol: "<value>",
+  denomination: "<value>",
+  shareToken: "<value>",
+  stablecoinish: true,
+};
+```
+
+## Fields
+
+| Field                                                    | Type                                                     | Required                                                 | Description                                              |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `id`                                                     | *string*                                                 | :heavy_minus_sign:                                       | Unique vault identifier.                                 |
+| `name`                                                   | *string*                                                 | :heavy_check_mark:                                       | The name of the vault.                                   |
+| `address`                                                | *string*                                                 | :heavy_check_mark:                                       | The vault contract address.                              |
+| `protocol`                                               | *string*                                                 | :heavy_check_mark:                                       | The DeFi protocol name.                                  |
+| `chain`                                                  | *string*                                                 | :heavy_minus_sign:                                       | Blockchain name (e.g., 'ethereum', 'base').              |
+| `chainId`                                                | *number*                                                 | :heavy_minus_sign:                                       | Blockchain chain ID.                                     |
+| `denomination`                                           | *string*                                                 | :heavy_check_mark:                                       | The denomination token symbol (underlying asset).        |
+| `shareToken`                                             | *string*                                                 | :heavy_check_mark:                                       | The vault share token symbol.                            |
+| `stablecoinish`                                          | *boolean*                                                | :heavy_check_mark:                                       | Whether the vault is denominated in a stablecoin.        |
+| `lifetimeReturn`                                         | *string*                                                 | :heavy_minus_sign:                                       | Total lifetime return as a decimal (e.g., 0.093 = 9.3%). |
+| `lifetimeReturnNet`                                      | *string*                                                 | :heavy_minus_sign:                                       | Total lifetime return after fees as a decimal.           |
+| `cagr`                                                   | *string*                                                 | :heavy_minus_sign:                                       | Compound Annual Growth Rate as a decimal.                |
+| `cagrNet`                                                | *string*                                                 | :heavy_minus_sign:                                       | Compound Annual Growth Rate after fees as a decimal.     |
+| `threeMonthsReturns`                                     | *string*                                                 | :heavy_minus_sign:                                       | 3-month returns as a decimal.                            |
+| `threeMonthsReturnsNet`                                  | *string*                                                 | :heavy_minus_sign:                                       | 3-month returns after fees as a decimal.                 |
+| `threeMonthsCagr`                                        | *string*                                                 | :heavy_minus_sign:                                       | 3-month CAGR as a decimal.                               |
+| `threeMonthsCagrNet`                                     | *string*                                                 | :heavy_minus_sign:                                       | 3-month CAGR after fees as a decimal.                    |
+| `threeMonthsSharpe`                                      | *string*                                                 | :heavy_minus_sign:                                       | 3-month Sharpe ratio.                                    |
+| `threeMonthsSharpeNet`                                   | *string*                                                 | :heavy_minus_sign:                                       | 3-month Sharpe ratio after fees.                         |
+| `threeMonthsVolatility`                                  | *string*                                                 | :heavy_minus_sign:                                       | 3-month volatility.                                      |
+| `oneMonthReturns`                                        | *string*                                                 | :heavy_minus_sign:                                       | 1-month returns as a decimal.                            |
+| `oneMonthReturnsNet`                                     | *string*                                                 | :heavy_minus_sign:                                       | 1-month returns after fees as a decimal.                 |
+| `oneMonthCagr`                                           | *string*                                                 | :heavy_minus_sign:                                       | 1-month CAGR as a decimal.                               |
+| `oneMonthCagrNet`                                        | *string*                                                 | :heavy_minus_sign:                                       | 1-month CAGR after fees as a decimal.                    |
+| `currentNav`                                             | *string*                                                 | :heavy_minus_sign:                                       | Current Net Asset Value in denomination token.           |
+| `peakNav`                                                | *string*                                                 | :heavy_minus_sign:                                       | Peak Net Asset Value in denomination token.              |
+| `feeLabel`                                               | *string*                                                 | :heavy_minus_sign:                                       | Human-readable fee structure label.                      |
+| `managementFee`                                          | *string*                                                 | :heavy_minus_sign:                                       | Management fee as a decimal.                             |
+| `performanceFee`                                         | *string*                                                 | :heavy_minus_sign:                                       | Performance fee as a decimal.                            |
+| `depositFee`                                             | *string*                                                 | :heavy_minus_sign:                                       | Deposit fee as a decimal.                                |
+| `withdrawFee`                                            | *string*                                                 | :heavy_minus_sign:                                       | Withdrawal fee as a decimal.                             |
+| `years`                                                  | *string*                                                 | :heavy_minus_sign:                                       | Age of the vault in years.                               |
+| `eventCount`                                             | *number*                                                 | :heavy_minus_sign:                                       | Number of events/transactions in the vault.              |
+| `features`                                               | *string*[]                                               | :heavy_minus_sign:                                       | List of vault features and capabilities.                 |

package/docs/models/components/vaultslistresponse.md

@@ -0,0 +1,25 @@
+# VaultsListResponse
+
+Response model for a paginated list of DeFi vaults.
+
+## Example Usage
+
+```typescript
+import { VaultsListResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultsListResponse = {
+  total: 885806,
+  offset: 592454,
+  limit: 325,
+  vaults: [],
+};
+```
+
+## Fields
+
+| Field                                                          | Type                                                           | Required                                                       | Description                                                    |
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
+| `total`                                                        | *number*                                                       | :heavy_check_mark:                                             | N/A                                                            |
+| `offset`                                                       | *number*                                                       | :heavy_check_mark:                                             | N/A                                                            |
+| `limit`                                                        | *number*                                                       | :heavy_check_mark:                                             | N/A                                                            |
+| `vaults`                                                       | [components.VaultInfo](../../models/components/vaultinfo.md)[] | :heavy_check_mark:                                             | A list of vault information objects.                           |

package/docs/models/components/vaultvenue.md

@@ -0,0 +1,19 @@
+# VaultVenue
+
+## Example Usage
+
+```typescript
+import { VaultVenue } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultVenue = {
+  type: "VAULT",
+  vaultAddress: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                       | Type                                                        | Required                                                    | Description                                                 |
+| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
+| `type`                                                      | *"VAULT"*                                                   | :heavy_check_mark:                                          | The venue type discriminator.                               |
+| `vaultAddress`                                              | *string*                                                    | :heavy_check_mark:                                          | The vault address you are interacting with for this action. |

package/docs/models/components/vaultwithdrawparams.md

@@ -0,0 +1,22 @@
+# VaultWithdrawParams
+
+## Example Usage
+
+```typescript
+import { VaultWithdrawParams } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultWithdrawParams = {
+  actionType: "VAULT_WITHDRAW",
+  vaultAddress: "<value>",
+  amount: "242.69",
+};
+```
+
+## Fields
+
+| Field                                                                                                                  | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            | Example                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                           | *"VAULT_WITHDRAW"*                                                                                                     | :heavy_check_mark:                                                                                                     | N/A                                                                                                                    | VAULT_WITHDRAW                                                                                                         |
+| `vaultAddress`                                                                                                         | *string*                                                                                                               | :heavy_check_mark:                                                                                                     | The vault address you are withdrawing from.                                                                            |                                                                                                                        |
+| `amount`                                                                                                               | *any*                                                                                                                  | :heavy_check_mark:                                                                                                     | The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn. |                                                                                                                        |
+| `receiver`                                                                                                             | *string*                                                                                                               | :heavy_minus_sign:                                                                                                     | The address which will receive the tokens withdrawn. Defaults to the sender.                                           |                                                                                                                        |

package/docs/models/components/vaultwithdrawrequest.md

@@ -0,0 +1,26 @@
+# VaultWithdrawRequest
+
+## Example Usage
+
+```typescript
+import { VaultWithdrawRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: VaultWithdrawRequest = {
+  vaultAddress: "0xfdB431E661372fA1146efB70bf120ECDed944a78",
+  amount: "ALL",
+  chain: "base",
+  sender: "0x52680FEe4CC87AFB748F98F9B2f8D80190b8EF2c",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"VAULT_WITHDRAW"*                                                                                                           | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | VAULT_WITHDRAW                                                                                                               |
+| `vaultAddress`                                                                                                               | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The vault address you are withdrawing from.                                                                                  |                                                                                                                              |
+| `amount`                                                                                                                     | *any*                                                                                                                        | :heavy_check_mark:                                                                                                           | The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.       |                                                                                                                              |
+| `receiver`                                                                                                                   | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address which will receive the tokens withdrawn. Defaults to the sender.                                                 |                                                                                                                              |
+| `chain`                                                                                                                      | [components.VaultWithdrawRequestChain](../../models/components/vaultwithdrawrequestchain.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/vaultwithdrawrequestchain.md

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

package/docs/models/components/venue.md

@@ -0,0 +1,25 @@
+# Venue
+
+The earn venue.
+
+
+## Supported Types
+
+### `components.AaveVenue`
+
+```typescript
+const value: components.AaveVenue = {
+  type: "AAVE",
+  token: "<value>",
+};
+```
+
+### `components.VaultVenue`
+
+```typescript
+const value: components.VaultVenue = {
+  type: "VAULT",
+  vaultAddress: "<value>",
+};
+```
+

package/docs/models/components/weeklyapys.md

@@ -0,0 +1,23 @@
+# WeeklyApys
+
+## Example Usage
+
+```typescript
+import { WeeklyApys } from "@compass-labs/api-sdk/models/components";
+
+let value: WeeklyApys = {
+  supplyApy: 8739.48,
+  netSupplyApy: 2421.52,
+  borrowApy: 6085.23,
+  netBorrowApy: 4010.96,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `supplyApy`        | *number*           | :heavy_check_mark: | N/A                |
+| `netSupplyApy`     | *number*           | :heavy_check_mark: | N/A                |
+| `borrowApy`        | *number*           | :heavy_check_mark: | N/A                |
+| `netBorrowApy`     | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/components/wildcatgetmarketresponse.md

@@ -0,0 +1,57 @@
+# WildcatGetMarketResponse
+
+## Example Usage
+
+```typescript
+import { WildcatGetMarketResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: WildcatGetMarketResponse = {
+  marketAddress: "<value>",
+  name: "<value>",
+  symbol: "<value>",
+  decimals: 410793,
+  availableToLend: "<value>",
+  loaned: "<value>",
+  maxBorrowingCapacity: "<value>",
+  grossInterestAccrued: "<value>",
+  minimumDeposit: "<value>",
+  minimumReserveRatio: "<value>",
+  baseLenderApr: "<value>",
+  protocolFeeApr: "<value>",
+  effectiveLenderApr: "<value>",
+  penaltyApr: "<value>",
+  maximumGracePeriod: 39534,
+  availableGracePeriod: 150479,
+  withdrawalCycleDuration: 88031,
+  underlyingToken: {
+    address: "90228 Bosco Shoals",
+    name: "<value>",
+    symbol: "<value>",
+    decimals: 84128,
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                            | Type                                                                                                                                                                             | Required                                                                                                                                                                         | Description                                                                                                                                                                      |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `marketAddress`                                                                                                                                                                  | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The address of the market.                                                                                                                                                       |
+| `name`                                                                                                                                                                           | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | Name of the vault.                                                                                                                                                               |
+| `symbol`                                                                                                                                                                         | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | Symbol of the vault.                                                                                                                                                             |
+| `decimals`                                                                                                                                                                       | *number*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | Number of decimals used for the vault's share precision.                                                                                                                         |
+| `availableToLend`                                                                                                                                                                | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The borrower's remaining available credit.                                                                                                                                       |
+| `loaned`                                                                                                                                                                         | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The total value of all funds supplied by lenders, including interest.                                                                                                            |
+| `maxBorrowingCapacity`                                                                                                                                                           | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The maximum limit of funds that borrowers can access in the market.                                                                                                              |
+| `grossInterestAccrued`                                                                                                                                                           | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The total gross interest generated by the loan before being split between lenders, reserves, and protocol fees.                                                                  |
+| `minimumDeposit`                                                                                                                                                                 | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The minimum amount of underlying asset required for a single deposit transaction.                                                                                                |
+| `minimumReserveRatio`                                                                                                                                                            | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | A required percentage of market funds that must remain liquid and unavailable for borrowing.                                                                                     |
+| `baseLenderApr`                                                                                                                                                                  | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The fixed annual percentage rate (excluding any protocol fees) that borrowers pay to lenders for assets within the market.                                                       |
+| `protocolFeeApr`                                                                                                                                                                 | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | An additional APR that accrues to the protocol by slowly increasing required reserves. Derived by the fee configuration of the protocol as a percentage of the current base APR. |
+| `effectiveLenderApr`                                                                                                                                                             | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The current interest rate being paid to lenders: the base APR plus penalty APR if applicable.                                                                                    |
+| `penaltyApr`                                                                                                                                                                     | *string*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | An additional interest rate charged if the market remains delinquent—failing to maintain required reserves—after the grace period has elapsed.                                   |
+| `maximumGracePeriod`                                                                                                                                                             | *number*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The number of seconds borrowers have to resolve reserve deficiencies or correct delinquency in the market before penalties take effect.                                          |
+| `availableGracePeriod`                                                                                                                                                           | *number*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The portion of the grace period left for borrowers to fix non-compliance issues, such as restoring reserves.                                                                     |
+| `withdrawalCycleDuration`                                                                                                                                                        | *number*                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                               | The number of seconds for which withdrawal requests are grouped and processed.                                                                                                   |
+| `underlyingToken`                                                                                                                                                                | [components.UnderlyingToken](../../models/components/underlyingtoken.md)                                                                                                         | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |
+| `userPosition`                                                                                                                                                                   | [components.CompassApiBackendV1ModelsWildcatReadResponseMarketUserPosition](../../models/components/compassapibackendv1modelswildcatreadresponsemarketuserposition.md)           | :heavy_minus_sign:                                                                                                                                                               | The user's position in the vault.                                                                                                                                                |

package/docs/models/components/withdraw.md

@@ -0,0 +1,35 @@
+# Withdraw
+
+## Example Usage
+
+```typescript
+import { Withdraw } from "@compass-labs/api-sdk/models/components";
+
+let value: Withdraw = {
+  id: "<id>",
+  timestamp: 147233,
+  txHash: "<value>",
+  amount: 4842.28,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 7585.27,
+  action: "Withdraw",
+  block: 237308,
+};
+```
+
+## 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 |
+| `amount`                                                               | *number*                                                               | :heavy_check_mark:                                                     | Quantity of token                                                      |
+| `reserve`                                                              | [components.Reserve](../../models/components/reserve.md)               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `assetPriceUSD`                                                        | *number*                                                               | :heavy_check_mark:                                                     | Price of token in USD                                                  |
+| `action`                                                               | *"Withdraw"*                                                           | :heavy_check_mark:                                                     | The type of transaction                                                |
+| `block`                                                                | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |

package/docs/models/components/wrapethparams.md

@@ -0,0 +1,21 @@
+# WrapEthParams
+
+Parameters model for wrapping ETH into WETH.
+
+## Example Usage
+
+```typescript
+import { WrapEthParams } from "@compass-labs/api-sdk/models/components";
+
+let value: WrapEthParams = {
+  actionType: "WRAP_ETH",
+  amount: 7893.14,
+};
+```
+
+## Fields
+
+| Field                            | Type                             | Required                         | Description                      | Example                          |
+| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
+| `actionType`                     | *"WRAP_ETH"*                     | :heavy_check_mark:               | N/A                              | WRAP_ETH                         |
+| `amount`                         | *components.WrapEthParamsAmount* | :heavy_check_mark:               | The amount of ETH to wrap.       |                                  |

package/docs/models/components/wrapethparamsamount.md

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

package/docs/models/components/wrapethrequest.md

@@ -0,0 +1,25 @@
+# WrapEthRequest
+
+Request model for wrapping ETH into WETH.
+
+## Example Usage
+
+```typescript
+import { WrapEthRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: WrapEthRequest = {
+  amount: "0.000001",
+  chain: "base",
+  sender: "0xdc3db667461DeE4881E73469c144FAe21eE920A2",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"WRAP_ETH"*                                                                                                                 | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | WRAP_ETH                                                                                                                     |
+| `amount`                                                                                                                     | *components.WrapEthRequestAmount*                                                                                            | :heavy_check_mark:                                                                                                           | The amount of ETH to wrap.                                                                                                   |                                                                                                                              |
+| `chain`                                                                                                                      | [components.WrapEthRequestChain](../../models/components/wrapethrequestchain.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/wrapethrequestamount.md

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

package/docs/models/components/wrapethrequestchain.md

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

package/docs/models/components/yieldrange.md

@@ -0,0 +1,19 @@
+# YieldRange
+
+## Example Usage
+
+```typescript
+import { YieldRange } from "@compass-labs/api-sdk/models/components";
+
+let value: YieldRange = {
+  min: 1254.08,
+  max: 3379.01,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `min`              | *number*           | :heavy_check_mark: | N/A                |
+| `max`              | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/errors/httpvalidationerror.md

@@ -0,0 +1,15 @@
+# HTTPValidationError
+
+## Example Usage
+
+```typescript
+import { HTTPValidationError } from "@compass-labs/api-sdk/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `detail`                                                                   | [components.ValidationError](../../models/components/validationerror.md)[] | :heavy_minus_sign:                                                         | N/A                                                                        |

package/docs/models/errors/mintpreparenotfoundresponseerror.md

@@ -0,0 +1,22 @@
+# MintPrepareNotFoundResponseError
+
+Response when the burn event has not been found yet.
+
+This means the burn transaction hasn't been confirmed on-chain yet, or the user
+hasn't broadcast the burn transaction.
+
+## Example Usage
+
+```typescript
+import { MintPrepareNotFoundResponseError } from "@compass-labs/api-sdk/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field                                                       | Type                                                        | Required                                                    | Description                                                 | Example                                                     |
+| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
+| `status`                                                    | *"burn_not_found"*                                          | :heavy_minus_sign:                                          | Indicates the burn event was not found on the source chain. | burn_not_found                                              |
+| `bridgeId`                                                  | *string*                                                    | :heavy_check_mark:                                          | The bridge identifier.                                      |                                                             |
+| `message`                                                   | *string*                                                    | :heavy_check_mark:                                          | Human-readable message explaining the status.               |                                                             |

package/docs/models/operations/amountin.md

@@ -0,0 +1,19 @@
+# AmountIn
+
+The amount of the token to swap from
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1;
+```
+
+### `string`
+
+```typescript
+const value: string = "1";
+```
+