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

package/docs/models/components/morphosupplycollateralrequest.md

@@ -0,0 +1,28 @@
+# MorphoSupplyCollateralRequest
+
+## Example Usage
+
+```typescript
+import { MorphoSupplyCollateralRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoSupplyCollateralRequest = {
+  amount: 0.5,
+  uniqueMarketKey:
+    "0x3b3769cfca57be2eaed03fcc5299c25691b77781a1e124e7a8d520eb9a7eabb5",
+  chain: "base",
+  sender: "0x62e25C7CAADca07b5dFB6C52E01329451048632E",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"MORPHO_SUPPLY_COLLATERAL"*                                                                                                 | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | MORPHO_SUPPLY_COLLATERAL                                                                                                     |
+| `amount`                                                                                                                     | *components.MorphoSupplyCollateralRequestAmount*                                                                             | :heavy_check_mark:                                                                                                           | Amount of the token to supply to the market as collateral.                                                                   |                                                                                                                              |
+| `uniqueMarketKey`                                                                                                            | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.                             |                                                                                                                              |
+| `onBehalfOf`                                                                                                                 | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address on behalf of whom the supplied collateral is made. Defaults to sender.                                           |                                                                                                                              |
+| `callbackData`                                                                                                               | *Uint8Array*                                                                                                                 | :heavy_minus_sign:                                                                                                           | An optional field for callback byte data that will be triggered upon successful supplying of collateral.                     |                                                                                                                              |
+| `chain`                                                                                                                      | [components.MorphoSupplyCollateralRequestChain](../../models/components/morphosupplycollateralrequestchain.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/morphosupplycollateralrequestamount.md

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

package/docs/models/components/morphosupplycollateralrequestchain.md

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

package/docs/models/components/morphovault.md

@@ -0,0 +1,51 @@
+# MorphoVault
+
+## Example Usage
+
+```typescript
+import { MorphoVault } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoVault = {
+  address: "5723 E 11th Street",
+  symbol: "<value>",
+  name: "<value>",
+  creationBlockNumber: 34892,
+  creationTimestamp: 184536,
+  creatorAddress: "<value>",
+  whitelisted: true,
+  asset: {
+    symbol: "<value>",
+    address: "662 Gerhold Grove",
+    decimals: 902243,
+    chain: {
+      id: 111446,
+    },
+  },
+  chain: {
+    id: 111446,
+  },
+  state: {
+    id: "<id>",
+    apy: 7130.98,
+    netApy: 5519.29,
+    totalAssets: 436664,
+    fee: 5855.77,
+    timelock: 334586,
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                  | Type                                                                                                                                                                   | Required                                                                                                                                                               | Description                                                                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `address`                                                                                                                                                              | *string*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `symbol`                                                                                                                                                               | *string*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `name`                                                                                                                                                                 | *string*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `creationBlockNumber`                                                                                                                                                  | *number*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `creationTimestamp`                                                                                                                                                    | *number*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `creatorAddress`                                                                                                                                                       | *string*                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `whitelisted`                                                                                                                                                          | *boolean*                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `asset`                                                                                                                                                                | [components.CompassApiBackendV1ModelsMorphoReadResponseGetVaultsAsset](../../models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsasset.md)           | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `chain`                                                                                                                                                                | [components.ChainInfo](../../models/components/chaininfo.md)                                                                                                           | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |
+| `state`                                                                                                                                                                | [components.CompassApiBackendV1ModelsMorphoReadResponseGetVaultsVaultState](../../models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsvaultstate.md) | :heavy_check_mark:                                                                                                                                                     | N/A                                                                                                                                                                    |

package/docs/models/components/morphowithdrawcollateralparams.md

@@ -0,0 +1,23 @@
+# MorphoWithdrawCollateralParams
+
+## Example Usage
+
+```typescript
+import { MorphoWithdrawCollateralParams } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoWithdrawCollateralParams = {
+  actionType: "MORPHO_WITHDRAW_COLLATERAL",
+  amount: "809.65",
+  uniqueMarketKey: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                            | Type                                                                                             | Required                                                                                         | Description                                                                                      | Example                                                                                          |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `actionType`                                                                                     | *"MORPHO_WITHDRAW_COLLATERAL"*                                                                   | :heavy_check_mark:                                                                               | N/A                                                                                              | MORPHO_WITHDRAW_COLLATERAL                                                                       |
+| `amount`                                                                                         | *components.MorphoWithdrawCollateralParamsAmount*                                                | :heavy_check_mark:                                                                               | Amount of the token to supply to the market as collateral.                                       |                                                                                                  |
+| `uniqueMarketKey`                                                                                | *string*                                                                                         | :heavy_check_mark:                                                                               | The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint. |                                                                                                  |
+| `onBehalfOf`                                                                                     | *string*                                                                                         | :heavy_minus_sign:                                                                               | The address on behalf of whom the withdraw is made. Defaults to sender.                          |                                                                                                  |
+| `receiver`                                                                                       | *string*                                                                                         | :heavy_minus_sign:                                                                               | The address where the withdrawn collateral will be received. Defaults to sender.                 |                                                                                                  |

package/docs/models/components/morphowithdrawcollateralparamsamount.md

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

package/docs/models/components/morphowithdrawcollateralrequest.md

@@ -0,0 +1,28 @@
+# MorphoWithdrawCollateralRequest
+
+## Example Usage
+
+```typescript
+import { MorphoWithdrawCollateralRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoWithdrawCollateralRequest = {
+  amount: 0.5,
+  uniqueMarketKey:
+    "0x3b3769cfca57be2eaed03fcc5299c25691b77781a1e124e7a8d520eb9a7eabb5",
+  chain: "base",
+  sender: "0x81d310Eb515E05EB26322e2DeDE9e75b754885A4",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"MORPHO_WITHDRAW_COLLATERAL"*                                                                                               | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | MORPHO_WITHDRAW_COLLATERAL                                                                                                   |
+| `amount`                                                                                                                     | *components.MorphoWithdrawCollateralRequestAmount*                                                                           | :heavy_check_mark:                                                                                                           | Amount of the token to supply to the market as collateral.                                                                   |                                                                                                                              |
+| `uniqueMarketKey`                                                                                                            | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.                             |                                                                                                                              |
+| `onBehalfOf`                                                                                                                 | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address on behalf of whom the withdraw is made. Defaults to sender.                                                      |                                                                                                                              |
+| `receiver`                                                                                                                   | *string*                                                                                                                     | :heavy_minus_sign:                                                                                                           | The address where the withdrawn collateral will be received. Defaults to sender.                                             |                                                                                                                              |
+| `chain`                                                                                                                      | [components.MorphoWithdrawCollateralRequestChain](../../models/components/morphowithdrawcollateralrequestchain.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/morphowithdrawcollateralrequestamount.md

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

package/docs/models/components/morphowithdrawcollateralrequestchain.md

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

package/docs/models/components/morphowithdrawparams.md

@@ -0,0 +1,22 @@
+# MorphoWithdrawParams
+
+## Example Usage
+
+```typescript
+import { MorphoWithdrawParams } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoWithdrawParams = {
+  actionType: "MORPHO_WITHDRAW",
+  vaultAddress: "<value>",
+  amount: "457.92",
+};
+```
+
+## Fields
+
+| Field                                                                                                                  | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            | Example                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                           | *"MORPHO_WITHDRAW"*                                                                                                    | :heavy_check_mark:                                                                                                     | N/A                                                                                                                    | MORPHO_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/morphowithdrawrequest.md

@@ -0,0 +1,26 @@
+# MorphoWithdrawRequest
+
+## Example Usage
+
+```typescript
+import { MorphoWithdrawRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: MorphoWithdrawRequest = {
+  vaultAddress: "0xc1256Ae5FF1cf2719D4937adb3bbCCab2E00A2Ca",
+  amount: "ALL",
+  chain: "base",
+  sender: "0xB3B45f5aCBb58a432BDe58724c1C959E11D5A418",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                                                 | *"MORPHO_WITHDRAW"*                                                                                                          | :heavy_minus_sign:                                                                                                           | N/A                                                                                                                          | MORPHO_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.MorphoWithdrawRequestChain](../../models/components/morphowithdrawrequestchain.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/morphowithdrawrequestchain.md

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

package/docs/models/components/movement10percent.md

@@ -0,0 +1,18 @@
+# Movement10Percent
+
+## Example Usage
+
+```typescript
+import { Movement10Percent } from "@compass-labs/api-sdk/models/components";
+
+let value: Movement10Percent = {};
+```
+
+## Fields
+
+| Field               | Type                | Required            | Description         |
+| ------------------- | ------------------- | ------------------- | ------------------- |
+| `ptMovementUpUsd`   | *number*            | :heavy_minus_sign:  | N/A                 |
+| `ptMovementDownUsd` | *number*            | :heavy_minus_sign:  | N/A                 |
+| `ytMovementUpUsd`   | *number*            | :heavy_minus_sign:  | N/A                 |
+| `ytMovementDownUsd` | *number*            | :heavy_minus_sign:  | N/A                 |

package/docs/models/components/multicallauthorizationrequest.md

@@ -0,0 +1,25 @@
+# MulticallAuthorizationRequest
+
+Request model for getting a multicall authorization.
+
+This model is used to authorize a sender address to perform multicall operations,
+allowing it to call multiple functions on multiple contracts in a single
+transaction.
+
+## Example Usage
+
+```typescript
+import { MulticallAuthorizationRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: MulticallAuthorizationRequest = {
+  chain: "arbitrum",
+  sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+};
+```
+
+## Fields
+
+| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                        | [components.MulticallAuthorizationRequestChain](../../models/components/multicallauthorizationrequestchain.md) | :heavy_check_mark:                                                                                             | N/A                                                                                                            |
+| `sender`                                                                                                       | *string*                                                                                                       | :heavy_check_mark:                                                                                             | The Ethereum address to use for authorization                                                                  |

package/docs/models/components/multicallauthorizationrequestchain.md

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

package/docs/models/components/multicallauthorizationresponse.md

@@ -0,0 +1,23 @@
+# MulticallAuthorizationResponse
+
+Response model for multicall authorization.
+
+## Example Usage
+
+```typescript
+import { MulticallAuthorizationResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: MulticallAuthorizationResponse = {
+  nonce: 443922,
+  address: "5497 S Pine Street",
+  chainId: 625615,
+};
+```
+
+## Fields
+
+| Field                                         | Type                                          | Required                                      | Description                                   |
+| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
+| `nonce`                                       | *number*                                      | :heavy_check_mark:                            | A unique nonce value for this authorization   |
+| `address`                                     | *string*                                      | :heavy_check_mark:                            | The Ethereum address authorized for multicall |
+| `chainId`                                     | *number*                                      | :heavy_check_mark:                            | The chain ID for the blockchain network       |

package/docs/models/components/multicallexecuterequest.md

@@ -0,0 +1,84 @@
+# MulticallExecuteRequest
+
+Request model for executing a multicall.
+
+## Example Usage
+
+```typescript
+import { MulticallExecuteRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: MulticallExecuteRequest = {
+  chain: "arbitrum",
+  sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  estimateGas: true,
+  signedAuthorization: {
+    nonce: 1000,
+    address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    chainId: 42161,
+    r: "0x5f9f3f3226ac91bc01a72dd117141f6c6de1ed30d3af9f95c3423316dc21d615",
+    s: "0x78f7982ede9dabc53d7153974c5692fda8a21fc73bdafc42aaf135505e22817c",
+    yParity: 0,
+  },
+  actions: [
+    {
+      body: {
+        actionType: "SET_ALLOWANCE",
+        token: "WETH",
+        contract: "UniswapV3Router",
+        amount: "1000",
+      },
+    },
+    {
+      body: {
+        actionType: "UNISWAP_BUY_EXACTLY",
+        tokenIn: "WETH",
+        tokenOut: "USDC",
+        fee: "0.01",
+        amountOut: "1000",
+        maxSlippagePercent: 0.5,
+      },
+    },
+    {
+      body: {
+        actionType: "SET_ALLOWANCE",
+        token: "USDC",
+        contract: "AaveV3Pool",
+        amount: "1000",
+      },
+    },
+    {
+      body: {
+        actionType: "SET_ALLOWANCE",
+        token: "WETH",
+        contract: "AaveV3Pool",
+        amount: "0.1",
+      },
+    },
+    {
+      body: {
+        actionType: "AAVE_SUPPLY",
+        token: "USDC",
+        amount: "1000",
+      },
+    },
+    {
+      body: {
+        actionType: "AAVE_BORROW",
+        token: "WETH",
+        amount: "0.1",
+        interestRateMode: "variable",
+      },
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                      | [components.MulticallExecuteRequestChain](../../models/components/multicallexecuterequestchain.md)                           | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          |                                                                                                                              |
+| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       |                                                                                                                              |
+| `estimateGas`                                                                                                                | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true                                                                                                                         |
+| `signedAuthorization`                                                                                                        | [components.SignedAuthorization](../../models/components/signedauthorization.md)                                             | :heavy_minus_sign:                                                                                                           | EIP-7702 authorization                                                                                                       |                                                                                                                              |
+| `actions`                                                                                                                    | [components.UserOperation](../../models/components/useroperation.md)[]                                                       | :heavy_check_mark:                                                                                                           | List of possible actions for multicall                                                                                       |                                                                                                                              |

package/docs/models/components/multicallexecuterequestchain.md

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

package/docs/models/components/multiplier.md

@@ -0,0 +1,19 @@
+# Multiplier
+
+Leverage multiplier. Total loop collateral will be calculated as `multiplier` x `initial_collateral_amount`
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/odosswapparams.md

@@ -0,0 +1,25 @@
+# OdosSwapParams
+
+## Example Usage
+
+```typescript
+import { OdosSwapParams } from "@compass-labs/api-sdk/models/components";
+
+let value: OdosSwapParams = {
+  actionType: "ODOS_SWAP",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: "<value>",
+  maxSlippagePercent: 2426.43,
+};
+```
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    | Example                                                                        |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `actionType`                                                                   | *"ODOS_SWAP"*                                                                  | :heavy_check_mark:                                                             | N/A                                                                            | ODOS_SWAP                                                                      |
+| `tokenIn`                                                                      | *string*                                                                       | :heavy_check_mark:                                                             | The symbol or address of the token that is to be sold.                         |                                                                                |
+| `tokenOut`                                                                     | *string*                                                                       | :heavy_check_mark:                                                             | The symbol or address of the token that is to be bought.                       |                                                                                |
+| `amountIn`                                                                     | *components.OdosSwapParamsAmountIn*                                            | :heavy_check_mark:                                                             | The amount of token_in to be sold.                                             |                                                                                |
+| `maxSlippagePercent`                                                           | *number*                                                                       | :heavy_check_mark:                                                             | The maximum slippage allowed in percent. e.g. `1` means `1%` slippage allowed. |                                                                                |

package/docs/models/components/odosswapparamsamountin.md

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