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.
Wraps Ramses V3 positions in the ERC721 non-fungible token interface. Extends the standard position management with gauge reward claiming and voter integration.
Functions
constructor
function constructor(
) public
positions
function positions(
uint256 tokenId
) external view returns (address token0, address token1, int24 tickSpacing, int24 tickLower, int24 tickUpper, uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128, uint128 tokensOwed0, uint128 tokensOwed1)
Parameters:
| Name | Type | Description |
|---|
tokenId | uint256 | The ID of the token that represents the position |
Return Values:
| Name | Type | Description |
|---|
token0 | address | The address of the token0 for a specific pool |
token1 | address | The address of the token1 for a specific pool |
tickSpacing | int24 | The tick spacing of the pool |
tickLower | int24 | The lower end of the tick range for the position |
tickUpper | int24 | The higher end of the tick range for the position |
liquidity | uint128 | The liquidity of the position |
feeGrowthInside0LastX128 | uint256 | The fee growth of token0 as of the last action on the individual position |
feeGrowthInside1LastX128 | uint256 | The fee growth of token1 as of the last action on the individual position |
tokensOwed0 | uint128 | The uncollected amount of token0 owed to the position as of the last computation |
tokensOwed1 | uint128 | The uncollected amount of token1 owed to the position as of the last computation |
mint
function mint(
struct IRamsesV3PositionManager.MintParams params
) external payable returns (uint256 tokenId, uint128 liquidity, uint256 amount0, uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
params | struct IRamsesV3PositionManager.MintParams | The params necessary to mint a position, encoded as MintParams in calldata |
Return Values:
| Name | Type | Description |
|---|
tokenId | uint256 | The ID of the token that represents the minted position |
liquidity | uint128 | The amount of liquidity for this position |
amount0 | uint256 | The amount of token0 |
amount1 | uint256 | The amount of token1 |
tokenURI
function tokenURI(
uint256 tokenId
) public view returns (string)
Parameters:
| Name | Type | Description |
|---|
tokenId | uint256 | The ID of the token that represents the minted position |
Return Values:
A base64 string with the URI data.
increaseLiquidity
function increaseLiquidity(
struct IRamsesV3PositionManager.IncreaseLiquidityParams params
) external payable returns (uint128 liquidity, uint256 amount0, uint256 amount1)
msg.sender
Parameters:
| Name | Type | Description |
|---|
params | struct IRamsesV3PositionManager.IncreaseLiquidityParams | tokenId The ID of the token for which liquidity is being increased, |
Return Values:
| Name | Type | Description |
|---|
liquidity | uint128 | The new liquidity amount as a result of the increase |
amount0 | uint256 | The amount of token0 to achieve resulting liquidity |
amount1 | uint256 | The amount of token1 to achieve resulting liquidity |
decreaseLiquidity
function decreaseLiquidity(
struct IRamsesV3PositionManager.DecreaseLiquidityParams params
) external payable returns (uint256 amount0, uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
params | struct IRamsesV3PositionManager.DecreaseLiquidityParams | tokenId The ID of the token for which liquidity is being decreased, |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint256 | The amount of token0 accounted to the position’s tokens owed |
amount1 | uint256 | The amount of token1 accounted to the position’s tokens owed |
collect
function collect(
struct IRamsesV3PositionManager.CollectParams params
) external payable returns (uint256 amount0, uint256 amount1)
Parameters:
| Name | Type | Description |
|---|
params | struct IRamsesV3PositionManager.CollectParams | tokenId The ID of the NFT for which tokens are being collected, |
Return Values:
| Name | Type | Description |
|---|
amount0 | uint256 | The amount of fees collected in token0 |
amount1 | uint256 | The amount of fees collected in token1 |
burn
function burn(
uint256 tokenId
) external payable
Parameters:
| Name | Type | Description |
|---|
tokenId | uint256 | The ID of the token that is being burned |
getReward
function getReward(
uint256 tokenId,
address[] tokens
) external
Parameters:
| Name | Type | Description |
|---|
tokenId | uint256 | The ID of the token for which to claim rewards |
tokens | address[] | The reward token addresses to claim |
setVoter
function setVoter(
address _voter
) external
Parameters:
| Name | Type | Description |
|---|
_voter | address | The address of the Voter contract |
