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

package/docs/models/components/body.md

@@ -0,0 +1,424 @@
+# Body
+
+
+## Supported Types
+
+### `components.AaveBorrowParams`
+
+```typescript
+const value: components.AaveBorrowParams = {
+  actionType: "AAVE_BORROW",
+  token: "<value>",
+  amount: "219.26",
+  interestRateMode: "stable",
+};
+```
+
+### `components.AaveRepayParams`
+
+```typescript
+const value: components.AaveRepayParams = {
+  actionType: "AAVE_REPAY",
+  token: "<value>",
+  amount: 734.27,
+  interestRateMode: "stable",
+};
+```
+
+### `components.AaveSupplyParams`
+
+```typescript
+const value: components.AaveSupplyParams = {
+  actionType: "AAVE_SUPPLY",
+  token: "<value>",
+  amount: 4486.99,
+};
+```
+
+### `components.AaveWithdrawParams`
+
+```typescript
+const value: components.AaveWithdrawParams = {
+  actionType: "AAVE_WITHDRAW",
+  token: "<value>",
+  amount: 9580.15,
+  recipient: "<value>",
+};
+```
+
+### `components.AerodromeSlipstreamBuyExactlyParams`
+
+```typescript
+const value: components.AerodromeSlipstreamBuyExactlyParams = {
+  actionType: "AERODROME_SLIPSTREAM_BUY_EXACTLY",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  tickSpacing: 121289,
+  amountOut: "<value>",
+  amountInMaximum: "<value>",
+};
+```
+
+### `components.AerodromeSlipstreamIncreaseLiquidityProvisionParams`
+
+```typescript
+const value: components.AerodromeSlipstreamIncreaseLiquidityProvisionParams = {
+  actionType: "AERODROME_SLIPSTREAM_INCREASE_LIQUIDITY_PROVISION",
+  tokenId: 800217,
+  amount0Desired: 7257.53,
+  amount1Desired: "<value>",
+  amount0Min: 5828.13,
+  amount1Min: 7309.97,
+};
+```
+
+### `components.AerodromeSlipstreamMintLiquidityProvisionParams`
+
+```typescript
+const value: components.AerodromeSlipstreamMintLiquidityProvisionParams = {
+  actionType: "AERODROME_SLIPSTREAM_MINT_LIQUIDITY_PROVISION",
+  token0: "<value>",
+  token1: "<value>",
+  tickSpacing: 428263,
+  tickLower: 959069,
+  tickUpper: 386201,
+  amount0Desired: "<value>",
+  amount1Desired: "<value>",
+  amount0Min: 6169.06,
+  amount1Min: "<value>",
+};
+```
+
+### `components.AerodromeSlipstreamSellExactlyParams`
+
+```typescript
+const value: components.AerodromeSlipstreamSellExactlyParams = {
+  actionType: "AERODROME_SLIPSTREAM_SELL_EXACTLY",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  tickSpacing: 665084,
+  amountIn: "<value>",
+  amountOutMinimum: "0",
+};
+```
+
+### `components.AerodromeSlipstreamWithdrawLiquidityProvisionParams`
+
+```typescript
+const value: components.AerodromeSlipstreamWithdrawLiquidityProvisionParams = {
+  actionType: "AERODROME_SLIPSTREAM_WITHDRAW_LIQUIDITY_PROVISION",
+  tokenId: 928157,
+  percentageForWithdrawal: 5338.99,
+};
+```
+
+### `components.EthenaDepositParams`
+
+```typescript
+const value: components.EthenaDepositParams = {
+  actionType: "ETHENA_DEPOSIT",
+  amount: 4651.6,
+};
+```
+
+### `components.EthenaRequestToWithdrawParams`
+
+```typescript
+const value: components.EthenaRequestToWithdrawParams = {
+  actionType: "ETHENA_REQUEST_WITHDRAW",
+  amount: 918.81,
+};
+```
+
+### `components.EthenaUnstakeParams`
+
+```typescript
+const value: components.EthenaUnstakeParams = {
+  actionType: "ETHENA_UNSTAKE",
+};
+```
+
+### `components.MorphoBorrowParams`
+
+```typescript
+const value: components.MorphoBorrowParams = {
+  actionType: "MORPHO_BORROW",
+  amount: 2478.69,
+  uniqueMarketKey: "<value>",
+};
+```
+
+### `components.MorphoDepositParams`
+
+```typescript
+const value: components.MorphoDepositParams = {
+  actionType: "MORPHO_DEPOSIT",
+  vaultAddress: "<value>",
+  amount: "953.69",
+};
+```
+
+### `components.MorphoRepayParams`
+
+```typescript
+const value: components.MorphoRepayParams = {
+  actionType: "MORPHO_REPAY",
+  amount: 2349.41,
+  uniqueMarketKey: "<value>",
+};
+```
+
+### `components.MorphoSupplyCollateralParams`
+
+```typescript
+const value: components.MorphoSupplyCollateralParams = {
+  actionType: "MORPHO_SUPPLY_COLLATERAL",
+  amount: "631.13",
+  uniqueMarketKey: "<value>",
+};
+```
+
+### `components.MorphoWithdrawParams`
+
+```typescript
+const value: components.MorphoWithdrawParams = {
+  actionType: "MORPHO_WITHDRAW",
+  vaultAddress: "<value>",
+  amount: "457.92",
+};
+```
+
+### `components.MorphoWithdrawCollateralParams`
+
+```typescript
+const value: components.MorphoWithdrawCollateralParams = {
+  actionType: "MORPHO_WITHDRAW_COLLATERAL",
+  amount: "809.65",
+  uniqueMarketKey: "<value>",
+};
+```
+
+### `components.OdosSwapParams`
+
+```typescript
+const value: components.OdosSwapParams = {
+  actionType: "ODOS_SWAP",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: "<value>",
+  maxSlippagePercent: 2426.43,
+};
+```
+
+### `components.PendleManageLiquidityParams`
+
+```typescript
+const value: components.PendleManageLiquidityParams = {
+  actionType: "PENDLE_MANAGE_LIQUIDITY",
+  marketAddress: "<value>",
+  action: "SUPPLY",
+  token: "<value>",
+  amountIn: 302.03,
+  maxSlippagePercent: 8988.92,
+};
+```
+
+### `components.PendleRedeemYieldParams`
+
+```typescript
+const value: components.PendleRedeemYieldParams = {
+  actionType: "PENDLE_REDEEM_YIELD",
+  marketAddress: "<value>",
+};
+```
+
+### `components.PendleTradePtParams`
+
+```typescript
+const value: components.PendleTradePtParams = {
+  actionType: "PENDLE_TRADE_PT",
+  marketAddress: "<value>",
+  action: "BUY",
+  token: "<value>",
+  amountIn: "<value>",
+  maxSlippagePercent: 815.26,
+};
+```
+
+### `components.PendleTradeYtParams`
+
+```typescript
+const value: components.PendleTradeYtParams = {
+  actionType: "PENDLE_TRADE_YT",
+  marketAddress: "<value>",
+  action: "BUY",
+  token: "<value>",
+  amountIn: 3618.19,
+  maxSlippagePercent: 7418.59,
+};
+```
+
+### `components.SetAllowanceParams`
+
+```typescript
+const value: components.SetAllowanceParams = {
+  actionType: "SET_ALLOWANCE",
+  token: "<value>",
+  contract: "MorphoMarket",
+  amount: 2204.6,
+};
+```
+
+### `components.SkyBuyParams`
+
+```typescript
+const value: components.SkyBuyParams = {
+  actionType: "SKY_BUY",
+  tokenIn: "DAI",
+  amount: "212.14",
+};
+```
+
+### `components.SkyDepositParams`
+
+```typescript
+const value: components.SkyDepositParams = {
+  actionType: "SKY_DEPOSIT",
+  amount: "888.31",
+};
+```
+
+### `components.SkySellParams`
+
+```typescript
+const value: components.SkySellParams = {
+  actionType: "SKY_SELL",
+  tokenOut: "USDC",
+  amount: 9013.63,
+};
+```
+
+### `components.SkyWithdrawParams`
+
+```typescript
+const value: components.SkyWithdrawParams = {
+  actionType: "SKY_WITHDRAW",
+  amount: "512.05",
+};
+```
+
+### `components.TokenTransferParams`
+
+```typescript
+const value: components.TokenTransferParams = {
+  actionType: "TOKEN_TRANSFER",
+  to: "<value>",
+  token: "<value>",
+  amount: "513.47",
+};
+```
+
+### `components.UniswapIncreaseLiquidityProvisionParams`
+
+```typescript
+const value: components.UniswapIncreaseLiquidityProvisionParams = {
+  actionType: "UNISWAP_ADD_LIQUIDITY",
+  tokenId: 952512,
+  amount0Desired: 893.1,
+  amount1Desired: "<value>",
+  amount0Min: 5290.69,
+  amount1Min: 9512.3,
+};
+```
+
+### `components.UniswapBuyExactlyParams`
+
+```typescript
+const value: components.UniswapBuyExactlyParams = {
+  actionType: "UNISWAP_BUY_EXACTLY",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  fee: "0.01",
+  amountOut: "<value>",
+  maxSlippagePercent: 2494.68,
+};
+```
+
+### `components.UniswapMintLiquidityProvisionParams`
+
+```typescript
+const value: components.UniswapMintLiquidityProvisionParams = {
+  actionType: "UNISWAP_MINT_LIQUIDITY_PROVISION",
+  token0: "<value>",
+  token1: "<value>",
+  fee: "1.0",
+  tickLower: 957705,
+  tickUpper: 323259,
+  amount0Desired: 354.23,
+  amount1Desired: "<value>",
+  amount0Min: 1895.34,
+  amount1Min: "<value>",
+};
+```
+
+### `components.UniswapSellExactlyParams`
+
+```typescript
+const value: components.UniswapSellExactlyParams = {
+  actionType: "UNISWAP_SELL_EXACTLY",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  fee: "0.05",
+  amountIn: "<value>",
+  maxSlippagePercent: 3391.63,
+};
+```
+
+### `components.UniswapWithdrawLiquidityProvisionParams`
+
+```typescript
+const value: components.UniswapWithdrawLiquidityProvisionParams = {
+  actionType: "UNISWAP_WITHDRAW_LIQUIDITY_PROVISION",
+  tokenId: 405500,
+  percentageForWithdrawal: "<value>",
+};
+```
+
+### `components.UnwrapWethParams`
+
+```typescript
+const value: components.UnwrapWethParams = {
+  actionType: "UNWRAP_WETH",
+  amount: 1365.33,
+};
+```
+
+### `components.VaultDepositParams`
+
+```typescript
+const value: components.VaultDepositParams = {
+  actionType: "VAULT_DEPOSIT",
+  vaultAddress: "<value>",
+  amount: 5966,
+};
+```
+
+### `components.VaultWithdrawParams`
+
+```typescript
+const value: components.VaultWithdrawParams = {
+  actionType: "VAULT_WITHDRAW",
+  vaultAddress: "<value>",
+  amount: "242.69",
+};
+```
+
+### `components.WrapEthParams`
+
+```typescript
+const value: components.WrapEthParams = {
+  actionType: "WRAP_ETH",
+  amount: 7893.14,
+};
+```
+

