Skip to main content

Factory

Code​

PegasysFactory.sol

Address

0x7Bbbb6abaD521dE677aBe089C85b29e3b2021496

Events

PairCreated​

event PairCreated(address indexed token0, address indexed token1, 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) external view returns (address pair);

Returns the address of the pair for tokenA and tokenB, if it has been created, else address(0) (0x0000000000000000000000000000000000000000).

  • tokenA and tokenB are interchangeable.
  • Pair addresses can also be calculated deterministically.

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.

feeTo​

function feeTo() external view returns (address);

See Protocol Charge Calculation.

feeToSetter​

function feeToSetter() external view returns (address);

The address allowed to change feeTo.

State-Changing Functions

createPair​

function createPair(address tokenA, address tokenB) external returns (address pair);

Creates a pair for tokenA and tokenB if one doesn't exist already.

  • tokenA and tokenB are interchangeable.
  • Emits PairCreated.

Interface

import '@pollum-io/pegasys-protocol/contracts/pegasys-core/interfaces/IPegasysFactory.sol';
pragma solidity >=0.5.0;

interface IPegasysFactory {
  event PairCreated(address indexed token0, address indexed token1, address pair, uint);

  function getPair(address tokenA, address tokenB) external view returns (address pair);
  function allPairs(uint) external view returns (address pair);
  function allPairsLength() external view returns (uint);

  function feeTo() external view returns (address);
  function feeToSetter() external view returns (address);

  function createPair(address tokenA, address tokenB) external returns (address pair);
}

ABI

import IPegasysFactory from "@pollum-io/pegasys-protocol/artifacts/contracts/pegasys-core/interfaces/IPegasysFactory.sol/IPegasysFactory.json";

@pollum-io/pegasys-protocol