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

package/docs/models/components/aerodromeslipstreamsellexactlyrequestamountoutminimum.md

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

package/docs/models/components/aerodromeslipstreamsellexactlyrequestchain.md

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

package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionparams.md

@@ -0,0 +1,26 @@
+# AerodromeSlipstreamWithdrawLiquidityProvisionParams
+
+Endpoint parameters for liquidity provision withdrawal on aerodrome slipstream.
+
+This action is performed in a multicall on the NonfungiblePosition Manager: https://github.com/AerodromeSlipstream/v3-periphery/blob/0682387198a24c7cd63566a2c58398533860a5d1/contracts/base/Multicall.sol#L11-L27
+First, we call decrease liquidity then collect the tokens owed to the user.
+
+## Example Usage
+
+```typescript
+import { AerodromeSlipstreamWithdrawLiquidityProvisionParams } from "@compass-labs/api-sdk/models/components";
+
+let value: AerodromeSlipstreamWithdrawLiquidityProvisionParams = {
+  actionType: "AERODROME_SLIPSTREAM_WITHDRAW_LIQUIDITY_PROVISION",
+  tokenId: 928157,
+  percentageForWithdrawal: 5338.99,
+};
+```
+
+## Fields
+
+| Field                                                                                   | Type                                                                                    | Required                                                                                | Description                                                                             | Example                                                                                 |
+| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
+| `actionType`                                                                            | *"AERODROME_SLIPSTREAM_WITHDRAW_LIQUIDITY_PROVISION"*                                   | :heavy_check_mark:                                                                      | N/A                                                                                     | AERODROME_SLIPSTREAM_WITHDRAW_LIQUIDITY_PROVISION                                       |
+| `tokenId`                                                                               | *number*                                                                                | :heavy_check_mark:                                                                      | Token ID of the NFT representing the liquidity provisioned position.                    |                                                                                         |
+| `percentageForWithdrawal`                                                               | *components.AerodromeSlipstreamWithdrawLiquidityProvisionParamsPercentageForWithdrawal* | :heavy_check_mark:                                                                      | How much liquidity to take out in percentage.                                           |                                                                                         |

package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionparamspercentageforwithdrawal.md

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

package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequest.md

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

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

package/docs/models/components/aerodromeslipstreamwithdrawliquidityprovisionrequestpercentageforwithdrawal.md

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

package/docs/models/components/allowanceinforesponse.md

