Squeeth

https://opyn.gitbook.io/squeeth/
Admin
Squeeth is an automated volatility-based trading protocol featuring the Crab Strategy, which allows...
Tokens:15,892
Snippets:182
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Flash Deposit Example

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/strategy-lifecycle-flash

This example demonstrates calling flashDeposit with specific amounts for ethToDeposit and msg.value. The contract handles the borrowing, depositing, and selling of oSQTH on Uniswap, returning any excess ETH.

```Solidity
flashDeposit(ethToDeposit= 0.3, {msg.value=0.155})
```

--------------------------------

### GET /getIndex

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Retrieves the index price of the powerPerp, scaled down by INDEX_SCALE, used for calculating funding and collateralization.

```APIDOC
## GET /getIndex

### Description
Get the index price of the powerPerp, scaled down.

### Method
GET

### Parameters
#### Query Parameters
- **_period** (uint32) - Required - Period which you want to calculate twap with.

### Response
#### Success Response (200)
- **indexPrice** (uint256) - Index price denominated in USD, scaled by 1e18.
```

--------------------------------

### GET /getDenormalizedMark

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Retrieves the expected mark price of powerPerp after funding has been applied.

```APIDOC
## GET /getDenormalizedMark

### Description
Get the expected mark price of powerPerp after funding has been applied.

### Method
GET

### Parameters
#### Query Parameters
- **_period** (uint32) - Required - Period of time for the twap in seconds.

### Response
#### Success Response (200)
- **markPrice** (uint256) - Mark price denominated in USD, scaled by 1e18.
```

--------------------------------

### GET /getExpectedNormalizationFactor

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Retrieves the expected normalization factor, useful for on-chain and off-chain calculations if funding is paid immediately.

```APIDOC
## GET /getExpectedNormalizationFactor

### Description
Returns the expected normalization factor, if the funding is paid right now.

### Method
GET

### Response
#### Success Response (200)
- **normalizationFactor** (uint256) - The expected normalization factor.
```

--------------------------------

### GET /getUnscaledIndex

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Retrieves the unscaled index of the power perp in USD, representing the mark used for future funding after a new normalization factor is applied.

```APIDOC
## GET /getUnscaledIndex

### Description
The unscaled index of the power perp in USD, scaled by 18 decimals.

### Method
GET

### Parameters
#### Query Parameters
- **_period** (uint32) - Required - Period which you want to calculate twap with.

### Response
#### Success Response (200)
- **indexPrice** (uint256) - Index price denominated in USD, scaled by 1e18.
```

--------------------------------

### initialize()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Initializes the collateral ratio upon the first migration.

```APIDOC
## initialize() CrabStrategyV2

### Description
Initializes the collateral ratio upon the first migration.

### Method
initialize

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_wSqueethToMint** (uint256) - squeeth to mint to match crab v1 collateral ratio
* **_crabSharesToMint** (uint256) - shares to mint to match crab v1
* **_timeAtLastHedge** (uint256) - time of last crab v1 hedge
* **_priceAtLastHedge** (uint256) - price at last crab v1 hedge

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### deposit()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Deposits ETH into the strategy and returns minted wSqueeth and strategy tokens.

```APIDOC
## deposit() CrabStrategyV2

### Description
Deposit ETH into strategy. Provide ETH, return wSqueeth and strategy token.

### Method
POST

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
* **minted amount of wSqueeth** (uint256) - minted amount of wSqueeth
* **minted amount of strategy token** (uint256) - minted amount of strategy token

#### Response Example
N/A
```

--------------------------------

### CrabStrategyV2 Constructor

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Initializes the CrabStrategyV2 contract with essential addresses and configuration parameters.

```APIDOC
## CONSTRUCTOR CrabStrategyV2

### Description
Strategy constructor. This will open a vault in the power token contract and store the vault ID.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A

### Parameters
* **_wSqueethController** (address) - power token controller address
* **_oracle** (address) - oracle address
* **_weth** (address) - weth address
* **_uniswapFactory** (address) - uniswap factory address
* **_ethWSqueethPool** (address) - eth-wSqueeth uniswap pool address
* **_timelock** (address) - timelock contract address
* **_crabMigration** (address) - crab migration contract address
* **_hedgeTimeThreshold** (uint256) - hedge time threshold (seconds)
* **_hedgePriceThreshold** (uint256) - hedge price threshold (0.1*1e18 = 10%)
```

--------------------------------

### flashMigrateFromV1toV2

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabmigration-doc

Executes migration from Crab V1 to Crab V2 when CR1 >= CR2.

```APIDOC
## POST flashMigrateFromV1toV2

### Description
Used to migrate from crab V1 to crab V2 when CR1 >= CR2.

### Parameters
#### Request Body
- **_v1Shares** (uint256) - Required - V1 shares to migrate
- **_ethToFlashDeposit** (uint256) - Required - Flash deposit amount in crab v2 with excess ETH
- **_poolFee** (uint24) - Required - Uniswap pool fee for flash deposit
```

--------------------------------

### getWsqueethFromCrabAmount

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Calculates the wSqueeth debt amount corresponding to a given amount of strategy tokens.

```APIDOC
## GET /getWsqueethFromCrabAmount

### Description
Retrieves the wSqueeth debt amount associated with a given strategy token amount.

### Method
GET

### Endpoint
/getWsqueethFromCrabAmount

### Parameters
#### Query Parameters
- **_crabAmount** (uint256) - Required - The amount of strategy token to burn.

### Response
#### Success Response (200)
- **wSqueeth amount** (uint256) - The calculated wSqueeth amount.
```

--------------------------------

### flashDeposit(uint256 _ethToDeposit)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Executes a flash deposit into the strategy, providing ETH, selling wSqueeth, and receiving strategy tokens.

```APIDOC
## flashDeposit(uint256 _ethToDeposit) CrabStrategyV2

### Description
Flash deposit into strategy, providing ETH, selling wSqueeth and receiving strategy tokens. This function will execute a flash swap where it receives ETH, deposits and mints using flash swap proceeds and msg.value, and then repays the flash swap with wSqueeth.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_ethToDeposit** (uint256) - total ETH that will be deposited in to the strategy which is a combination of msg.value and flash swap proceeds

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Mint Wrapped Squeeth

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/examples/lifecycle-of-a-squeeth

Call the controller contract to mint a specified amount of oSQTH by providing ETH collateral.

```solidity
mintWPowerPerpAmount(_vaultId=0, _wPowerPerpAmount=1, _uniTokenId=0,  {msg.value=`0.6`})
```

--------------------------------

### getWsqueethFromCrabAmount(uint256 _crabAmount)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Calculates the equivalent wSqueeth amount for a given crab amount.

```APIDOC
## getWsqueethFromCrabAmount(uint256 _crabAmount) CrabStrategyV2

### Description
Calculates the equivalent wSqueeth amount for a given crab amount.

### Method
GET

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
* **_crabAmount** (uint256) - The amount of crab tokens.

### Request Example
N/A

### Response
#### Success Response (200)
* **wSqueeth amount** (uint256) - The equivalent wSqueeth amount.

#### Response Example
N/A
```

--------------------------------

### receive()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Allows the contract to receive ETH transfers.

```APIDOC
## receive() CrabStrategyV2

### Description
Receive function to allow ETH transfer to this contract.

### Method
receive

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### Initiate OTC Hedge Auction

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/hedge

The `hedgeOTC` function is called to execute the auction. It requires the total quantity to be hedged, the clearing price, a flag indicating if it's a buy hedge, and an array of accepted orders.

```solidity
hedgeOTC(_totalQuantity=0.26, _clearingPrice = 0.34, _isHedgeBuying=true, _orders=orders)
```

--------------------------------

### checkTimeHedge()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Checks if a time-based hedge is required.

```APIDOC
## checkTimeHedge() CrabStrategyV2

