# MixedRouteQuoterV1

Allows getting the expected amount out for a given swap without executing the swap

Does not support exact output swaps since using the contract balance between exactOut swaps is not supported

*These functions are not gas efficient and should not be called on chain. Instead, optimistically execute the swap and check the amounts in the callback.*

### State Variables <a href="#state-variables" id="state-variables"></a>

#### factoryV1 <a href="#factoryv1" id="factoryv1"></a>

```solidity
address public immutable factoryV1;
```

#### flagBitmask <a href="#flagbitmask" id="flagbitmask"></a>

*Value to bit mask with path fee to determine if V1 or V2 route*

```solidity
uint24 private constant flagBitmask = 8388608;
```

#### amountOutCached <a href="#amountoutcached" id="amountoutcached"></a>

*Transient storage variable used to check a safety condition in exact output swaps.*

```solidity
uint256 private amountOutCached;
```

### Functions <a href="#functions" id="functions"></a>

#### constructor <a href="#constructor" id="constructor"></a>

```solidity
constructor(address _factory, address _factoryV1, address _WSEI) PeripheryImmutableState(_factory, _WSEI);
```

#### getPool <a href="#getpool" id="getpool"></a>

```solidity
function getPool(address tokenA, address tokenB, uint24 fee) private view returns (IDragonswapV2Pool);
```

#### getPairAmountOut <a href="#getpairamountout" id="getpairamountout"></a>

*Given an amountIn, fetch the reserves of the V1 pair and get the amountOut*

```solidity
function getPairAmountOut(uint256 amountIn, address tokenIn, address tokenOut) private view returns (uint256);
```

#### dragonswapV2SwapCallback <a href="#dragonswapv2swapcallback" id="dragonswapv2swapcallback"></a>

Called to `msg.sender` after executing a swap via IDragonswapV2Pool#swap.

*In the implementation you must pay the pool tokens owed for the swap. The caller of this method must be checked to be a DragonswapV2Pool deployed by the canonical DragonswapV2Factory. amount0Delta and amount1Delta can both be 0 if no tokens were swapped.*

```solidity
function dragonswapV2SwapCallback(int256 amount0Delta, int256 amount1Delta, bytes memory path) external view override;
```

**Parameters**

| Name           | Type     | Description                                                                                                                                                                             |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount0Delta` | `int256` | The amount of token0 that was sent (negative) or must be received (positive) by the pool by the end of the swap. If positive, the callback must send that amount of token0 to the pool. |
| `amount1Delta` | `int256` | The amount of token1 that was sent (negative) or must be received (positive) by the pool by the end of the swap. If positive, the callback must send that amount of token1 to the pool. |
| `path`         | `bytes`  |                                                                                                                                                                                         |

#### parseRevertReason <a href="#parserevertreason" id="parserevertreason"></a>

since we don't support exactOutput, revert here

*Parses a revert reason that should contain the numeric quote*

```solidity
function parseRevertReason(bytes memory reason)
    private
    pure
    returns (uint256 amount, uint160 sqrtPriceX96After, int24 tickAfter);
```

#### handleV2Revert <a href="#handlev2revert" id="handlev2revert"></a>

```solidity
function handleV2Revert(bytes memory reason, IDragonswapV2Pool pool, uint256 gasEstimate)
    private
    view
    returns (uint256 amount, uint160 sqrtPriceX96After, uint32 initializedTicksCrossed, uint256);
```

#### quoteExactInputSingleV2 <a href="#quoteexactinputsinglev2" id="quoteexactinputsinglev2"></a>

*Fetch an exactIn quote for a V2 Pool on chain*

```solidity
function quoteExactInputSingleV2(QuoteExactInputSingleV2Params memory params)
    public
    override
    returns (uint256 amountOut, uint160 sqrtPriceX96After, uint32 initializedTicksCrossed, uint256 gasEstimate);
```

#### quoteExactInputSingleV1 <a href="#quoteexactinputsinglev1" id="quoteexactinputsinglev1"></a>

*Fetch an exactIn quote for a V1 pair on chain*

```solidity
function quoteExactInputSingleV1(QuoteExactInputSingleV1Params memory params)
    public
    view
    override
    returns (uint256 amountOut);
```

#### quoteExactInput <a href="#quoteexactinput" id="quoteexactinput"></a>

To encode a V1 pair within the path, use 0x800000 (hex value of 8388608) for the fee between the two token addresses

*Get the quote for an exactIn swap between an array of V1 and/or V2 pools*

```solidity
function quoteExactInput(bytes memory path, uint256 amountIn)
    public
    override
    returns (
        uint256 amountOut,
        uint160[] memory v2SqrtPriceX96AfterList,
        uint32[] memory v2InitializedTicksCrossedList,
        uint256 v2SwapGasEstimate
    );
```
