PoolAddress

Functions for computing deterministic pool addresses.

Source: contracts/periphery/libraries/PoolAddress.sol

Overview

Pools are deployed using CREATE2, making their addresses deterministic and computable off-chain.

Structs

PoolKey

struct PoolKey {
    address token0;
    address token1;
    uint24 fee;
}

Functions

getPoolKey

function getPoolKey(
    address tokenA,
    address tokenB,
    uint24 fee
) internal pure returns (PoolKey memory)

Returns the PoolKey with tokens sorted (token0 < token1).

computeAddress

function computeAddress(
    address factory,
    PoolKey memory key
) internal pure returns (address pool)

Computes the pool address for the given factory and pool key.

Note: Requires the correct POOL_INIT_CODE_HASH constant.

JavaScript Implementation

const { ethers } = require('ethers');

// Get this from PoolInitHelper contract
const POOL_INIT_CODE_HASH = '0x...';

function computePoolAddress(factory, tokenA, tokenB, fee) {
    // Sort tokens
    const [token0, token1] = tokenA.toLowerCase() < tokenB.toLowerCase()
        ? [tokenA, tokenB]
        : [tokenB, tokenA];

    // Compute salt
    const salt = ethers.utils.keccak256(
        ethers.utils.defaultAbiCoder.encode(
            ['address', 'address', 'uint24'],
            [token0, token1, fee]
        )
    );

    // Compute CREATE2 address
    return ethers.utils.getCreate2Address(
        factory,
        salt,
        POOL_INIT_CODE_HASH
    );
}

Getting Init Code Hash

Deploy the PoolInitHelper and call it:

const poolInitHelper = await ethers.getContractAt(
    'PoolInitHelper',
    POOL_INIT_HELPER_ADDRESS
);

const hash = await poolInitHelper.POOL_INIT_CODE_HASH();
console.log('Init code hash:', hash);

Usage Example

// Compute WVC/USDT pool address
const poolAddress = computePoolAddress(
    FACTORY_ADDRESS,
    WVC,
    USDT,
    3000  // 0.3% fee
);

// Verify
const factoryContract = new ethers.Contract(FACTORY_ADDRESS, factoryABI, provider);
const actualAddress = await factoryContract.getPool(WVC, USDT, 3000);

console.log('Computed:', poolAddress);
console.log('Actual:', actualAddress);
console.log('Match:', poolAddress.toLowerCase() === actualAddress.toLowerCase());

Related

• VinuSwapFactory

• VinuSwapPoolDeployer