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

package/docs/sdks/erc4626vaults/README.md

@@ -0,0 +1,264 @@
+# Erc4626Vaults
+(*erc4626Vaults*)
+
+## Overview
+
+### Available Operations
+
+* [vaultsVault](#vaultsvault) - Get Vault & User Position
+* [vaultsDeposit](#vaultsdeposit) - Deposit to Vault
+* [vaultsWithdraw](#vaultswithdraw) - Withdraw from Vault
+
+## vaultsVault
+
+Get Vault data & User Position.
+
+The user position is only included if 'user_address' parameter is included.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_vaults_vault" method="get" path="/v1/vaults/vault" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.erc4626Vaults.vaultsVault({
+    chain: "ethereum",
+    vaultAddress: "0x182863131F9a4630fF9E27830d945B1413e347E8",
+    userAddress: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { erc4626VaultsVaultsVault } from "@compass-labs/api-sdk/funcs/erc4626VaultsVaultsVault.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await erc4626VaultsVaultsVault(compassApiSDK, {
+    chain: "ethereum",
+    vaultAddress: "0x182863131F9a4630fF9E27830d945B1413e347E8",
+    userAddress: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("erc4626VaultsVaultsVault failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V1VaultsVaultRequest](../../models/operations/v1vaultsvaultrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.VaultGetVaultResponse](../../models/components/vaultgetvaultresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## vaultsDeposit
+
+Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
+
+Each vault accepts one unique token that can be deposited.
+                    <Info>
+                    **Required Allowances**
+
+                        In order to make this transaction, token allowances need to be set for the following contracts.
+
+                     - `<vault_address>`
+                    </Info>
+                
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_vaults_deposit" method="post" path="/v1/vaults/deposit" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.erc4626Vaults.vaultsDeposit({
+    vaultAddress: "0xfdB431E661372fA1146efB70bf120ECDed944a78",
+    amount: 0.5,
+    chain: "base",
+    sender: "0x38EBf6c7D836f476cEE7DD093Ca43Bbc08e4Cc91",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { erc4626VaultsVaultsDeposit } from "@compass-labs/api-sdk/funcs/erc4626VaultsVaultsDeposit.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await erc4626VaultsVaultsDeposit(compassApiSDK, {
+    vaultAddress: "0xfdB431E661372fA1146efB70bf120ECDed944a78",
+    amount: 0.5,
+    chain: "base",
+    sender: "0x38EBf6c7D836f476cEE7DD093Ca43Bbc08e4Cc91",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("erc4626VaultsVaultsDeposit failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.VaultDepositRequest](../../models/components/vaultdepositrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## vaultsWithdraw
+
+Withdraw deposited tokens from a Vault (ERC-4626 Standard).
+
+The passive yield earned on token deposits is represented by the increased value of
+the shares received upon depositing tokens. Trade in these shares for the tokens you
+deposited plus any accrued yield.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_vaults_withdraw" method="post" path="/v1/vaults/withdraw" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.erc4626Vaults.vaultsWithdraw({
+    vaultAddress: "0xfdB431E661372fA1146efB70bf120ECDed944a78",
+    amount: "ALL",
+    chain: "base",
+    sender: "0x52680FEe4CC87AFB748F98F9B2f8D80190b8EF2c",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { erc4626VaultsVaultsWithdraw } from "@compass-labs/api-sdk/funcs/erc4626VaultsVaultsWithdraw.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await erc4626VaultsVaultsWithdraw(compassApiSDK, {
+    vaultAddress: "0xfdB431E661372fA1146efB70bf120ECDed944a78",
+    amount: "ALL",
+    chain: "base",
+    sender: "0x52680FEe4CC87AFB748F98F9B2f8D80190b8EF2c",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("erc4626VaultsVaultsWithdraw failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.VaultWithdrawRequest](../../models/components/vaultwithdrawrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/ethena/README.md

@@ -0,0 +1,357 @@
+# Ethena
+(*ethena*)
+
+## Overview
+
+### Available Operations
+
+* [ethenaVault](#ethenavault) - Get Vault & User Position
+* [ethenaDeposit](#ethenadeposit) - Deposit USDe
+* [ethenaRequest](#ethenarequest) - Request to Withdraw USDe
+* [ethenaUnstake](#ethenaunstake) - Unstake USDe
+
+## ethenaVault
+
+Get data & user Position for the Ethena vault on Ethereum.
+
+Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+
+The user position is only included in the response if 'user_address' parameter is included in the request.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_ethena_vault" method="get" path="/v1/ethena/vault" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.ethena.ethenaVault({
+    chain: "ethereum",
+    userAddress: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { ethenaEthenaVault } from "@compass-labs/api-sdk/funcs/ethenaEthenaVault.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await ethenaEthenaVault(compassApiSDK, {
+    chain: "ethereum",
+    userAddress: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ethenaEthenaVault failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.V1EthenaVaultRequest](../../models/operations/v1ethenavaultrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.EthenaGetVaultResponse](../../models/components/ethenagetvaultresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## ethenaDeposit
+
+Deposit USDe into a Ethena's Vault to earn passive yield.
+
+The shares of a deposit are respresented as sUSDe.
+                    <Info>
+                    **Required Allowances**
+
+                        In order to make this transaction, token allowances need to be set for the following contracts.
+
+                     - `EthenaVault`
+                    </Info>
+                
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_ethena_deposit" method="post" path="/v1/ethena/deposit" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.ethena.ethenaDeposit({
+    amount: 0.4,
+    chain: "ethereum",
+    sender: "0x5283A28b694ce2748e2dE1071417E5830de06518",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { ethenaEthenaDeposit } from "@compass-labs/api-sdk/funcs/ethenaEthenaDeposit.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await ethenaEthenaDeposit(compassApiSDK, {
+    amount: 0.4,
+    chain: "ethereum",
+    sender: "0x5283A28b694ce2748e2dE1071417E5830de06518",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ethenaEthenaDeposit failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.EthenaDepositRequest](../../models/components/ethenadepositrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## ethenaRequest
+
+Request to withdraw deposited USDe from Ethena's vault.
+
+The Ethena vault requires a cooldown period. Once a request to withdraw a specified
+amount of USDe has been submitted, the alloted cooldown period must pass before the
+withdraw USDe transaction can be submitted.
+
+If an additional amount of USDe is requested to be withdrawn anytime before
+withdrawing the originally requested amount, the cooldown period restarts.
+
+Yield is not earned on USDe while in its cooldown period.
+
+An allowance does not have to be set to initiate the cooldown period.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_ethena_request" method="post" path="/v1/ethena/request" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.ethena.ethenaRequest({
+    amount: "ALL",
+    chain: "ethereum",
+    sender: "0x85b049df4E74AFF38c6D79F3c71Ae4C998b69342",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { ethenaEthenaRequest } from "@compass-labs/api-sdk/funcs/ethenaEthenaRequest.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await ethenaEthenaRequest(compassApiSDK, {
+    amount: "ALL",
+    chain: "ethereum",
+    sender: "0x85b049df4E74AFF38c6D79F3c71Ae4C998b69342",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ethenaEthenaRequest failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.EthenaRequestToWithdrawRequest](../../models/components/ethenarequesttowithdrawrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.EthenaRequestToWithdrawTransactionResponse](../../models/components/ethenarequesttowithdrawtransactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## ethenaUnstake
+
+Unstake deposited USDe from Ethena's vault.
+
+Verify that the USDe being unstaked has completed its mandatory cooldown period
+using the Ethena 'Get Vault & User Position' endpoint.
+
+This is an all or nothing action. All of the USDe that has completed its cooldown
+period must be withdrawn.
+
+The passive yield earned on USDe deposits is represented by the increased value of
+the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
+for the intial USDe deposited and any accrued yield since depositing.
+
+An allowance does not have to be set to unstake USDe that has completed its cooldown
+period.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v1_ethena_unstake" method="post" path="/v1/ethena/unstake" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.ethena.ethenaUnstake({
+    chain: "ethereum",
+    sender: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { ethenaEthenaUnstake } from "@compass-labs/api-sdk/funcs/ethenaEthenaUnstake.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await ethenaEthenaUnstake(compassApiSDK, {
+    chain: "ethereum",
+    sender: "0xb8340945eBc917D2Aa0368a5e4E79C849c461511",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("ethenaEthenaUnstake failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.EthenaUnstakeRequest](../../models/components/ethenaunstakerequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.TransactionResponse](../../models/components/transactionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |