SDK
technical-reference
Helpers

Helpers

Pool IDs

splitPoolId

/**
 * Splits a poolId into its components, i.e. pool address, pool specialization and its nonce
 * @param poolId - a bytes32 string of the pool's ID
 * @returns an object with the decomposed poolId
 */
export const splitPoolId = (
  poolId: string
): {
  address: string,
  specialization: PoolSpecialization,
  nonce: BigNumber,
} => {
  return {
    address: getPoolAddress(poolId),
    specialization: getPoolSpecialization(poolId),
    nonce: getPoolNonce(poolId),
  };
};

getPoolAddress

/**
 * Extracts a pool's address from its poolId
 * @param poolId - a bytes32 string of the pool's ID
 * @returns the pool's address
 */
export const getPoolAddress = (poolId: string): string => {
  invariant(poolId.length === 66, 'Invalid poolId length');
  return poolId.slice(0, 42);
};

getPoolSpecialization

/**
 * Extracts a pool's specialization from its poolId
 * @param poolId - a bytes32 string of the pool's ID
 * @returns the pool's specialization
 */
export const getPoolSpecialization = (poolId: string): PoolSpecialization => {
  invariant(poolId.length === 66, 'Invalid poolId length');
 
  // Only have 3 pool specializations so we can just pull the relevant character
  const specializationCode = parseInt(poolId[45]);
  invariant(specializationCode < 3, 'Invalid pool specialization');
 
  return specializationCode;
};

getPoolNonce

/**
 * Extracts a pool's nonce from its poolId
 * @param poolId - a bytes32 string of the pool's ID
 * @returns the pool's nonce
 */
export const getPoolNonce = (poolId: string): BigNumber => {
  invariant(poolId.length === 66, 'Invalid poolId length');
  return BigNumber.from(`0x${poolId.slice(46)}`);
};

© 2023 Balancer Labs