Documentation Index
Fetch the complete documentation index at: https://tech.ramses.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Supports quoting the calculated amounts from exact input or exact output swaps
These functions are not marked view because they rely on calling non-view functions and reverting
to compute the result. They are also not gas efficient and should not be called on-chain.
Functions
function quoteExactInput(
bytes path,
uint256 amountIn
) external returns (uint256 amountOut)
Parameters:
| Name | Type | Description |
|---|
path | bytes | The path of the swap, i.e. each token pair and the pool fee |
amountIn | uint256 | The amount of the first token to swap |
Return Values:
| Name | Type | Description |
|---|
amountOut | uint256 | The amount of the last token that would be received |
function quoteExactInputSingle(
address tokenIn,
address tokenOut,
int24 tickSpacing,
uint256 amountIn,
uint160 sqrtPriceLimitX96
) external returns (uint256 amountOut)
Parameters:
| Name | Type | Description |
|---|
tokenIn | address | The token being swapped in |
tokenOut | address | The token being swapped out |
tickSpacing | int24 | The tick spacing of the pool |
amountIn | uint256 | The desired input amount |
sqrtPriceLimitX96 | uint160 | The price limit of the pool that cannot be exceeded by the swap |
Return Values:
| Name | Type | Description |
|---|
amountOut | uint256 | The amount of tokenOut that would be received |
quoteExactOutput
function quoteExactOutput(
bytes path,
uint256 amountOut
) external returns (uint256 amountIn)
Parameters:
| Name | Type | Description |
|---|
path | bytes | The path of the swap, i.e. each token pair and the pool fee |
amountOut | uint256 | The amount of the last token to receive |
Return Values:
| Name | Type | Description |
|---|
amountIn | uint256 | The amount of first token required to be paid |
quoteExactOutputSingle
function quoteExactOutputSingle(
address tokenIn,
address tokenOut,
int24 tickSpacing,
uint256 amountOut,
uint160 sqrtPriceLimitX96
) external returns (uint256 amountIn)
Parameters:
| Name | Type | Description |
|---|
tokenIn | address | The token being swapped in |
tokenOut | address | The token being swapped out |
tickSpacing | int24 | The tick spacing of the pool |
amountOut | uint256 | The desired output amount |
sqrtPriceLimitX96 | uint160 | The price limit of the pool that cannot be exceeded by the swap |
Return Values:
| Name | Type | Description |
|---|
amountIn | uint256 | The amount required as the input for the swap in order to receive amountOut |
