This documentation covers Kwikswap-specific functionality. For ERC-20 functionality, see Pair (ERC-20).

Code

KwikswapV1Pair.sol

Address

See Pair Addresses.

Events

Mint

event Mint(address indexed sender, uint amount0, uint amount1);
Copy

Emitted each time liquidity tokens are created via mint.

Burn

event Burn(address indexed sender, uint amount0, uint amount1, address indexed to);
Copy

Emitted each time liquidity tokens are destroyed via burn.

Sync

event Sync(uint112 reserve0, uint112 reserve1);
Copy

Emitted each time reserves are updated via mint, burn, swap, or sync.

Swap

event Swap(
  address indexed sender,
  uint amount0In,
  uint amount1In,
  uint amount0Out,
  uint amount1Out,
  address indexed to
);
Copy

Emitted each time a swap occurs via swap.

Read-Only Functions

factory

function factory() external view returns (address);
Copy

Returns the factory address.

MINIMUM_LIQUIDITY

function MINIMUM_LIQUIDITY() external pure returns (uint);
Copy

Returns 1000 for all pairs. See Minimum Liquidity.

token0

function token0() external view returns (address);
Copy

Returns the address of the pair token with the lower sort order.

token1

function token1() external view returns (address);
Copy

Returns the address of the pair token with the higher sort order.

price0CumulativeLast

function price0CumulativeLast() external view returns (uint);
Copy

See Oracles.

price1CumulativeLast

function price1CumulativeLast() external view returns (uint);
Copy

See Oracles.

getReserves

function getReserves() external view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast);
Copy

Returns the reserves of token0 and token1 used to price trades and distribute liquidity. See Pricing. Also returns the block.timestamp (mod 2**32) of the last block during which an interaction occured for the pair.

kLast

function kLast() external view returns (uint);
Copy

Returns the product of the reserves as of the most recent liquidity event. See Protocol Charge Calculation.

State-Changing Functions

mint

function mint(address to) external returns (uint liquidity);
Copy

Creates pool tokens.

• Emits Mint, Sync, Transfer.

swap

function swap(uint amount0Out, uint amount1Out, address to, bytes calldata data) external;
Copy

Swaps tokens. For regular swaps, data.length must be 0.

• Emits Swap, Sync.

skim

function skim(address to) external;
Copy

See the whitepaper.

burn

function burn(address to) external returns (uint amount0, uint amount1);
Copy

Destroys pool tokens.

• Emits Burn, Sync, Transfer.

sync

function sync() external;
Copy

See the whitepaper.

• Emits Sync.

Interface

import '@kwikswap/v1-core/contracts/interfaces/IKwikswapV1Pair.sol';
Copy

pragma solidity >=0.5.0;

interface IKwikswapV1Pair {
  event Approval(address indexed owner, address indexed spender, uint value);
  event Transfer(address indexed from, address indexed to, uint value);

  function name() external pure returns (string memory);
  function symbol() external pure returns (string memory);
  function decimals() external pure returns (uint8);
  function totalSupply() external view returns (uint);
  function balanceOf(address owner) external view returns (uint);
  function allowance(address owner, address spender) external view returns (uint);

  function approve(address spender, uint value) external returns (bool);
  function transfer(address to, uint value) external returns (bool);
  function transferFrom(address from, address to, uint value) external returns (bool);

  function DOMAIN_SEPARATOR() external view returns (bytes32);
  function PERMIT_TYPEHASH() external pure returns (bytes32);
  function nonces(address owner) external view returns (uint);

  function permit(address owner, address spender, uint value, uint deadline, uint8 v, bytes32 r, bytes32 s) external;

  event Mint(address indexed sender, uint amount0, uint amount1);
  event Burn(address indexed sender, uint amount0, uint amount1, address indexed to);
  event Swap(
      address indexed sender,
      uint amount0In,
      uint amount1In,
      uint amount0Out,
      uint amount1Out,
      address indexed to
  );
  event Sync(uint112 reserve0, uint112 reserve1);

  function MINIMUM_LIQUIDITY() external pure returns (uint);
  function factory() external view returns (address);
  function token0() external view returns (address);
  function token1() external view returns (address);
  function getReserves() external view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast);
  function price0CumulativeLast() external view returns (uint);
  function price1CumulativeLast() external view returns (uint);
  function kLast() external view returns (uint);

  function mint(address to) external returns (uint liquidity);
  function burn(address to) external returns (uint amount0, uint amount1);
  function swap(uint amount0Out, uint amount1Out, address to, bytes calldata data) external;
  function skim(address to) external;
  function sync() external;
}
Copy

ABI

import IKwikswapV1Pair from '@kwikswap/v1-core/build/IKwikswapV1Pair.json'
Copy