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.
Contains pool methods that can be called by anyone
Functions
initialize
function initialize(
uint160 sqrtPriceX96
) external
Parameters:
| Name | Type | Description |
|---|
sqrtPriceX96 | uint160 | the initial sqrt price of the pool as a Q64.96 |
mint
function mint(
address recipient,
uint256 index,
int24 tickLower,
int24 tickUpper,
uint128 amount,
bytes data
) external returns (uint256 amount0, uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
recipient | address | The address for which the liquidity will be created |
index | uint256 | The index of the position (distinguishes multiple positions at the same range) |
tickLower | int24 | The lower tick of the position in which to add liquidity |
tickUpper | int24 | The upper tick of the position in which to add liquidity |
amount | uint128 | The amount of liquidity to mint |
data | bytes | Any data that should be passed through to the callback |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint256 | The amount of token0 that was paid to mint the given amount of liquidity. Matches the value in the callback |
amount1 | uint256 | The amount of token1 that was paid to mint the given amount of liquidity. Matches the value in the callback |
collect
function collect(
address recipient,
uint256 index,
int24 tickLower,
int24 tickUpper,
uint128 amount0Requested,
uint128 amount1Requested
) external returns (uint128 amount0, uint128 amount1)
Parameters:
| Name | Type | Description |
|---|
recipient | address | The address which should receive the fees collected |
index | uint256 | The index of the position |
tickLower | int24 | The lower tick of the position for which to collect fees |
tickUpper | int24 | The upper tick of the position for which to collect fees |
amount0Requested | uint128 | How much token0 should be withdrawn from the fees owed |
amount1Requested | uint128 | How much token1 should be withdrawn from the fees owed |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint128 | The amount of fees collected in token0 |
amount1 | uint128 | The amount of fees collected in token1 |
burn
function burn(
uint256 index,
int24 tickLower,
int24 tickUpper,
uint128 amount
) external returns (uint256 amount0, uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
index | uint256 | The index of the position |
tickLower | int24 | The lower tick of the position for which to burn liquidity |
tickUpper | int24 | The upper tick of the position for which to burn liquidity |
amount | uint128 | How much liquidity to burn |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint256 | The amount of token0 sent to the recipient |
amount1 | uint256 | The amount of token1 sent to the recipient |
swap
function swap(
address recipient,
bool zeroForOne,
int256 amountSpecified,
uint160 sqrtPriceLimitX96,
bytes data
) external returns (int256 amount0, int256 amount1)
Parameters:
| Name | Type | Description |
|---|
recipient | address | The address to receive the output of the swap |
zeroForOne | bool | The direction of the swap, true for token0 to token1, false for token1 to token0 |
amountSpecified | int256 | The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative) |
sqrtPriceLimitX96 | uint160 | The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap |
data | bytes | Any data passed through to the callback |
Return Values:
| Name | Type | Description |
|---|
amount0 | int256 | The delta of the balance of token0 of the pool, exact when negative, minimum when positive |
amount1 | int256 | The delta of the balance of token1 of the pool, exact when negative, minimum when positive |
flash
function flash(
address recipient,
uint256 amount0,
uint256 amount1,
bytes data
) external
Parameters:
| Name | Type | Description |
|---|
recipient | address | The address which will receive the token0 and token1 amounts |
amount0 | uint256 | The amount of token0 to send |
amount1 | uint256 | The amount of token1 to send |
data | bytes | Any data to be passed through to the callback |
increaseObservationCardinalityNext
function increaseObservationCardinalityNext(
uint16 observationCardinalityNext
) external
Parameters:
| Name | Type | Description |
|---|
observationCardinalityNext | uint16 | The desired minimum number of observations for the pool to store |
