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.

Functions

deploy

  function deploy(
    address token0,
    address token1,
    int24 tickSpacing
  ) external returns (address pool)
Deploys a pool with the given parameters. Can only be called by the RamsesV3Factory. The pool’s factory, fee, and tick spacing are read from the factory’s parameters() transient storage during deployment.

Parameters:

NameTypeDescription
token0addressThe first token of the pool by address sort order
token1addressThe second token of the pool by address sort order
tickSpacingint24The spacing between usable ticks

Return Values:

NameTypeDescription
pooladdressThe address of the newly created pool

parameters

  function parameters(
  ) external view returns (address factory, address token0, address token1, uint24 fee, int24 tickSpacing)
Returns the pool constructor parameters. Reads from the factory’s parameters() storage, which is transiently set during createPool and cleared after deployment.

RamsesV3Factory

  function RamsesV3Factory(
  ) external view returns (address)
Returns the address of the canonical RamsesV3Factory. Set as an immutable in the constructor.