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.
Provides functions for computing liquidity amounts from token amounts and prices
Functions
getLiquidityForAmount0
function getLiquidityForAmount0(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint256 amount0
) internal returns (uint128 liquidity)
Parameters:
| Name | Type | Description |
|---|
sqrtRatioAX96 | uint160 | A sqrt price representing the first tick boundary |
sqrtRatioBX96 | uint160 | A sqrt price representing the second tick boundary |
amount0 | uint256 | The amount0 being sent in |
Return Values:
| Name | Type | Description |
|---|
liquidity | uint128 | The amount of returned liquidity |
getLiquidityForAmount1
function getLiquidityForAmount1(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint256 amount1
) internal returns (uint128 liquidity)
Parameters:
| Name | Type | Description |
|---|
sqrtRatioAX96 | uint160 | A sqrt price representing the first tick boundary |
sqrtRatioBX96 | uint160 | A sqrt price representing the second tick boundary |
amount1 | uint256 | The amount1 being sent in |
Return Values:
| Name | Type | Description |
|---|
liquidity | uint128 | The amount of returned liquidity |
getLiquidityForAmounts
function getLiquidityForAmounts(
uint160 sqrtRatioX96,
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint256 amount0,
uint256 amount1
) internal returns (uint128 liquidity)
Parameters:
| Name | Type | Description |
|---|
sqrtRatioX96 | uint160 | A sqrt price representing the current pool prices |
sqrtRatioAX96 | uint160 | A sqrt price representing the first tick boundary |
sqrtRatioBX96 | uint160 | A sqrt price representing the second tick boundary |
amount0 | uint256 | The amount of token0 being sent in |
amount1 | uint256 | The amount of token1 being sent in |
Return Values:
| Name | Type | Description |
|---|
liquidity | uint128 | The maximum amount of liquidity received |
getAmount0ForLiquidity
function getAmount0ForLiquidity(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint128 liquidity
) internal returns (uint256 amount0)
Parameters:
| Name | Type | Description |
|---|
sqrtRatioAX96 | uint160 | A sqrt price representing the first tick boundary |
sqrtRatioBX96 | uint160 | A sqrt price representing the second tick boundary |
liquidity | uint128 | The liquidity being valued |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint256 | The amount of token0 |
getAmount1ForLiquidity
function getAmount1ForLiquidity(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint128 liquidity
) internal returns (uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
sqrtRatioAX96 | uint160 | A sqrt price representing the first tick boundary |
sqrtRatioBX96 | uint160 | A sqrt price representing the second tick boundary |
liquidity | uint128 | The liquidity being valued |
Return Values:
| Name | Type | Description |
|---|
amount1 | uint256 | The amount of token1 |
getAmountsForLiquidity
function getAmountsForLiquidity(
uint160 sqrtRatioX96,
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint128 liquidity
) internal returns (uint256 amount0, uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
sqrtRatioX96 | uint160 | A sqrt price representing the current pool prices |
sqrtRatioAX96 | uint160 | A sqrt price representing the first tick boundary |
sqrtRatioBX96 | uint160 | A sqrt price representing the second tick boundary |
liquidity | uint128 | The liquidity being valued |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint256 | The amount of token0 |
amount1 | uint256 | The amount of token1 |