package/docs/models/components/borrow.md

@@ -0,0 +1,37 @@
+# Borrow
+
+## Example Usage
+
+```typescript
+import { Borrow } from "@compass-labs/api-sdk/models/components";
+
+let value: Borrow = {
+  id: "<id>",
+  timestamp: 132507,
+  txHash: "<value>",
+  amount: 5726.04,
+  borrowRateMode: 1,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 1060.46,
+  action: "Borrow",
+  block: 644384,
+};
+```
+
+## 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                                                                                                  |
+| `borrowRateMode`                                                                                                   | [components.Borrowratemode](../../models/components/borrowratemode.md)                                             | :heavy_check_mark:                                                                                                 | The interest rate mode to borrow: 1 represents stable interest rate mode. 2 represents variable interest rate mode |
+| `reserve`                                                                                                          | [components.Reserve](../../models/components/reserve.md)                                                           | :heavy_check_mark:                                                                                                 | N/A                                                                                                                |
+| `assetPriceUSD`                                                                                                    | *number*                                                                                                           | :heavy_check_mark:                                                                                                 | Price of token in USD                                                                                              |
+| `action`                                                                                                           | *"Borrow"*                                                                                                         | :heavy_check_mark:                                                                                                 | The type of transaction                                                                                            |
+| `block`                                                                                                            | *number*                                                                                                           | :heavy_check_mark:                                                                                                 | N/A                                                                                                                |