### Description
Checks if a time-based hedge is required.

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### Squeeth Configuration and Administration

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Functions for updating operator addresses, setting fee recipients, and adjusting fee rates.

```APIDOC
## POST /api/config/updateOperator

### Description
Authorize an address to modify the vault. This can be revoked by setting the address to 0.

### Method
POST

### Endpoint
`/api/config/updateOperator`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault.
- **_operator** (address) - Required - The new operator address. Set to 0x0 to revoke authorization.

### Request Example
```json
{
  "_vaultId": "12345",
  "_operator": "0x1234567890abcdef1234567890abcdef12345678"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/config/setFeeRecipient

### Description
Set the recipient who will receive the fee. This should be a contract handling insurance.

### Method
POST

### Endpoint
`/api/config/setFeeRecipient`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_newFeeRecipient** (address) - Required - The new fee recipient address.

### Request Example
```json
{
  "_newFeeRecipient": "0xabcdef1234567890abcdef1234567890abcdef12"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/config/setFeeRate

### Description
Set the fee rate when a user mints. This function cannot be called if the feeRecipient is still unset. The fee rate cannot be higher than 1%.

### Method
POST

### Endpoint
`/api/config/setFeeRate`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_newFeeRate** (uint256) - Required - The new fee rate in basis points. Must be less than or equal to 100 (for 1%).

### Request Example
```json
{
  "_newFeeRate": "50" 
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```
```

--------------------------------

### Calculate Target Hedge Quantity

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/hedge

Calculates the target quantity of oSQTH to buy or sell based on current market conditions and strategy exposure. This calculation is crucial for initiating a buy or sell auction.

```text
targetHedge = ((ETH delta) - (oSQTH delta))/(oSQTH price) = (0.6 - 0.345*2*1)/0.345 = -0.26
```

--------------------------------

### checkPriceHedge()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Checks if a price-based hedge is required.

```APIDOC
## checkPriceHedge() CrabStrategyV2

### Description
Checks if a price-based hedge is required.

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### Squeeth Perpetual Operations

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Functions for minting and burning power perpetuals (wPowerPerp and PowerPerp), and calculating funding.

```APIDOC
## POST /api/perpetuals/mintPowerPerpAmount

### Description
Deposit collateral and mint wPowerPerp (non-rebasing) for a specified PowerPerp (rebasing) amount.

### Method
POST

### Endpoint
`/api/perpetuals/mintPowerPerpAmount`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The vault to mint wPowerPerp in.
- **_powerPerpAmount** (uint256) - Required - The amount of PowerPerp to mint.
- **_uniTokenId** (uint256) - Required - The Uniswap V3 position token ID (additional collateral).

### Request Example
```json
{
  "_vaultId": "12345",
  "_powerPerpAmount": "1000000000000000000",
  "_uniTokenId": "67890"
}
```

### Response
#### Success Response (200)
- **_wPowerPerpAmount** (uint256) - The amount of wPowerPerp minted.

#### Response Example
```json
{
  "_wPowerPerpAmount": "1000000000000000000"
}
```

## POST /api/perpetuals/mintWPowerPerpAmount

### Description
Deposit collateral and mint wPowerPerp.

### Method
POST

### Endpoint
`/api/perpetuals/mintWPowerPerpAmount`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The vault to mint wPowerPerp in.
- **_wPowerPerpAmount** (uint256) - Required - The amount of wPowerPerp to mint.
- **_uniTokenId** (uint256) - Required - The Uniswap V3 position token ID (additional collateral).

### Request Example
```json
{
  "_vaultId": "12345",
  "_wPowerPerpAmount": "1000000000000000000",
  "_uniTokenId": "67890"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/perpetuals/burnWPowerPerpAmount

### Description
Burn wPowerPerp and remove collateral from a vault.

### Method
POST

### Endpoint
`/api/perpetuals/burnWPowerPerpAmount`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault.
- **_wPowerPerpAmount** (uint256) - Required - The amount of wPowerPerp to burn.
- **_withdrawAmount** (uint256) - Required - The amount of ETH to withdraw.

### Request Example
```json
{
  "_vaultId": "12345",
  "_wPowerPerpAmount": "1000000000000000000",
  "_withdrawAmount": "1000000000000000000"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/perpetuals/burnPowerPerpAmount

### Description
Burn PowerPerp and remove collateral from a vault.

### Method
POST

### Endpoint
`/api/perpetuals/burnPowerPerpAmount`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault.
- **_powerPerpAmount** (uint256) - Required - The amount of PowerPerp to burn.
- **_withdrawAmount** (uint256) - Required - The amount of ETH to withdraw.

### Request Example
```json
{
  "_vaultId": "12345",
  "_powerPerpAmount": "1000000000000000000",
  "_withdrawAmount": "1000000000000000000"
}
```

### Response
#### Success Response (200)
- **_wPowerPerpAmount** (uint256) - The amount of wPowerPerp burned.

#### Response Example
```json
{
  "_wPowerPerpAmount": "1000000000000000000"
}
```

## GET /api/perpetuals/getDenormalizedMarkForFunding

### Description
Get the mark price of PowerPerp before funding has been applied. This is the mark that would be used to calculate a new normalization factor if funding was calculated now.

### Method
GET

### Endpoint
`/api/perpetuals/getDenormalizedMarkForFunding`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **_period** (uint32) - Required - The period for which to calculate the TWAP.

### Request Example
```json
{
  "_period": "3600"
}
```

### Response
#### Success Response (200)
- **markPrice** (uint256) - The mark price in USD, scaled by 1e18.

#### Response Example
```json
{
  "markPrice": "1050000000000000000"
}
```
```

--------------------------------

### Squeeth Repository Layout

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/contract-architecture

Overview of the contract directory structure within the Squeeth monorepo. Useful for navigating and locating specific strategy and helper contracts.

```plaintext
strategy/
     - CrabStrategyV2: contract for crab strategy v2 strategy
     - CrabMigration: contract for migrating from crab v1 to crab v2
     - CrabHelper: contract for crab helper functions
     - CrabStrategy (no longer in use): contract for crab v1 strategy
     base/
     - StrategyBase: commonly used functions for strategy templates
     - StraegyFlashSwap: functions to help with uniswap flashes
     - StrategyMath: safe math for strategies
     helper/
     - StrategySwap: key strategy swap helper functions

```

--------------------------------

### Burn Wrapped Squeeth and Withdraw Collateral

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/examples/lifecycle-of-a-squeeth

Execute `burnWPowerPerp` to close a Squeeth position. This burns the specified amount of wrapped squeeth and withdraws all associated ETH collateral.

```solidity
burnWPowerPerp(_vaultId = 1, _wPowerPerpAmount = 1, withdrawAmount = 0.6)
```

--------------------------------

### flashWithdraw(uint256 _crabAmount, uint256 _maxEthToPay)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Executes a flash withdraw from the strategy, providing strategy tokens, buying wSqueeth, burning, and receiving ETH.

```APIDOC
## flashWithdraw(uint256 _crabAmount, uint256 _maxEthToPay) CrabStrategyV2

### Description
Flash withdraw from strategy, providing strategy tokens, buying wSqueeth, burning and receiving ETH. This function will execute a flash swap where it receives wSqueeth, burns, withdraws ETH and then repays the flash swap with ETH.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_crabAmount** (uint256) - strategy token amount to burn
* **_maxEthToPay** (uint256) - maximum ETH to pay to buy back the owed wSqueeth debt

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Flash Deposit Function Call

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/strategy-lifecycle-flash

Use this function to deposit ETH into a strategy, borrow additional collateral, and sell oSQTH on Uniswap to repay the loan in a single transaction. Ensure ethToDeposit is greater than or equal to msg.value to avoid excessive ETH returns.

```Solidity
flashDeposit(ethToDeposit, {msg.value})
```

--------------------------------

### flashMigrationDetails

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabmigration-doc

Retrieves details regarding a potential flash migration for a specific amount of V1 shares.

```APIDOC
## GET flashMigrationDetails

### Description
View details of flash migration for specified amount of V1 shares.

### Parameters
#### Query Parameters
- **_v1Shares** (uint256) - Required - Amount of crab V1 shares

### Response
#### Success Response (200)
- **result** (tuple) - (bool, uint256, uint256, uint256) representing (ethNeededForV2 <= ethToGetFromV1, ethNeededForV2, v1oSqthToPay, ethToGetFromV1)
```

--------------------------------

### depositV1Shares

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabmigration-doc

Deposits Crab V1 shares into the migration pool.

```APIDOC
## POST depositV1Shares

### Description
Deposits Crab V1 shares into the pool for migration.

### Parameters
#### Request Body
- **_amount** (uint256) - Required - Amount of crabV1 shares to deposit
```

--------------------------------

### redeemShortShutdown()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Redeems short positions during a shutdown.

```APIDOC
## redeemShortShutdown() CrabStrategyV2

### Description
Redeem short positions during a shutdown.

### Method
POST

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### System Management Functions

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Functions for controlling system state including pausing, unpausing, and emergency shutdown.

```APIDOC
## shutDown()

### Description
Pauses the system (if not already paused) and immediately triggers an irreversible shutdown, enabling emergency settlement.

## pause()

### Description
Pauses the system for up to 24 hours. Can only be called within 365 days of launch or a maximum of 4 times.

## unPauseAnyone()

### Description
Allows anyone to unpause the contract after the 24-hour pause period has elapsed.

## unPauseOwner()

### Description
Allows the contract owner to unpause the system at any time.
```

--------------------------------

### hedgeOTC(uint256 _totalQuantity, uint256 _clearingPrice, bool _isHedgeBuying, Order[] memory _orders)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Executes an Over-The-Counter (OTC) hedge operation.

```APIDOC
## hedgeOTC(uint256 _totalQuantity, uint256 _clearingPrice, bool _isHedgeBuying, Order[] memory _orders) CrabStrategyV2

### Description
Executes an Over-The-Counter (OTC) hedge operation.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_totalQuantity** (uint256) - The total quantity for the hedge.
* **_clearingPrice** (uint256) - The clearing price for the hedge.
* **_isHedgeBuying** (bool) - Boolean indicating if this is a buying hedge.
* **_orders** (Order[]) - An array of orders for the OTC hedge.

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Squeeth Risk Management and Liquidations

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Functions for checking vault safety, liquidating undercollateralized vaults, and managing debt.

```APIDOC
## GET /api/risk/isVaultSafe

### Description
Return whether the vault is properly collateralized.

### Method
GET

### Endpoint
`/api/risk/isVaultSafe`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **_vaultId** (uint256) - Required - The ID of the vault to check.

### Request Example
```json
{
  "_vaultId": "12345"
}
```

### Response
#### Success Response (200)
- **isSafe** (boolean) - True if the vault is properly collateralized, false otherwise.

#### Response Example
```json
{
  "isSafe": true
}
```

## POST /api/liquidations/reduceDebtShutdown

### Description
After the system is shut down, insolvent vaults need to have their Uniswap V3 token assets withdrawn by force. If a vault has a Uniswap V3 position, anyone can call this to withdraw assets, reducing debt and increasing collateral in the vault. The caller does not receive a bounty. This is expected to be used for insolvent vaults in shutdown.

### Method
POST

### Endpoint
`/api/liquidations/reduceDebtShutdown`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The vault containing the Uniswap V3 position to liquidate.

### Request Example
```json
{
  "_vaultId": "12345"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/liquidations/reduceDebt

### Description
Withdraw assets from a Uniswap V3 position, reducing debt and increasing collateral in the vault. The caller does not receive a bounty. This is expected to be used by the vault owner.

### Method
POST

### Endpoint
`/api/liquidations/reduceDebt`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The target vault.

### Request Example
```json
{
  "_vaultId": "12345"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/liquidations/liquidate

### Description
If a vault is under the 150% collateral ratio, anyone can liquidate the vault by burning wPowerPerp. The liquidator can receive back (wPowerPerp burned) * (index price) * (normalizationFactor) * 110% in collateral. Normally, only 50% of a vault's debt can be liquidated. If a vault is under the dust limit after a liquidation, it can be fully liquidated. This function will attempt to reduceDebt first and may earn a bounty if successful.

### Method
POST

### Endpoint
`/api/liquidations/liquidate`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The vault to liquidate.
- **_maxDebtAmount** (uint256) - Required - The maximum amount of wPowerPerpetual to repay.

### Request Example
```json
{
  "_vaultId": "12345",
  "_maxDebtAmount": "500000000000000000"
}
```

### Response
#### Success Response (200)
- **_wPowerPerpAmountRepaid** (uint256) - The amount of wPowerPerp repaid.

#### Response Example
```json
{
  "_wPowerPerpAmountRepaid": "500000000000000000"
}
```
```

--------------------------------

### Deposit Uniswap LP Token

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/examples/lifecycle-of-a-squeeth

Deposit a Uniswap v3 position NFT into a vault to serve as collateral.

```solidity
depositUniPositionToken(_vaultId=1, uniTokenId=999)
```

--------------------------------

### checkTimeHedge

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Checks if hedging based on a time threshold is currently allowed.

```APIDOC
## GET /checkTimeHedge

### Description
Determines if hedging based on a time threshold is permitted.

### Method
GET

### Endpoint
/checkTimeHedge

### Response
#### Success Response (200)
- **allowed** (bool) - True if hedging is allowed based on time.
- **timestamp** (uint256) - The timestamp associated with the time-based hedge check.
```

--------------------------------

### Squeeth Vault and Collateral Management

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Functions for managing vaults, including depositing and withdrawing collateral, and handling Uniswap V3 positions.

```APIDOC
## POST /api/vaults/deposit

### Description
Deposit collateral into a vault.

### Method
POST

### Endpoint
`/api/vaults/deposit`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault to deposit collateral into.

### Request Example
```json
{
  "_vaultId": "12345"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/vaults/depositUniPositionToken

### Description
Deposit a Uniswap V3 position token into a vault to increase the collateral ratio.

### Method
POST

### Endpoint
`/api/vaults/depositUniPositionToken`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault.
- **_uniTokenId** (uint256) - Required - The Uniswap V3 position token ID.

### Request Example
```json
{
  "_vaultId": "12345",
  "_uniTokenId": "67890"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/vaults/withdraw

### Description
Withdraw collateral from a vault.

### Method
POST

### Endpoint
`/api/vaults/withdraw`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault.
- **_amount** (uint256) - Required - The amount of ETH to withdraw.

### Request Example
```json
{
  "_vaultId": "12345",
  "_amount": "1000000000000000000"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```

## POST /api/vaults/withdrawUniPositionToken

### Description
Withdraw a Uniswap V3 position token from a vault.

### Method
POST

### Endpoint
`/api/vaults/withdrawUniPositionToken`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **_vaultId** (uint256) - Required - The ID of the vault.

### Request Example
```json
{
  "_vaultId": "12345"
}
```

### Response
#### Success Response (200)
- **Success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "Success": true
}
```
```

--------------------------------

### Liquidate a Vault

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/examples/liquidation

Call the liquidate function on the controller to reduce debt in an unsafe vault by providing oSQTH.

```solidity
liquidate(_vaultId = 1,  _maxDebtAmount = 0.5)
```

--------------------------------

### checkPriceHedge

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Checks if hedging based on a price threshold is currently allowed.

```APIDOC
## GET /checkPriceHedge

### Description
Determines if hedging based on a price threshold is permitted.

### Method
GET

### Endpoint
/checkPriceHedge

### Response
#### Success Response (200)
- **allowed** (bool) - True if hedging is allowed based on price, false otherwise.
```

--------------------------------

### Deposit to Strategy Contract

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/strategy-lifecycle

Call the deposit function on the strategy contract with the amount of ETH to deposit. This function manages the issuance of oSQTH and strategy tokens based on collateral contributions and debt-to-collateral ratios.

```Solidity
deposit({msg.value=`0.3`})
```

--------------------------------

### Execute OTC Hedge Auction

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/hedge

Initiates the settlement period for an auction by calling the hedgeOTC function with the calculated quantity, clearing price, direction, and bid array.

```solidity
hedgeOTC(_totalQuantity=0.4, _clearingPrice = 0.272, _isHedgeBuying=false, _orders=bids)
```

--------------------------------

### hedgeOTC

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Executes a hedge trade to reduce delta using a provided array of signed orders.

```APIDOC
## POST /hedgeOTC

### Description
Hedges the delta by executing trades based on an array of signed orders.

### Method
POST

### Endpoint
/hedgeOTC

### Parameters
#### Request Body
- **_totalQuantity** (uint256) - Required - The total quantity the manager wants to trade.
- **_clearingPrice** (uint256) - Required - The clearing price in weth.
- **_isHedgeBuying** (bool) - Required - The direction of the hedge trade (true for buying, false for selling).
- **_orders** (Order[]) - Required - An array of signed orders to swap tokens.

### Response
#### Success Response (200)
- **hedge status** (string) - Indicates the success or failure of the hedge operation.
```

--------------------------------

### Deposit ETH Collateral

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/examples/lifecycle-of-a-squeeth

Add additional ETH collateral to an existing vault to improve the collateral ratio.

```solidity
deposit(_vaultId=1, {msg.value=0.1})
```

--------------------------------

### DOMAIN_SEPARATOR()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Returns the domain separator for EIP-712 compliance.

```APIDOC
## DOMAIN_SEPARATOR() CrabStrategyV2

### Description
Returns the domain separator for EIP-712 compliance.

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
* **domain separator** (bytes32) - The domain separator.

#### Response Example
N/A
```

--------------------------------

### incrementNonce()

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Increments the nonce for replay protection.

```APIDOC
## incrementNonce() CrabStrategyV2

### Description
Increment the nonce for replay protection.

### Method
POST

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### Redemption and Funding Functions

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/controller-functions/function-doc

Functions for redeeming long and short positions during shutdown and managing contract funding.

```APIDOC
## redeemLong(uint256 _wPerpAmount)

### Description
Redeems wPowerPerp for settlement value when the system is shut down.

### Parameters
- **_wPerpAmount** (uint256) - Required - Amount of wPowerPerp to burn

## redeemShort(uint256 _vaultId)

### Description
Redeems a short position by valuing the debt at the settlement index value during shutdown.

### Parameters
- **_vaultId** (uint256) - Required - The vault ID to redeem

## applyFunding()

### Description
Updates the normalization factor to process funding payments.

## donate()

### Description
Adds ETH to the contract to ensure sufficient funds for settlement transactions.
```

--------------------------------

### transferVault(address _newStrategy)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Transfers the vault NFT to a new strategy contract.

```APIDOC
## transferVault(address _newStrategy) CrabStrategyV2

### Description
Transfer vault NFT to new contract.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_newStrategy** (address) - address of new strategy version contract

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Flash Withdraw Function Call

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/strategy-lifecycle-flash

Use this function to withdraw ETH from a strategy by returning strategy tokens. It allows specifying the maximum ETH to pay for oSQTH on Uniswap, providing slippage protection. The contract handles borrowing oSQTH, withdrawing, and repurchasing oSQTH on Uniswap.

```Solidity
flashWithdraw(_crabAmount=0.3, _maxEthToPay=0.145)
```

--------------------------------

### Call liquidate to save a vault

Source: https://opyn.gitbook.io/squeeth/contracts/core-contracts/examples/save-an-unsafe-vault

Call the liquidate function on the controller to attempt to save an undercollateralized vault. No oSQTH needs to be attached for this operation.

```solidity
liquidate(_vaultId = 1, _maxDebtAmount = 0)
```

--------------------------------

### Controller Error Codes Reference

Source: https://opyn.gitbook.io/squeeth/contracts/error-code

A comprehensive list of error codes and their corresponding meanings for the Controller contract.

```APIDOC
## Controller Error Codes

### Description
This table outlines the error codes returned by the Controller contract during contract interactions.

### Error Codes
| Code | Error |
| :--- | :--- |
| C0 | Paused |
| C1 | Not paused |
| C2 | Shutdown |
| C3 | Not shutdown |
| C4 | Invalid oracle address |
| C5 | Invalid shortPowerPerp address |
| C6 | Invalid wPowerPerp address |
| C7 | Invalid weth address |
| C8 | Invalid quote currency address |
| C9 | Invalid eth:quoteCurrency pool address |
| C10 | Invalid wPowerPerp:eth pool address |
| C11 | Invalid Uniswap position manager |
| C12 | Can not liquidate safe vault |
| C13 | Invalid address |
| C14 | Set fee recipient first |
| C15 | Fee too high |
| C16 | Paused too many times |
| C17 | Pause time limit exceeded |
| C18 | Not enough paused time has passed |
| C19 | Cannot receive eth |
| C20 | Invalid vault id |
| C21 | Need full liquidation |
| C22 | Dust vault left |
| C23 | Invalid nft |
| C24 | Invalid state |
| C25 | Not allowed |
```

--------------------------------

### withdraw(uint256 _crabAmount)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Withdraws WETH from the strategy by providing strategy tokens and wSqueeth.

```APIDOC
## withdraw(uint256 _crabAmount) CrabStrategyV2

### Description
Withdraw WETH from strategy. Provide strategy tokens and wSqueeth, returns ETH.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_crabAmount** (uint256) - strategy token amount

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### nonces(address _owner)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Retrieves the nonce for a given owner address.

```APIDOC
## nonces(address _owner) CrabStrategyV2

### Description
Retrieves the nonce for a given owner address.

### Method
GET

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
* **_owner** (address) - The owner's address.

### Request Example
N/A

### Response
#### Success Response (200)
* **nonce** (uint256) - The nonce value.

#### Response Example
N/A
```

--------------------------------

### withdrawShutdown(uint256 _crabAmount)

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Withdraws from the strategy during shutdown.

```APIDOC
## withdrawShutdown(uint256 _crabAmount) CrabStrategyV2

### Description
Withdraw from strategy during shutdown.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
* **_crabAmount** (uint256) - strategy token amount

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### incrementNonce

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/strategy-functions/crabstrategyv2-doc

Allows a user to increment their nonce, which can be used to cancel previous orders.

```APIDOC
## POST /incrementNonce

### Description
Increments the user's nonce to allow for the cancellation of previous orders.

### Method
POST

### Endpoint
/incrementNonce

### Parameters
#### Request Body
- **current** (uint256) - Required - The current user nonce.

### Response
#### Success Response (200)
- **nonce** (uint256) - The incremented nonce.
```

--------------------------------

### Withdraw from Strategy Contract

Source: https://opyn.gitbook.io/squeeth/contracts/strategies/examples/strategy-lifecycle

Call the withdraw function on the strategy contract, specifying the amounts of strategy tokens and oSQTH to withdraw. This process involves repurchasing oSQTH and returning collateral.

```Solidity
withdraw(_crabAmount=0.3, oSQTHAmount=0.5)
```
Tokens:
Raw