WhaleSwap
Search…
Factory

Events

PairCreated

event PairCreated(address indexed token0, address indexed token1, bool stable, address pair, uint);
Emitted each time a pair is created via createPair.
  • token0 is guaranteed to be strictly less than token1 by sort order.
  • The final uint log value will be 1 for the first pair created, 2 for the second, etc. (see allPairs/getPair).

Read-Only Functions

getPair

function getPair(address tokenA, address tokenB, bool stable) external view returns (address pair);
Returns the address of the pair for tokenA and tokenB with the pool type if it has been created, else address(0) (0x0000000000000000000000000000000000000000).
  • tokenA and tokenB are interchangeable.
  • Pair addresses can also be calculated deterministically via the SDK.

allPairs

function allPairs(uint) external view returns (address pair);
Returns the address of the nth pair (0-indexed) created through the factory, or address(0) (0x0000000000000000000000000000000000000000) if not enough pairs have been created yet.
  • Pass 0 for the address of the first pair created, 1 for the second, etc.

allPairsLength

function allPairsLength() external view returns (uint);
Returns the total number of pairs created through the factory so far.

State-Changing Functions

createPair

function createPair(address tokenA, address tokenB, bool stable) external returns (address pair);
Creates a pair of the specified type for tokenA and tokenB if one doesn't exist already.
  • tokenA and tokenB are interchangeable.
  • Emits PairCreated.
Copy link
On this page
Events
PairCreated
Read-Only Functions
getPair
allPairs
allPairsLength
State-Changing Functions
createPair