package/docs/models/components/borrowratemode.md

@@ -0,0 +1,17 @@
+# Borrowratemode
+
+The interest rate mode to borrow: 1 represents stable interest rate mode. 2 represents variable interest rate mode
+
+## Example Usage
+
+```typescript
+import { Borrowratemode } from "@compass-labs/api-sdk/models/components";
+
+let value: Borrowratemode = 1;
+```
+
+## Values
+
+```typescript
+1 | 2
+```

package/docs/models/components/bundlertransactionresponse.md

@@ -0,0 +1,28 @@
+# BundlerTransactionResponse
+
+## Example Usage
+
+```typescript
+import { BundlerTransactionResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: BundlerTransactionResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+    authorizationList: [],
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                      | [components.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md) | :heavy_check_mark:                                                                                 | N/A                                                                                                |

package/docs/models/components/chain.md

@@ -0,0 +1,17 @@
+# Chain
+
+The chain to use.
+
+## Example Usage
+
+```typescript
+import { Chain } from "@compass-labs/api-sdk/models/components";
+
+let value: Chain = "base";
+```
+
+## Values
+
+```typescript
+"base" | "ethereum" | "arbitrum"
+```

package/docs/models/components/chaininfo.md

@@ -0,0 +1,18 @@
+# ChainInfo
+
+## Example Usage
+
+```typescript
+import { ChainInfo } from "@compass-labs/api-sdk/models/components";
+
+let value: ChainInfo = {
+  id: 436750,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *number*           | :heavy_check_mark: | N/A                |
+| `network`          | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/components/chainratedata.md

@@ -0,0 +1,21 @@
+# ChainRateData
+
+Rate data for a specific chain.
+
+## Example Usage
+
+```typescript
+import { ChainRateData } from "@compass-labs/api-sdk/models/components";
+
+let value: ChainRateData = {
+  supplyApyVariableRate: "<value>",
+  borrowApyVariableRate: "<value>",
+};
+```
+
+## Fields
+
+| Field                           | Type                            | Required                        | Description                     |
+| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
+| `supplyApyVariableRate`         | *string*                        | :heavy_check_mark:              | Variable rate APY for deposits. |
+| `borrowApyVariableRate`         | *string*                        | :heavy_check_mark:              | Variable rate APY for loans.    |

package/docs/models/components/compassapibackendv1modelsgenericreadresponseportfoliotokenbalance.md

@@ -0,0 +1,27 @@
+# CompassApiBackendV1ModelsGenericReadResponsePortfolioTokenBalance
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsGenericReadResponsePortfolioTokenBalance } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsGenericReadResponsePortfolioTokenBalance = {
+  amount: "780.49",
+  decimals: 191282,
+  tokenSymbol: "<value>",
+  tokenAddress: "<value>",
+  price: "87.97",
+  tokenValueInUsd: "<value>",
+};
+```
+
+## Fields
+
+| Field                                       | Type                                        | Required                                    | Description                                 |
+| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
+| `amount`                                    | *string*                                    | :heavy_check_mark:                          | Amount of tokens a particular address holds |
+| `decimals`                                  | *number*                                    | :heavy_check_mark:                          | Number of decimals of the token             |
+| `tokenSymbol`                               | *string*                                    | :heavy_check_mark:                          | Symbol of the token.                        |
+| `tokenAddress`                              | *string*                                    | :heavy_check_mark:                          | Address of the token                        |
+| `price`                                     | *string*                                    | :heavy_check_mark:                          | Price of the token in USD                   |
+| `tokenValueInUsd`                           | *string*                                    | :heavy_check_mark:                          | Value of the token balance in USD           |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionapydata.md

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

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionasset.md

@@ -0,0 +1,27 @@
+# CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionAsset
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionAsset } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionAsset = {
+  name: "<value>",
+  symbol: "<value>",
+  address: "5008 Princes Street",
+  decimals: 71732,
+  priceUsd: "<value>",
+  logoURI: "https://wiggly-strait.com",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `symbol`           | *string*           | :heavy_check_mark: | N/A                |
+| `address`          | *string*           | :heavy_check_mark: | N/A                |
+| `decimals`         | *number*           | :heavy_check_mark: | N/A                |
+| `priceUsd`         | *string*           | :heavy_check_mark: | N/A                |
+| `logoURI`          | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionmarketstate.md

@@ -0,0 +1,34 @@
+# CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionMarketState
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionMarketState } from "@compass-labs/api-sdk/models/components";
+
+let value:
+  CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionMarketState = {
+    pnlUsd: "<value>",
+    borrowAssets: "<value>",
+    borrowShares: "<value>",
+    borrowAssetsUsd: "<value>",
+    collateral: "<value>",
+    collateralUsd: "<value>",
+    supplyAssets: "<value>",
+    supplyShares: "<value>",
+    supplyAssetsUsd: "<value>",
+  };
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `pnlUsd`           | *string*           | :heavy_check_mark: | N/A                |
+| `borrowAssets`     | *string*           | :heavy_check_mark: | N/A                |
+| `borrowShares`     | *string*           | :heavy_check_mark: | N/A                |
+| `borrowAssetsUsd`  | *string*           | :heavy_check_mark: | N/A                |
+| `collateral`       | *string*           | :heavy_check_mark: | N/A                |
+| `collateralUsd`    | *string*           | :heavy_check_mark: | N/A                |
+| `supplyAssets`     | *string*           | :heavy_check_mark: | N/A                |
+| `supplyShares`     | *string*           | :heavy_check_mark: | N/A                |
+| `supplyAssetsUsd`  | *string*           | :heavy_check_mark: | N/A                |