Skip to main content

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 may only be called by the factory owner

Functions

setFeeProtocol

  function setFeeProtocol(
  ) external
Syncs the pool’s protocol fee from the factory. Called by the factory when the global or pool-specific fee protocol is updated. Takes no parameters — reads the fee directly from IRamsesV3Factory.poolFeeProtocol(address(this)).

collectProtocol

  function collectProtocol(
    address recipient,
    uint128 amount0Requested,
    uint128 amount1Requested
  ) external returns (uint128 amount0, uint128 amount1)
Collect the protocol fee accrued to the pool

Parameters:

NameTypeDescription
recipientaddressThe address to which collected protocol fees should be sent
amount0Requesteduint128The maximum amount of token0 to send, can be 0 to collect fees in only token1
amount1Requesteduint128The maximum amount of token1 to send, can be 0 to collect fees in only token0

Return Values:

NameTypeDescription
amount0uint128The protocol fee collected in token0
amount1uint128The protocol fee collected in token1

setFee

  function setFee(
    uint24 _fee
  ) external
Sets the pool’s swap fee. Can only be called by the factory. Ramses-specific addition allowing governance to adjust fees per pool.

Parameters:

NameTypeDescription
_feeuint24The new swap fee, denominated in hundredths of a bip (i.e. 1e-6)