@@ -0,0 +1,27 @@
+# AllowanceInfoResponse
+
+Response model for token allowance information.
+
+## Example Usage
+
+```typescript
+import { AllowanceInfoResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: AllowanceInfoResponse = {
+  amount: "134.12",
+  decimals: 155183,
+  tokenSymbol: "<value>",
+  tokenAddress: "<value>",
+  contractAddress: "<value>",
+};
+```
+
+## Fields
+
+| Field                                           | Type                                            | Required                                        | Description                                     |
+| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
+| `amount`                                        | *string*                                        | :heavy_check_mark:                              | Amount of tokens allowed to be spent by spender |
+| `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                            |
+| `contractAddress`                               | *string*                                        | :heavy_check_mark:                              | Address of the contract                         |

package/docs/models/components/approvetransferrequest.md

@@ -0,0 +1,22 @@
+# ApproveTransferRequest
+
+## Example Usage
+
+```typescript
+import { ApproveTransferRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: ApproveTransferRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  chain: "base",
+  token: "USDT",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                      | Type                                                                                                                                                                                       | Required                                                                                                                                                                                   | Description                                                                                                                                                                                | Example                                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `owner`                                                                                                                                                                                    | *string*                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                         | The owner of the smart account's address.                                                                                                                                                  |                                                                                                                                                                                            |
+| `chain`                                                                                                                                                                                    | [components.Chain](../../models/components/chain.md)                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                         | The chain to use.                                                                                                                                                                          |                                                                                                                                                                                            |
+| `token`                                                                                                                                                                                    | *string*                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                         | The token you would like to transfer with gas sponsorship.                                                                                                                                 |                                                                                                                                                                                            |
+| `gasSponsorship`                                                                                                                                                                           | *boolean*                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                         | Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint. | false                                                                                                                                                                                      |

package/docs/models/components/approvetransferresponse.md

@@ -0,0 +1,48 @@
+# ApproveTransferResponse
+
+## Example Usage
+
+```typescript
+import { ApproveTransferResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: ApproveTransferResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+  eip712: {
+    domain: {
+      name: "<value>",
+      version: "<value>",
+      chainId: 76014,
+      verifyingContract: "<value>",
+    },
+    types: {
+      eip712Domain: [],
+      permit: [],
+    },
+    primaryType: "Permit",
+    message: {
+      owner: "<value>",
+      spender: "<value>",
+      value: "<value>",
+      nonce: "<value>",
+      deadline: "<value>",
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                        | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                     | :heavy_check_mark:                                                                                   | N/A                                                                                                  |
+| `eip712`                                                                                             | [components.PermitTypedDataResponseOutput](../../models/components/permittypeddataresponseoutput.md) | :heavy_check_mark:                                                                                   | N/A                                                                                                  |

package/docs/models/components/apy.md

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

package/docs/models/components/batchedsafeoperationsresponseinput.md

@@ -0,0 +1,47 @@
+# BatchedSafeOperationsResponseInput
+
+Response containing EIP-712 typed data for Safe transaction signing.
+
+## Example Usage
+
+```typescript
+import { BatchedSafeOperationsResponseInput } from "@compass-labs/api-sdk/models/components";
+
+let value: BatchedSafeOperationsResponseInput = {
+  domain: {
+    chainId: 95340,
+    verifyingContract: "<value>",
+  },
+  types: {
+    eip712Domain: [],
+    safeTx: [
+      {
+        name: "<value>",
+        type: "<value>",
+      },
+    ],
+  },
+  primaryType: "SafeTx",
+  message: {
+    to: "<value>",
+    value: "<value>",
+    data: "<value>",
+    operation: 0,
+    safeTxGas: "<value>",
+    baseGas: "<value>",
+    gasPrice: "<value>",
+    gasToken: "<value>",
+    refundReceiver: "<value>",
+    nonce: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                  | Type                                                                                                                                                                                                   | Required                                                                                                                                                                                               | Description                                                                                                                                                                                            |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `domain`                                                                                                                                                                                               | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md) | :heavy_check_mark:                                                                                                                                                                                     | The EIP-712 domain separator for Safe transactions.                                                                                                                                                    |
+| `types`                                                                                                                                                                                                | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md)   | :heavy_check_mark:                                                                                                                                                                                     | The type definitions for EIP-712 structured data.                                                                                                                                                      |
+| `primaryType`                                                                                                                                                                                          | *"SafeTx"*                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                     | Primary type for the structured data                                                                                                                                                                   |
+| `message`                                                                                                                                                                                              | [components.SafeTxMessage](../../models/components/safetxmessage.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                     | The message data for a Safe transaction.                                                                                                                                                               |

package/docs/models/components/batchedsafeoperationsresponseoutput.md

@@ -0,0 +1,47 @@
+# BatchedSafeOperationsResponseOutput
+
+Response containing EIP-712 typed data for Safe transaction signing.
+
+## Example Usage
+
+```typescript
+import { BatchedSafeOperationsResponseOutput } from "@compass-labs/api-sdk/models/components";
+
+let value: BatchedSafeOperationsResponseOutput = {
+  domain: {
+    chainId: 95340,
+    verifyingContract: "<value>",
+  },
+  types: {
+    eip712Domain: [],
+    safeTx: [
+      {
+        name: "<value>",
+        type: "<value>",
+      },
+    ],
+  },
+  primaryType: "SafeTx",
+  message: {
+    to: "<value>",
+    value: "<value>",
+    data: "<value>",
+    operation: 0,
+    safeTxGas: "<value>",
+    baseGas: "<value>",
+    gasPrice: "<value>",
+    gasToken: "<value>",
+    refundReceiver: "<value>",
+    nonce: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                  | Type                                                                                                                                                                                                   | Required                                                                                                                                                                                               | Description                                                                                                                                                                                            |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `domain`                                                                                                                                                                                               | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md) | :heavy_check_mark:                                                                                                                                                                                     | The EIP-712 domain separator for Safe transactions.                                                                                                                                                    |
+| `types`                                                                                                                                                                                                | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md)   | :heavy_check_mark:                                                                                                                                                                                     | The type definitions for EIP-712 structured data.                                                                                                                                                      |
+| `primaryType`                                                                                                                                                                                          | *"SafeTx"*                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                     | Primary type for the structured data                                                                                                                                                                   |
+| `message`                                                                                                                                                                                              | [components.SafeTxMessage](../../models/components/safetxmessage.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                     | The message data for a Safe transaction.                                                                                                                                                               |

package/docs/models/components/batcheduseroperationsrequest.md

@@ -0,0 +1,36 @@
+# BatchedUserOperationsRequest
+
+Request model for batching user operations.
+
+Used for smart account batching and 5792 batching.
+
+## Example Usage
+
+```typescript
+import { BatchedUserOperationsRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: BatchedUserOperationsRequest = {
+  chain: "arbitrum",
+  sender: "<value>",
+  estimateGas: true,
+  operations: [
+    {
+      body: {
+        actionType: "SET_ALLOWANCE",
+        token: "USDC",
+        contract: "UniswapV3Router",
+        amount: "1000",
+      },
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                      | [components.BatchedUserOperationsRequestChain](../../models/components/batcheduseroperationsrequestchain.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                                                                                                                         |
+| `operations`                                                                                                                 | [components.UserOperation](../../models/components/useroperation.md)[]                                                       | :heavy_check_mark:                                                                                                           | List of possible user operations                                                                                             |                                                                                                                              |

package/docs/models/components/batcheduseroperationsrequestchain.md

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

package/docs/models/components/batcheduseroperationsresponse.md

@@ -0,0 +1,17 @@
+# BatchedUserOperationsResponse
+
+## Example Usage
+
+```typescript
+import { BatchedUserOperationsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: BatchedUserOperationsResponse = {
+  operations: [],
+};
+```
+
+## Fields
+
+| Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `operations`                                                                           | [components.UserOperationResponse](../../models/components/useroperationresponse.md)[] | :heavy_check_mark:                                                                     | List of user operations to be batched and executed by the smart account.               |